From 82b0ece96fcdc37052ac3d9a2252289998887974 Mon Sep 17 00:00:00 2001 From: Inteon <42113979+inteon@users.noreply.github.com> Date: Mon, 26 Jul 2021 10:42:13 +0200 Subject: [PATCH] add check api docs Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com> --- content/en/docs/installation/verify.md | 43 +++++++++++++++++++------- 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/content/en/docs/installation/verify.md b/content/en/docs/installation/verify.md index 6a4d2f37cf..42a374cc4b 100644 --- a/content/en/docs/installation/verify.md +++ b/content/en/docs/installation/verify.md @@ -5,6 +5,34 @@ weight: 30 type: "docs" --- +## Check cert-manager API + +First, make sure that the [cert-manager kubectl plugin is installed](../../usage/kubectl-plugin/#installation). + +This kubectl plugin performs a dry-run certificate creation check against the Kubernetes cluster. +If successful, the message `The cert-manager API is ready` is displayed. + +```bash +$ kubectl cert-manager check api +The cert-manager API is ready +``` + +The command can also be used to wait for the check to be successful. +Here is an output example of running the command at the same time that cert-manager is being installed: + +```bash +$ kubectl cert-manager check api --wait=2m +Not ready: the cert-manager CRDs are not yet installed on the Kubernetes API server +Not ready: the cert-manager CRDs are not yet installed on the Kubernetes API server +Not ready: the cert-manager webhook deployment is not ready yet +Not ready: the cert-manager webhook deployment is not ready yet +Not ready: the cert-manager webhook deployment is not ready yet +Not ready: the cert-manager webhook deployment is not ready yet +The cert-manager API is ready +``` + +## Manual verification + Once you've installed cert-manager, you can verify it is deployed correctly by checking the `cert-manager` namespace for running pods: @@ -23,11 +51,6 @@ little longer to successfully provision than the others. If you experience problems, first check the [FAQ](../../faq/). -The following steps will confirm that cert-manager is set up correctly and able -to issue basic certificate types. Alternatively, to automatically check if -cert-manager is correctly configured, you can run the community-maintained -[cert-manager-verifier](https://github.com/alenkacz/cert-manager-verifier) tool. - Create an `Issuer` to test the webhook works okay. ```bash $ cat < test-resources.yaml @@ -95,11 +118,7 @@ $ kubectl delete -f test-resources.yaml If all the above steps have completed without error, you're good to go! -## Configuring your first Issuer - -Before you can begin issuing certificates, you must configure at least one -`Issuer` or `ClusterIssuer` resource in your cluster. +## Community-maintained tool -You should read the [configuration](../../configuration/) guide to -learn how to configure cert-manager to issue certificates from one of the -supported backends. +Alternatively, to automatically check if cert-manager is correctly configured, +you can run the community-maintained [cert-manager-verifier](https://github.com/alenkacz/cert-manager-verifier) tool.