Skip to content

Latest commit

 

History

History
176 lines (106 loc) · 7.83 KB

README.md

File metadata and controls

176 lines (106 loc) · 7.83 KB
Raw

ACME webhook for Gandi (SINTEF fork)

cert-manager-webhook-gandi is an ACME webhook for cert-manager. It provides an ACME (read: Let's Encrypt) webhook for cert-manager, which allows to use a DNS-01 challenge with Gandi. This allows to provide Let's Encrypt certificates to Kubernetes for service protocols other than HTTP and furthermore to request wildcard certificates. Internally it uses the Gandi LiveDNS API to communicate with Gandi.

What does the fork do?

This repository is a fork of [bwolf/cert-manager-webhook-gandi] with the following changes:

  • The dependencies have been updated to newer versions
  • A few pending pull requests on the upstream repository have been merged
  • The software container image is hosted on GitHub
  • The Helm chart is hosted on GitHub
  • Secret handled in the Helm Chart (SOPS is recommended to save the secrets).

Helm chart

Read the Helm chart documentation.

DNS-01 challenge ?

Quoting the ACME DNS-01 challenge:

This challenge asks you to prove that you control the DNS for your domain name by putting a specific value in a TXT record under that domain name. It is harder to configure than HTTP-01, but can work in scenarios that HTTP-01 can’t. It also allows you to issue wildcard certificates. After Let’s Encrypt gives your ACME client a token, your client will create a TXT record derived from that token and your account key, and put that record at _acme-challenge.<YOUR_DOMAIN>. Then Let’s Encrypt will query the DNS system for that record. If it finds a match, you can proceed to issue a certificate!

Building

Build the container image cert-manager-webhook-gandi:latest:

make build

Image

Ready made images are hosted on Docker Hub (image tags). Use at your own risk:

ghcr.io/sintef/cert-manager-webhook-gandi

Release History

Refer to the CHANGELOG file.

Testing with Minikube

  1. Install cert-manager with Helm:

     helm repo add jetstack https://charts.jetstack.io

 helm install cert-manager jetstack/cert-manager \
     --namespace cert-manager \
     --create-namespace \
     --set installCRDs=true \
     --version v1.5.4 \
     --set 'extraArgs={--dns01-recursive-nameservers=8.8.8.8:53\,1.1.1.1:53}'

 kubectl get pods --namespace cert-manager --watch

    Note: refer to Name servers in the official documentation according the extraArgs.

    Note: ensure that the custom CRDS of cert-manager match the major version of the cert-manager release by comparing the URL of the CRDS with the helm info of the charts app version:

         helm search repo jetstack

    Example output:

         NAME                    CHART VERSION   APP VERSION     DESCRIPTION
     jetstack/cert-manager   v1.5.4          v1.5.4          A Helm chart for cert-manager

    Check the state and ensure that all pods are running fine (watch out for any issues regarding the cert-manager-webhook- pod and its volume mounts):

         kubectl describe pods -n cert-manager | less

  2. Deploy this webhook (add --dry-run to try it and --debug to inspect the rendered manifests; Set logLevel to 6 for verbose logs):

    The features.apiPriorityAndFairness argument must be removed or set to false for Kubernetes older than 1.20.

     helm repo add cert-manager-webhook-gandi https://sintef.github.io/cert-manager-webhook-gandi

 helm install cert-manager-webhook-gandi cert-manager-webhook-gandi/cert-manager-webhook-gandi \
     --set gandiApiToken=<GANDI-API-KEY>

    Check the logs

         kubectl get pods -n cert-manager --watch
     kubectl logs -n cert-manager cert-manager-webhook-gandi-XYZ

  3. Create a staging issuer (email addresses with the suffix example.com are forbidden).

    See letsencrypt-staging-issuer.yaml

    Don't forget to replace email [email protected].

    Check status of the Issuer:

     kubectl describe issuer letsencrypt-staging

    You can deploy a ClusterIssuer instead : see letsencrypt-staging-clusterissuer.yaml

    Note: The production Issuer is similar.

  4. Issue a Certificate for your domain: see certif-example-com.yaml

    Replace your-domain and your.domain in the certif-example-com.yaml

    Create the Certificate:

     kubectl apply -f ./examples/certificates/certif-example-com.yaml

    Check the status of the Certificate:

     kubectl describe certificate example-com

    Display the details like the common name and subject alternative names:

     kubectl get secret example-com-tls -o yaml

    If you deployed a ClusterIssuer : use certif-example-com-clusterissuer.yaml

  5. Issue a wildcard Certificate for your domain: see certif-wildcard-example-com.yaml

    Replace your-domain and your.domain in the certif-wildcard-example-com.yaml

    Create the Certificate:

     kubectl apply -f ./examples/certificates/certif-wildcard-example-com.yaml

    Check the status of the Certificate:

     kubectl describe certificate wildcard-example-com

    Display the details like the common name and subject alternative names:

     kubectl get secret wildcard-example-com-tls -o yaml

    If you deployed a ClusterIssuer : use certif-wildcard-example-com-clusterissuer.yaml

  6. Uninstall this webhook:

     helm uninstall cert-manager-webhook-gandi --namespace cert-manager
 kubectl delete gandi-credentials --namespace cert-manager

  7. Uninstalling cert-manager: This is out of scope here. Refer to the official documentation.

Conformance test

Please note that the test is not a typical unit or integration test. Instead it invokes the web hook in a Kubernetes-like environment which asks the web hook to really call the DNS provider (.i.e. Gandi). It attempts to create an TXT entry like cert-manager-dns01-tests.example.com, verifies the presence of the entry via Google DNS. Finally it removes the entry by calling the cleanup method of web hook.

As said above, the conformance test is run against the real Gandi API. Therefore you must have a Gandi account, a domain and an API key.

# With API key
cp testdata/gandi/api-key.yaml.sample testdata/gandi/api-key.yaml
cp testdata/gandi/api-key-config.json.sample testdata/gandi/config.json
echo -n $YOUR_GANDI_API_KEY | base64 | pbcopy # or xclip
$EDITOR testdata/gandi/api-key.yaml
# With Personal Access Token (PAT)
cp testdata/gandi/pat.yaml.sample testdata/gandi/pat.yaml
cp testdata/gandi/pat-config.json.sample testdata/gandi/config.json
echo -n $YOUR_GANDI_PAT | base64 | pbcopy # or xclip
$EDITOR testdata/gandi/pat.yaml

TEST_ZONE_NAME=example.com. make test
make clean