cluster-bootstrap-controller

This is a controller that tracks [GitopsCluster] objects.

It provides the following CRs:

• ClusterBootstrapConfig
• SecretSync

ClusterBootstrapConfig

ClusterBootstrapConfig CR provides a Job template.

When a GitopsCluster is "Ready" a Job is created from the template, the template can access multiple fields.

apiVersion: capi.weave.works/v1alpha1
kind: ClusterBootstrapConfig
metadata:
  name: clusterbootstrapconfig-sample
  namespace: default
spec:
  clusterSelector:
    matchLabels:
      demo: "true"
  jobTemplate:
    generateName: 'run-wego-{{ .ObjectMeta.Name }}'
    spec:
      containers:
      - image: alpine:latest
        name: cat-kubeconfig
        volumeMounts:
        - name: kubeconfig
          mountPath: "/etc/wego"
          readOnly: true
        command: ["cat", "/etc/wego/value"]
      restartPolicy: Never
      volumes:
      - name: kubeconfig
        secret:
          secretName: '{{ .ObjectMeta.Name }}-kubeconfig'

This is using Go templating and the GitopsCluster object is provided as the context, this means that expressions like {{ .ObjectMeta.Name }} will get the name of the GitopsCluster that has transitioned to "Ready".

Annotations

Go templating doesn't easily support access to strings that have "/" in them, which is a common annotation naming strategy.

The templating provides a function called "annotation", this can accept a string annotation which can access an annotation.

e.g.

      volumes:
      - name: kubeconfig
        secret:
          secretName: '{{ annotation "example.com/secret-name }}'

SecretSync

SecretSync provides a way to sync secrets from management cluster to leaf cluster.

The CR references the secret on management cluster to be synced to matched leaf clusters.

SecretSync has a selector to select group of clusters based on their labels

Secrets will be re-synced to leaf clusters when updated

Example

apiVersion: capi.weave.works/v1alpha1
kind: SecretSync
metadata:
  name: my-dev-secret-syncer
  namespace: default
spec:
  clusterSelector:
    matchLabels:
      environment: dev
  secretRef:
    name: my-dev-secret
  targetNamespace: my-namespace

Installation

Release files are available https://github.com/weaveworks/cluster-bootstrap-controller/releases

You can install these e.g.

$ kubectl apply -f https://github.com/weaveworks/cluster-bootstrap-controller/releases/download/v0.0.5/cluster-bootstrap-controller-v0.0.5.yaml