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

Fix documentation about install and renew your own CA certificates #6240

Merged
merged 15 commits into from
Jan 27, 2022

Conversation

ppatierno
Copy link
Member

Type of change

  • Documentation

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

  • Update documentation

@ppatierno ppatierno added this to the 0.28.0 milestone Jan 21, 2022
Signed-off-by: Paolo Patierno <[email protected]>
@ppatierno
Copy link
Member Author

This PR can be merged only after #6180

Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
Copy link
Contributor

@PaulRMellor PaulRMellor left a 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

Signed-off-by: Paolo Patierno <[email protected]>
Signed-off-by: Paolo Patierno <[email protected]>
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Nice 👍

Copy link
Member

@scholzj scholzj left a 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.

Signed-off-by: Paolo Patierno <[email protected]>
@ppatierno
Copy link
Member Author

@scholzj I pushed changes related to your comments, can you have another pass please?

@ppatierno
Copy link
Member Author

TBH, I'm not sure I understand what exactly should be done for the renewal. It should probably have more steps and more examples.

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?

Copy link
Member

@scholzj scholzj left a 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.

@ppatierno
Copy link
Member Author

Ok then. I will re-write this PR by having two procedures:

  • Renewing your own CA certificates
  • Replacing private keys used by your own CA certificates

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]>
@ppatierno
Copy link
Member Author

@scholzj @PaulRMellor I made a big change on this PR with two different procedures (if key is replaced or not).

Added pause/resume reconcile in the replace CA key procedure

Signed-off-by: Paolo Patierno <[email protected]>
Copy link
Member

@scholzj scholzj left a 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.

Signed-off-by: Paolo Patierno <[email protected]>
@ppatierno ppatierno requested a review from PaulRMellor January 26, 2022 15:49
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
Copy link
Contributor

@PaulRMellor PaulRMellor left a 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

Signed-off-by: prmellor <[email protected]>
@ppatierno ppatierno merged commit 3c7c44c into strimzi:main Jan 27, 2022
@ppatierno ppatierno deleted the fix-doc-user-ca-renewal branch January 27, 2022 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants