Skip to content

Update kubed sync example and use secret template instead of pre-annotated secret #727

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

Merged
jetstack-bot merged 5 commits into from
Nov 3, 2021
Merged

Update kubed sync example and use secret template instead of pre-annotated secret #727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb13c2c
docs(kubed): Add hyperlink for CertificateSecretTemplate
aljoshare Oct 26, 2021
dfc82ae
docs(kubed): Use secretTemplate instead of pre-created secret in example
aljoshare Oct 26, 2021
480db37
docs(kubed): Update the description to match the example
aljoshare Oct 26, 2021
6c9420e
docs(kubed): link to v1 because v1alpha3 is deprecated
aljoshare Nov 2, 2021
fa61085
docs(spelling): Add CertificateSecretTemplate to .spelling for exclusion
aljoshare Nov 2, 2021
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
1 change: 1 addition & 0 deletions .spelling
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ boolean
CAs
CertificateRequest
CertificateRequests
CertificateSecretTemplate
CertificateSigningRequest
CertificateSigningRequests
Changelog
Expand Down
22 changes: 6 additions & 16 deletions content/en/docs/faq/kubed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ spec:

## Syncing arbitrary secrets across namespaces using kubed

In order for the target Secret to be synced, the Secret resource must first be
created with the correct annotations before the creation of the Certificate,
else the Secret will need to be edited instead. The example below shows syncing
In order for the target Secret to be synced, you can use the `secretTemplate` field for annotating the generated secret with the kubed sync annotation (See [CertificateSecretTemplate]). The example below shows syncing
a certificate belonging to the `sandbox` Certificate from the `cert-manager`
namespace, into the `sandbox` namespace.

Expand All @@ -47,19 +45,6 @@ metadata:
labels:
cert-manager-tls: sandbox # Define namespace label for kubed
---
apiVersion: v1
data:
ca.crt: ''
tls.crt: ''
tls.key: ''
kind: Secret
metadata:
name: sandbox-tls
namespace: cert-manager
annotations:
kubed.appscode.com/sync: "cert-manager-tls=sandbox" # Sync certificate to matching namespaces
type: kubernetes.io/tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
Expand All @@ -72,4 +57,9 @@ spec:
name: sandbox-ca
kind: Issuer
group: cert-manager.io
secretTemplate:
annotations:
kubed.appscode.com/sync: "cert-manager-tls=sandbox" # Sync certificate to matching namespaces
```

[CertificateSecretTemplate]: ../../reference/api-docs/#cert-manager.io/v1.CertificateSecretTemplate