TELEMETRY PIPELINE
Helm reference

Helm reference

If you used Helm to install Core Operators and create Core Instances, you can also use Helm to manage your Chronosphere Telemetry Pipeline installation and 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

Container image configuration

Telemetry Pipeline uses Bitnami (opens in a new tab) conventions to configure container images.

Global settings

To set global settings for your container images, use the global.imageRegistry parameter:

global:
  imageRegistry: ""
  imagePullSecrets: []
  storageClass: ""
  pullPolicy: IfNotPresent

If the global container registry requires authentication, you can provide pull secrets in the global.imagePullSecrets parameter.

Individual settings

To set individual settings for your container images, use the cloud parameter:

    cloud:
      registry: ghcr.io
      repository: calyptia/cloud
      tag: 1.4.1
      pullSecrets: []

If a container image requires authentication, you can provide pull secrets in the cloud.pullSecrets parameter.

Services and ports

The Helm chart for Telemetry Pipeline provides the following Kubernetes Services:

  • cloud-api: Corresponds to the Telemetry Pipeline API (cloud-api.calyptia.com). Default port: 5000.
  • core: Corresponds to the Telemetry Pipeline web interface (core.calyptia.com) Default port: 3000.

Both of these Kubernetes Services use the LoadBalancer Service type by default.

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.

ParameterDescriptionDefault
coreInstanceRequired. If not set, use the release name.""
cloudTokenRequired. Cloud API Token.""
clusterLoggingEnable cluster logging pipeline creation.false
coreSecretName of the secret containing private key used to decrypt secrets."core-instance"
cloudUrlThe Cloud API URL."https://cloud-api.calyptia.com"
enableHealthCheckPipelineEnable health check pipeline creation alongside the core instance.false
healthCheckPipelinePortThe port health check uses.2020
healthCheckPipelineServiceTypeThe service the health check performs.LoadBalancer
calyptiaAnnotationsA 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.registryThe registry Telemetry Pipeline software downloads from.ghcr.io
images.fromCloud.repositoryThe software repository location.calyptia/core-operator/sync-from-cloud
images.fromCloud.tagThe release tag to download.This value is the most recent tag. Example: 3.3.5
images.toCloud.registryThe registry Telemetry Pipeline software synchronizes from.ghcr.io
images.toCloud.repositoryThe software repository location.calyptia/core-operator/sync-to-cloud
images.toCloud.tagThe release tag to download.This value is the most recent tag. Example: 3.3.5
images.hotReload.registryThe registry to hot reload from.ghcr.io
images.hotReload.repositoryThe software repository location.calyptia/configmap-reload
images.hotReload.tagThe release tag to download.
images.ingestCheck.registryThe registry containing information for ingest checks.ghcr.io
images.ingestCheck.repositoryThe ingest check repository.calyptia/core/ingest-check
images.ingestCheck.tagThe release tag.0.0.7
notlsDetermine whether or not connections use TLS."true"
intervalTime period between ingest checks."15s"
metricsPortThe communication port."15334"
nameOverrideOverride the generated chart name.""
fullnameOverrideOverride the full generated name.""
serviceAccount.createWhether to create a service account.true
serviceAccount.nameThe service account name.""
rbac.createCreate role based access controls.true
global.imageRegistryOverrides any of the specific registries.""
global.storageClassThe name of the global storage class.""
global.pullPolicyDetermines the pull policy used by Kubernetes.IfNotPresent

Troubleshooting

If you need assistance, contact Chronosphere Support. As part of the support process, Chronosphere recommends downloading and running the support.sh (opens in a new tab) script, which gathers information about your Telemetry Pipeline installation and packages this information into an archive that you can attach to your ticket.