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

Update getting started guide

Browse Source 
Signed-off-by: James Munnelly <james@munnelly.eu>
This commit is contained in:
James Munnelly 2018-12-04 18:26:49 +00:00
parent cdd513c6c5
commit 779cc0ae1f
2 changed files with 31 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
deploy/manifests/README.md
View File

@ -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?

37
docs/getting-started/2-installing.rst
View File

@ -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