Helm Chart Values Reference

This document provides a comprehensive reference for configuring the Observo Manager Helm chart. Each section contains configuration options for different components and aspects of the system.

The values file allows you to customize the deployment according to your environment's requirements. Configuration options range from basic settings like image registries to advanced component-specific configurations.

Global Settings

These settings affect the entire Observo Manager deployment and should be configured before installation. They include fundamental configurations that determine how the system operates.

Core Configuration

Controls basic deployment settings such as image locations and versioning. These settings are essential for accessing container images and managing versions across the deployment.

Parameter
Description
Default
Required

global.imageRegistry

Registry for public images

""

Yes

global.observoImageRegistry

Registry for Observo Manager images

""

Yes

global.version

Version of Observo Manager

"1.37.1"

Yes

global.imagePullSecrets

Image pull secrets for private registries

[]

No

Database Configuration

Manages the connection to the PostgreSQL database used by Observo Manager. You can either use an existing database or have the chart create one for you.

Parameter
Description
Default
Required

global.dbCred.secretName

Name of database credentials secret

"postgres-auth"

Yes

global.dbCred.create

Whether to create database credentials

false

No

global.dbCred.host

Database host (if create is true)

""

Conditional

global.dbCred.port

Database port (if create is true)

""

Conditional

global.dbCred.username

Database username (if create is true)

""

Conditional

global.dbCred.password

Database password (if create is true)

""

Conditional

global.dbCred.db_name

Database name (if create is true)

""

Conditional

Monitoring Configuration

Configures how metrics and logs are collected and processed within the system. These settings are crucial for observability and troubleshooting.

Parameter
Description
Default
Required

global.monitorSideCar.logsDestination

Logs receiver destination

"telemetry-rcvr:9002"

No

global.monitorSideCar.metricsDestination

Metrics receiver destination

"telemetry-rcvr:9001"

No

global.monitorSideCar.prometheusReleaseName

Prometheus release name

"observo-manager"

No

Component Settings

Each component can be configured independently to meet specific requirements. These settings allow fine-tuning of individual services.

Analytics Service

The Analytics Service processes and analyzes data collected by the system. It provides insights and metrics about your observability data.

Parameter
Description
Default
Required

analytics-service.enabled

Enable Analytics Service

true

No

analytics-service.image.tag

Image tag

"prod-master-latest"

No

API Gateway

The API Gateway handles all external requests and routes them to appropriate internal services. It's the main entry point for API requests.

Parameter
Description
Default
Required

api-gateway.enabled

Enable API Gateway

true

No

api-gateway.ingress.enabled

Enable ingress

false

No

api-gateway.ingress.className

Ingress class name

"nginx"

If ingress enabled

Authentication Service

Manages user authentication and authorization. This service integrates with Keycloak to provide secure access control.

Parameter
Description
Default
Required

auth-service.enabled

Enable Auth Service

true

No

auth-service.bootstrap.org_id

Organization ID

"org_poc"

Yes

auth-service.bootstrap.org_name

Organization name

"observo poc"

Yes

auth-service.bootstrap.admin_email

Admin email

Yes

auth-service.bootstrap.admin_username

Admin username

"observoadmin"

Yes

Clickhouse

Clickhouse is used for storing and processing large volumes of log data. These settings control its storage and authentication.

Parameter
Description
Default
Required

clickhouse.persistence.size

Storage size

"5Gi"

No

For ClickHouse High Availability setup and configuration details, see ClickHouse HA Setup.

Prometheus

Handles metrics collection and storage. These settings control data retention and storage capacity.

Parameter
Description
Default
Required

prometheus.enabled

Enable Prometheus

true

No

prometheus.retention

Data retention period

"7d"

No

prometheus.retentionSize

Storage size

"8GB"

No

Kafka

Manages event streaming and message queuing within the system.

Parameter
Description
Default
Required

kafka.enabled

Enable Kafka

true

No

kafka.replicaCount

Number of replicas

1

No

kafka.autoCreateTopicsEnable

Enable auto topic creation

true

No

For detailed setup instructions and examples, refer to the Installation Guide.

Last updated

Was this helpful?