cert-manager/docs/admin/upgrading/index.rst
James Munnelly 0991f8e412 Add notes on --validate=false to upgrading and installing guide
Signed-off-by: James Munnelly <james@munnelly.eu>
2019-01-16 19:20:42 +00:00

91 lines
3.4 KiB
ReStructuredText

======================
Upgrading cert-manager
======================
This section contains information on upgrading cert-manager.
It also contains documents detailing breaking changes between cert-manager
versions, and information on things to look out for when upgrading.
Upgrading with Helm
===================
If you installed cert-manager using Helm, you can easily upgrade using the Helm
CLI.
.. note::
Before upgrading, please read the relevant instructions at the links below
for your from and to version.
Once you have read the relevant upgrading notes and taken any appropriate
actions, you can begin the upgrade process like so - replacing
``<release_name>`` with the name of your Helm release for cert-manager (usually
this is ``cert-manager``) and replacing ``<version>`` with the
version number you want to install:
.. code:: shell
# Install the cert-manager CustomResourceDefinition resources before
# upgrading the Helm chart
$ kubectl apply \
-f https://raw.githubusercontent.com/jetstack/cert-manager/<version>/deploy/manifests/00-crds.yaml
# Ensure the local Helm chart repository cache is up to date
$ helm repo update
# If you are upgrading from v0.5 or below, you should manually add this
# label to your cert-manager namespace to ensure the `webhook component`_
# can provision correctly.
$ kubectl label namespace cert-manager certmanager.k8s.io/disable-validation=true
$ helm upgrade --version <version> <release_name> stable/cert-manager
This will upgrade you to the latest version of cert-manager, as listed in the
`official Helm charts repository`_.
.. note::
You can find out your release name using ``helm list | grep cert-manager``.
Upgrading using static manifests
================================
If you installed cert-manager using the `static deployment manifests`_, you
can upgrade them in a similar way to how you first installed them.
.. note::
Before upgrading, please read the relevant instructions at the links below
for your from and to version.
Once you have read the relevant notes and taken any appropriate actions, you
can begin the upgrade process like so - replacing ``<version>`` with the
version number you want to install:
.. code:: shell
# If you are upgrading from v0.5 or below, you should manually add this
# label to your cert-manager namespace to ensure the `webhook component`_
# can provision correctly.
$ kubectl label namespace cert-manager certmanager.k8s.io/disable-validation=true
$ kubectl apply \
-f https://raw.githubusercontent.com/jetstack/cert-manager/<version>/deploy/manifests/cert-manager.yaml
.. note::
If you are running kubectl v1.12 or below, you will need to add the
``--validate=false`` flag to your ``kubectl apply`` command above else you
will receive a validation error relating to the ``caBundle`` field of the
``ValidatingWebhookConfiguration`` resource.
This issue is resolved in Kubernetes 1.13 onwards. More details can be found
in `kubernetes/kubernetes#69590`_.
.. toctree::
:maxdepth: 1
upgrading-0.2-0.3
upgrading-0.3-0.4
upgrading-0.4-0.5
upgrading-0.5-0.6
.. _`official Helm charts repository`: https://github.com/helm/charts
.. _`static deployment manifests`: https://github.com/jetstack/cert-manager/blob/master/contrib/manifests/cert-manager
.. _`kubernetes/kubernetes#69590`: https://github.com/kubernetes/kubernetes/issues/69590