Install in an online Bring-Your-Own (BYO) cluster with KOTS

Prerequisites Copied

Before installing ITRS Analytics, ensure that all the prerequisites are met in the environment where you will deploy.

• Ensure your Kubernetes version is compatible with the ITRS Analytics Platform 2.10.x. The supported managed service providers are listed below.

  Expand table

  Cluster type	Supported versions
  Embedded Cluster	1.29, 1.30, 1.31
  Azure Kubernetes Service (AKS)	1.29, 1.30, 1.31
  Amazon Elastic Kubernetes Service (EKS)	1.29, 1.30, 1.31
  Google Kubernetes Engine (GKE)	1.30, 1.31
  Oracle Cloud Infrastructure Kubernetes Engine (OKE - Beta)	1.29, 1.30, 1.31
  RedHat OpenShift Container Platform (OCP)	4.16, 4.17

  For compatibility details with earlier versions, please refer to the compatibility matrix.

• Check that resource and hardware requirements are met.

• Note the host name of the server, which will be used for accessing ITRS Analytics from outside the Kubernetes cluster.

• Make sure that a load balancer is configured for your cluster.

• Ensure cluster permissions are set. Cluster role configs are necessary for BYO clusters. By default, KOTS uses cluster-scoped RBAC, which is used in BYO online. You can also opt to grant minimal RBAC permissions to KOTS. However, please be aware that this is an alpha feature and subject to potential modifications in upcoming releases.

Start installation Copied

If you opt to install ITRS Analytics in an existing cluster, you should choose the Bring-Your-Own (BYO) option. You can either download kotscli from the Customer’s Download Portal or continue with the next installation steps.

Installing ITRS Analytics via Kubernetes Off-the-Shelf (KOTS) streamlines the process through the use of a kubectl plugin (KOTS CLI) and an admin console where you can upload your license file, choose install options, and run pre-flight checks prior to deployment.

To install ITRS Analytics using KOTS, do the following:

• Install the latest KOTS CLI, which is a kubectl plugin. Run:

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

• Install the admin console on your desired namespace. To do this, run:

  kubectl kots install itrs-analytics/stable -n [namespace] 
  

Log in to the Admin Console Copied

• Once the namespace has been created, you’ll see a link to the admin console in the command line. Using the password you set in the previous step, log in to the admin console.

• When prompted, upload your license file in the admin console.

  • The license file should have been previously provided to you. Contact your ITRS representative if you do not have the required information.

• Click Download ITRS Analytics from the Internet.

Tip

For a visual walkthrough of the installation process, please watch the demo. If you prefer, you can follow the detailed instructions below.

Configure ITRS Analytics Copied

Prerequisites Copied

• On the Configure ITRS Analytics screen, set your options and then click Continue.

• On the Prerequisites section, verify that the required packages have been installed.

Cluster Settings Copied

• On the Cluster Settings section, select the appropriate cluster size based on your needs. For more information, see Sizing guidelines.

Host names Copied

• On the Host names section, specify the paths to the apps and ingestion host names you will use.

ITRS Analytics Apps Copied

• On the ITRS Analytics Apps section, select whether to install only production apps or both production and beta apps. Your choice during initial installation cannot be changed later. From the list, choose the apps you want to install.

Credentials Copied

• The Credentials section contains default login information for different user and admin levels, intended for informational purposes.

Storage Settings Copied

• On the Storage Settings section, click a checkbox to display configuration options. Note that modifying these settings may require advanced configuration to adjust correctly. When configuring storage classes, make sure that upgrades are supported, since these are performed independently from ITRS Analytics installation.

Advanced Settings Copied

• On the Advanced settings section, select Show Advanced Configuration to view advanced configuration options.

  • Under Service Mesh, select to install trust-manager for Linkerd integration (only available if linkerd installation is enabled).
  • Under TLS Certificates, you can choose between using self-signed certificates or deploying your own custom, non-self-signed certificates. If linkerd is enabled, select Linkerd: custom linkerd certificates to use custom Linkerd certificates. You will need to provide a PEM file and a corresponding private TLS key.
  • To use custom ITRS Analytics certificates, select ITRS Analytics: custom certificates. You will need to provide a PEM file and a corresponding private TLS key.
  • Under Parameters Override, input your desired configuration values to override the default Helm chart settings and then save your configuration.

Preflight checks and deploy Copied

• Once you have verified that your environment has met the prerequisites during the preflight checks, click Deploy. Once the status of all resources are confirmed ready, the install is completed.