Skip to main content

Kubernetes

Accessing the Helm chart​

# add the synadia repo (only needs to be run once)
helm repo add synadia https://synadia-io.github.io/helm-charts

# update the synadia repo index (run to get updated chart versions)
helm repo update synadia

# now you can install the synadia/control-plane chart
# note: you will need to configure image pull secrets for this to work
helm upgrade --install control-plane synadia/control-plane

Useful tools and references​

  • Chart Values file - lists all possible configuration options
  • Software Bill of Materials - inventory and licenses of third-party components in Control Plane and other Platform images
  • Login Details - On first run, the admin user's credentials will be printed to the logs here: 
    kubectl logs -c syn-cp deployment/control-plane

Common configuration​

Image pull secret​

By default, you must add an Image Pull Secret that allows you to pull the Control Plane image:

imagePullSecret:
  username: my-user
  password: my-password

From version 1.4.3​

You can set administrative credentials on first access to the Web UI.

Exposing Control Plane via ingress​

Control Plane web server can optionally be exposed via HTTP(S) using an Ingress.

config:
  server:
    url: https://cp.nats.io

ingress:
  enabled: true
  className: nginx
  hosts:
    - cp.nats.io
  tlsSecretName: ingress-tls

Full example​

values.yaml

config:
  server:
    url: https://cp.nats.io

ingress:
  enabled: true
  className: nginx
  hosts:
    - host: cp.nats.io
  tlsSecretName: ingress-tls

values-secrets.yaml

imagePullSecret:
  username: my-user
  password: my-password

Deploy

helm upgrade \
  --install \
  -f values.yaml \
  -f values-secrets.yaml \
  control-plane \
  synadia/control-plane

Deployment modes​

Single replica deployment​

By default, the Control Plane deployment is a 1-replica Deployment that will create 3 Persistent Volume Claims.

  1. 1GiB PVC mounted at /data/encryption - stores the auto-generated KMS key. This PVC is not needed if config.kms.key is configured.
  2. 10GiB PVC mounted at /data/postgres - stores the internal PostgreSQL Database data. This PVC is not needed if an external PostgreSQL Database at config.dataSources.postgres is configured.
  3. 10GiB PVC mounted at /data/prometheus - stores the internal Prometheus Server data. This PVC is not needed if an external Prometheus Server at config.dataSources.prometheus is configured.

HA deployment​

Requirements for an HA Deployment:

  1. KMS Key URL. URLs for KMS integrations are documented on the GoCloud Secrets website. This script will generate a random base64 key, which can be used as the KMS Key URL: 
    echo "base64key://$(head -c 32 /dev/urandom | basenc --base64url)"
  2. External PostgreSQL Database
  3. External Prometheus Server

Example Configuration:

config:
  kms:
    key:
      url: your KMS Key URL
  dataSources:
    postgres:
      dsn: your PostgreSQL DSN
    prometheus:
      url: your Prometheus URL

deployment:
  replicas: 2

singleReplicaMode:
  enabled: false