SOTOON Webhook for Cert Manager

This is a webhook solver for Sotoon Cloud.

Prerequisites

cert-manager version 0.11.0 or higher (tested with 0.12.0):
- Installing on Kubernetes

Installation

Choose a unique group name to identify your company or organization (for example acme.mycompany.example).

helm install ./deploy/cert-manager-webhook-sotoon \
 --set groupName='<YOUR_UNIQUE_GROUP_NAME>'

If you customized the installation of cert-manager, you may need to also set the certManager.namespace and certManager.serviceAccountName values.

Issuer

Get your API token from Sotoon Panel. The user whose api token is used must have dns-editor role:

Create a secret to store your api token secret:

kubectl create secret generic sotoon-credentials \
  --from-literal=apiToken='<SOTOON_API_TOKEN>'

Grant permission to get the secret to the cert-manager-webhook-sotoon service account:

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: cert-manager-webhook-sotoon:secret-reader
rules:
- apiGroups: [""]
  resources: ["secrets"]
  resourceNames: ["sotoon-credentials"]
  verbs: ["get", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: RoleBinding
metadata:
  name: cert-manager-webhook-sotoon:secret-reader
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: cert-manager-webhook-sotoon:secret-reader
subjects:
- apiGroup: ""
  kind: ServiceAccount
  name: cert-manager-webhook-sotoon

Create a certificate issuer:

apiVersion: cert-manager.io/v1alpha2
kind: Issuer
metadata:
  name: letsencrypt
spec:
  acme:
    server: https://acme-v02.api.letsencrypt.org/directory
    email: '<YOUR_EMAIL_ADDRESS>'
    privateKeySecretRef:
      name: letsencrypt-account-key
    solvers:
    - dns01:
        webhook:
          groupName: '<YOUR_UNIQUE_GROUP_NAME>'
          solverName: sotoon
          config:
            endpoint: https://api.sotoon.ir
            namespace: <SOTOON_NAMESPACE_OF_YOURS>
            apiTokenSecretRef:
              name: sotoon-credentials
              key: apiToken

Certificate

Issue a certificate:

apiVersion: cert-manager.io/v1alpha2
kind: Certificate
metadata:
  name: example-com
spec:
  dnsNames:
  - example.com
  - *.example.com
  issuerRef:
    name: letsencrypt
  secretName: example-com-tls

Development

All DNS providers must run the DNS01 provider conformance testing suite, else they will have undetermined behaviour when used with cert-manager.

It is essential that you configure and run the test suite when creating a DNS01 webhook.

An example Go test file has been provided in main_test.go.

Before you can run the test suite, you need to download the test binaries:

./scripts/fetch-test-binaries.sh

Then duplicate the .sample files in testdata/sotoon/ and update the configuration with the appropriate SOTOON credentials.

Now you can run the test suite with: