Core Operator Installation - Helm chart reference

This chart deploys Calyptia core-instance on a Kubernetes cluster using the Helm 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/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.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall the core-instance:

helm uninstall  core-instance

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

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

Parameter	Description	Default	Required
coreInstance	If not set, use the release name.	""	true
cloudToken	Cloud Token.	""	true
clusterLogging	Enable cluster logging pipeline creation.	false
coreSecret		"core-instance"
cloudUrl		"https://cloud-api.calyptia.com"
enableHealthCheckPipeline	Enable health check pipeline creation alongside the core instance.	false
healthCheckPipelinePort		2020
healthCheckPipelineServiceType		LoadBalancer
calyptiaAnnotations	A 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.registry		ghcr.io
images.fromCloud.repository		calyptia/core-operator/sync-from-cloud
images.fromCloud.tag		2.1.1
images.toCloud.registry		ghcr.io
images.toCloud.repository		calyptia/core-operator/sync-to-cloud
images.toCloud.tag		2.1.1
images.hotReload.registry		ghcr.io
images.hotReload.repository		calyptia/configmap-reload
images.hotReload.tag		0.11.1
images.ingestCheck.registry		ghcr.io
images.ingestCheck.repository		calyptia/core/ingest-check
images.ingestCheck.tag		0.0.7
notls		"true"
interval		"15s"
metricsPort		"15334"
nameOverride		""
fullnameOverride		""
serviceAccount.create		true
serviceAccount.name		""
rbac.create		true
global.imageRegistry	Overrides any of the following specific ones.	""
global.storageClass		""
global.pullPolicy		IfNotPresent

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"