diff --git a/MkDocs/mas_techzone_base/docs/extra.css b/MkDocs/mas_techzone_base/docs/extra.css new file mode 100644 index 00000000..fedf8fb6 --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/extra.css @@ -0,0 +1,48 @@ +table { + margin-bottom: 2em +} + +table tr th { + padding: 5px 10px; + background-color: #ddd; + border:1px solid #aaa !important +} + +table tr td { + padding: 5px 10px; + border:1px solid #aaa !important +} + +table tr:nth-child(even) { + background-color: #eee; +} + +/* If an unordered list immediately follows a normal paragraph, set negative + margin so that it flows better */ +div[role=main] p + ul { + margin-top: -20px +} + +/* Ensure we keep the margin if the previous paragraph is an admonition title */ +div[role=main] p.admonition-title + ul { + margin-top: 0 +} + +img { + display: block; + margin-left: auto; + margin-right: auto; +} + +.wy-nav-content { + max-width: 1200px !important; +} + +.wy-table-responsive table td, .wy-table-responsive table th { + white-space: normal !important; +} + +h2 { + margin-top: 2em; + border-bottom: 2px solid black +} \ No newline at end of file diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_01.png b/MkDocs/mas_techzone_base/docs/img/instantiate_01.png new file mode 100644 index 00000000..4a44ae3a Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_01.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_02.png b/MkDocs/mas_techzone_base/docs/img/instantiate_02.png new file mode 100644 index 00000000..cffc48a5 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_02.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_03.png b/MkDocs/mas_techzone_base/docs/img/instantiate_03.png new file mode 100644 index 00000000..a31cf260 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_03.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_04.png b/MkDocs/mas_techzone_base/docs/img/instantiate_04.png new file mode 100644 index 00000000..e98e8570 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_04.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_05.png b/MkDocs/mas_techzone_base/docs/img/instantiate_05.png new file mode 100644 index 00000000..76b3f570 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_05.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_06.png b/MkDocs/mas_techzone_base/docs/img/instantiate_06.png new file mode 100644 index 00000000..45a6f54d Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_06.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_07.png b/MkDocs/mas_techzone_base/docs/img/instantiate_07.png new file mode 100644 index 00000000..1cd12674 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_07.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_08.png b/MkDocs/mas_techzone_base/docs/img/instantiate_08.png new file mode 100644 index 00000000..5e90af69 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_08.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_09.png b/MkDocs/mas_techzone_base/docs/img/instantiate_09.png new file mode 100644 index 00000000..00cf0080 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_09.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_10.png b/MkDocs/mas_techzone_base/docs/img/instantiate_10.png new file mode 100644 index 00000000..e0b817fb Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_10.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_11.png b/MkDocs/mas_techzone_base/docs/img/instantiate_11.png new file mode 100644 index 00000000..2c96cbcb Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_11.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_12.png b/MkDocs/mas_techzone_base/docs/img/instantiate_12.png new file mode 100644 index 00000000..84832511 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_12.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_13.png b/MkDocs/mas_techzone_base/docs/img/instantiate_13.png new file mode 100644 index 00000000..ee653b02 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_13.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_14.png b/MkDocs/mas_techzone_base/docs/img/instantiate_14.png new file mode 100644 index 00000000..794cac37 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_14.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_15.png b/MkDocs/mas_techzone_base/docs/img/instantiate_15.png new file mode 100644 index 00000000..967c57ca Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/instantiate_15.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_01.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_01.png new file mode 100644 index 00000000..142509eb Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_01.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_02.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_02.png new file mode 100644 index 00000000..c4d74aee Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_02.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_03.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_03.png new file mode 100644 index 00000000..44af092d Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_03.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_04.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_04.png new file mode 100644 index 00000000..46f788ab Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_04.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_05.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_05.png new file mode 100644 index 00000000..69290ee1 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_05.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_06.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_06.png new file mode 100644 index 00000000..b69997d0 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_06.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_07.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_07.png new file mode 100644 index 00000000..f99ddeb1 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_07.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/prepare_for_use_08.png b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_08.png new file mode 100644 index 00000000..2a047ef6 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/prepare_for_use_08.png differ diff --git a/MkDocs/mas_techzone_base/docs/img/techzone_support_01.png b/MkDocs/mas_techzone_base/docs/img/techzone_support_01.png new file mode 100644 index 00000000..b5b1b917 Binary files /dev/null and b/MkDocs/mas_techzone_base/docs/img/techzone_support_01.png differ diff --git a/MkDocs/mas_techzone_base/docs/index.md b/MkDocs/mas_techzone_base/docs/index.md new file mode 100644 index 00000000..8f99c1c5 --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/index.md @@ -0,0 +1,24 @@ +# Welcome to the
MAS Techzone Certified Base Image Hands-on Lab + +!!! danger "Audience" + This hands-on lab is only applicable for IBM Business Partners and IBM'ers, as it requires access to IBM Technology Zone (aka TechZone). + +--- + +You will learn how to use MAS Techzone Certified Base Images. + +The exercises will cover: + +* Instantiate/Reserve a MAS Techzone Certified Base Image +* Prepare the MAS instance for usage +* Have fun + +!!! note + Expected time needed to run the complete lab will depend one which MAS Techzone Certified Base Image that is selected: 2+ hours + + +--- + +**Updated: 2024-09-21** + +--- \ No newline at end of file diff --git a/MkDocs/mas_techzone_base/docs/install.md b/MkDocs/mas_techzone_base/docs/install.md new file mode 100644 index 00000000..5b6a75f5 --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/install.md @@ -0,0 +1,17 @@ + + +````bash + +oc login --token=sha256~zxwGF1b0XEPf6R6QS5ODeiSD67abErDsas0s63JbC4o --server=https://api.1e35f5fc927.ocp.techzone.ibm.com:6443 +mkdir /root/mas_configs +kubectl get secret ibm-sls-sls-entitlement -n ibm-sls -o json | jq -r '.data.entitlement' | base64 --decode > /root/mas_configs/entitlement.lic + +export IBM_ENTITLEMENT_KEY=$(kubectl get secret ibm-entitlement -n mas-inst1-core -o json | jq -r '.data[".dockerconfigjson"]' | base64 --decode | jq -r '.auths["cp.icr.io/cp"].password') +export DB2_INSTANCE_NAME=db2u-iot +export MAS_INSTANCE_ID=inst1 +export MAS_CONFIG_DIR=/root/mas_configs + +ansible-playbook ibm.mas_devops.oneclick_add_iot +ansible-playbook ibm.mas_devops.oneclick_add_monitor + +```` \ No newline at end of file diff --git a/MkDocs/mas_techzone_base/docs/instantiate.md b/MkDocs/mas_techzone_base/docs/instantiate.md new file mode 100644 index 00000000..c8a07a7b --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/instantiate.md @@ -0,0 +1,92 @@ +# Objectives +In this Exercise you will learn how to: + +* Reserve an instance of a MAS Techzone Certified Base Image + +--- +*Before you begin:* +This Exercise requires that you have: + +1. completed the pre-requisites required for [all exercises](prereqs.md) + +--- + +Login to [IBM Technology Zone](https://techzone.ibm.com/){target=_blank} (aka TechZone) with your IBMid. + +!!! note "Remember" + Remember that TechZone is only available for IBM Business Partner and IBM'ers with an IBMid. + +Search for `TechZone Certified Base Images` and you will find this page:
+ +![TechZone](img/instantiate_01.png)

+ +Scroll down untill you find the `Maximo Application Suite` images.
+At this point in time (August '24) these two exists for version 9.0:
+ +![MAS Images](img/instantiate_02.png)

+ +Click on `Reserve` in order to instantiate one of these. The `Maximo Application Suite 9.0 - Core` image was used in this lab.
+Click on `Reserve now` or schedule for a later time if needed: + +![Reservation Now](img/instantiate_03.png)

+ +To understand the durations for the four different purposes, click on `Reservation Duration Policy`:
+ +![Reservation Duration Policy](img/instantiate_04.png)

+ +Demo and Pilot purposes requires an open opportunity in IBM Sales Cloud. Education and Test only require a purpose description:
+ +![Reservation Duration Policy](img/instantiate_05.png)

+ +In this case `Education` was selected, so a purpose description is needed and the geography has to be selected before scrolling down:
+ +![Reservation For Education](img/instantiate_06.png)

+ +Select `Master Node Flavor`, `OpenShift Version`, `Worker Node Count`, and `Worker Node Flavor` before agreeing to IBM T&C and clicking on Submit:
+ +![Reservation Cluster Details](img/instantiate_07.png)

+ +You will be greeted with a Thank you. Click on `My reservations`:
+ +![Create Reservation](img/instantiate_08.png)

+ +You can see the status is `Provisioning` in the TecZone `My reservations` page:
+ +![Reservation Provisioning](img/instantiate_09.png)

+ +After some time it will change to `Ready`:
+ +![Reservation Ready](img/instantiate_10.png)

+ +In this case it only took 1 hour and 18 minutes to instatiate a `Maximo Application Suite 9.0 - Core` image:
+ +![Reservation Provisioning Emails](img/instantiate_11.png)

+ + +Now you have an OpenShift Cluster where MAS Core is installed.
+Click on the reservation and you will find the link to the OCP cluster as well as the credentials needed to login to it:
+ +![Reservation OpenShift Login Details](img/instantiate_12.png)

+ +Click on the link to open the IBM Cloud environment. Select `kube:admin`:
+ +![OpenShift Login](img/instantiate_13.png)

+ +Enter the credentials from the reservation page and click on `Log in`:
+ +![OpenShift Login](img/instantiate_14.png)

+ +Navigate to the `Pipelines` tab and you should see the `mas-masdevops-deploy` pipeline succeeded:
+ +![OpenShift Pipelines](img/instantiate_15.png)

+ + +!!! tip + In case the pipeline did not succeed, open the reservation and report the problem to TechZone Support:

+ ![TechZone Support](img/techzone_support_01.png) + + + + +--- +Congratulations you have successfully instantiated a MAS Techzone Certified Base Image.
diff --git a/MkDocs/mas_techzone_base/docs/prepare_for_use.md b/MkDocs/mas_techzone_base/docs/prepare_for_use.md new file mode 100644 index 00000000..928ec5bb --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/prepare_for_use.md @@ -0,0 +1,60 @@ +# Objectives +In this Exercise you will learn how to do the first steps once the deployment has finalized. + +The OpenShift Cluster with MAS Core installed is up and running and the next step is to prepare the MAS Core for usage.
+This require to find the credentials of the suite super user in the OpenShift environment and create a MAS Administrator user for normal administrative usage in the MAS Suite Administration page.
+ +--- +*Before you begin:* +This Exercise requires that you have: + +1. completed the pre-requisites required for [all exercises](prereqs.md) +2. completed the previous exercises + +--- + +Login to the OpenShift Cluster where MAS Core is installed.
+Navigate to `Networking | Routes`. Select the `mas-inst1-core` project in the top.:
+ +![Prepare for use](img/prepare_for_use_01.png)

+ +Click on the link to the `inst1-admin` route, which will open in a new tab.
+Navigate to `Workloads | Secrets`. Ensure the `mas-inst1-core` project is selected. Filter with name `superuser`.
+Open the `inst1-credentials-superuser` secret and click on `Reveal values`:
+ +![Prepare for use](img/prepare_for_use_02.png)

+ +Switch to the recently opened tab and login with the MAS Super User credentials:
+ +![Prepare for use](img/prepare_for_use_03.png)
+ +!!! note + It is good practice to only use the MAS Super User account to create the first MAS Admin user and then use the new MAS Admin user going forward.
+ +Click on `Create a personal account` to create a the MAS administrator account:
+ +![Prepare for use](img/prepare_for_use_04.png)

+ +Fill out the Identity fields `Display name`, `User ID`, and `Primary email` - and scroll down:
+ +![Prepare for use](img/prepare_for_use_05.png)

+ +Add the propor entitlement, at least Premium Administration entitlement. Click `Create`:
+ +![Prepare for use](img/prepare_for_use_06.png)

+ +Copy and and save the credentials somewhere else for later use. Click `Close`:
+ +![Prepare for use](img/prepare_for_use_07.png)

+ +The new user will be syncronized. Click on the `Users` breadcrump link in the upper left hand corner:
+ +![Prepare for use](img/prepare_for_use_08.png)

+ + +!!! tip + Log out of the Suite Administration page and login with the new MAS Admin credentials to verify it is ready to be used.
+ + +--- +Congratulations you have successfully instantiated a MAS Techzone Certified Base Image and prepared it for use.
diff --git a/MkDocs/mas_techzone_base/docs/prereqs.md b/MkDocs/mas_techzone_base/docs/prereqs.md new file mode 100644 index 00000000..9b560519 --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/prereqs.md @@ -0,0 +1,16 @@ +# Pre-Requisite Instructions + +Here are the pre-requisites for the exercises in this lab. + +# All Exercises + +All Exercises require that you have: + +1. Access to IBM TechZone. + +2. A computer with a Chrome or Firefox browser and internet connectivity. + +3. An IBM ID. If you don't have an IBM ID you can get one [here](https://www.ibm.com/account/reg/signup?){target=_blank}:
+o Click `Login to MY IBM` button
+o Click `Create an IBM ID` link + diff --git a/MkDocs/mas_techzone_base/docs/release_notes.md b/MkDocs/mas_techzone_base/docs/release_notes.md new file mode 100644 index 00000000..2971da09 --- /dev/null +++ b/MkDocs/mas_techzone_base/docs/release_notes.md @@ -0,0 +1,17 @@ + +# Contributors to This Hands-on Lab + +#### Author & Developer: + +- Jan Ekstrøm - + +--- + +# Change Information + +|Date |By | Description | +|:---------|:--------------|:------------------------------------------------------| +|2024-09-21|Jan Ekstrøm |Lab is ready for the first release. | + + +--- diff --git a/MkDocs/mas_techzone_base/mkdocs.yml b/MkDocs/mas_techzone_base/mkdocs.yml new file mode 100644 index 00000000..49dbd600 --- /dev/null +++ b/MkDocs/mas_techzone_base/mkdocs.yml @@ -0,0 +1,28 @@ +site_name: MAS Techzone Certified Base Image Lab +site_url: https://ibm.github.io/maximo-labs/ +site_author: Jan Ekstrøm +site_description: "MAS TechZone Certified Base Image Hands-on Lab" +site_dir: ../../site/mas_techzone_base + +nav: + - Get back to Maximo Labs: .. + - MAS Techzone Certified Image Lab: + - Welcome: index.md + - Pre-Requisites: prereqs.md + - Exercises: + - 1. Instantiate a Base Image: instantiate.md + - 2. Prepare For Use: prepare_for_use.md + - About: + - Release Notes: release_notes.md + - Copyright: ../copyright + +theme: + name: readthedocs + highlightjs: true + hljs_languages: + - yaml +extra_css: + - extra.css +markdown_extensions: + - attr_list + - admonition \ No newline at end of file diff --git a/MkDocs/toplevel/docs/release_notes.md b/MkDocs/toplevel/docs/release_notes.md index 2a9fc7f5..107af9e9 100644 --- a/MkDocs/toplevel/docs/release_notes.md +++ b/MkDocs/toplevel/docs/release_notes.md @@ -7,7 +7,7 @@ - Angelina Nicolella - - Arif Ali - - Juan Gu - -- John Douglas - +- John Douglas - - Eric Lowry - - Graeme Pexton - @@ -15,10 +15,11 @@ # Change Information -|Date |By | Description | -|:--------|:--------------|:------------------------------------------------------| -|2024-09-20|Jan Ekstrøm|Updated the [Maximo Monitor Managed Gateway lab](../monitor_managed_gateway_9.0/).| -|2024-06-21|Jan Ekstrøm|Added the [Maximo Monitor Managed Gateway lab](../monitor_managed_gateway_9.0/).| +|Date |By | Description | +|:--------|:--------------|:-----------------------------------------------------------------------------------| +|2024-09-21|Jan Ekstrøm|Added the [MAS TechZone Base Certified Image lab](../mas_techzone_base/). | +|2024-09-20|Jan Ekstrøm|Updated the [Maximo Monitor Managed Gateway lab](../monitor_managed_gateway_9.0/). | +|2024-06-21|Jan Ekstrøm|Added the [Maximo Monitor Managed Gateway lab](../monitor_managed_gateway_9.0/). | |2024-06-06|Jan Ekstrøm|Updated the [Maximo Monitor Modbus Simulator lab](../monitor_modbus_simulator/) to support Apple Silicon (ARM) as well as x86 chip architecture.| |2024-05-29|Carlos Ferreira|Added the MAS 9.0 APM lab (Under Development).| |2024-04-23|Jan Ekstrøm|Updated the [Edge Data Collector lab](../edc_8.11) to use a new modbus simulator.| diff --git a/build_all_mkdocs.sh b/build_all_mkdocs.sh index 47dd92c4..5b3cda3c 100755 --- a/build_all_mkdocs.sh +++ b/build_all_mkdocs.sh @@ -23,11 +23,10 @@ echo "BUILD_INFO - The top level of IBM Maximo Labs is build." #### BELOW IS WHERE EACH LAB IS BEING BUILD #### : ' -How to comment out a blog to lover build time during development. +How to comment out a blog to lower build time during development. Look at the character used above and belove these two lines of text. ' - # Build the Monitor SaaS level: lab=monitor_saas echo "===================================================================================" @@ -204,6 +203,14 @@ cd $root_dir/MkDocs/$lab mkdocs build echo "BUILD_INFO - The $lab lab is build and added under the top level of IBM Maximo Labs." +# Build the MAS TechZone Base Certified Image level: +lab=mas_techzone_base +echo "===================================================================================" +echo "BUILD_INFO - The $lab lab is being build" +cd $root_dir/MkDocs/$lab +mkdocs build +echo "BUILD_INFO - The $lab lab is build and added under the top level of IBM Maximo Labs." + ######################################################################################## #### DON't CHANGE THE BELOW MANDATORY SECTION WHICH IS PART OF THE TOPLEVEL CONTENT #### ########################################################################################