Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document custom annotation behaviour #1501

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document custom annotation behaviour #1501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/usage/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,17 @@ Certificate resources:
configure `spec.privateKey.rotationPolicy` field to set the rotation policy of the private key for a Certificate.
Valid values are `Never` and `Always`. If unset a rotation policy `Never` will be used.

Any other annotations are copied as is into generated `Certificate` object. Like custom `Venafi` configuration could be specified.
```yaml
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
name: example
annotations:
# custom venafi configuration
venafi.cert-manager.io/custom-fields: `[ {"name": "field-name", "value": "field value"}]`
```

## Inner workings diagram for developers

<object data="/images/request-certificate-debug/gateway-shim-flow.svg"></object>
Expand Down
12 changes: 12 additions & 0 deletions content/docs/usage/ingress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,18 @@ trigger Certificate resources to be automatically created:
configure `spec.privateKey.rotationPolicy` field to set the rotation policy of the private key for a Certificate.
Valid values are `Never` and `Always`. If unset a rotation policy `Never` will be used.

Any other annotations are copied as is into generated `Certificate` object. Like custom `Venafi` configuration could be specified.
```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
# custom venafi configuration
venafi.cert-manager.io/custom-fields: `[ {"name": "field-name", "value": "field value"}]`
name: myIngress
namespace: myIngress
```

## Generate multiple certificates with multiple ingresses

If you need to generate certificates from multiple ingresses make sure it has the issuer annotation.
Expand Down