Add diagrams to explain all the "requesting certificates" flows #1289
Conversation
jetstack-bot
added
dco-signoff: yes
✅ Deploy Preview for cert-manager-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
inteon
force-pushed
the
add_diagrams
branch
3 times, most recently
from
adbd70a to
83fbd6e
Compare
jetstack-bot
added
the
needs-rebase
inteon
force-pushed
the
add_diagrams
branch
from
83fbd6e to
743ec9c
Compare
jetstack-bot
removed
the
needs-rebase
jetstack-bot
added
the
needs-rebase
inteon
force-pushed
the
add_diagrams
branch
from
743ec9c to
54fb651
Compare
jetstack-bot
removed
the
needs-rebase
inteon
force-pushed
the
add_diagrams
branch
2 times, most recently
from
853b083 to
1be8ac0
Compare
jetstack-bot
added
the
needs-rebase
jetstack-bot
removed
the
needs-rebase
inteon
changed the title
… diagram Signed-off-by: Tim Ramlot <[email protected]>
jetstack-bot
added
size/XXL
| <div style={{textAlign: "center"}}> | ||
| <object data="/images/request-certificate-overview/request-certificate-certificaterequest.svg"></object> | ||
| </div> |
There was a problem hiding this comment.
I'm unsure about these diagrams. Unless the reader is comfortable with all the terms (CSI driver, etc), I think they won't find any value in looking at the diagram. At best, they will think "huh?", at worst they will feel they are on the wrong page.
What idea are you trying to convey with these diagrams? That they could be using another approach? Or are you reminding them of all the features of cert-manager?
There was a problem hiding this comment.
IMO, this diagram should only show the "resources at play": the CertificateResource + the Secret.
There was a problem hiding this comment.
It aims to show you what resources are created by the user & what resources are auto-generated for each of the different paths. (eg. If you annotate an Ingress, that will create a Certificate resource and that Certificate resource will create CertificateRequest resources.
There was a problem hiding this comment.
IMO, this diagram should only show the "resources at play": the Gateway (with the principal annotation that enables the workflow) + the CertificateResource + the Secret. Anything else will confuse people.
Knowing what resources are at play is important since folks will need to know about them almost immediately to debug things.
There was a problem hiding this comment.
Knowing what resources are at play is important since folks will need to know about them almost immediately to debug things.
That is my goal for this diagram.
Do you know how we can adapt these diagrams to make that more clear?
There was a problem hiding this comment.
I would probably only show one box with a Gateway, one box with the CertificateResource, and one box with the Secret. I don't think that "CSI driver" and "Certificate" are useful context here
Signed-off-by: Tim Ramlot <[email protected]>
jetstack-bot
added
size/XL
|
Thank you for digging into my old diagrams and for fixing them!! The new CR diagrams should also help. /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: maelvls 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
I split the diagram from https://cert-manager.io/docs/concepts/certificate/ into multiple diagrams and placed them on the different "requesting certificates" pages.