Merge pull request #106 from Volt-MX-GO/zerlordGA-072223

Added installation procedure update

docs/index.md

@@ -39,3 +39,4 @@ The Volt MX Go documentation is based on the [Diátaxis framework](https://diata
 **[Topic guides](topicguides/index.md)** - High-level discussion and explanation of key topics and concepts to give background information
 
 **[References](references/index.md)** - Technical references and descriptions on using Volt MX Go
+

docs/references/index.md

@@ -42,7 +42,7 @@ List [known limitations](knownlimitation.md) of Volt MX Go.
 
 - To open support tickets, go to the [Customer Support](https://support.hcltechsw.com/csm){: target="_blank"} portal.  
 
-<!--- To share information, ask questions, and learn about Volt MX Go, go to the [Community](){: target:"blank"} portal.-->
+- To share information, ask questions, and learn about Volt MX Go, go to the [Community](https://support.hcltechsw.com/community?id=community_forum&sys_id=2a45adef1bc4fd14a67e9759bc4bcb3d){: target="_blank"} portal.
 
 <!--## Widgets
 

docs/tutorials/containerdeployment.md

@@ -2,7 +2,7 @@
 
 The procedure intends to install Volt MX Go server components to a development or test only environment to allow you to try its different features in a safe environment. **This isn't intended for a production environment**.
 
-The server components of Volt MX Go can be deployed with Kubernetes via the following options:
+The server components of Volt MX Go can be deployed with Kubernetes via the following options, which have been tailored for a self contained, fewer prerequisites, and well specified procedure:
 
 - using K3s on an Ubuntu, RHEL, SLES machine or VM
 - using Rancher Desktop running on Windows

docs/tutorials/nativeinstallers.md

@@ -26,24 +26,176 @@ For more information, see the [Installation and configuration](https://opensourc
 
 ## Install Volt MX Go Foundry
 
-1. Download the Volt MX Go Foundry installer based on your preferred installation platform/option.
+Volt MX Go Foundry supports the following installation mechanisms:
+
+- Use the Windows or Linux installers that use Install Anywhere to do the installation. It allows you to install a bundled Tomcat or JBoss app server or install it onto an existing app server (JBOSS single or multi-node, or WebLogic).
+- Use the Command Line installer for advanced deployments.
+- Use helm charts on one of the supported Kubernetes platforms, including OpenShift, AKS (Azure), EKS (AWS), and GKE (Google).
 
-    <!--- For Windows: `HCLVoltMXGO_Foundry_Installer_Windows_EA3.zip`
-    - For Linux: `HCLVoltMXGO_Foundry_Installer_Linux_EA3.zip`
-    - For command line installer: `HCLVoltMXGO_Foundry_Installer_CommandLine_EA3.zip`-->
+### For using an installer
+
+1. Download the Volt MX Go Foundry installer based on your preferred installation platform/option.
 
     For more information, see [Download HCL Volt MX Go Release package](portaldownload.md).
 
 2. Extract the installer from the downloaded ZIP file. 
 3. Follow the links to the installation guides based on your preferred installation platform/option:
 
     !!!warning "Important"
-        Make sure to check all the details and complete all the applicable procedures indicated in the sections in the installation guides. 
+        - The installation guides will indicate installation files and installation file download locations. **You must use the installer you downloaded in Step 1.**
+        - Make sure to check all the details and complete all the applicable procedures indicated in the sections in the installation guides. 
 
     - [For Windows](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_windows_install_guide/Content/Introduction.html){: target="_blank"}
     - [For Linux](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_linux_install_guide/Content/Introduction.html){: target="_blank"}
     - [For command line installer](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html){: target="_blank"}
 
+### For using helm charts on a supported Kubernetes platform
+
+
+#### 1. Configure Helm to pull from HCL Container Repository.
+
+The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository.
+
+- Run the following command to set up Helm:
+
+    ```
+    helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username <your hclcr username> --password <your hclcr password> 
+    ```
+
+    !!!example
+         `helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username user.name@example.com --password xx3ds2w`
+
+
+    If you get an error message similar to the following:
+
+    ``` { .yaml .no-copy }
+    Error: looks like https://hclcr.io/chartrepo/voltmxgo is not a valid chart repository or cannot be reached: failed to fetch https://hclcr.io/chartrepo/voltmxgo/index.yaml : 401 Unauthorized
+    ```
+
+    Most likely, you haven't specified your username or authentication token correctly. Make sure the case and content matches exactly what's listed on the HCL Container Repository site and retry.
+
+#### 2. Download Foundry charts
+
+1. Run the following command to make sure that the chart information for the repositories is up-to-date.
+
+    ```
+    helm repo update
+    ```
+
+2. Run the following commands to download the Foundry charts, unpack the files, and move the `values.yaml` file to the current directory:
+
+    ```
+    helm pull hclcr/voltmx-dbupdate
+    helm pull hclcr/voltmx-foundry
+    tar -xzf voltmx-foundry-1.2.5.tgz
+    tar -xzf voltmx-dbupdate-1.2.5.tgz
+    mv voltmx-foundry/values.yaml  ./
+    mv voltmx-foundry/init-guids.sh  ./
+    chmod +x init-guids.sh
+    ```
+    !!!note
+        The foundry and dbupdate chart names have a version string in the filename.  The `helm pull` command will pull down the latest version of the charts.  Please ensure your tar command uses the correct matching file names.
+
+
+3. Foundry uses several Global Unique IDs to distinguish different installations of Foundry. Invoke the init-guids script to generate the IDs using the following command:
+    ```
+    ./init-guids.sh --new
+    ```
+
+4. Edit the `values.yaml` file to update the `imageCredentials` by replacing `your-email` and   `your-authentication-token` with your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository.
+
+    ```{ .yaml .no-copy }
+    imageCredentials:
+      username: your-email
+      password: your-authentication-token
+    ```
+
+5. Locate the following line in the file and add your Foundry server domain name setting:
+
+    ```{ .yaml .no-copy }
+    serverDomainName:
+    ```
+    Whatever server domain name you specify here, you need to ensure that it's resolvable. There is no additional work if you have already registered your server domain name in DNS. However, if you haven't registered it, you must add it to the server's /etc/hosts file as described in [Add Preview Hostnames](prereq.md#4-add-preview-hostnames), substituting your server domain name. Additionally, you must make the same updates in k3s's coredns config map as described in [For K3s only](prereq.md#for-k3s-only) again substituting your server domain name.
+
+6. Locate the following lines in the file and add your Foundry database details:
+
+    ```{ .yaml .no-copy }
+    ### Database details ###
+
+    # Database type which you want to use for Volt MX Foundry (String)
+    # Possible values:
+    #   "mysql" for MySQL DB server
+    #   "sqlserver" for Azure MSSQL or SQLServer
+    #   "oracle" for Oracle DB server
+    dbType:
+
+    # Database server hostname (String)
+    dbHost:
+
+    # Database server port number (Number). This can be empty for cloud managed service.
+    dbPort:
+
+    # Database User and password - you may set a single general userid/password here,
+    # or you may set specific userid/password combinations below.  If set, the
+    # specific values override the general dbUser/dbPass.
+
+    # Database server user (String)
+    dbUser:
+
+    # Database server password (String) enclosed in quotes
+    dbPass:
+    ```
+
+7. For more advanced configuration options, see [Configuration](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#configuration){: target="_blank"} in the *Installation Guide for Volt MX Foundry Containers Helm Installation*.
+
+8. Save the file and exit.
+
+#### 3. (Optional) Perform advanced scenario procedures
+
+- Perform the procedures under [Advanced Scenarios](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Advanced_Scenarios.html){: target="_blank"} 
+
+#### 4. Install Foundry
+
+1. Run the following Helm install command to deploy Foundry:
+
+    ```
+    helm install foundry voltmx-foundry -f values.yaml
+    ```
+
+2. Run the following command to verify when the Foundry install is ready:
+
+    ```
+    kubectl get pods -o wide -w
+    ```
+
+    The output should be similar to the following and will update over time:
+
+    ![output](../assets/images/output1.png)
+
+
+3. Monitor all the foundry pods except for the foundry-db-update pod as it has already been completed. Once the other foundry pods have a 1/1 state in the READY column, press `Ctrl-c` to stop the kubectl command.
+
+**Foundry is now available at [http://foundry.mymxgo.com/mfconsole/](http://foundry.mymxgo.com/mfconsole/)**.
+
+!!!note
+    - If you defined a different Foundry hostname, the Foundry URL would be the defined Foundry hostname concatenated with `/mfconsole/`.
+    - If you want to access this deployment from a remote machine, you most likely need to update the `/etc/hosts` file on the remote machine as well.
+    - To create an account, see [Create a Foundry administrator account](../howto/foundryadminaccount.md).
+    - To connect to Domino server from your Notes client, see [Connect to Domino server from your Notes client](../howto/connectdominofromnotes.md).
+
+
+#### 5. (Optional) Perform monitoring procedures
+
+- Perform the procedures under [Monitoring](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_Monitoring.html){: target="_blank"}.
+
+!!!note
+    The procedures are for enabling important monitoring features such as Metrics Server, Elastic Stack, Kuberhealthy.
+
+#### 6. (Optional) Perform post installation tasks
+
+- Perform the procedures under the [Post Installation Tasks](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm_PostInstallation.html){: target="_blank"}
+
+
 ## Additional information
 
 After completing the installation of **Domino REST API** and **Volt MX Go Foundry**, proceed to [Install Volt MX Go Iris](installiris.md).

docs/tutorials/obtainauthenticationtoken.md

@@ -3,9 +3,9 @@
 ## About this procedure
 
 <!--!!!warning "Important"
-    This procedure is for containerized deployment only.-->
+    This procedure is for containerized deployment only.
 
---8<-- "devtestenvironment.md"
+--8<-- "devtestenvironment.md"-->
 
 The binary images and Helm charts for Volt MX GO server components are pulled from the HCL Container Repository. This requires you to get your authentication token from the HCL Container Repository. This procedure guides you on how to obtain your authentication token. 
 

docs/tutorials/prereq.md

@@ -9,7 +9,7 @@ The following procedure must be performed <!--when installing Volt MX Go for the
     If you deployed Kubernetes using Rancher Desktop, use an Ubuntu terminal session to run all the commands in this section and the other subsequent sections. To access the Ubuntu terminal, enter "Ubuntu" in the Windows search box and select the Ubuntu for Windows App. An Ubuntu terminal session opens with your home directory set as your current directory.
 
 
-## 1. Export username and authentication token
+<!--## 1. Export username and authentication token
 
 The binary images and Helm charts for Volt MX GO server components are pulled from the HCL Container Repository. You must [obtain your authentication token from the HCL Container Repository](obtainauthenticationtoken.md) before running the commands.
 
@@ -25,18 +25,20 @@ export HCLCR_USERNAME=<your hclcr username>
 ```
 export HCLCR_TOKEN=<your hclcr authentication token>
 ```
+-->
 
-## 2. Configure Helm to pull from HCL Container Repository
+## 1. Configure Helm to pull from HCL Container Repository
 
 The procedure sets up Helm with the details necessary to authenticate with the HCL Container Repository. You will need your [email and authentication token](obtainauthenticationtoken.md) used with the HCL Container Repository.
 
-1. Run the following command to set up Helm:
+- Run the following command to set up Helm:
 
     ```
-    helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo  --username $HCLCR_USERNAME
+    helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username <your hclcr username> --password <your hclcr password> 
     ```
 
-2. When prompted for a password, enter your authentication token for HCL Container Repository.
+    !!!example
+         `helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username user.name@example.com --password xx3ds2w`
 
 If you get an error message similar to the following:
 
@@ -46,7 +48,7 @@ Error: looks like https://hclcr.io/chartrepo/voltmxgo is not a valid chart repos
 
 Most likely, you haven't specified your username or authentication token correctly. Make sure the case and content matches exactly what's listed on the HCL Container Repository site and retry.
 
-## 3. Create a namespace for MXGO
+## 2. Create a namespace for MXGO
 
 Run the following commands to create a namespace and set the current context to **mxgo**:
 
@@ -55,9 +57,9 @@ kubectl create namespace mxgo
 kubectl config set-context --current --namespace=mxgo
 ```
 
-## 4. Ensure Foundry Hostnames are resolvable
+## 3. Ensure Foundry Hostnames are resolvable
 
-You must ensure the url used to access Foundry and Domino REST API are resolvable by all systems that will be accessing it including Kubernetes and any browsers that you use.  This can be done by adding DNS host names and IP addresses to your corporate DNS configuration, or by modifying the hosts file for all systems.
+You must ensure the url used to access Foundry and Domino REST API are resolvable by all systems that will be accessing it including Kubernetes and any browsers that you use. This can be done by adding DNS host names and IP addresses to your corporate DNS configuration, or by modifying the hosts file for all systems.
 
 In the examples that follow we are going to use these hostnames as examples:
 
@@ -122,7 +124,7 @@ You must restart Rancher Desktop:
 1. Select **File** &rarr; **Exit** to close the current session.
 2. Open a new session by opening Rancher Desktop via the desktop icon.
 
-## 5. Create a temp directory for the charts
+## 4. Create a temp directory for the charts
 
 Run the following commands to create a temp directory for the charts and make it the current directory:
 
@@ -131,7 +133,7 @@ mkdir ~/mxgo
 cd ~/mxgo
 ```
 
-## 6. Install wget and curl into your Linux environment
+## 5. Install wget and curl into your Linux environment
 
 Use a search engine, such as Google, to search for instructions on installing **wget** and **curl** to the Linux environment that you are using if they're not already installed.
 

docs/tutorials/sysreq.md

@@ -23,6 +23,9 @@ Check the [supported browsers](https://opensource.hcltechsw.com/volt-mx-docs/95/
 ### Prerequisites for Foundry command line installer
 Check the additional [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/VoltMX_Foundry_CLI/Content/installer_cli.html#prerequisites){: target="_blank"} when using the Foundry command line installer. 
 
+### Prerequisites for Volt MX Foundry Containers Helm Installation
+Check the [prerequisites](https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html#prerequisites){: target="_blank"} when using the Volt MX Foundry Containers Helm Installation. 
+
 ## For installing Domino REST API
 
 Check the [system requirements](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0101789){: target="_blank"} for installing Domino REST API using the installer.