Move Issuer / ClusterIssuer and Certificate resource content to a sub-folder of configuration/ #1075
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Richard Wall <[email protected]>
jetstack-bot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: wallrj The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
jetstack-bot
added
the
approved
✅ Deploy Preview for cert-manager-website ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
mehak151
reviewed
Sep 13, 2022
content/docs/configuration/issuer-and-clusterissuer-resources/README.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Richard Wall <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
wallrj
changed the title
jetstack-bot
removed
the
do-not-merge/work-in-progress
jsoref
reviewed
Sep 14, 2022
|
|
||
| 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`. | ||
| They all have `metadata`, `spec` and `status` fields, just like other Kubernetes resources. |
There was a problem hiding this comment.
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. |
Comment on lines
+11
to
+12
| 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`. |
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
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. |
| 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. |
There was a problem hiding this comment.
Suggested change
| This resource represents a desired X.509 certificate which will be signed and renewed before it expires. | |
| This resource represents a desired X.509 certificate which cert-manager will try to get signed and renewed before it expires. |
| 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. | ||
| 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. |
There was a problem hiding this comment.
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. | |
| The private key and signed certificate will be stored in a Secret which you can then mount into a Pod or use in an Ingress resource. |
| --- | ||
|
|
||
| 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. |
There was a problem hiding this comment.
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. | |
| The private key and signed certificate will be stored in a Secret which you can then mount into a Pod or use in an Ingress resource. |
Comment on lines
12
to
14
| 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 |
There was a problem hiding this comment.
Suggested change
| 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 | |
| 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 and which cert-manager will try to keep up-to-date. This is the usual way that |
| @@ -180,43 +180,31 @@ | |||
| "title": "Introduction", | |||
| "path": "/docs/configuration/README.md" | |||
| }, | |||
| { | |||
Comment on lines
256
to
+257
| ] | ||
| }, |
There was a problem hiding this comment.
The whitespace here looks suspicious
jetstack-bot
added
the
needs-rebase
|
@wallrj: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
inteon
requested changes
Jun 9, 2023
There was a problem hiding this comment.
@wallrj I think "Issuers" should be a top level menu item.
The layout could look like this:
- Issuers
- Introduction
- Full list
- In-tree issuer config
- ACME
- SelfSigned
- CA
- Vault
- Venafi
- External issuer config
- Requesting Certificates
- Introduction
- Certificate [cert-manager.io/v1]
- Ingress [networking.k8s.io/v1]
- GatewayAPI [gateway.networking.k8s.io/v1beta1]
- CertificateSigningRequest [certificates.k8s.io/v1]
- Istio Service Mesh
- CSI Driver
- CSI Driver SPIFFE
|
This has been solved in an alternative way. TODO: recover the changes made in the following files & apply them to the new website structure (if possible)
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview: https://deploy-preview-1075--cert-manager-website.netlify.app/
Part of the #1048 where we presented an improved overall navigation structure for the site.
configuration/issuer-and-clusterissuer-resources/homepage, because the side menu is not always expanded when you visit that page./cc @maelvls @mehak151 (and @jsoref ...if you have time)