Install in an online embedded cluster with KOTS

Note

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

From link to the download portal provided to you, the installation bundle for the embedded cluster option includes the Kubernetes runtime, essential add-ons, and dependencies, including the admin console and related tools. To set up this option, you will need to deploy the bundle on the server where you want to run Obcerv.

Note

When using an embedded cluster, the PVCs are stored in the /var/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 directories with bind mounts.

Installing Obcerv 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 Obcerv using KOTS, do the following:

• Install the KOTS CLI, which is 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] --shared password [password] 
  

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 Obcerv from the Internet.

• 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.
  • 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 Obcerv 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 TLS Certificates section, you can optionally upload your own certificate file for the host names.

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