KropCloud/cert-manager-webhook-example
1
0
Fork 1
mirror of https://github.com/cert-manager/webhook-example.git synced 2025-07-04 07:35:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add certificate creation to README

Browse source
This commit is contained in:
Arne Diekmann 2020-05-26 17:36:18 +02:00
parent 588325118e
commit f703e54983
1 changed files with 29 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -12,7 +12,7 @@ A [cert-manager][2] ACME DNS01 solver webhook for [DNSimple][1].
Take note of your DNSimple API token and account ID from the account settings in the automation tab. Run the following commands replacing the account ID, API token placeholders and email address: Take note of your DNSimple API token and account ID from the account settings in the automation tab. Run the following commands replacing the account ID, API token placeholders and email address:
``` ```bash
$ helm install cert-manager-webhook-dnsimple \ $ helm install cert-manager-webhook-dnsimple \
--namespace cert-manager \ --namespace cert-manager \
--dry-run \ --dry-run \
@ -24,25 +24,43 @@ $ helm install cert-manager-webhook-dnsimple \
./deploy/dnsimple ./deploy/dnsimple
``` ```
Afterwards issue a certificate:
```bash
$ cat << EOF | kubectl apply -f -
apiVersion: cert-manager.io/v1alpha3
kind: Certificate
metadata:
name: dnsimple-test
namespace: default
spec:
dnsNames:
- test.example.com
issuerRef:
name: cert-manager-webhook-dnsimple-production
kind: ClusterIssuer
secretName: dnsimple-test-tls
EOF
```
## Options ## Options
The Helm chart accepts the following values: The Helm chart accepts the following values:
| name | required | description | default value | | name | required | description | default value |
|----------------------------------- | -------- | ----------------------------------------------- |---------------------------------------- | | ---------------------------------- | -------- | ----------------------------------------------- | --------------------------------------- |
| `dnsimple.account` | ✔️ | DNSimple Account ID | _empty_ | | `dnsimple.account` | ✔️ | DNSimple Account ID | _empty_ |
| `dnsimple.token` | ✔️ | DNSimple API Token | _empty_ | | `dnsimple.token` | ✔️ | DNSimple API Token | _empty_ |
| `clusterIssuer.email` | | LetsEncrypt Admin Email | `name@example.com` | | `clusterIssuer.email` | | LetsEncrypt Admin Email | `name@example.com` |
| `clusterIssuer.production.enabled` | | Create a production `ClusterIssuer` | `false` | | `clusterIssuer.production.enabled` | | Create a production `ClusterIssuer` | `false` |
| `clusterIssuer.staging.enabled` | | Create a staging `ClusterIssuer` | `false` | | `clusterIssuer.staging.enabled` | | Create a staging `ClusterIssuer` | `false` |
| `image.repository` | ✔️ | Docker image for the webhook solver | `neoskop/cert-manager-webhook-dnsimple` | | `image.repository` | ✔️ | Docker image for the webhook solver | `neoskop/cert-manager-webhook-dnsimple` |
| `image.tag` | ✔️ | Docker image tag of the solver | `latest` | | `image.tag` | ✔️ | Docker image tag of the solver | `latest` |
| `image.pullPolicy` | ✔️ | Image pull policy of the solver | `IfNotPresent` | | `image.pullPolicy` | ✔️ | Image pull policy of the solver | `IfNotPresent` |
| `logLevel` | | Set the verbosity of the solver | _empty_ | | `logLevel` | | Set the verbosity of the solver | _empty_ |
| `groupName` | ✔️ | Identifies the company that created the webhook | `acme.neoskop.de` | | `groupName` | ✔️ | Identifies the company that created the webhook | `acme.neoskop.de` |
| `certManager.namespace` | ✔️ | The namespace cert-manager was installed to | `cert-manager` | | `certManager.namespace` | ✔️ | The namespace cert-manager was installed to | `cert-manager` |
| `certManager.serviceAccountName` | ✔️ | The service account cert-manager runs under | `cert-manager` | | `certManager.serviceAccountName` | ✔️ | The service account cert-manager runs under | `cert-manager` |
## Test suite ## Test suite