Merge pull request #127 from IBM/mas-techzone

Added MAS Techzone Base Image lab
IBM · Aug 21, 2024 · a5354a1 · a5354a1
2 parents 412935c + 10bcbc1
commit a5354a1
Show file tree

Hide file tree

Showing 34 changed files with 317 additions and 7 deletions.
diff --git a/MkDocs/mas_techzone_base/docs/extra.css 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
+}
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_01.png b/MkDocs/mas_techzone_base/docs/img/instantiate_01.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_02.png b/MkDocs/mas_techzone_base/docs/img/instantiate_02.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_03.png b/MkDocs/mas_techzone_base/docs/img/instantiate_03.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_04.png b/MkDocs/mas_techzone_base/docs/img/instantiate_04.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_05.png b/MkDocs/mas_techzone_base/docs/img/instantiate_05.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_06.png b/MkDocs/mas_techzone_base/docs/img/instantiate_06.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_07.png b/MkDocs/mas_techzone_base/docs/img/instantiate_07.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_08.png b/MkDocs/mas_techzone_base/docs/img/instantiate_08.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_09.png b/MkDocs/mas_techzone_base/docs/img/instantiate_09.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_10.png b/MkDocs/mas_techzone_base/docs/img/instantiate_10.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_11.png b/MkDocs/mas_techzone_base/docs/img/instantiate_11.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_12.png b/MkDocs/mas_techzone_base/docs/img/instantiate_12.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_13.png b/MkDocs/mas_techzone_base/docs/img/instantiate_13.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_14.png b/MkDocs/mas_techzone_base/docs/img/instantiate_14.png
diff --git a/MkDocs/mas_techzone_base/docs/img/instantiate_15.png b/MkDocs/mas_techzone_base/docs/img/instantiate_15.png
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
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
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
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
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
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
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
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
diff --git a/MkDocs/mas_techzone_base/docs/img/techzone_support_01.png b/MkDocs/mas_techzone_base/docs/img/techzone_support_01.png
diff --git a/MkDocs/mas_techzone_base/docs/index.md b/MkDocs/mas_techzone_base/docs/index.md
@@ -0,0 +1,24 @@
+# Welcome to the </br>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**
+
+---
diff --git a/MkDocs/mas_techzone_base/docs/install.md 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
+
+````
diff --git a/MkDocs/mas_techzone_base/docs/instantiate.md 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:</br>
+
+![TechZone](img/instantiate_01.png)</br></br>
+
+Scroll down untill you find the `Maximo Application Suite` images.</br>
+At this point in time (August '24) these two exists for version 9.0:</br>
+
+![MAS Images](img/instantiate_02.png)</br></br>
+
+Click on `Reserve` in order to instantiate one of these. The `Maximo Application Suite 9.0 - Core` image was used in this lab.</br>
+Click on `Reserve now` or schedule for a later time if needed:
+
+![Reservation Now](img/instantiate_03.png)</br></br>
+
+To understand the durations for the four different purposes, click on `Reservation Duration Policy`:</br>
+
+![Reservation Duration Policy](img/instantiate_04.png)</br></br>
+
+Demo and Pilot purposes requires an open opportunity in IBM Sales Cloud. Education and Test only require a purpose description:</br>
+
+![Reservation Duration Policy](img/instantiate_05.png)</br></br>
+
+In this case `Education` was selected, so a purpose description is needed and the geography has to be selected before scrolling down:</br>
+
+![Reservation For Education](img/instantiate_06.png)</br></br>
+
+Select `Master Node Flavor`, `OpenShift Version`, `Worker Node Count`, and `Worker Node Flavor` before agreeing to IBM T&C and clicking on Submit: </br>
+
+![Reservation Cluster Details](img/instantiate_07.png)</br></br>
+
+You will be greeted with a Thank you. Click on `My reservations`:</br>
+
+![Create Reservation](img/instantiate_08.png)</br></br>
+
+You can see the status is `Provisioning` in the TecZone `My reservations` page:</br>
+
+![Reservation Provisioning](img/instantiate_09.png)</br></br>
+
+After some time it will change to `Ready`: </br>
+
+![Reservation Ready](img/instantiate_10.png)</br></br>
+
+In this case it only took 1 hour and 18 minutes to instatiate a `Maximo Application Suite 9.0 - Core` image: </br>
+
+![Reservation Provisioning Emails](img/instantiate_11.png)</br></br>
+
+
+Now you have an OpenShift Cluster where MAS Core is installed. </br>
+Click on the reservation and you will find the link to the OCP cluster as well as the credentials needed to login to it: </br>
+
+![Reservation OpenShift Login Details](img/instantiate_12.png)</br></br>
+
+Click on the link to open the IBM Cloud environment. Select `kube:admin`:</br>
+
+![OpenShift Login](img/instantiate_13.png)</br></br>
+
+Enter the credentials from the reservation page and click on `Log in`: </br>
+
+![OpenShift Login](img/instantiate_14.png)</br></br>
+
+Navigate to the `Pipelines` tab and you should see the `mas-masdevops-deploy` pipeline succeeded: </br>
+
+![OpenShift Pipelines](img/instantiate_15.png)</br></br>
+
+
+!!! tip
+    In case the pipeline did not succeed, open the reservation and report the problem to TechZone Support:</br></br>
+    ![TechZone Support](img/techzone_support_01.png)
+
+
+
+
+---
+Congratulations you have successfully instantiated a MAS Techzone Certified Base Image.</br>
diff --git a/MkDocs/mas_techzone_base/docs/prepare_for_use.md 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. </br>
+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.</br>
+
+---
+*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.</br>
+Navigate to `Networking | Routes`. Select the `mas-inst1-core` project in the top.:</br>
+
+![Prepare for use](img/prepare_for_use_01.png)</br></br>
+
+Click on the link to the `inst1-admin` route, which will open in a new tab.</br>
+Navigate to `Workloads | Secrets`. Ensure the `mas-inst1-core` project is selected. Filter with name `superuser`.</br>
+Open the `inst1-credentials-superuser` secret and click on `Reveal values`:</br>
+
+![Prepare for use](img/prepare_for_use_02.png)</br></br>
+
+Switch to the recently opened tab and login with the MAS Super User credentials:</br>
+
+![Prepare for use](img/prepare_for_use_03.png)</br>
+
+!!! 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.</br>
+
+Click on `Create a personal account` to create a the MAS administrator account:</br>
+
+![Prepare for use](img/prepare_for_use_04.png)</br></br>
+
+Fill out the Identity fields `Display name`, `User ID`, and `Primary email` - and scroll down:</br>
+
+![Prepare for use](img/prepare_for_use_05.png)</br></br>
+
+Add the propor entitlement, at least Premium Administration entitlement. Click `Create`:</br>
+
+![Prepare for use](img/prepare_for_use_06.png)</br></br>
+
+Copy and and save the credentials somewhere else for later use. Click `Close`:</br>
+
+![Prepare for use](img/prepare_for_use_07.png)</br></br>
+
+The new user will be syncronized. Click on the `Users` breadcrump link in the upper left hand corner:</br>
+
+![Prepare for use](img/prepare_for_use_08.png)</br></br>
+
+
+!!! tip
+    Log out of the Suite Administration page and login with the new MAS Admin credentials to verify it is ready to be used.</br>
+
+
+---
+Congratulations you have successfully instantiated a MAS Techzone Certified Base Image and prepared it for use.</br>
diff --git a/MkDocs/mas_techzone_base/docs/prereqs.md 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}:<br>
+o Click `Login to MY IBM` button<br>
+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
@@ -0,0 +1,17 @@
+
+# Contributors to This Hands-on Lab
+
+#### Author & Developer:
+
+- Jan Ekstrøm - <[email protected]>
+
+---
+
+# 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
@@ -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
diff --git a/MkDocs/toplevel/docs/release_notes.md b/MkDocs/toplevel/docs/release_notes.md
@@ -7,18 +7,19 @@
 - Angelina Nicolella - <[email protected]>
 - Arif Ali - <[email protected]>
 - Juan Gu -  <[email protected]>
-- John Douglas  - <[email protected]>
+- John Douglas - <[email protected]>
 - Eric Lowry - <[email protected]>
 - Graeme Pexton - <[email protected]>
 
 ---
 
 # 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
@@ -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 ####
 ########################################################################################