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

Note

Before installing, make sure that you have met the prerequisites.

If you opt to install ITRS Analytics in an existing cluster, you should choose the Bring-Your-Own (BYO) option. You will download the necessary components from the provided link to the download portal.

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. Follow the steps in Installing the KOTS CLI.

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

  kubectl kots install [application-slug]/[channel] -n [namespace] 
  

Note

The application slug and channel should have been previously provided to you. Contact your ITRS representative if you do not have the required information.

• 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.

Note

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

• If you have access to the Internet, click Download ITRS Analytics from the Internet.

• 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. You can also opt to install Linkerd and Prometheus.

  Note

  Once Linkerd has been installed, removing it is currently not supported and may cause subsequent deployments to fail.

  • On the Cluster Settings section, select the appropriate cluster size based on your needs. For more information, see Sizing guidelines.
  • On the Host names section, specify the paths to the apps and ingestion host names you will use.
  • On the ITRS Analytics Apps section, select the optional apps you want to install.
  • On the Credentials section, supply the default usernames and passwords for different types of admins and users.
  • On the Advanced settings section, select Show Advanced Configuration to view advanced configuration options. This shows options for TLS Certificates, where 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 Obcerv: Use custom Obcerv certificates. You will need to provide a PEM file and a corresponding private TLS key.

• 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.