Skip to content

Data Center Installation Guide

Instructions to install in on-prem data centre

Infrastructure Requirements

Section titled “Infrastructure Requirements”
  1. Minimal Installation:
    • You need a system with a minimum of 16 CPUs and 32GB RAM.
    • If running a multi-node cluster, ensure the network reachability between the nodes.

Software Prerequisites

Section titled “Software Prerequisites”

Installation of Obsrv requires the following CLI tools as prerequisites. Please note that the following instructions for installing the prerequisites are provided only for Linux based operating systems. Please follow the instructions for the specific tools depending upon your operating system.

MinIO

Section titled “MinIO”
  • Obsrv Installation requires an Object Store for backups, checkpointing and to store other configurations. We have tested our installations with MinIO, and is the recommended one for quick setup. Follow the instructions from https://min.io/download to install.

Helm

Section titled “Helm”

  • Helm version 3.10.2 or later

    Terminal window
    curl https://get.helm.sh/helm-v3.10.2-linux-amd64.tar.gz -o helm.tar.gz && tar -zxvf helm.tar.gz && sudo mv linux-amd64/helm /usr/local/bin/

  • Download from here - https://helm.sh/docs/intro/install/

Addons

Section titled “Addons”

  • Ensure LoadBalancer is available. For example on a a local setup add-ons such as metallb can be enabled and configured. Following is a sample for minikube

    Terminal window
    minikube addons enable metallb
    minikube addons configure metallb

  • Ensure metrics is enabled. Following is a sample for minikube

    Terminal window
    minikube addons enable metrics-server

Installation Steps:

Section titled “Installation Steps:”

  1. Clone the obsrv-automation repository:

    Terminal window
    git clone https://github.com/Sanketika-Obsrv/obsrv-automation.git

  2. Navigate to the setup directory:

    Terminal window
    cd ./obsrv-automation/terraform/modules/helm/unified-helm

  3. Update the following values in obsrv/values.yaml to reflect your MinIO environment.

    cloud-storage-provider: &global-cloud-storage-provider "s3"
    cloud-storage-region: &global-cloud-storage-region "<MINIO_REGION>"
    s3_bucket: &global-s3-bucket "<MINIO_BUCKET>"
    s3_access_key: &global-s3-access-key "<MINIO_ACCESS_KEY>"
    s3_secret_key: &global-s3-secret-access-key "<MINIO_SECRET_KEY>"
    region: &global-region "<MINIO_REGION>"
    s3_endpoint_url: &global-s3-endpoint-url "<MINIO_ENDPOINT_URL>"
    s3_path_style_access: &global-s3-path-style-access "true"

  4. Export the KUBECONFIG environment variable with for your cluster. For example the below command is to set to its default path

    Terminal window
    export KUBECONFIG=~/.kube/kubeconfig.yaml

  5. First create the CRD’s that are required to install Obsrv

    Terminal window
    kubectl create -f ./crds/

  6. Run the below command to install the services. The following command may fail a couple of times due to timeouts while downloading the images. Run the same command for a couple of times incase of any errors for the installation to be successful

    Terminal window
    helm upgrade --install obsrv obsrv --namespace obsrv --create-namespace --atomic --debug --timeout 3600s

Upgrade Steps:

Section titled “Upgrade Steps:”

  1. Take latest code from obsrv-automation repository

    Terminal window
    cd ./obsrv-automation
    git pull
    cd ./terraform/modules/helm/unified-helm

  2. Ensure all the configuration configured during the installation is properly updated in all places.

  3. Run the helm upgrade the cluster to the latest versions.

    Terminal window
    helm upgrade --install obsrv obsrv --namespace obsrv --create-namespace --atomic --debug --timeout 3600s