SCM Controller

SCM Controller allows management of Source Control Management resources using Kubernetes. Currently only GitHubWebhooks are supported.

Kubebuilder was used to scaffold this project:

kubebuilder init --domain dippynark.co.uk
kubebuilder create api --group scm --version v1alpha1 --kind GitHubWebhook
kubebuilder create webhook --group scm --version v1alpha1 --kind GitHubWebhook --defaulting --programmatic-validation

Create GitHubWebhook

1. Create a GitHub personal access token with admin:repo_hook scope: https://github.com/settings/tokens/new?scopes=write:repo_hook. Admin is needed for webhook deletion.

2. Create a Kubernetes Secret containing the personal access token:

   kubectl create namespace scm-controller-system \
     -o yaml \
     --dry-run=client \
       | kubectl apply -f -
   kubectl apply -f - <<EOF
   apiVersion: v1
   kind: Secret
   metadata:
     name: github
     namespace: scm-controller-system
   stringData:
     token: ghp_EXAMPLE123
     # For Github Enterprise
     # baseUrl: https://my.org.com
   EOF

3. Deploy the controller:

   make deploy

4. Create GitHubWebhook with secret:

   kubectl apply -f - <<EOF
   apiVersion: v1
   kind: Secret
   metadata:
     name: github-webhook
   stringData:
     secret: c2VjcmV0
   ---
   apiVersion: scm.dippynark.co.uk/v1alpha1
   kind: GitHubWebhook
   metadata:
     name: test
   spec:
     repository:
       owner: example
       name: application
     payloadURL: https://test.example.com
     contentType: json
     secret:
       name: github-webhook
       key: secret
     insecureSSL: false
     events:
     - "*"
     active: true
   EOF

Adoption

GitHub does not allow two different webhooks with the same parameters (unless they are created inactive). For safety we opt to not allow SCM controller to adopt existing webhooks by default and instead raise an error if there is a collision. If you want an existing webhook to be adopted, set the .spec.id field to the ID of the webhook. If a webhook of that ID does not exist, a new webhook will be created and the new ID set.