Sunbird Obsrv
  • Welcome to Obsrv
    • The Value of Data
    • Data Value Chain
    • Challenges
    • The Solution: Obsrv
  • Core Concepts
    • Obsrv Overview
    • High Level Architecture
    • Key Capabilities
    • Datasets
    • Connectors
    • Tech Stack
    • Monitoring
  • Explore
    • Roadmap
    • Case Studies
      • Agri Climate Advisory
      • Learning Analytics at Population Scale
      • IOT Observations Infra
    • Performance Benchmarks
  • Guides
    • Installation Guide
      • AWS
      • Azure
      • GCP
      • OCI
      • Data Center
    • API Specification
      • Dataset Management APIs
      • Connector APIs
      • Data In & Out APIs
      • Alerts and Notification Channels APIs
    • Dataset Management Console
    • Developer Guide
    • Example Datasets
    • Connectors Developer Guide
      • SDK Assumptions
      • Required Files
        • metadata.json
        • ui-config.json
        • metrics.yaml
        • alerts.yaml
      • Obsrv Base Setup
      • Dev Requirements
      • Interfaces
        • Stream Interfaces
        • Batch Interfaces
      • Classes
        • ConnectorContext Class
        • ConnectorStats Class
        • ConnectorState Class
        • ErrorData Class
        • MetricData Class
      • Verifying
      • Packaging Guide
      • Reference Implementations
    • Coming Soon!
  • Community
  • Previous Versions
    • SB-5.0 Version
      • Overview
      • USE
        • Release Notes
          • Obsrv 2.0-Beta
          • Obsrv 2.1.0
          • Obsrv 2.2.0
          • Obsrv 2.0.0-GA
          • Obsrv 5.3.0-GA
          • Release V 5.1.0
          • Release V 5.1.2
          • Release V 5.1.3
          • Release V 5.0.0
          • Release V 4.10.0
        • Installation Guide
        • Obsrv 2.0 Installation Guide
          • Getting Started with Obsrv Deployment Using Helm
        • System Requirements
      • LEARN
        • Functional Capabilities
        • Dependencies
        • Product Roadmap
        • Product & Developer Guide
          • Telemetry Service
          • Data Pipeline
          • Data Service
          • Data Product
            • On Demand Druid Exhaust Job
              • Component Diagram
              • ML CSV Reports
              • Folder Struture
          • Report Service
          • Report Configurator
          • Summarisers
      • ENGAGE
        • Discuss
        • Contribute to Obsrv
      • Raise an Issue
  • Release Notes
    • Obsrv 1.1.0 Beta Release
    • Obsrv 1.2.0-RC Release
Powered by GitBook
On this page
  • Infrastructure Requirements
  • Software Prerequisites
  • Upgrade Steps:

Was this helpful?

Edit on GitHub
  1. Guides
  2. Installation Guide

Data Center

Instructions to install in on-prem data centre

PreviousOCINextAPI Specification

Last updated 17 days ago

Was this helpful?

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

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

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

Helm

  • Helm version 3.10.2 or later

    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 -

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

    minikube addons enable metallb
minikube addons configure metallb

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

    minikube addons enable metrics-server

Installation Steps:

  1. Clone the obsrv-automation repository:

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

  2. Navigate to the setup directory:

    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

    export KUBECONFIG=~/.kube/kubeconfig.yaml

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

    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

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

Upgrade Steps:

  1. Take latest code from obsrv-automation repository

    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.

    helm upgrade --install obsrv obsrv --namespace obsrv --create-namespace --atomic --debug --timeout 3600s
https://min.io/download
https://helm.sh/docs/intro/install/