-
Notifications
You must be signed in to change notification settings - Fork 378
Move Issuer / ClusterIssuer and Certificate resource content to a sub-folder of configuration/ #1075
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
base: master
Are you sure you want to change the base?
Move Issuer / ClusterIssuer and Certificate resource content to a sub-folder of configuration/ #1075
Changes from all commits
ab01100
8c03807
bae073e
fe41ac9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,30 +1,36 @@ | ||||||||||
| --- | ||||||||||
| 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. | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| Learn about how to configure cert-manager using Issuer, ClusterIssuer and Certificate resources. | ||||||||||
|
|
||||||||||
| ## Overview | ||||||||||
|
|
||||||||||
| 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
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I believe that cert-manager also adds Orders and Challenges. |
||||||||||
| They all have `metadata`, `spec` and `status` fields, just like other Kubernetes resources. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| 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. | ||||||||||
|
|
||||||||||
| Here is an overview of each of these resources explaining when you should create them and what cert-manager will do in each case. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Issuer / ClusterIssuer Resources | ||||||||||
|
|
||||||||||
| 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). | ||||||||||
| which are able to sign certificates in response to certificate signing requests. | ||||||||||
|
|
||||||||||
| 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. | ||||||||||
| 📖 [Learn more about Issuer and ClusterIssuer resources](issuer-and-clusterissuer-resources/README.md). | ||||||||||
|
|
||||||||||
| ## 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. | ||||||||||
| ## Certificate Resources | ||||||||||
|
|
||||||||||
| 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: | ||||||||||
| Next you'll probably want to create a Certificate. | ||||||||||
| This resource represents a desired X.509 certificate which will be signed and renewed before it expires. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| The private key and signed certificate will be stored in a Secret which you can then mount in to a Pod or use in an Ingress resource. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| --cluster-resource-namespace=my-namespace | ||||||||||
| ``` | ||||||||||
| 📖 [Learn more about Certificate resources](certificate-resources.md). | ||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,15 +1,21 @@ | ||||||||||||||
| --- | ||||||||||||||
| title: Certificate Resources | ||||||||||||||
| description: 'cert-manager usage: Certificates' | ||||||||||||||
| description: | | ||||||||||||||
| Learn about Certificate resources which represent a desired X.509 certificates which will be signed and renewed before they expire. | ||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| Learn about Certificate resources which represent a desired X.509 certificates which will be signed and renewed before they expire. | ||||||||||||||
| The private key and signed certificate will be stored in a Secret which you can then mount in to a Pod or use in an Ingress resource. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Overview | ||||||||||||||
|
|
||||||||||||||
| In cert-manager, the [`Certificate`](../concepts/certificate.md) resource | ||||||||||||||
| represents a human readable definition of a certificate request that is to be | ||||||||||||||
| honored by an issuer which is to be kept up-to-date. This is the usual way that | ||||||||||||||
|
Comment on lines
12
to
14
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| you will interact with cert-manager to request signed certificates. | ||||||||||||||
|
|
||||||||||||||
| In order to issue any certificates, you'll need to configure an | ||||||||||||||
| [`Issuer`](../configuration/README.md) or [`ClusterIssuer`](../configuration/README.md) | ||||||||||||||
| [`Issuer`](../configuration/issuer-and-clusterissuer-resources/README.md) or [`ClusterIssuer`](../configuration/issuer-and-clusterissuer-resources/README.md) | ||||||||||||||
| resource first. | ||||||||||||||
|
|
||||||||||||||
| ## Creating Certificate Resources | ||||||||||||||
|
|
@@ -183,7 +189,7 @@ makes sure deployments get restarted whenever a mounted Secret changes. | |||||||||||||
| Re-use of private keys | ||||||||||||||
|
|
||||||||||||||
| Some issuers, like the built-in [Venafi | ||||||||||||||
| issuer](../configuration/venafi.md), may disallow re-using private keys. | ||||||||||||||
| issuer](../configuration/issuer-and-clusterissuer-resources/venafi.md), may disallow re-using private keys. | ||||||||||||||
| If this is the case, you must explicitly configure the `rotationPolicy: | ||||||||||||||
| Always` setting for each of your Certificate objects accordingly. | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -365,4 +371,4 @@ type: kubernetes.io/tls | |||||||||||||
| data: | ||||||||||||||
| key.der: <DER binary format of private key> | ||||||||||||||
| ... | ||||||||||||||
| ``` | ||||||||||||||
| ``` | ||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| title: Issuer Configuration | ||
| description: | | ||
| Learn how to configure cert-manager using Issuer and ClusterIssuer resources | ||
| --- | ||
|
|
||
| Learn how to configure cert-manager using Issuer and ClusterIssuer resources. | ||
|
|
||
| ## Overview | ||
|
|
||
| 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. | ||
|
|
||
| ## ACME / Let's Encrypt | ||
|
|
||
| Learn how to use the ACME Issuer / ClusterIssuer fields to configure how cert-manager connects to Let's Encrypt | ||
| or any ACME compliant certificate authority. | ||
|
|
||
| 📖 Read the [ACME / Let's Encrypt Issuer section](./acme/README.md). | ||
|
|
||
| ## SelfSigned | ||
|
|
||
| Learn about the SelfSigned Issuer which is useful for bootstrapping a root certificate for custom Public Key Infrastructure, | ||
| or for creating simple ad-hoc certificates. | ||
|
|
||
| 📖 Read the [SelfSigned Issuer section](./selfsigned.md). | ||
|
|
||
| ## CA | ||
|
|
||
| Learn about the CA Issuer which generates a Certificate Authority whose certificate and | ||
| private key are stored inside the cluster as a Kubernetes `Secret`. | ||
|
|
||
| 📖 Read the [CA Issuer section](./ca.md). | ||
|
|
||
| ## Vault | ||
|
|
||
| Learn about the Vault Issuer which signs certificates using HashiCorp Vault. | ||
|
|
||
| 📖 Read the [Vault Issuer section](./vault.md). | ||
|
|
||
| ## Venafi | ||
|
|
||
| Learn about the Venafi Issuer which signs certificates using Venafi TPP or Venafi-as-a-Service. | ||
|
|
||
| 📖 Read the [Venafi Issuer section](./venafi.md). | ||
|
|
||
|
|
||
| ## External | ||
|
|
||
| Learn about external issuers which are extensions for cert-manager and allow it to get signed certificates from a variety of other certificate authorities. | ||
|
|
||
| 📖 Read the [External Issuer section](./external.md). | ||
|
|
||
| ## 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 | ||
| ``` |
Uh oh!
There was an error while loading. Please reload this page.