Helm reference for Core Operator and Core Instance

If you used Helm to install Core Operator and Core Instance, you can also use Helm to perform various pipeline operations.

Specify configurations

You can use the helm upgrade -i shell command to specify your configuration by passing a YAML file or specific flags to the command.

You can provide a YAML file that specifies the values for the parameters while installing the chart. For example:

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

The following file is an example values.yaml:

values.yaml

# Turn this chart off/on
enabled: true
name: "core-instance"
clusterLogging: false
# If not set then we use the release name
coreInstance: ""
coreSecret: "core-instance"
cloudToken: "nKd4jYakEwS7Xwxv9RJ6Nb2NXPjTdg2WZAEA6nwuVtxo2h6VQC2vKmwYCKkrH7sYr9YosSJOQ3at1H5M3rgfDsrUGvepZBX4SRI0CG67aR3KzzqvFekPRRffxwDmdvjfSw9H8lbx6ybXdZD5LTgEDK19W9LeKepEUl1USMcJuPeGPc8Yd3valTUkzkCvG3b90BfJ4wsV"
cloudTokenSec:
  name:
  key:
cloudUrl: "https://cloud-api.calyptia.com"
enableHealthCheckPipeline: false
skipServiceCreation: false
healthCheckPipelinePort: 2020
healthCheckPipelineServiceType: LoadBalancer
# calyptiaAnnotations is a core-instance specific parameter
# NOT to be confused with standard annotations
calyptiaAnnotations: ""
calyptiaTolerations: ""
images:
  fromCloud:
    registry: ghcr.io
    repository: calyptia/core-operator/sync-from-cloud
    tag: 3.3.5
    pullSecrets: []
  toCloud:
    registry: ghcr.io
    repository: calyptia/core-operator/sync-to-cloud
    tag: 3.3.5
    pullSecrets: []
  hotReload:
    registry: ghcr.io
    repository: calyptia/configmap-reload
    tag: 0.11.1
    pullSecrets: []
  ingestCheck:
    registry: ghcr.io
    repository: calyptia/core/ingest-check
    tag: 0.0.7
    pullSecrets: []
notls: "true"
interval: "15s"
# enables core instance metrics
metrics: "false"
metricsPort: "15334"
commonAnnotations: {}
commonLabels: {}
podAnnotations: {}
podLabels: {}
nameOverride: ""
fullnameOverride: ""
namespaceOverride: ""
fromCloud:
  resources: {}
toCloud:
  resources: {}
serviceAccount:
  create: true
  name: ""
  annotations: {}
httpProxy: ""
httpsProxy: ""
noProxy: ""
cloudProxy: ""
#
## RBAC configuration
## @param rbac.create Specifies whether RBAC resources should be created
##
rbac:
  create: true
#
## Global Docker image parameters
## Please, note that this will override the image parameters, including dependencies, configured to use the global value
## Current available global Docker image parameters: imageRegistry and imagePullSecrets
## @section Global parameters
## @param global.imageRegistry Global Docker image registry
## @param global.imagePullSecrets Global Docker registry secret names as an array
## @param global.storageClass Global StorageClass for Persistent Volume(s)
##
global:
  # Note that this overrides any specific ones below
  imageRegistry: ""
  # Add any custom pull secrets required
  imagePullSecrets:
    - regcreds
  storageClass: ""
  pullPolicy: IfNotPresent

Telemetry Pipeline uses Bitnami conventions to override image information. The following global defaults can be used to override:

chronosphereio/calyptia-charts@master/charts/calyptia-cloud-standalone#container-configuration
bitnami/charts@main/bitnami/common/README.md#imageroot

Parameter details

The following table lists the configurable parameters of the core-instance Helm chart and their default values. Values with a default of "" indicate an empty string.

Parameter	Description	Default
`coreInstance`	Required. If not set, use the release name.	`""`
`cloudToken`	Required. Cloud API Token.	`""`
`clusterLogging`	Enable cluster logging pipeline creation.	`false`
`coreSecret`	Name of the secret containing private key used to decrypt secrets.	`"core-instance"`
`cloudUrl`	The Cloud API URL.	`"https://cloud-api.calyptia.com"`
`enableHealthCheckPipeline`	Enable health check pipeline creation alongside the core instance.	`false`
`healthCheckPipelinePort`	The port health check uses.	`2020`
`healthCheckPipelineServiceType`	The service the health check performs.	`LoadBalancer`
`calyptiaAnnotations`	A core-instance specific parameter not to be confused with standard annotations. Pass multiple annotations in the form `first=primary\,second=another`. Commas must be escaped due to Helm reservation.	`""`
`images.fromCloud.registry`	The registry Telemetry Pipeline software downloads from.	`ghcr.io`
`images.fromCloud.repository`	The software repository location.	`calyptia/core-operator/sync-from-cloud`
`images.fromCloud.tag`	The release tag to download.	This value is the most recent tag. Example: `3.3.5`
`images.toCloud.registry`	The registry Telemetry Pipeline software synchronizes from.	`ghcr.io`
`images.toCloud.repository`	The software repository location.	`calyptia/core-operator/sync-to-cloud`
`images.toCloud.tag`	The release tag to download.	This value is the most recent tag. Example: `3.3.5`
`images.hotReload.registry`	The registry to hot reload from.	`ghcr.io`
`images.hotReload.repository`	The software repository location.	`calyptia/configmap-reload`
`images.hotReload.tag`		The release tag to download.
`images.ingestCheck.registry`	The registry containing information for ingest checks.	`ghcr.io`
`images.ingestCheck.repository`	The ingest check repository.	`calyptia/core/ingest-check`
`images.ingestCheck.tag`	The release tag.	`0.0.7`
`notls`	Determine whether or not connections use TLS.	`"true"`
`interval`	Time period between ingest checks.	`"15s"`
`metricsPort`	The communication port.	`"15334"`
`nameOverride`	Override the generated chart name.	`""`
`fullnameOverride`	Override the full generated name.	`""`
`serviceAccount.create`	Whether to create a service account.	`true`
`serviceAccount.name`	The service account name.	`""`
`rbac.create`	Create role based access controls.	`true`
`global.imageRegistry`	Overrides any of the specific registries.	`""`
`global.storageClass`	The name of the global storage class.	`""`
`global.pullPolicy`	Determines the pull policy used by Kubernetes.	`IfNotPresent`

Core Operator and Core Instance Update a project token