Skip to content

README.md

Latest commit

 

History

History
90 lines (58 loc) · 3.71 KB

README.md

File metadata and controls

90 lines (58 loc) · 3.71 KB

Conversion Webhook

The snapshot conversion webhook is an HTTP callback which responds to conversion requests, allowing the API server to convert between the VolumeGroupSnapshotContent v1beta1 API to and from the v1beta2 API.

The cluster admin or Kubernetes distribution admin should install the webhook alongside the snapshot controllers and CRDs.

How to build the webhook

Build the binary

make

Build the docker image

docker build -t snapshot-conversion-webhook:latest -f ./cmd/snapshot-conversion-webhook/Dockerfile .

How to deploy the webhook

The webhook server is provided as an image which can be built from this repository. It can be deployed anywhere, as long as the api server is able to reach it over HTTPS. It is recommended to deploy the webhook server in the cluster as snapshotting is latency sensitive.

The CRD may need to be patched to allow safe TLS communication to the webhook server. Please see the documentation for more details.

The webhook server code is adapted from the webhook server used in the kubernetes/kubernetes e2e testing code.

Example in-cluster deployment using Kubernetes Secrets

Please note this is not considered to be a production ready method to deploy the certificates and is only provided for demo purposes. This is only one of many ways to deploy the certificates, it is your responsibility to ensure the security of your cluster.

TLS certificates and private keys should be handled with care and you may not want to keep them in plain Kubernetes secrets.

Method

These commands should be run from the top level directory.

  1. Run the create-cert.sh script. Note using the default namespace will allow anyone with access to that namespace to read your secret. It is recommended to change the namespace in all the files and the commands given below.

    # This script will create a TLS certificate signed by the [cluster](https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/). It will place the public and private key into a secret on the cluster.
./deploy/kubernetes/webhook-example/create-cert.sh --service snapshot-conversion-webhook-service --secret snapshot-conversion-webhook-secret --namespace default # Make sure to use a different namespace

  2. Patch the VolumeGroupSnapshotContent CRD filling in the CA bundle field.

    ./deploy/kubernetes/webhook-example/patch-ca-bundle.sh

  3. Change the namespace in the service and deployment in the webhook.yaml file.

  4. Create the deployment, service, RBAC, and admission configuration objects on the cluster.

    kubectl apply -f ./deploy/kubernetes/webhook-example

Once all the pods from the deployment are up and running, you should be ready to go.

Verify the webhook works

Try to query the API server for a VolumeGroupSnapshotContent object in the version v1beta1.

kubectl get volumegroupsnapshotcontent.v1beta1.groupsnapshot.storage.k8s.io

Other methods to deploy the webhook server

Look into cert-manager to handle the certificates, and this kube-builder tutorial on how to deploy a webhook.

Important

Please see the deployment yaml for the arguments expected by the webhook server. The conversion webhook is served at the path /convert.