weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add provisional upgrade notes for v0.11

Browse Source 
Signed-off-by: James Munnelly <james@munnelly.eu>
This commit is contained in:
James Munnelly 2019-09-27 11:22:44 +01:00
parent 689372b4d7
commit 093aa6844c
2 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/tasks/upgrading/index.rst
View File

@ -98,6 +98,7 @@ version number you want to install:
upgrading-0.7-0.8
upgrading-0.8-0.9
upgrading-0.9-0.10
upgrading-0.10-0.11
.. _`official Helm charts repository`: https://hub.helm.sh/charts/jetstack
.. _`static deployment manifests`: https://github.com/jetstack/cert-manager/blob/release-0.10/deploy/manifests

50
docs/tasks/upgrading/upgrading-0.10-0.11.rst Normal file
View File

@ -0,0 +1,50 @@
=============================
Upgrading from v0.10 to v0.11
=============================
** NOTE: THIS UPGRADE GUIDE IS PROVISIONAL AND MAY NOT BE COMPLETE WHILST THE v0.11 RELEASE SERIES IS IN ALPHA**
The v0.11 release marks the removal of the v1alpha1 API that was used in
previous versions of cert-manager, as well as our API group changing to be
``cert-manager.io`` instead of ``certmanager.k8s.io``.
We have also removed support for the **old style config format** that was
deprecated in the v0.8 release. This means you **must** transition to using the
new ``solvers`` style configuration format for your ACME issuers **before**
upgrading to v0.11. For more information, see the
:doc:`upgrading to v0.8 </tasks/upgrading/upgrading-0.7-0.8>` guide.
This makes for a fairly significant breaking change for users, as **all**
cert-manager resources, or even Ingresses that reference cert-manager
resources, will need to be updated to reflect these changes.
This upgrade should be performed in a few steps:
1) Back up existing cert-manager resources, as per the
:doc:`backup and restore guide <../backup-restore-crds>`.
2) Uninstall cert-manager (by running ``kubectl delete -f`` or ``helm delete --purge``)
3) Ensure the old cert-manager CRD resources have also been deleted: ``kubectl get crd | grep certmanager.k8s.io``
4) Update the apiVersion on all your backed up resources from
``certmanager.k8s.io/v1alpha1`` to ``cert-manager.io/v1alpha2``.
5) Re-install cert-manager from scratch according to the :doc:`getting started guide </getting-started/index>`.
You must be sure to properly **backup**, **uninstall**, **re-install** and
**restore** your installation in order to ensure the upgrade is successful.
Additional annotation changes
=============================
As well as changing the API group used by our CRDs, we have also changed the
annotation-based configuration key to **also** reflect the new API group.
This means that if you use any cert-manager annotations on any of your other
resources (such as Ingresses, {Validating,Mutating}WebhookConfiguration, etc)
you will need to update them to reflect the new API group.
A full table of annotations, including the old and new equivalents:
.. TODO: create a table mapping old annotations to new