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

Added SQL cloud proxy support guide for postgres dependent services #235

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Added SQL cloud proxy support guide for postgres dependent services #235

wants to merge 8 commits into from

Conversation

priyadarshini-ni
Copy link

@priyadarshini-ni priyadarshini-ni commented Dec 10, 2024 •
edited
Loading

What does this Pull Request accomplish?

The support guide for adding cloud SQL auth proxy container as sidecar has been added to the services which uses postgres namely testmonitor service, dashboardhosts service and dynamic form fields.

Why should this Pull Request be merged?

  1. Updated the systemlink-values.yaml to include the sidecar container support. It doesn't restrict the use to just Cloud SQL auth proxy but allows any container addition as a sidecar along with any volumes needed. This approach is inspired by Grafana where we can use a similar approach to add sidecar containers.
  2. Dashboardhosts uses the parameters 'extraContainers' and 'extraContainerVolumes' instead of 'sidecars' and 'extraVolumes' as only that is supported by the 3rd party Grafana chart.
  3. The support to add annotations to the serviceAccount has also been added. This is required to link the service account with the Google service account which will have the permissions required for Cloud SQL Workload Identity.

What testing has been done?

NA

@SSSantosh18 SSSantosh18 self-requested a review December 10, 2024 14:27
SSSantosh18
SSSantosh18 requested changes Dec 11, 2024
View reviewed changes
Copy link
Contributor

@SSSantosh18 SSSantosh18 left a comment

Choose a reason for hiding this comment

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

Update the similar changes for other services too

getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
getting-started/templates/systemlink-values.yaml Outdated
serviceAccount:
## @param serviceAccount.create Specifies whether a service account should be created
##
create: false
Copy link
Contributor

Choose a reason for hiding this comment

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

I think just exposing the annotations section in the top-level helm values should be enough. Do we have any other reason to expose other parameters?

Copy link
Author

Choose a reason for hiding this comment

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

Removed 'serviceAccount.create' as it is true by default. The sericeAccount.name parameter would be useful while referencing the service account for authentication using workflow identity

getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
SSSantosh18
SSSantosh18 reviewed Dec 11, 2024
View reviewed changes
Copy link
Contributor

@SSSantosh18 SSSantosh18 left a comment

Choose a reason for hiding this comment

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

same comments will apply for other services too

getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
getting-started/templates/systemlink-values.yaml Show resolved Hide resolved
SSSantosh18
SSSantosh18 approved these changes Dec 11, 2024
View reviewed changes
Copy link
Contributor

@SSSantosh18 SSSantosh18 left a comment

Choose a reason for hiding this comment

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

remove the unnecessary white space changes if possible

getting-started/templates/systemlink-values.yaml Outdated Show resolved Hide resolved
Priyadarshini Piramanayagam added 2 commits December 11, 2024 22:33
@priyadarshini-ni priyadarshini-ni marked this pull request as ready for review December 11, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SSSantosh18 SSSantosh18 SSSantosh18 approved these changes

@JD-Robertson JD-Robertson Awaiting requested review from JD-Robertson JD-Robertson is a code owner

@prestwick prestwick Awaiting requested review from prestwick prestwick is a code owner

@BKnight760 BKnight760 Awaiting requested review from BKnight760 BKnight760 is a code owner

@lnowotny lnowotny Awaiting requested review from lnowotny lnowotny is a code owner

@Christian-Nunnally Christian-Nunnally Awaiting requested review from Christian-Nunnally Christian-Nunnally is a code owner

@MelissaHilliard MelissaHilliard Awaiting requested review from MelissaHilliard MelissaHilliard is a code owner

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
@priyadarshini-ni @SSSantosh18