From 779cc0ae1f1f7db5a1b522f44760b9472c9f767d Mon Sep 17 00:00:00 2001 From: James Munnelly Date: Tue, 4 Dec 2018 18:26:49 +0000 Subject: [PATCH] Update getting started guide Signed-off-by: James Munnelly --- deploy/manifests/README.md | 2 +- docs/getting-started/2-installing.rst | 37 ++++++++++++++++++++++----- 2 files changed, 31 insertions(+), 8 deletions(-) diff --git a/deploy/manifests/README.md b/deploy/manifests/README.md index 5fd61b114..d959c0137 100644 --- a/deploy/manifests/README.md +++ b/deploy/manifests/README.md @@ -2,7 +2,7 @@ This directory contains the Kubernetes manifests needed to deploy cert-manager. -For full information on deploying cert-manager, see the [getting started guide](TODO). +For full information on deploying cert-manager, see the [getting started guide](https://cert-manager.readthedocs.io/en/latest/getting-started/index.html). ## Where do these come from? diff --git a/docs/getting-started/2-installing.rst b/docs/getting-started/2-installing.rst index d3c0f2bf8..bf25f97f8 100644 --- a/docs/getting-started/2-installing.rst +++ b/docs/getting-started/2-installing.rst @@ -8,15 +8,30 @@ With Helm Using Helm is the recommended way to deploy cert-manager. We publish a stable version of the chart to the public `charts repository`_. -You can install the chart with the following command: +Before installing the cert-manager Helm chart, you will need to install the +CustomResourceDefinition resources that it uses. + +You can perform these two steps with the following commands: .. code-block:: shell + # Install the cert-manager CRDs + $ kubectl apply \ + -f https://raw.githubusercontent.com/jetstack/cert-manager/v0.6.0/deploy/manifests/00-crds.yaml + + # Update helm repository cache + $ helm repo update + + # Install cert-manager $ helm install \ --name cert-manager \ - --namespace kube-system \ + --namespace cert-manager \ + --version v0.6.0 \ stable/cert-manager +Each time you upgrade, you will need to re-apply the ``00-crds.yaml`` manifest +above (updating the version number, in this case ``v0.6.0``, accordingly). + The default cert-manager configuration is good for the majority of users, but a full list of the available options can be found in the `Helm chart README`_. @@ -32,13 +47,21 @@ full list of the available options can be found in the `Helm chart README`_. With static manifests ===================== -As some users may not be able to run Tiller in their own environment, static -Kubernetes deployment manifests are provided which can be used to install -cert-manager. +As some users may not want to use Helm, or would prefer to use a more +traditional deployment management mechanism, we also provide 'static manifests' +which can be installed with ``kubectl apply -f``. -You can get a copy of the static manifests from the `deploy directory`_. +To install cert-manager using the static manifests, you should run: -.. TODO: expand this to include a 'kubectl apply' example +.. code-block:: shell + + # Install the cert-manager CRDs + $ kubectl apply \ + -f https://raw.githubusercontent.com/jetstack/cert-manager/v0.6.0/deploy/manifests/00-crds.yaml + + # Install cert-manager + $ kubectl apply \ + -f https://raw.githubusercontent.com/jetstack/cert-manager/v0.6.0/deploy/manifests/cert-manager.yaml .. _`charts repository`: https://github.com/kubernetes/charts .. _`Helm chart README`: https://github.com/kubernetes/charts/blob/master/stable/cert-manager/README.md