Skip to content

Commit cb3e684

Browse files
committed
Document custom annotation behaviour
For feature: cert-manager/cert-manager#7083 Signed-off-by: Dinar Valeev <[email protected]>
1 parent d9fbc01 commit cb3e684

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

content/docs/usage/gateway.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,18 @@ Certificate resources:
438438
configure `spec.privateKey.rotationPolicy` field to set the rotation policy of the private key for a Certificate.
439439
Valid values are `Never` and `Always`. If unset a rotation policy `Never` will be used.
440440

441+
It is possible to copy any specific custom annotation into generated `Certificate` object.
442+
Like below, custom `Venafi` configuration could be specified. When `cert-manager` is started with `--extra-certificate-annotations=venafi.cert-manager.io/custom-fields`
443+
```yaml
444+
apiVersion: gateway.networking.k8s.io/v1
445+
kind: Gateway
446+
metadata:
447+
name: example
448+
annotations:
449+
# custom venafi configuration
450+
venafi.cert-manager.io/custom-fields: `[ {"name": "field-name", "value": "field value"}]`
451+
```
452+
441453
## Inner workings diagram for developers
442454

443455
<object data="/images/request-certificate-debug/gateway-shim-flow.svg"></object>

content/docs/usage/ingress.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,19 @@ trigger Certificate resources to be automatically created:
177177
configure `spec.privateKey.rotationPolicy` field to set the rotation policy of the private key for a Certificate.
178178
Valid values are `Never` and `Always`. If unset a rotation policy `Never` will be used.
179179

180+
It is possible to copy any specific custom annotation into generated `Certificate` object.
181+
Like below, custom `Venafi` configuration could be specified. When `cert-manager` is started with `--extra-certificate-annotations=venafi.cert-manager.io/custom-fields`
182+
```yaml
183+
apiVersion: networking.k8s.io/v1
184+
kind: Ingress
185+
metadata:
186+
annotations:
187+
# custom venafi configuration
188+
venafi.cert-manager.io/custom-fields: `[ {"name": "field-name", "value": "field value"}]`
189+
name: myIngress
190+
namespace: myIngress
191+
```
192+
180193
## Generate multiple certificates with multiple ingresses
181194
182195
If you need to generate certificates from multiple ingresses make sure it has the issuer annotation.

0 commit comments

Comments
 (0)