Install Core Operator using Helm

You can use Helm to install and manage your Core Operator and Instances.

Prerequisites

  • Helm CLI
  • Running Kubernetes Cluster
  • API Token

Install

  1. Add the Calyptia Helm repository using the following command:

    helm repo add calyptia https://helm.calyptia.com/
  2. If you already have the Calyptia Repository, update the repository to get the latest chart:

    helm repo update
  3. Install the custom resource definitions (CRDs). This step installs the Calyptia Core CRDs that Core Operator needs to function properly:

    • pipeline
    • ingestcheck
    helm install core-crd calyptia/core-crd
  4. Install Core Operator. This step installs the Kubernetes operator that handles Calyptia CRDs installed in the previous step:

    helm install core-operator calyptia/core-operator
  5. Create a Core Instance using the following command:

    helm install core-instance calyptia/core-instance --set coreInstance=<CORE_INSTANCE_NAME> --set cloudToken=<YOUR_TOKEN>

    core-instance

  6. Use the following command to uninstall your Core Instance. Include the namespace if needed.

    helm uninstall core-instance
  7. To uninstall the Core Operator, use the following command:

    helm uninstall core-operator
  8. To uninstall the Core CRDs, use the following command:

    helm uninstall core-crd

Helm reference

This chart deploys Calyptia core-instance on a Kubernetes (opens in a new tab) cluster using the Helm (opens in a new tab) package manager.

Quick reference

helm repo add calyptia https://helm.calyptia.com/ --force-update
helm repo update
helm search repo calyptia/core-instance
helm upgrade -i calyptia/core-instance

Installing the Chart

To install or upgrade the chart with the release name ``:

helm upgrade -i core-instance calyptia/core-instance --create-namespace

The command deploys core-operator on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

List all releases using helm list.

Configuration

The following table lists the configurable parameters of the core-instance chart and their default values:

ParameterDescriptionDefaultRequired
coreInstanceIf not set, use the release name.""true
cloudTokenCloud Token.""true
clusterLoggingEnable cluster logging pipeline creation.false
coreSecret"core-instance"
cloudUrl"https://cloud-api.calyptia.com"
enableHealthCheckPipelineEnable health check pipeline creation alongside the core instance.false
healthCheckPipelinePort2020
healthCheckPipelineServiceTypeLoadBalancer
calyptiaAnnotationsA core-instance specific parameter not to be confused with standard annotations. Passing multiple annotations in the form "first=primary\,second=another". Comma is helm reserved so it needs to be escaped.""
images.fromCloud.registryghcr.io
images.fromCloud.repositorycalyptia/core-operator/sync-from-cloud
images.fromCloud.tag2.1.1
images.toCloud.registryghcr.io
images.toCloud.repositorycalyptia/core-operator/sync-to-cloud
images.toCloud.tag2.1.1
images.hotReload.registryghcr.io
images.hotReload.repositorycalyptia/configmap-reload
images.hotReload.tag0.11.1
images.ingestCheck.registryghcr.io
images.ingestCheck.repositorycalyptia/core/ingest-check
images.ingestCheck.tag0.0.7
notls"true"
interval"15s"
metricsPort"15334"
nameOverride""
fullnameOverride""
serviceAccount.createtrue
serviceAccount.name""
rbac.createtrue
global.imageRegistryOverrides any of the following specific ones.""
global.storageClass""
global.pullPolicyIfNotPresent

Specify each parameter using the --set key=value[,key=value] argument to helm upgrade -i. For example:

helm upgrade -i core-instance calyptia/core-instance --set name="core-instance" --set cloudToken="xxx" --set coreInstance="xxx"

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:

helm upgrade -i core-instance calyptia/core-instance --values values.yaml

Calyptia Annotations example:

helm upgrade -i core-instance calyptia/core-instance --set name="core-instance" --set cloudToken="xxx" --set coreInstance="xxx" --set calyptiaAnnotations="first=primary\,second=another"