Install in an online embedded cluster

Prerequisites Copied

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

Important

Embedded clusters are currently not fit for production use due to the following limitations:

• High availability (HA) of the cluster’s control plane is still in the alpha stage.
• PersistentVolumeClaim (PVC) in a multi-node cluster are not highly available. ITRS Analytics requires them to be.

These limitations are currently being addressed to improve the embedded cluster.

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

• Check that cluster permissions are set. You need to use sudo to access the cluster.

• Make sure that the server has a file descriptor limit of at least 1024 for fs.inotify.max_user_instances.

Start installation Copied

Important

Embedded clusters are currently not fit for production use due to the following limitations:

• High availability (HA) of the cluster’s control plane is still in the alpha stage.
• PersistentVolumeClaim (PVC) in a multi-node cluster are not highly available. ITRS Analytics requires them to be.

These limitations are currently being addressed to improve the embedded cluster.

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]/stable -H "Authorization: [authorization-key]" -o itrs-analytics-stable.tgz
  

• Extract the installation bundle. Run:

  tar -zxvf itrs-analytics-stable.tgz
  

• Install ITRS Analytics. Run:

  sudo ./itrs-analytics 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 Copied

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

Tip

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

Configure the cluster (optional) Copied

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

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.

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