Configure Telemetry Pipeline using Helm

If you used Helm to install Core Operators and create Core Instances, you can also use Helm to configure 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.

Provide a YAML file that specifies the values of parameters while installing the chart. For example:

helm upgrade -i core-instance calyptia/core-instance --values FILE

Replace FILE with the name of your YAML file.

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, find that image’s key nested under the images key. For example, you can modify the fromCloud image using the parameters in images.fromCloud:

images:
  fromCloud:
    registry: ghcr.io
    repository: calyptia/core-operator/sync-from-cloud
    tag: 3.23.0
    pullSecrets: []

If a container image requires authentication, you can provide pull secrets in that image’s pullSecrets parameter. that image’s pullSecrets parameter. For example, to include pull secrets in the fromCloud container, store their values in images.fromCloud.pullSecrets.

Services and ports

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

cloud-api: Corresponds to the Telemetry Pipeline backend (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.

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.

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 URL of the Telemetry Pipeline backend.	`"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.	This value is the most recent tag. Example: `0.11.1`
`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`

Files History and rollback