Provide cluster configuration#

This guide shows you how to build an integration chart that consumes the shared stack and supplies your cluster-specific values. The library splits configuration into two parts: values you must provide, and values it defaults for you. You provide the first set and call mergeConfig to obtain a complete configuration.

Required cluster values#

Six fields have no sensible universal default, so the type RequiredClusterConfig makes them mandatory.

namespace

The Kubernetes namespace the stack runs in.

clusterName

The value of the cluster external label on every metric and log line. It tells clusters apart when several of them feed one Grafana or one Thanos.

domains.grafana

The hostname for the Grafana ingress.

s3

The endpoint, region, and bucket names for Thanos and Loki object storage.

smtp

The mail server settings Alertmanager uses to send alerts.

integrations

The names of the external Crossplane and External Secrets Operator resources the stack references. The library does not create these; they must already exist in your cluster, and you wire your own names here.

The compiler rejects an integration chart that omits any of these.

Resolve the configuration#

Call mergeConfig with your required values. It returns a complete MonitoringConfig with every default filled in.

import { App } from 'cdk8s';
import { MonitoringChart, mergeConfig } from '@bluedynamics/cdk8s-monitoring';

const app = new App();

const config = mergeConfig({
  namespace: 'monitoring',
  clusterName: 'prod',
  domains: { grafana: 'grafana.ops.example.net' },
  s3: {
    endpoint: 'https://fsn1.your-objectstorage.com',
    endpointNoProtocol: 'fsn1.your-objectstorage.com',
    region: 'fsn1',
    buckets: { thanos: 'metrics-thanos-prod', loki: 'logs-loki-prod' },
  },
  smtp: {
    host: 'smtp.example.net',
    port: 587,
    from: 'monitoring@example.net',
    passwordSecret: { name: 'alertmanager-smtp', key: 'password' },
    requireTls: true,
  },
  integrations: {
    s3ProviderConfig: 'my-s3-provider',
    s3SecretStore: 'my-s3-secret-store',
    s3CredentialsKey: 'my-s3-credentials',
    grafanaSecretStore: 'my-app-secret-store',
    grafanaCredentialsKey: 'my-grafana-admin',
  },
});

new MonitoringChart(app, 'monitoring', config);
app.synth();

Keep the SMTP password in a Secret and reference it through smtp.passwordSecret, so it never reaches the synthesized manifests. See Configure SMTP alerting for the alerting details.

Override a default while you are at it#

mergeConfig deep-merges your input over the package defaults, so you can override any subset in the same call. Here requiredClusterValues stands for the required fields from the previous example.

const config = mergeConfig({
  ...requiredClusterValues,
  storage: { prometheus: '30Gi' },
});

Only the keys you set change; everything else keeps its default. See Override the defaults for the full mechanism.

Synthesize and commit#

Synthesize the chart and commit the resulting manifests with your integration repo.

npx cdk8s synth

Next steps#

See also#