From ee225290c2fee862bf197120d817122b296b98ce Mon Sep 17 00:00:00 2001 From: James Munnelly Date: Thu, 9 May 2019 13:44:44 +0100 Subject: [PATCH] Fix linkcheck errors Signed-off-by: James Munnelly --- docs/reference/cainjector.rst | 3 +++ docs/reference/index.rst | 1 + docs/reference/issuers.rst | 4 ++-- docs/tasks/issuers/index.rst | 2 +- docs/tasks/issuers/setup-acme/dns01/google.rst | 2 +- docs/tasks/issuers/setup-acme/dns01/index.rst | 2 +- docs/tasks/issuers/setup-acme/dns01/rfc2136.rst | 2 +- docs/tasks/issuers/setup-acme/http01/index.rst | 2 +- docs/tasks/issuers/setup-acme/index.rst | 11 +++++++---- docs/tasks/issuers/setup-vault.rst | 2 +- docs/tasks/issuers/setup-venafi.rst | 8 ++++---- docs/tasks/upgrading/upgrading-0.5-0.6.rst | 2 +- docs/tutorials/acme/quick-start/index.rst | 2 +- 13 files changed, 25 insertions(+), 18 deletions(-) create mode 100644 docs/reference/cainjector.rst diff --git a/docs/reference/cainjector.rst b/docs/reference/cainjector.rst new file mode 100644 index 000000000..e43301368 --- /dev/null +++ b/docs/reference/cainjector.rst @@ -0,0 +1,3 @@ +===================== +cainjector controller +===================== diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 9406d8a57..a11849155 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -17,4 +17,5 @@ Step by step user guides and tutorials can be found in the challenges issuers clusterissuers + cainjector api-docs/index diff --git a/docs/reference/issuers.rst b/docs/reference/issuers.rst index fbe68c718..bf7e2f03e 100644 --- a/docs/reference/issuers.rst +++ b/docs/reference/issuers.rst @@ -35,7 +35,7 @@ This is the simplest of ACME issuers - it specifies no DNS-01 challenge providers. HTTP-01 validation can be performed through using Ingress resources by enabling the HTTP-01 challenge mechanism (with the ``http01: {}`` field). -More information on configuring ACME Issuers can be found :doc:`here `. +More information on configuring ACME Issuers can be found :doc:`here `. *********** Namespacing @@ -120,7 +120,7 @@ currently supported Issuer types are: +------------------------------------------------------+----------------------------------------------------------------------+ | Name | Description | +======================================================+======================================================================+ -| :doc:`ACME ` | Supports obtaining certificates from an ACME server, validating with | +| :doc:`ACME ` | Supports obtaining certificates from an ACME server, validating with | | | HTTP01 or DNS01 | +------------------------------------------------------+----------------------------------------------------------------------+ | :doc:`CA ` | Supports issuing certificates using a simple signing keypair, stored | diff --git a/docs/tasks/issuers/index.rst b/docs/tasks/issuers/index.rst index afc695f53..380c6c033 100644 --- a/docs/tasks/issuers/index.rst +++ b/docs/tasks/issuers/index.rst @@ -37,7 +37,7 @@ types you require: * :doc:`CA <./setup-ca>` - issue certificates signed by a X509 signing keypair, stored in a Secret in the Kubernetes API server. * :doc:`Self signed <./setup-selfsigned>` - issue self signed certificates. -* :doc:`ACME <./setup-acme>` - issue certificates obtained by performing +* :doc:`ACME <./setup-acme/index>` - issue certificates obtained by performing challenge validations against an ACME server such as `Let's Encrypt`_. * :doc:`Vault <./setup-vault>`- issue certificates from a Vault instance configured with the `Vault PKI backend`_. diff --git a/docs/tasks/issuers/setup-acme/dns01/google.rst b/docs/tasks/issuers/setup-acme/dns01/google.rst index 240b884aa..6f78f12ad 100644 --- a/docs/tasks/issuers/setup-acme/dns01/google.rst +++ b/docs/tasks/issuers/setup-acme/dns01/google.rst @@ -2,7 +2,7 @@ Google CloudDNS ========================= -This guide explains how to set up an Issuer, or ClusterIssuer, to use Google CloudDNS to solve DNS01 ACME challenges. It's advised you read the :doc:`DNS01 Challenge Provider ` page first for a more general understanding of how cert-manager handles DNS01 challenges. +This guide explains how to set up an Issuer, or ClusterIssuer, to use Google CloudDNS to solve DNS01 ACME challenges. It's advised you read the :doc:`DNS01 Challenge Provider <./index>` page first for a more general understanding of how cert-manager handles DNS01 challenges. .. note:: This guide assumes that your cluster is hosted on Google Cloud Platform (GCP) and that you already have a domain set up with CloudDNS. diff --git a/docs/tasks/issuers/setup-acme/dns01/index.rst b/docs/tasks/issuers/setup-acme/dns01/index.rst index 91372a282..1a2755052 100644 --- a/docs/tasks/issuers/setup-acme/dns01/index.rst +++ b/docs/tasks/issuers/setup-acme/dns01/index.rst @@ -6,7 +6,7 @@ This page contains details on the different options available on the ``Issuer`` resource's DNS01 challenge solver configuration. For more information on configuring ACME issuers and their API format, read the -:doc:`Setting up ACME Issuers <./setup-acme>` documentation. +:doc:`Setting up ACME Issuers <../index>` documentation. DNS01 provider configuration must be specified on the Issuer resource, similar to the examples in the setting up documentation: diff --git a/docs/tasks/issuers/setup-acme/dns01/rfc2136.rst b/docs/tasks/issuers/setup-acme/dns01/rfc2136.rst index 984177a14..d936f2f18 100644 --- a/docs/tasks/issuers/setup-acme/dns01/rfc2136.rst +++ b/docs/tasks/issuers/setup-acme/dns01/rfc2136.rst @@ -192,7 +192,7 @@ What’s next? ------------ This configuration so far will actually do nothing. You still have to -request a certificate as in :doc:`dns-validation`. Once a certficate is requested, +request a certificate as in :doc:`/tasks/issuing-certificates/index`. Once a certficate is requested, the provider will begin processing the request. Troubleshooting diff --git a/docs/tasks/issuers/setup-acme/http01/index.rst b/docs/tasks/issuers/setup-acme/http01/index.rst index a6f1e3c91..69f621ad4 100644 --- a/docs/tasks/issuers/setup-acme/http01/index.rst +++ b/docs/tasks/issuers/setup-acme/http01/index.rst @@ -6,7 +6,7 @@ This page contains details on the different options available on the ``Issuer`` resource's HTTP01 challenge solver configuration. For more information on configuring ACME issuers and their API format, read the -:doc:`Setting up ACME Issuers <./setup-acme>` documentation. +:doc:`Setting up ACME Issuers <../index>` documentation. How HTTP01 validations work =========================== diff --git a/docs/tasks/issuers/setup-acme/index.rst b/docs/tasks/issuers/setup-acme/index.rst index 054f767b5..c0b4cdc28 100644 --- a/docs/tasks/issuers/setup-acme/index.rst +++ b/docs/tasks/issuers/setup-acme/index.rst @@ -11,10 +11,6 @@ which is used to identify you with the ACME server. To set up a basic ACME issuer, you should create a new Issuer or ClusterIssuer resource. -In this example, we will create a non-namespaced ClusterIssuer resource for -the `Let's Encrypt staging endpoint`_ that has only the -:doc:`HTTP01 Challenge Provider ` enabled. - You should read the guides linked at the bottom of this page to learn more about the ACME challenge validation mechanisms that cert-manager supports and how to configure the various DNS01 provider implementations. @@ -172,4 +168,11 @@ the DNS01 challenge solver for ``*.example.com``. It is possible to specify both ``matchLabels`` AND ``dnsNames`` on an ACME solver selector. +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + http01/index + dns01/index + .. _`Let's Encrypt staging endpoint`: https://letsencrypt.org/docs/staging-environment/ diff --git a/docs/tasks/issuers/setup-vault.rst b/docs/tasks/issuers/setup-vault.rst index cd1bb0da7..f716fd9ed 100644 --- a/docs/tasks/issuers/setup-vault.rst +++ b/docs/tasks/issuers/setup-vault.rst @@ -7,7 +7,7 @@ Installing Vault Vault installation is a complex subject. For a thorough tour of the subject you can read the official HashiCorp Vault -`documentation `__. +`documentation `__. Vault PKI Backend diff --git a/docs/tasks/issuers/setup-venafi.rst b/docs/tasks/issuers/setup-venafi.rst index b7a059b35..0e6ba04c2 100644 --- a/docs/tasks/issuers/setup-venafi.rst +++ b/docs/tasks/issuers/setup-venafi.rst @@ -5,7 +5,7 @@ Setting up Venafi Issuers The Venafi Issuer types allows you to obtain certificates from `Venafi Cloud`_ and `Venafi Trust Protection Platform`_ instances. -Register your account at https://api.venafi.cloud/login and get an API key from +Register your account at https://ui.venafi.cloud/enroll and get an API key from your dashboard. You can have multiple different Venafi Issuer types installed within the same @@ -30,7 +30,7 @@ obtain certificates from. You can configure your Issuer resource to either issue certificates only within a single namespace, or cluster-wide (using a ClusterIssuer resource). For more information on the distinction between Issuer and ClusterIssuer -resources, read the issuer_vs_clusterissuer_ section. +resources, read the :ref:`issuer_vs_clusterissuer` section. Creating a Venafi Cloud Issuer @@ -95,7 +95,7 @@ Verify the Issuer has been initialised correctly using ``kubectl describe``: You are now ready to issue certificates using the newly provisioned Venafi Issuer. -Read the :doc:`Issuing Certificates <../issuing-certificates>` document +Read the :doc:`Issuing Certificates <../issuing-certificates/index>` document for more information on how to create Certificate resources. Creating a Venafi Trust Protection Platform Issuer @@ -176,4 +176,4 @@ Read the :doc:`Issuing Certificates <../issuing-certificates/index>` document for more information on how to create Certificate resources. .. _Venafi Cloud: https://pki.venafi.com/venafi-cloud/ -.. _Venafi Trust Protection Platform:: https://venafi.com/ +.. _Venafi Trust Protection Platform: https://venafi.com/ diff --git a/docs/tasks/upgrading/upgrading-0.5-0.6.rst b/docs/tasks/upgrading/upgrading-0.5-0.6.rst index 46d9cfb0a..ba348c63b 100644 --- a/docs/tasks/upgrading/upgrading-0.5-0.6.rst +++ b/docs/tasks/upgrading/upgrading-0.5-0.6.rst @@ -70,7 +70,7 @@ Before upgrading you will need to: clusterissuers.certmanager.k8s.io 3. Perform a fresh install (as per the - :doc:`installation guide `): + :doc:`installation guide `): .. code-block:: shell diff --git a/docs/tutorials/acme/quick-start/index.rst b/docs/tutorials/acme/quick-start/index.rst index 98429fe4e..d3bb50e96 100644 --- a/docs/tutorials/acme/quick-start/index.rst +++ b/docs/tutorials/acme/quick-start/index.rst @@ -525,7 +525,7 @@ will need to update this example and add in your own email address. issuer.certmanager.k8s.io "letsencrypt-prod" created Both of these issuers are configured to use the -:doc:`HTTP01 ` challenge provider. +:doc:`HTTP01 ` challenge provider. Check on the status of the issuer after you create it: