Torch Installation using KOTS CLI

Acceldata Torch uses Replicated KOTS to deploy to Kubernetes environment. For a manual installation and deployment the user is expected to use the Replicated KOTS Admin Console. The steps for the same are listed here.

However, users may want to automate the installation and deployment using the KOTS CLI. The following section explains the steps for the same.

Online Image Registry Installation/Upgrade

The following section explains the steps for the automation of the installation and deployment using KOTS CLI for an online image registry. For application images available in online registry, perform the following:

Installation

The user can create a custom .yaml file by downloading the config.yaml for the first time from an existing cluster using the following:

kubectl kots download torch --decrypt-password-values --namespace <namespace>

Note: This is hosted in a repository for ease of access.

Once completed, for a new cluster, install the kots application and copy configuration of admin-console automatically using:

kubectl kots install torch  --license-file <license file>  --namespace <namespace>  --shared-password <password> --config-values <configuration yaml>  --no-port-forward

Upgrade

For subsequent application upgrades, execute:

kubectl kots upstream upgrade torch -n <namespace> --deploy

KOTS Admin Console Configuration Update

For KOTS Admin Console configuration changes, execute the following steps:

1. Connect to the cluster where the configuration change must be performed.
2. Execute the following command and download the application manifests:

kubectl kots download torch --decrypt-password-values --namespace <namespace>

3. The user can make changes as relevant to use case, in the config.yaml file downloaded in the previous step. The use case, which user would have originally performed in the Admin Console UI.
4. Execute the following command:

kubectl kots upload --namespace <namespace> --slug  torch  <location of the downloaded manifests>

5. Next, execute the following command(this command will update the Admin Console and restart the relevant pods):

kubectl kots upstream upgrade torch -n <namespace> --deploy

Airgapped Installation/Update

The following section describes the Acceldata Torch installation and deployment using the Replicated KOTS CLI in an air-gapped environment. An air-gapped environment differs from an online installation in the fact that the Kubernetes cluster does not have access to internet. Hence, one fundamental step in this regard is to upload the air-gap bundle (containing KOTS Admin Console images and Acceldata Torch application images) to a private registry and provide credentials for the same to KOTS.

The following section explains the pre-requisites that must be fulfilled for a successful installation of KOTS Admin Console and Acceldata Torch in an air-gapped environment:

1. The customer license must have Air-gap bundle build enabled for automated releases made to the customer’s channel.
2. In the private registry to be used for this purpose, create the following repositories :

<kubernetes namespace>/dex

<kubernetes namespace>/kotsadm

<kubernetes namespace>/kotsadm-migrations

<kubernetes namespace>/local-volume-fileserver

<kubernetes namespace>/local-volume-provider

<kubernetes namespace>/postgres

<kubernetes namespace>/local-volume-fileserver

<kubernetes namespace>/kotsadm-operator

<kubernetes namespace>/minio

<kubernetes namespace>/ad-analysis-docker-spark-24

<kubernetes namespace>/ad-analysis-docker-spark-30

<kubernetes namespace>/ad-catalog-analysis-service-spark-24

<kubernetes namespace>/ad-catalog-analysis-service-spark-30

<kubernetes namespace>/ad-catalog-athena-crawler

<kubernetes namespace>/ad-catalog-bigquery-crawler

<kubernetes namespace>/ad-catalog-db

<kubernetes namespace>/ad-catalog-file-crawler

<kubernetes namespace>/ad-catalog-glue-crawler

<kubernetes namespace>/ad-catalog-hbase-crawler

<kubernetes namespace>/ad-catalog-hive-crawler

<kubernetes namespace>/ad-catalog-kafka-crawler

<kubernetes namespace>/ad-catalog-memsql-crawler

<kubernetes namespace>/ad-catalog-mongodb-crawler

<kubernetes namespace>/ad-catalog-mssql-crawler

<kubernetes namespace>/ad-catalog-mysql-crawler

<kubernetes namespace>/ad-catalog-oracle-crawler

<kubernetes namespace>/ad-catalog-postgresql-crawler

<kubernetes namespace>/ad-catalog-presto-crawler

<kubernetes namespace>/ad-catalog-redshift-crawler

<kubernetes namespace>/ad-catalog-service

<kubernetes namespace>/ad-catalog-snowflake-crawler

<kubernetes namespace>/ad-catalog-tableau-crawler

<kubernetes namespace>/ad-catalog-teradata-crawler

<kubernetes namespace>/ad-notifications

<kubernetes namespace>/ad-torch-glossary

<kubernetes namespace>/ad-torch-ml

<kubernetes namespace>/ad-torch-pipeline

<kubernetes namespace>/ad-torch-query-analyzer

<kubernetes namespace>/ad-torch-reporting

<kubernetes namespace>/ad-torch-swagger

<kubernetes namespace>/busybox

<kubernetes namespace>/cloud-admin-central-ui

<kubernetes namespace>/cloud-admin-central

<kubernetes namespace>/cloud-dashplot

<kubernetes namespace>/keycloak

<kubernetes namespace>/cloud-keycloak

<kubernetes namespace>/livy

<kubernetes namespace>/nats

<kubernetes namespace>/openssl

<kubernetes namespace>/postgresql

<kubernetes namespace>/torch-ui

<kubernetes namespace>/traefik

<kubernetes namespace>/redis

3. Now, download the Acceldata Torch Air-gap bundle as provided.

For the Replicated KOTS admin console air-gap bundle and Replicated KOTS CLI installer, execute the following commands :

1. Execute the following command to install the KOTS CLI :

curl https://kots.io/install/v1.69.1 | bash

2. Execute the following command to download the KOTS Admin Console air-gap bundle:

> wget https://github.com/replicatedhq/kots/releases/download/v1.69.1/kotsadm.tar.gz

Installation

For a first time installation on a cluster, perform the following:

1. Store the ECR repository access token for the user credentials in an environment variable as follows:

export TOKEN=$(aws ecr get-login-password --region <aws ecr region>)

2. Push the KOTS admin console images to the private ECR registry:

kubectl kots admin-console push-images <location of kotsadm.tar.gz> <registry name>/<kubernetes namespace used in pre-requisites> --registry-username <user-name> --registry-password "${TOKEN}"

3. Push the Torch application air-gap bundle to the private ECR registry:

kubectl kots admin-console push-images <location of torch air-gap bundle> <registry name>/<kubernetes namespace used in pre-requisites> --registry-username <user-name> --registry-password "${TOKEN}"

4. At this step, you can run any scan on the images for verification and the follow the subsequent steps for Torch application installation.
5. Install the KOTS Admin Console using the following command:

kubectl kots install <kubernetes namespace used in pre-requisites> --kotsadm-namespace <kubernetes namespace used in pre-requisites> --namespace <kubernetes namespace used in pre-requisites> --shared-password <password> --kotsadm-registry <private ECR registry> --registry-username <user-name> --registry-password "${TOKEN}" --no-port-forward

6. Install the Acceldata Torch application using the following command:

kubectl kots install torch --namespace <kubernetes namespace used in pre-requisites> --shared-password <password> --license-file <respective license file> --config-values <config.yaml containing the Admin Console configuration> --airgap-bundle <location of Acceldata Torch Air Gap bundle> --kotsadm-registry <private ECR registry> --kotsadm-namespace <kubernetes namespace used in pre-requisites> --registry-username <user-name> --registry-password "${TOKEN}" --disable-image-push --no-port-forward

Note: This command will automatically deploy the Acceldata Torch application as well.

Upgrade

1. Download the Acceldata Torch application air-gap bundle from the download site as shared.
2. Push the Acceldata Torch application images in the air-gap bundle using the following command:

kubectl kots admin-console push-images <location of new torch air-gap bundle> <registry name>/<kubernetes namespace used in pre-requisites> --registry-username <user-name> --registry-password "${TOKEN}"

3. Next, execute the following command:

kubectl kots upstream upgrade torch --airgap-bundle <Location of new air gap bundle> --kotsadm-namespace <kubernetes namespace used in pre-requisites> --kotsadm-registry <private ECR registry> --registry-username <user-name> --registry-password "${TOKEN}" -n <kubernetes namespace used in pre-requisites> --disable-image-push --no-port-forward --deploy

Note: The “--deploy“ flag is mandatory for the application to deploy automatically.

KOTS Admin Console Configuration Update

Sometimes, there might be a requirement that any specific configuration of the Torch application be changed from the KOTS admin console using the GUI. The following section explains the KOTS CLI approach for performing the same:

1. Connect to the cluster where the configuration change needs to be performed.
2. Execute the following command and download the application manifests:

kubectl kots download torch --decrypt-password-values --namespace <kubernetes namespace used in pre-requisites>

3. Make changes to the KOTS Admin Console config.yaml file present at <path>/torch/upstream/userdata/config.yaml.
4. Once completed, upload the changes using the following command. The following upload will be visible in the KOTS admin console as “KOTS Upload“.

kubectl kots upload --namespace <kubernetes namespace used in pre-requisites> --slug torch <path>/torch

5. Execute the following command to deploy the configuration change made:

kubectl kots upstream upgrade torch -n <kubernetes namespace used in pre-requisites> --deploy

Note: This will deploy the configuration change and re-deploy relevant Kubernetes pods impacted by this change.