-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Fix documentation about install and renew your own CA certificates #6240
Conversation
Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
This PR can be merged only after #6180 |
Signed-off-by: Paolo Patierno <[email protected]>
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Paolo Patierno <[email protected]>
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good. I wasn't entirely clear on where we're suggesting to add an incremental value in the doc. Thought an example might help
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Paolo Patierno <[email protected]>
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Paolo Patierno <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, I'm not sure I understand what exactly should be done for the renewal. It should probably have more steps and more examples.
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Paolo Patierno <[email protected]>
@scholzj I pushed changes related to your comments, can you have another pass please? |
I just updated the procedure with the additional stuff needed. I think the current way works why re-writing it again if it was approved in the past? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, I'm not sure I think this is really understandable. What about:
- Splitting the key replacement and CA renewal into two separate procedures?
- Adding more examples which would include a YAMLs of the secrets to show exactly how they should look like? I think that will make it much clearer and you can use callouts to point out what should be where, what needs to be changed etc. Editing the secrets would also help to deal with the delayed annotations etc.
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
Ok then. I will re-write this PR by having two procedures:
It will follow the same pattern we have for the ones related to auto-generated CA by Strimzi. |
with/without new key Changed to not using Secret deletion but edit in place Signed-off-by: Paolo Patierno <[email protected]>
@scholzj @PaulRMellor I made a big change on this PR with two different procedures (if key is replaced or not). |
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-installing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
Added pause/resume reconcile in the replace CA key procedure Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice touch with the pausing or the reconciliation.
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've reviewed and pushed up some edits
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-renewing-your-own-ca-certificates.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/security/proc-replacing-your-own-private-keys.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: prmellor <[email protected]>
Type of change
Description
This is the documentation related update for PR #6180 which fixes issues #5466.
The PR adds more information about certification generations to be added to the Secret for handling your own CA certificates and corresponding renewal.
Checklist