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.

Sign up for GitHub

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

Jump to bottom

Add docs on rotating encryption keys and managing secrets #840

Open
wants to merge 6 commits into
base: next
Choose a base branch
from
Open

Add docs on rotating encryption keys and managing secrets #840

wants to merge 6 commits into from
+497 −273

Conversation

eamansour
Copy link
Member

@eamansour eamansour commented Nov 1, 2024 •
edited
Loading

Why?

See galasa-dev/projectmanagement#1467

Changes

  • Added initial docs for Galasa Ecosystem admins on how to rotate encryption keys using the rotate-encryption-keys script
  • Updated docs about setting credentials to use the new galasactl secrets commands rather than manually logging into the etcd pod and setting credentials that way
  • Updated docs for managing Galasa resources using galasactl resources commands to include the new GalasaSecret resource type

@eamansour
docs: Add docs on rotating encryption keys and managing secrets
35c2bce 
Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
@eamansour
docs: Add manual steps to rotate encryption keys and move encryption …
40f91db 
…docs to separate topic

Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
@eamansour eamansour mentioned this pull request Nov 4, 2024
Merged
@eamansour
docs: Remove duplicate prerequisites
12c582a 
Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
jt-nti
jt-nti previously approved these changes Nov 5, 2024
View reviewed changes
Copy link
Member

@jt-nti jt-nti left a comment

Choose a reason for hiding this comment

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

Looks good, thanks. Just a couple of thoughts...

  • I'm not entirely sure about using "CREDS" instead of just "credentials store" each time
  • Linking to an unversioned/unreleased shell script doesn't seem ideal but that's bigger than a doc review :)

@eamansour
docs: Replace rotate-encryption-keys link to main branch with to-be-r…
34a6845 
…eleased link

Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
@eamansour
review: Replace mentions of 'CREDS' with 'credentials store'
c88826f 
Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
jt-nti
jt-nti previously approved these changes Nov 14, 2024
View reviewed changes
@eamansour
fix: Replace links to specific released helm chart versions with link…
ce6f6c7 
…s to helm the releases page

Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jt-nti jt-nti jt-nti left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eamansour @jt-nti