From 3391084979388300ff8d42155314dccb6bb3a9d2 Mon Sep 17 00:00:00 2001 From: Richard Wall Date: Wed, 27 Oct 2021 18:01:46 +0100 Subject: [PATCH] Add an upgrade 1.5 to 1.6 document Signed-off-by: Richard Wall --- .../upgrading/upgrading-1.5-1.6.md | 29 +++++++++++++++++++ .../docs/release-notes/release-notes-1.6.md | 18 ++++++++++-- 2 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 content/en/docs/installation/upgrading/upgrading-1.5-1.6.md diff --git a/content/en/docs/installation/upgrading/upgrading-1.5-1.6.md b/content/en/docs/installation/upgrading/upgrading-1.5-1.6.md new file mode 100644 index 00000000000..b6e85d89cec --- /dev/null +++ b/content/en/docs/installation/upgrading/upgrading-1.5-1.6.md @@ -0,0 +1,29 @@ +--- +title: "Upgrading from v1.5 to v1.6" +linkTitle: "v1.5 to v1.6" +weight: 760 +type: "docs" +--- + +### Upgrading cert-manager CRDs and stored versions of cert-manager custom resources + +Following their deprecation in version 1.4, the cert-manager API versions `v1alpha2, v1alpha3, and v1beta1` are no longer served. + +This means if your deployment manifests contain any of these API versions, you will not be able to deploy them after upgrading. +Our new `cmctl` utility or old `kubectl cert-manager` plugin can [convert](../../../usage/cmctl/#convert) old manifests to `v1` for you. + +{{% pageinfo color="warning" %}} + +⛔️ If you are upgrading cert-manager on a cluster which has previously had +cert-manager < `v1.0.0`, you will need to ensure that all cert-manager custom +resources are stored in `etcd` at `v1` version and that cert-manger CRDs do not +reference the deprecated APIs **before you upgrade to `v1.6`**. + +This is explained in more detail in the [Upgrading existing cert-manager resources](../remove-deprecated-apis/#upgrading-existing-cert-manager-resources) +page. + +{{% /pageinfo %}} + +## Now Follow the Regular Upgrade Process + +From here on you can follow the [regular upgrade process](../). diff --git a/content/en/docs/release-notes/release-notes-1.6.md b/content/en/docs/release-notes/release-notes-1.6.md index cd099b0c5b2..0d6ae436351 100644 --- a/content/en/docs/release-notes/release-notes-1.6.md +++ b/content/en/docs/release-notes/release-notes-1.6.md @@ -9,9 +9,21 @@ type: "docs" ### Legacy cert-manager API versions are no-longer served -Following their deprecation in version 1.5, the cert-manager API versions `v1alpha2, v1alpha3, and v1beta1` are no longer served. +Following their deprecation in version 1.4, the cert-manager API versions `v1alpha2, v1alpha3, and v1beta1` are no longer served. -This means if your deployment manifests contain any of these API versions, you will not be able to deploy them after upgrading. Our new `cmctl` utility or old `kubectl cert-manager` plugin can [convert](https://cert-manager.io/docs/usage/kubectl-plugin/#convert) old manifests to `v1` for you. +This means if your deployment manifests contain any of these API versions, you will not be able to deploy them after upgrading. Our new `cmctl` utility or old `kubectl cert-manager` plugin can [convert](../../usage/cmctl/#convert) old manifests to `v1` for you. + +{{% pageinfo color="warning" %}} + +⛔️ If you are upgrading cert-manager on a cluster which has previously had +cert-manager < `v1.0.0`, you will need to ensure that all cert-manager custom +resources are stored in `etcd` at `v1` version and that cert-manger CRDs do not +reference the deprecated APIs **before you upgrade to `v1.6`**. + +This is explained in more detail in the [Upgrading existing cert-manager resources](../../installation/upgrading/remove-deprecated-apis/#upgrading-existing-cert-manager-resources) +page. + +{{% /pageinfo %}} ### JKS Keystore Minimum Password Length @@ -21,7 +33,7 @@ If you are using a shorter password, certificates will fail to renew, and the only observable error will be in the cert-manager logs. We are discussing the best remediation for a future `v1.6.1` release. -[jks-keystore]: https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.CertificateKeystores +[jks-keystore]: ../../reference/api-docs/#cert-manager.io/v1.CertificateKeystores [jks-keystore-upgrade-pr]: https://github.com/jetstack/cert-manager/pull/4428 ## Major Themes