Helm Based Deployment

Overview

This guide outlines the steps required to deploy and manage Observo Site using the Helm package manager. Helm-based deployment provides a robust and scalable way to install and manage Observo Site in Kubernetes environments.

Prerequisites

Kubernetes Requirements

• Kubernetes cluster deployed in AWS, GCP, or other supported platforms

• Sufficient cluster resources for Observo Site components

For AWS Users: If you need to create an EKS cluster from scratch, see the Create AWS EKS Cluster Guide

Software Requirements

• Helm installed on your local machine

  Note: Avoid Helm version 3.13.0 due to known issues with OCI charts

Permissions

• Access to create following Kubernetes resources:

  • Namespaces

  • Deployments

  • Secrets

  • ConfigMaps

  • Roles

  • Service Accounts

  • Role Bindings

  • Services

Load Balancer Requirements

If your use case involves data pipeline sources or sinks:

• Permissions to create load balancers in your Kubernetes cluster

• For AWS:

  • ELB Permission List

  • Load Balancer Setup Guide

Installation Steps

1. Access Observo Settings

1. Navigate to the Observo dashboard

2. Click on the "Settings" tab

3. Select the "Site" section

2. Download Configuration

1. Locate the Helm configuration download option

2. Download the YAML configuration file

3. Prepare Environment

1. If cert-manager is not installed, create CRDs and install cert-manager:

   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.1/cert-manager.crds.yaml
   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.1/cert-manager.yaml

4. Deploy Observo Site

helm upgrade --install -n observo-client observo-site \
    oci://public.ecr.aws/e4z0a1h1/observo-site \
    --create-namespace \
    --values=/path/to/downloaded_config.yaml

5. Verify Installation

1. Check pod status:

   kubectl get pods -n observo-client

2. Verify services:

   kubectl get svc -n observo-client

3. Confirm site status is green in Observo Cloud interface

Next Steps

• Configure Ingress

• Review Helm Values

• Upgrade Guide

• Cleanup Guide

For detailed configuration options, refer to the Helm Values Reference.

Additional Resources

• Create AWS EKS Cluster - Set up an EKS cluster for AWS deployments