temporal-operator

README

temporal-operator

The Kubernetes Operator to deploy and manage Temporal clusters.

Current Status: Work in Progress. The operator can create a basic cluster. Many improvements are needed to make it production ready.

Roadmap

Features:

• Deploy a new temporal cluster.
• Ability to deploy multiple clusters.
• Support for SQL datastores.
• Deploy Web UI.
• Deploy admin tools.
• Support for Elastisearch.
• Support for Cassandra datastore.
• Automatic mTLS certificates management (using cert-manager).
• Support for integration in meshes: istio & linkerd.
• Namespace management using CRDs.
• Cluster version upgrades.
• Cluster monitoring.
• Auto scaling.
• Multi cluster replication.
• Complete end2end test suite.

Quick start

First install CRDs on your cluster and the operator:

kubectl apply -f https://github.com/alexandrevilain/temporal-operator/releases/latest/download/temporal-operator.crds.yaml
kubectl apply -f https://github.com/alexandrevilain/temporal-operator/releases/latest/download/temporal-operator.yaml

Then create the namespace "demo" and create a simple postgresql server:

kubectl apply -f https://raw.githubusercontent.com/alexandrevilain/temporal-operator/main/examples/cluster-postgres/00-namespace.yaml
kubectl apply -f https://raw.githubusercontent.com/alexandrevilain/temporal-operator/main/examples/cluster-postgres/01-postgresql.yaml

Finish by creating your first temporal cluster:

apiVersion: temporal.io/v1beta1
kind: TemporalCluster
metadata:
  name: prod
  namespace: demo
spec:
  version: 1.16.0
  numHistoryShards: 1
  persistence:
    defaultStore: default
    visibilityStore: visibility
  datastores:
    - name: default
      sql:
        user: temporal
        pluginName: postgres
        databaseName: temporal
        connectAddr: postgres.demo.svc.cluster.local:5432
        connectProtocol: tcp
      passwordSecretRef:
        name: postgres-password
        key: PASSWORD
    - name: visibility
      sql:
        user: temporal
        pluginName: postgres
        databaseName: temporal_visibility
        connectAddr: postgres.demo.svc.cluster.local:5432
        connectProtocol: tcp
      passwordSecretRef:
        name: postgres-password
        key: PASSWORD

Apply this file to the cluster. For more customization options refers to the api documentation.

Examples

Few examples are available to help you get started:

• Demo cluster with PostgreSQL
• Demo cluster with PostgreSQL & advanced visibility using ElasticSearch
• Demo cluster with Cassandra
• Demo cluster with mTLS using cert-manager & PostgreSQL as datastore

License

Temporal Operator is licensed under Apache License Version 2.0. See LICENSE for more information.