From 67156110f04a4248a1dbc3c1dbac4e20008cb3b2 Mon Sep 17 00:00:00 2001 From: Chris Abiad Date: Tue, 4 Jun 2019 08:42:02 -0400 Subject: [PATCH] merge namespace restriction doc into earlier text Also, clarify that ClusterIssuer doesn't have this restriction and link to documentation. Signed-off-by: Christopher Abiad --- docs/tutorials/acme/quick-start/index.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/tutorials/acme/quick-start/index.rst b/docs/tutorials/acme/quick-start/index.rst index 9bce4703a..a4939d364 100644 --- a/docs/tutorials/acme/quick-start/index.rst +++ b/docs/tutorials/acme/quick-start/index.rst @@ -475,6 +475,19 @@ operation. These two resources are: certificates. An Issuer is specific to a single namespace in Kubernetes, and a ClusterIssuer is meant to be a cluster-wide definition for the same purpose. + + Note that if you're using this document as a guide to configure cert-manager + for your own Issuer, you must either create the Issuers in the same namespace + as your Ingress resouces, adding '-n my-namespace' to your 'kubectl create' + commands, or use a ClusterIssuer. ClusterIssuer resouces apply across all + Ingress resources in your cluster and don't have this namespace-matching + requirement. + + More information on the difference between Issuers and ClusterIssuers, how + to create ClusterIssuers, and when you might choose to use each can be found + at: + + https://docs.cert-manager.io/en/latest/tasks/issuers/index.html#difference-between-issuers-and-clusterissuers :doc:`Certificate ` @@ -501,15 +514,6 @@ Create this definition locally and update the email address to your own. This email required by Let's Encrypt and used to notify you of certificate expirations and updates. -.. note:: - - If you're using this document as a guide to configure cert-manager for your - own ingress, it's important to note that you must install the issuers in the - same namespace as your ingress. This example installs the ingress in the - `default` namespace, so it doesn't need to be specified. If your ingress is in - another namespace add `-n my-namespace` to the `kubectl create` commands below. - - - staging issuer: `staging-issuer.yaml`_ .. literalinclude:: example/staging-issuer.yaml