Skip to content

Commit

Permalink
add check api docs
Browse files Browse the repository at this point in the history
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
  • Loading branch information
inteon committed Jul 26, 2021
1 parent ab959b5 commit 82b0ece
Showing 1 changed file with 31 additions and 12 deletions.
43 changes: 31 additions & 12 deletions content/en/docs/installation/verify.md
Expand Up @@ -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:

Expand All @@ -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 <<EOF > test-resources.yaml
Expand Down Expand Up @@ -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.

0 comments on commit 82b0ece

Please sign in to comment.