Skip to content

Add 'kubectl cert-manager check api' docs #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jetstack-bot merged 1 commit into from
Jul 29, 2021
Merged

Add 'kubectl cert-manager check api' docs #656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 31 additions & 12 deletions content/en/docs/installation/verify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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.