cert-manager/docs/tasks/backup-restore-crds.rst
James Munnelly c01c63120c Add backing up and restoring guide
Signed-off-by: James Munnelly <james@munnelly.eu>
2019-01-30 13:29:24 +00:00

56 lines
1.5 KiB
ReStructuredText

========================
Backing up and restoring
========================
If you need to uninstall cert-manager, or transfer your installation to a new
cluster, you can backup all of cert-manager's configuration in order to
later re-install.
Backing up
==========
To backup all of your cert-manager configuration resources, run:
.. code-block:: shell
kubectl get -o yaml \
--all-namespaces \
issuer,clusterissuer,certificates,orders,challenges > cert-manager-backup.yaml
If you are transferring data to a new cluster, you may also need to copy across
additional Secret resources that are referenced by your configured Issuers,
such as:
CA Issuers
----------
* The root CA Secret referenced by ``issuer.spec.ca.secretName``
Vault Issuers
-------------
* The token authentication Secret referenced by
``issuer.spec.vault.auth.tokenSecretRef``
* The approle configuration Secret referenced by
``issuer.spec.vault.auth.appRole.secretRef``
ACME Issuers
------------
* The ACME account private key Secret referenced by ``issuer.acme.privateKeySecretRef``
* Any Secrets referenced by DNS providers configured under the
``issuer.acme.dns01.providers`` field
Restoring
=========
In order to restore your configuration, you can simply ``kubectl apply`` the
files created above after installing cert-manager.
.. code-block:: shell
kubectl apply -f cert-manager-backup.yaml
If you have migrated from an old cluster, you will need to make sure to run a
similar ``kubectl apply`` command to restore your Secret resources too.