Skip to main content

Kubernetes (Helm)

This chapter provides a comprehensive guide for end users on how to install the OID application using the provided Helm charts. The deployment process ensures that the application is set up securely and efficiently on the customer's Kubernetes (K8S) cluster.

Prerequisites​

Kubernetes (K8S) Cluster Requirements​

info

These requirements are recommendations to ensure optimal performance and stability of the OID application. Your specific environment and use case may vary.

  • Kubernetes Version: 1.18 or higher
  • Cluster Nodes: At least 3 nodes for a production environment
  • Node Resources: Minimum 2 CPUs and 4GB RAM per node
  • Persistent Storage: Provisioned storage class for stateful components
  • Network: Proper network configuration for intra-cluster communication
  • kubectl: Command-line tool for interacting with the Kubernetes cluster

Helm Requirements​

  • Helm Version: 3.0 or higher
  • Helm Installed: Ensure Helm is installed and configured to interact with your Kubernetes cluster 
    helm version
  • Access: Proper access permissions to deploy applications on the Kubernetes cluster

Installation​

  1. Add the Helm Repository

    helm repo add oid oci://ghcr.io/spherity/oid
    helm repo update

  2. Verify the Repository

    helm search repo oid

  3. Configure Values

    Before installing the Helm chart, you may need to customize certain values to match your environment. Create a values.yaml file to override default values.

    Example values.yaml:

    replicaCount: 3
    image:
      repository: oid/oid-application
      tag: latest
    service:
      type: LoadBalancer
      port: 80
    resources:
      limits:
        cpu: 500m
        memory: 512Mi
      requests:
        cpu: 250m
        memory: 256Mi

  4. Install the Helm Chart

    Use the helm install command to deploy the OID application onto your Kubernetes cluster.

    helm install oid-application oid/oid-application -f values.yaml

    This command will install the application using the custom values provided in values.yaml.

  5. Verify the Deployment

    After the installation, verify that the application has been deployed successfully by checking the status of the pods and services.

    kubectl get pods
    kubectl get services

    Ensure that all pods are running and services are correctly configured.

warning

The repository URL and application name are subject to change. Please check with Spherity for the latest information.

Upgrading the Application​

If a new version of the OID application is released, you can upgrade your deployment using Helm.

helm upgrade oid-application oid/oid-application -f values.yaml

This command will update the existing deployment with the new chart version and custom values.

Uninstalling the Application​

To uninstall the OID application, use the following Helm command:

helm uninstall oid-application

This command will remove all resources associated with the OID application from your Kubernetes cluster.