Install in an air-gapped 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 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.

To install Obcerv in an air-gapped embedded cluster, do the following:

• On a machine that has internet access, download the installation bundle by running:

  curl -f [download URL]/[channel]?airgap=true -H "Authorization: [authorization key]" -o obcerv-bobcat-[channel].tgz
  

• Extract the installation bundle on the server where Obcerv will be installed. Make sure to also transfer the downloaded installation bundle to that host. Run:

  tar -zxvf obcerv-bobcat-[channel].tgz
  

• Install Obcerv with the --airgap-bundle flag. For example:

  sudo ./obcerv-bobcat install --license license.yaml --airgap-bundle ./obcerv-bobcat.airgap
  

• 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, set the Certificate type and optionally supply a hostname for accessing the Obcerv 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.
  • 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.