cert-manager/docs/admin/upgrading/index.rst
James Munnelly e77eacdcec Update upgrading docs
Update docs

Signed-off-by: James Munnelly <james.munnelly@jetstack.io>
2018-08-20 12:36:35 +01:00

68 lines
2.3 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 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``):
.. code:: shell
$ helm repo update
$ helm upgrade <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_number>`` and
``<namespace>`` with the version number you want to install, and the namespace
that cert-manager is deployed into respectively:
.. code:: shell
$ kubectl apply --namespace <namespace> -f \
https://github.com/jetstack/cert-manager/blob/<version_number>/contrib/manifests/cert-manager/with-rbac.yaml
.. note::
Please be sure to choose the correct variant of the static manifests, i.e.
one of the ``with-rbac`` or ``without-rbac`` files, depending on your cluster
configuration.
.. toctree::
:maxdepth: 1
upgrading-0.2-0.3
upgrading-0.3-0.4
upgrading-0.4-0.5
.. _`official Helm charts repository`: https://github.com/helm/charts
.. _`static deployment manifests`: https://github.com/jetstack/cert-manager/blob/master/contrib/manifests/cert-manager