Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
491ff92
Add cert-manager-alidns-webhook
olivierboudet Sep 10, 2021
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
728cb85
Merge pull request #729 from cert-manager/release-next
jetstack-bot Oct 27, 2021
9f9501a
Adding Netlify redirect config for legacy docs url
chance19 Oct 27, 2021
1d8c932
Merge pull request #736 from chance19/docs-redirect-config
jetstack-bot Oct 27, 2021
3391084
Add an upgrade 1.5 to 1.6 document
wallrj Oct 27, 2021
cd0c89d
Merge pull request #737 from wallrj/1.6-upgrade-doc
jetstack-bot Oct 28, 2021
258f3e1
Update supported releases to remove 1.16
SgtCoDFish Oct 29, 2021
5bad905
Merge pull request #738 from SgtCoDFish/newsupported
jetstack-bot Oct 29, 2021
f3ea8a5
removing incorrect redirect config
chance19 Oct 29, 2021
1d4bea7
adding docs redirect config here to remain consistent with existing r…
chance19 Oct 29, 2021
202cdf1
Merge pull request #739 from chance19/redirect-docs-subdomain
jetstack-bot Oct 29, 2021
c7fd953
Update 1.6 release notes for v1.6.1
jakexks Nov 1, 2021
39b4b2d
Merge pull request #741 from jakexks/keystore-fixes
jetstack-bot Nov 1, 2021
4ee3b3b
Add the splat to redirect URL
mattbates Nov 2, 2021
6c9420e
docs(kubed): link to v1 because v1alpha3 is deprecated
aljoshare Nov 2, 2021
eb3dda0
Don't show removed API reference docs
irbekrm Nov 3, 2021
231b646
Bump gen-crd-api-reference-docs version
irbekrm Nov 3, 2021
a0601ab
Remove references to removed API versions
irbekrm Nov 3, 2021
fa61085
docs(spelling): Add CertificateSecretTemplate to .spelling for exclusion
aljoshare Nov 2, 2021
00bbe2c
Merge pull request #727 from AljoschaP/update-kubed-sync-example-by-u…
jetstack-bot Nov 3, 2021
4f2ead2
Merge pull request #700 from olivierboudet/patch-1
jetstack-bot Nov 3, 2021
c3c04b0
Add newline
mattbates Nov 3, 2021
6b3fa9a
Merge pull request #743 from mattbates/mb/fix-docs-redirect
jetstack-bot Nov 3, 2021
d9d5407
adding redirect rules to prevent google links from reaching page not …
chance19 Nov 3, 2021
5d03b4f
Merge pull request #745 from irbekrm/removed_apis_refs
jetstack-bot Nov 4, 2021
976c73b
updating content links to valid urls
chance19 Nov 4, 2021
7d83d64
Add temp 302 redirect to all other paths than the root
mattbates Nov 4, 2021
9b8fc1d
adding specific url redirects
chance19 Nov 4, 2021
4344ac5
Merge pull request #748 from mattbates/mb/switch-redirect-temp
jetstack-bot Nov 4, 2021
48c7e4e
Merge branch 'master' into seo-docs-redirects
chance19 Nov 4, 2021
42d3bff
correcting typo
chance19 Nov 4, 2021
551a25e
Merge pull request #747 from chance19/seo-docs-redirects
jetstack-bot Nov 4, 2021
11f1c5a
add specific redirect rule for docs subdomain
SgtCoDFish Nov 4, 2021
5144947
Merge pull request #750 from SgtCoDFish/specificredirect
jetstack-bot Nov 4, 2021
37f3660
fix redirects for "latest/tasks" path on old docs site
SgtCoDFish Nov 10, 2021
4beace3
Merge pull request #754 from SgtCoDFish/k8sdocslink
jetstack-bot Nov 10, 2021
d7e8f9e
redirect all 404s to the root of the site
SgtCoDFish Nov 10, 2021
7a565f3
Merge pull request #755 from SgtCoDFish/redir404
jetstack-bot Nov 10, 2021
f4f9843
Revert "redirect all 404s to the root of the site"
SgtCoDFish Nov 10, 2021
b90f257
Merge pull request #756 from SgtCoDFish/redir404-revert
jetstack-bot Nov 10, 2021
b100355
reorder some of the language in signature verification docs
SgtCoDFish Nov 16, 2021
6004d58
Merge pull request #759 from SgtCoDFish/sigupdate
jetstack-bot Nov 16, 2021
3e42dad
add link to AWS blog post on tutorials page
SgtCoDFish Nov 18, 2021
3159c5f
Merge pull request #760 from SgtCoDFish/awsblogpost
jetstack-bot Nov 18, 2021
c913074
update cloud vendor k8s compat list
SgtCoDFish Nov 19, 2021
1dba26f
Merge pull request #762 from SgtCoDFish/supportedcloudvendors
jetstack-bot Nov 19, 2021
da1d06e
update references to 1.6.0 to point to 1.6.1
SgtCoDFish Nov 23, 2021
658853c
Merge pull request #763 from SgtCoDFish/installatest
jetstack-bot Nov 23, 2021
dd667d1
venafi: service-generated CSRs must not be locked
maelvls Dec 2, 2021
3745695
venafi: Service Generated CSRs overrides Certificate config
maelvls Dec 3, 2021
d26c2a0
Merge pull request #767 from maelvls/say-more-about-service-generated…
jetstack-bot Dec 3, 2021
73b4516
Merge pull request #744 from irbekrm/remove_alpha_beta-docs
jetstack-bot Dec 3, 2021
44b60ef
update release date (with note) for 1.7
SgtCoDFish Dec 7, 2021
20057f7
Merge pull request #774 from SgtCoDFish/delay17
jetstack-bot Dec 7, 2021
5965e6c
update supported releases with the agreed-upon timeline for 1.7
SgtCoDFish Dec 16, 2021
3e66efd
Merge pull request #778 from SgtCoDFish/17release
jetstack-bot Dec 16, 2021
37d6065
supported-releases: update testing coverage
maelvls Dec 16, 2021
07c03ab
supported-releases: remove test links for release-1.7 as we disabled it
maelvls Dec 17, 2021
e0886a9
supported-releases: typo "Our testing coverage"
maelvls Dec 19, 2021
6044f16
Merge pull request #779 from maelvls/update-supported-releases-again
jetstack-bot Dec 20, 2021
0da5999
release-process: mention the removal/re-enabling of next periodics
maelvls Dec 20, 2021
5cda788
Merge pull request #782 from maelvls/release-process-update
jetstack-bot Dec 20, 2021
d83c6ca
change call to action button to be more descriptive
SgtCoDFish Dec 21, 2021
2cb6e92
Merge pull request #783 from SgtCoDFish/learnmoresoicanlearnmore
jetstack-bot Dec 21, 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
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ CSR
CSRs
CertificateRequest
CertificateRequests
CertificateSecretTemplate
CertificateSigningRequest
CertificateSigningRequests
Changelog
Expand Down
42 changes: 42 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,45 @@ https://cert-manager.io/docs/usage/kubectl-plugin/#status-certificate https://ce
https://cert-manager.io/docs/usage/kubectl-plugin/#completion https://cert-manager.io/docs/usage/cmctl/#completion
https://cert-manager.io/docs/usage/kubectl-plugin/#experimental https://cert-manager.io/docs/usage/cmctl/#experimental
https://cert-manager.io/docs/usage/kubectl-plugin/#certificatesigningrequest https://cert-manager.io/docs/usage/cmctl/#certificatesigningrequest

# docs.cert-manager.io was previously a separately hosted service. The dns has since been redirected and the following rules are required for historical links
# These rules are in place to capture traffic that is specifically referencing these source urls
https://docs.cert-manager.io/en/latest/getting-started/index.html https://cert-manager.io/docs/tutorials/
https://docs.cert-manager.io/en/latest/tutorials/acme/index.html https://cert-manager.io/docs/tutorials/
https://docs.cert-manager.io/en/latest/ https://cert-manager.io/docs/

# Issuer-specific redirects; these were mined from a wayback machine crawl of the old site:
# https://web.archive.org/web/20190802192846/http://docs.cert-manager.io/en/latest/tasks/issuers/index.html
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-acme/http01/* https://cert-manager.io/docs/configuration/acme/http01/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-acme/dns01/* https://cert-manager.io/docs/configuration/acme/dns01/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-acme/* https://cert-manager.io/docs/configuration/acme/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-ca.html https://cert-manager.io/docs/configuration/ca/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-selfsigned.html https://cert-manager.io/docs/configuration/selfsigned/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-vault.html https://cert-manager.io/docs/configuration/vault/
https://docs.cert-manager.io/en/latest/tasks/issuers/setup-venafi.html https://cert-manager.io/docs/configuration/venafi/

# fallback in case there are any pages we missed:
https://docs.cert-manager.io/en/latest/tasks/issuers/* https://cert-manager.io/docs/configuration/

# These rules should capture all historical links that reference endpoints for specfic release versions. Whilst these endpoints might not exist anymore these
# redirect rules will capture the request and route the user to the specific release-note page
https://docs.cert-manager.io/en/release-0.1/* https://cert-manager.io/docs/release-notes/release-notes-0.1/ 301!
https://docs.cert-manager.io/en/release-0.2/* https://cert-manager.io/docs/release-notes/release-notes-0.2/ 301!
https://docs.cert-manager.io/en/release-0.3/* https://cert-manager.io/docs/release-notes/release-notes-0.3/ 301!
https://docs.cert-manager.io/en/release-0.4/* https://cert-manager.io/docs/release-notes/release-notes-0.4/ 301!
https://docs.cert-manager.io/en/release-0.5/* https://cert-manager.io/docs/release-notes/release-notes-0.5/ 301!
https://docs.cert-manager.io/en/release-0.6/* https://cert-manager.io/docs/release-notes/release-notes-0.6/ 301!
https://docs.cert-manager.io/en/release-0.7/* https://cert-manager.io/docs/release-notes/release-notes-0.7/ 301!
https://docs.cert-manager.io/en/release-0.8/* https://cert-manager.io/docs/release-notes/release-notes-0.8/ 301!
https://docs.cert-manager.io/en/release-0.9/* https://cert-manager.io/docs/release-notes/release-notes-0.9/ 301!
https://docs.cert-manager.io/en/release-0.10/* https://cert-manager.io/docs/release-notes/release-notes-0.10/ 301!
https://docs.cert-manager.io/en/release-0.11/* https://cert-manager.io/docs/release-notes/release-notes-0.11/ 301!
https://docs.cert-manager.io/en/release-0.12/* https://cert-manager.io/docs/release-notes/release-notes-0.12/ 301!
https://docs.cert-manager.io/en/release-0.13/* https://cert-manager.io/docs/release-notes/release-notes-0.13/ 301!
https://docs.cert-manager.io/en/release-0.14/* https://cert-manager.io/docs/release-notes/release-notes-0.14/ 301!
https://docs.cert-manager.io/en/release-0.15/* https://cert-manager.io/docs/release-notes/release-notes-0.15/ 301!
https://docs.cert-manager.io/en/release-0.16/* https://cert-manager.io/docs/release-notes/release-notes-0.16/ 301!
# These rules should capture requests to release-notes pages and re-route them accordingly
https://docs.cert-manager.io/en/release-* https://cert-manager.io/docs/release-notes/release-notes-:splat 301!
https://docs.cert-manager.io https://cert-manager.io/docs 301!
https://docs.cert-manager.io/* https://cert-manager.io/docs/:splat 302!
2 changes: 1 addition & 1 deletion content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<p class="lead mt-2 display-5">X.509 certificate management for Kubernetes</p>
<div class="mx-auto mt-5">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
Documentation <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/jetstack/cert-manager">
View Repository <i class="fab fa-github ml-2 "></i>
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/configuration/acme/dns01/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ cert-manager also supports out of tree DNS providers using an external webhook.
Links to these supported providers along with their documentation are below:

- [`AliDNS-Webhook`](https://github.com/pragkent/alidns-webhook)
- [`cert-manager-alidns-webhook`](https://github.com/DEVmachine-fr/cert-manager-alidns-webhook)
- [`cert-manager-webhook-civo`](https://github.com/okteto/cert-manager-webhook-civo)
- [`cert-manager-webhook-dnspod`](https://github.com/qqshfox/cert-manager-webhook-dnspod)
- [`cert-manager-webhook-dnsimple`](https://github.com/neoskop/cert-manager-webhook-dnsimple)
Expand Down
18 changes: 18 additions & 0 deletions content/en/docs/configuration/venafi.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,24 @@ of the connection parameters are slightly different.

> **Note**: You *must* allow "User Provided CSRs" as part of your TPP policy, as
> this is the only type supported by cert-manager at this time.
>
> More specifically, the valid configurations of the "CSR handling" are:
>
> - "User Provided CSRs" selected and unlocked,
> - "User Provided CSRs" selected and locked,
> - "Service Generated CSRs" selected and unlocked.
>
> When using "Service Generated CSRs" selected and unlocked, the default CSR
> configuration present in your policy folder will override the configuration of
> your Certificate resource. The subject DN, key algorithm, and key size will be
> overridden by the values set in the policy folder.
>
> With "Service Generated CSRs" selected and locked, the certificate issuance
> will systematically fail with the following message:
>
> ```plain
> 400 PKCS#10 data will not be processed. Policy "\VED\Policy\foo" is locked to a Server Generated CSR.
> ```

In order to set up a Venafi Trust Protection Platform `Issuer`, you must first
create a Kubernetes `Secret` resource containing your Venafi TPP API
Expand Down
55 changes: 49 additions & 6 deletions content/en/docs/contributing/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,15 +439,58 @@ page if a step is missing or if it is outdated.

13. Proceed to the post-release steps:

1. **(final release only)** Add the new final release to the
[supported-releases](/docs/installation/supported-releases/) page.
1. **(initial alpha only)** Create a PR on
[`cert-manager/release`](https://github.com/cert-manager/release) in
order to re-enable the next periodic tests configured in:

2. **(final release only)** Open a PR to
```plain
config/jobs/cert-manager/release-next/cert-manager-release-next-periodics.yaml
```

Why? Because we disable the "next" periodic tests right after a final release
since next periodics are only useful after we do the first alpha (e.g.,
in [PR 606](https://github.com/jetstack/testing/pull/606)).

2. **(initial alpha only)** Open a PR to
[`cert-manager/website`](https://github.com/cert-manager/website) in
order to:

- Update the section "How we determine supported Kubernetes versions" on
the [supported-releases](/docs/installation/supported-releases/) page.
In the table, change the "next periodic" line with the correct links.

3. **(final release only)** Create a PR on
[`cert-manager/release`](https://github.com/cert-manager/release) in
order to disable the next periodic tests configured in:

```plain
config/jobs/cert-manager/release-next/cert-manager-release-next-periodics.yaml
```

(just remove the file and commit)

Why? Because that saves us compute time between a final release
and the first alpha.

4. **(final release only)** Open a PR to
[`cert-manager/website`](https://github.com/cert-manager/website) in
order to:

- Update the section "Supported releases" in the
[supported-releases](/docs/installation/supported-releases/) page.
- Update the section "Supported releases" in the
[supported-releases](/docs/installation/supported-releases/) page.
- Update the section "How we determine supported Kubernetes versions" on
the [supported-releases](/docs/installation/supported-releases/) page.
In the table, set "n/a" for the line where "next periodic" is since
these tests will be disabled until we do our first alpha.

5. **(final release only)** Open a PR to
[`jetstack/testing`](https://github.com/jetstack/testing) and change Prow's
config. To do this, take inspiration from [Maartje's PR
example](https://github.com/jetstack/testing/pull/397/files).

3. **(final release only)** Push a new release branch to
6. **(final release only)** Push a new release branch to
[`jetstack/cert-manager`](https://github.com/jetstack/cert-manager). If the
final release is `v1.0.0`, then push the new branch `release-1.1`:

Expand All @@ -457,13 +500,13 @@ page if a step is missing or if it is outdated.
git push origin release-1.1
```

4. **(final release only)** Open a PR to
7. **(final release only)** Open a PR to
[`cert-manager/website`](https://github.com/cert-manager/website) with
updates to the website configuration. To do this, take inspiration from
[Maartje's PR
example](https://github.com/cert-manager/website/pull/309/files).

5. Ensure that any installation commands in
8. Ensure that any installation commands in
[`cert-manager/website`](https://github.com/cert-manager/website) install
the latest version. This should be done after every release, including
patch releases as we want to encourage users to always install the latest
Expand Down
22 changes: 6 additions & 16 deletions content/en/docs/faq/kubed.md
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
2 changes: 1 addition & 1 deletion content/en/docs/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ install methods are listed below for each of the situations.

The default static configuration can be installed as follows:
```bash
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.yaml
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
```
More information on this install method [can be found here](./kubectl/).

Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/installation/code-signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ curl -sSL https://cert-manager.io/public-keys/cert-manager-keyring-2021-09-20-10
helm verify --keyring cert-manager-keyring-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.gpg /path/to/cert-manager-vx.y.z.tgz
```

- ASCII-armored signing key: [`cert-manager-pgp-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.asc`](../../../public-keys/cert-manager-pgp-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.asc)
- GPG keyring: [`cert-manager-keyring-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.gpg`](../../../public-keys/cert-manager-keyring-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.gpg)

If you know what you're doing and you want the signing key in a format that's easy to import into GPG,
it's available in an ASCII armored version:

- ASCII-armored signing key: [`cert-manager-pgp-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.asc`](../../../public-keys/cert-manager-pgp-2021-09-20-1020CF3C033D4F35BAE1C19E1226061C665DF13E.asc)

## Container Images / Cosign

Soon, all container images which make up cert-manager will be verifiable using [`cosign`](https://docs.sigstore.dev/cosign/overview).
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ or using the `installCRDs` option when installing the Helm chart.


```bash
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.crds.yaml
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.crds.yaml
```

##### Option 2: install CRDs as part of the Helm release
Expand All @@ -67,7 +67,7 @@ $ helm install \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace \
--version v1.6.0 \
--version v1.6.1 \
# --set installCRDs=true
```

Expand All @@ -80,7 +80,7 @@ $ helm install \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace \
--version v1.6.0 \
--version v1.6.1 \
--set prometheus.enabled=false \ # Example: disabling prometheus using a Helm parameter
--set webhook.timeoutSeconds=4 # Example: changing the wehbook timeout using a Helm parameter
```
Expand All @@ -97,7 +97,7 @@ $ helm template \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace \
--version v1.6.0 \
--version v1.6.1 \
# --set prometheus.enabled=false \ # Example: disabling prometheus using a Helm parameter
# --set installCRDs=true \ # Uncomment to also template CRDs
> cert-manager.custom.yaml
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/installation/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ are included in a single YAML manifest file:
Install all cert-manager components:

```bash
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.0/cert-manager.yaml
$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
```

By default, cert-manager will be installed into the `cert-manager`
Expand Down
Loading