Skip to content
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.

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

Move Issuer / ClusterIssuer and Certificate resource content to a sub-folder of configuration/ #1075

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
37 changes: 15 additions & 22 deletions content/docs/configuration/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,23 @@
---
title: Issuer Configuration
description: Learn about configuring cert-manager using Issuer and ClusterIssuer resources.
title: Configuration
description: |
Learn about how to configure cert-manager using Issuer, ClusterIssuer and Certificate resources.
wallrj marked this conversation as resolved.
Show resolved Hide resolved
---

The first thing you'll need to configure after you've installed cert-manager is an `Issuer` or a `ClusterIssuer`.
These are resources that represent certificate authorities (CAs)
able to sign certificates in response to certificate signing requests.

This section documents how the different issuer types can be configured. You might want to
[read more about `Issuer` and `ClusterIssuer` resources](../concepts/issuer.md).
After installing cert-manager you will find that some new resource types have been added to the Kubernetes API server
such as `Issuer`, `ClusterIssuer`, and `Certificate`.
Comment on lines +11 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After installing cert-manager you will find that some new resource types have been added to the Kubernetes API server
such as `Issuer`, `ClusterIssuer`, and `Certificate`.
After installing cert-manager you will find see new resource types have been added to the Kubernetes API server
including `Issuer`, `ClusterIssuer`, and `Certificate`.

I believe that cert-manager also adds Orders and Challenges.

They all have `metadata`, `spec` and `status` fields, just like other Kubernetes resources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
They all have `metadata`, `spec` and `status` fields, just like other Kubernetes resources.
They each have `metadata`, `spec` and `status` fields, just like other Kubernetes resources.


cert-manager comes with a number of built-in certificate issuers which are denoted by being in
the `cert-manager.io` group. You can also install external issuers in addition to the built-in types.
Built-in and external issuers are treated the same and are configured similarly.
You can create them by writing the content to a YAML file and using `kubectl apply` to send them to the Kubernetes API server.
Whenever you create or update one of these resources cert-manager will react;
it will do some work and it will update the status with information about what it has done.

## Cluster Resource Namespace
Here is an overview of each of these resources explaining when you should create them and what cert-manager will do in each case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Here is an overview of each of these resources explaining when you should create them and what cert-manager will do in each case.
Here is an overview of each of these resources explaining when you should create them and what cert-manager will do for each resource type.


When using `ClusterIssuer` resource types, ensure you understand the purpose of the
Cluster Resource Namespace; this can be a common source
of issues for people getting started with cert-manager.
## Issuer / ClusterIssuer

The `ClusterIssuer` resource is cluster scoped. This means that when referencing
a secret via the `secretName` field, secrets will be looked for in the `Cluster
Resource Namespace`. By default, this namespace is `cert-manager` however it can be
changed via a flag on the cert-manager-controller component:
The first thing you'll need to configure after you've installed cert-manager is an `Issuer` or a `ClusterIssuer`.
These are resources that represent certificate authorities (CAs)
which are able to sign certificates in response to certificate signing requests.

```bash
--cluster-resource-namespace=my-namespace
```
📖 [Learn more about Issuer and ClusterIssuer resources](issuer-and-clusterissuer-resources/README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Issuer Configuration
description: Learn about configuring cert-manager using Issuer and ClusterIssuer resources.
wallrj marked this conversation as resolved.
Show resolved Hide resolved
---

The first thing you'll need to configure after you've installed cert-manager is an `Issuer` or a `ClusterIssuer`.
These are resources that represent certificate authorities (CAs)
able to sign certificates in response to certificate signing requests.

This section documents how the different issuer types can be configured. You might want to
[read more about `Issuer` and `ClusterIssuer` resources](../concepts/issuer.md).

cert-manager comes with a number of built-in certificate issuers which are denoted by being in
the `cert-manager.io` group. You can also install external issuers in addition to the built-in types.
Built-in and external issuers are treated the same and are configured similarly.

## Cluster Resource Namespace

When using `ClusterIssuer` resource types, ensure you understand the purpose of the
Cluster Resource Namespace; this can be a common source
of issues for people getting started with cert-manager.

The `ClusterIssuer` resource is cluster scoped. This means that when referencing
a secret via the `secretName` field, secrets will be looked for in the `Cluster
Resource Namespace`. By default, this namespace is `cert-manager` however it can be
changed via a flag on the cert-manager-controller component:

```bash
--cluster-resource-namespace=my-namespace
```
77 changes: 45 additions & 32 deletions content/docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -180,43 +180,31 @@
"title": "Introduction",
"path": "/docs/configuration/README.md"
},
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{
{

"title": "Issuer / ClusterIssuer",
"routes": [

{
"title": "SelfSigned",
"path": "/docs/configuration/selfsigned.md"
},
{
"title": "CA",
"path": "/docs/configuration/ca.md"
},
{
"title": "Vault",
"path": "/docs/configuration/vault.md"
},
{
"title": "Venafi",
"path": "/docs/configuration/venafi.md"
},
{
"title": "External",
"path": "/docs/configuration/external.md"
"title": "Introduction",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/README.md"
},
{
"title": "ACME",
"routes": [
{
"title": "Introduction",
"path": "/docs/configuration/acme/README.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/README.md"
},
{
"title": "HTTP01",
"routes": [
{
"title": "Introduction",
"path": "/docs/configuration/acme/http01/README.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/http01/README.md"
},
{
"title": "External Load Balancer",
"path": "/docs/configuration/acme/http01/externalloadbalancer.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/http01/externalloadbalancer.md"
}
]
},
Expand All @@ -225,49 +213,74 @@
"routes": [
{
"title": "Introduction",
"path": "/docs/configuration/acme/dns01/README.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/README.md"
},
{
"title": "ACMEDNS",
"path": "/docs/configuration/acme/dns01/acme-dns.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/acme-dns.md"
},
{
"title": "Akamai",
"path": "/docs/configuration/acme/dns01/akamai.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/akamai.md"
},
{
"title": "AzureDNS",
"path": "/docs/configuration/acme/dns01/azuredns.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/azuredns.md"
},
{
"title": "Cloudflare",
"path": "/docs/configuration/acme/dns01/cloudflare.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/cloudflare.md"
},
{
"title": "DigitalOcean",
"path": "/docs/configuration/acme/dns01/digitalocean.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/digitalocean.md"
},
{
"title": "Google CloudDNS",
"path": "/docs/configuration/acme/dns01/google.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/google.md"
},
{
"title": "RFC-2136",
"path": "/docs/configuration/acme/dns01/rfc2136.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/rfc2136.md"
},
{
"title": "Route53",
"path": "/docs/configuration/acme/dns01/route53.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/route53.md"
},
{
"title": "Webhook",
"path": "/docs/configuration/acme/dns01/webhook.md"
"path": "/docs/configuration/issuer-and-clusterissuer-resources/acme/dns01/webhook.md"
}
]
}
]
},
Comment on lines 256 to +257
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whitespace here looks suspicious




{
"title": "SelfSigned",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/selfsigned.md"
},
{
"title": "CA",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/ca.md"
},
{
"title": "Vault",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/vault.md"
},
{
"title": "Venafi",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/venafi.md"
},
{
"title": "External",
"path": "/docs/configuration/issuer-and-clusterissuer-resources/external.md"
}
]
}
]
]
},
{
"title": "Usage",
Expand Down
9 changes: 9 additions & 0 deletions public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,12 @@ https://docs.cert-manager.io/* https://cert-manager.io/docs/:splat 302!

# Demoted the cmctl x install page
/docs/installation/cmctl/ /docs/reference/cmctl/ 301!


# Moved Issuer and ClusterIssuer resources to a subdirectory
/docs/configuration/acme/* /docs/configuration/issuer-and-clusterissuer-resources/acme/:splat 301!
/docs/configuration/ca/ /docs/configuration/issuer-and-clusterissuer-resources/ca/ 301!
/docs/configuration/external/ /docs/configuration/issuer-and-clusterissuer-resources/external/ 301!
/docs/configuration/selfsigned/ /docs/configuration/issuer-and-clusterissuer-resources/selfsigned/ 301!
/docs/configuration/vault/ /docs/configuration/issuer-and-clusterissuer-resources/vault/ 301!
/docs/configuration/venafi/ /docs/configuration/issuer-and-clusterissuer-resources/venafi/ 301!