Kubernetes Altinity Operator

Deploys the Altinity ClickHouse Operator on Kubernetes using the official altinity-clickhouse-operator Helm chart (v0.25.4). The operator installs ClickHouse-related CRDs and watches all namespaces, enabling declarative management of ClickHouse clusters across the entire Kubernetes cluster. Supports configurable CPU and memory resources for the operator pod and optional namespace creation.

What Gets Created

When you deploy a KubernetesAltinityOperator resource, OpenMCF provisions:

• Kubernetes Namespace — created only when createNamespace is true
• Helm Release (Altinity ClickHouse Operator) — deploys the altinity-clickhouse-operator chart (v0.25.4) from https://docs.altinity.com/clickhouse-operator/, with atomic rollback enabled, cleanup-on-fail, wait-for-jobs, and a 5-minute timeout; installs ClickHouse CRDs automatically (createCRD: true)
• Cluster-Wide Namespace Watch — the operator is configured to watch all namespaces using the ".*" regex pattern, so ClickHouseInstallation resources in any namespace are reconciled
• Standard Labels — all created resources are labeled with the resource kind, name, organization, and environment for consistent discovery

Prerequisites

• Kubernetes credentials configured via environment variables or OpenMCF provider config
• A Kubernetes namespace that already exists, or set createNamespace to true
• Helm 3 support in the target cluster (provided by the Pulumi Kubernetes provider)

Quick Start

Create a file altinity-operator.yaml:

apiVersion: kubernetes.openmcf.org/v1
kind: KubernetesAltinityOperator
metadata:
  name: my-altinity-operator
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.KubernetesAltinityOperator.my-altinity-operator
spec:
  namespace:
    value: altinity-operator
  createNamespace: true
  container: {}

Deploy:

openmcf apply -f altinity-operator.yaml

This creates the Altinity ClickHouse Operator in the altinity-operator namespace with default resources (1000m CPU / 1Gi memory limit, 100m CPU / 256Mi memory request). The operator watches all namespaces for ClickHouseInstallation custom resources.

Configuration Reference

Required Fields

Optional Fields

Examples

Development Instance with Default Resources

A minimal operator deployment for development or testing:

apiVersion: kubernetes.openmcf.org/v1
kind: KubernetesAltinityOperator
metadata:
  name: dev-altinity
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.KubernetesAltinityOperator.dev-altinity
spec:
  namespace:
    value: altinity-dev
  createNamespace: true
  container:
    resources:
      limits:
        cpu: "500m"
        memory: "512Mi"
      requests:
        cpu: "50m"
        memory: "128Mi"

Production Instance with Higher Resources

An operator deployment sized for production workloads managing multiple ClickHouse clusters:

apiVersion: kubernetes.openmcf.org/v1
kind: KubernetesAltinityOperator
metadata:
  name: prod-altinity
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.KubernetesAltinityOperator.prod-altinity
spec:
  namespace:
    value: altinity-system
  createNamespace: true
  container:
    resources:
      limits:
        cpu: "2000m"
        memory: "2Gi"
      requests:
        cpu: "250m"
        memory: "512Mi"

Using Foreign Key References

Reference an OpenMCF-managed namespace instead of hardcoding the name:

apiVersion: kubernetes.openmcf.org/v1
kind: KubernetesAltinityOperator
metadata:
  name: platform-altinity
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.KubernetesAltinityOperator.platform-altinity
spec:
  namespace:
    valueFrom:
      kind: KubernetesNamespace
      name: platform-operators
      field: spec.name
  container:
    resources:
      limits:
        cpu: "1000m"
        memory: "1Gi"
      requests:
        cpu: "100m"
        memory: "256Mi"

Stack Outputs

After deployment, the following outputs are available in status.outputs:

Related Components

• KubernetesNamespace — provides the target namespace via valueFrom reference
• KubernetesClickhouse — deploy ClickHouse clusters managed by the Altinity operator
• KubernetesHelmRelease — alternative for deploying Helm charts directly when a dedicated component is not available