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

DCJ-495: New Cert documentation and configuration render script #2621

Merged
merged 8 commits into from
Jul 11, 2024
Merged

DCJ-495: New Cert documentation and configuration render script #2621

merged 8 commits into from
Jul 11, 2024

Conversation

rushtong
Copy link
Contributor

Addresses

https://broadworkbench.atlassian.net/browse/DCJ-495

Summary

Updates documentation for how to generate certificates for local development
Also adds a script to do the rendering for local dev needs.

Have you read Terra's Contributing Guide lately? If not, do that first.

  • Label PR with a Jira ticket number and include a link to the ticket
  • Label PR with a security risk modifier [no, low, medium, high]
  • PR describes scope of changes
  • Get a minimum of one thumbs worth of review, preferably two if enough team members are available
  • Get PO sign-off for all non-trivial UI or workflow changes
  • Verify all tests go green
  • Test this change deployed correctly and works on dev environment after deployment

@rushtong rushtong requested a review from a team as a code owner July 10, 2024 15:56
@rushtong rushtong requested review from fboulnois, okotsopoulos and aarohinadkarni and removed request for a team July 10, 2024 15:56
fboulnois
fboulnois approved these changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@fboulnois fboulnois 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! 👍 Huge fan of simplifying local deployments.

scripts/render-configs.sh Outdated
#!/bin/bash
# Populates local cert files necessary for local development
# You MUST be on the Broad VPN
# You MUST have gcloud and kubectl installed to run this script.
Copy link
Contributor

Choose a reason for hiding this comment

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

And jq

scripts/render-configs.sh Show resolved Hide resolved
okotsopoulos
okotsopoulos approved these changes Jul 10, 2024
View reviewed changes
Copy link
Contributor

@okotsopoulos okotsopoulos left a comment

Choose a reason for hiding this comment

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

Nice!

I'm remembering that you said these certificates will need to be regenerated more frequently moving forward (quarterly). Should that be documented somewhere?

@rushtong
Copy link
Contributor Author

I'm remembering that you said these certificates will need to be regenerated more frequently moving forward (quarterly). Should that be documented somewhere?

Great point, yes, it's now on a 3-month rotation, I'll add that.

@rushtong rushtong merged commit 382870e into develop Jul 11, 2024
9 checks passed
@rushtong rushtong deleted the gr-DCJ-495-cert-documentation branch July 11, 2024 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@okotsopoulos okotsopoulos okotsopoulos approved these changes

@fboulnois fboulnois fboulnois approved these changes

@aarohinadkarni aarohinadkarni Awaiting requested review from aarohinadkarni

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

Successfully merging this pull request may close these issues.
3 participants
@rushtong @fboulnois @okotsopoulos