Install in an online embedded cluster

Note

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

The installation bundle (.tgz) for the embedded cluster option includes the installer, license file, and the admin console and related tools for an airgap environment. To set up this option, you will need to deploy the bundle on the server where you want to run ITRS Analytics.

Note

When using an embedded cluster, the PVCs are stored in the /var/lib/embedded-cluster/openebs/local directory, which does not reserve a specific amount of space upfront. The folder will initially use close to no space until files are actually added even when there is allocated storage space.

Make sure that the total volume of your PVCs will fit within this directory. For example, if you have PVCs for Timescale (100 GB) and Kafka (100 GB), the directory needs to be at least 200 GB.

Tip

When installing on an embedded cluster with limited space, you can relocate the data directory by passing the --data-dir flag.

To install ITRS Analytics in an online embedded cluster, do the following:

• Download the installation bundle. Run:

  curl -f [download URL]/[channel] -H "Authorization: [authorization-key]" -o [application-slug]-[channel].tgz
  

• Extract the installation bundle. Run:

  tar -zxvf [application-slug]-[channel].tgz
  

• Install ITRS Analytics. Run:

  sudo ./[application-slug] install --license license.yaml
  

• Once the installation is finished, go to the URL from the installation output to access the admin console. If you see a security warning in the browser, click Advanced and proceed to the URL.

• When prompted, choose whether to use a self-signed certificate or your own custom certificate. If you choose to upload your own, you will need to provide a PEM file and a corresponding private TLS key.

• Optionally, supply a hostname for accessing the ITRS Analytics UI. Click Continue.

• Log in to the admin console using the password you set in the command output during installation.

• On the Nodes screen, optionally add nodes before deploying Obcerv and then click Continue.

• On the Configure Obcerv 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.