Skip to content

Adds PostgreSQL Database Table Schema to Configuration#677

Open
chriscannon wants to merge 2 commits into
tektoncd:mainfrom
chriscannon:feat/configure_db_schema
Open

Adds PostgreSQL Database Table Schema to Configuration#677
chriscannon wants to merge 2 commits into
tektoncd:mainfrom
chriscannon:feat/configure_db_schema

Conversation

@chriscannon
Copy link
Copy Markdown

@chriscannon chriscannon commented Dec 4, 2023 •
edited by adambkaplan
Loading

Changes

This allows a schema to be set on the table instead of assuming public.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you review them:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Tested your changes locally (if this is a code change)
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user-facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contain the string "action required" if the change requires additional action from users switching to the new release

Release Notes

PostgreSQL table schema can be set using the DB_SCHEMA environment and configuration variable.

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Dec 4, 2023
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Dec 4, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 4, 2023
@tekton-robot
Copy link
Copy Markdown

tekton-robot commented Dec 4, 2023

Hi @chriscannon. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@chriscannon
Copy link
Copy Markdown
Author

chriscannon commented Dec 4, 2023

/kind feature

@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. and removed release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Dec 4, 2023
@sayan-biswas
Copy link
Copy Markdown
Contributor

sayan-biswas commented Dec 6, 2023

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 6, 2023
@tekton-robot
Copy link
Copy Markdown

tekton-robot commented Jan 3, 2024

The following is the coverage report on the affected files.
Say /test pull-tekton-results-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/api/main.go 11.9% 11.7% -0.2

adambkaplan
adambkaplan approved these changes Jan 5, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@adambkaplan adambkaplan left a comment

Choose a reason for hiding this comment

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

/approve

Looks good to me!

@tekton-robot
Copy link
Copy Markdown

tekton-robot commented Jan 5, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adambkaplan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 5, 2024
@chriscannon
Copy link
Copy Markdown
Author

chriscannon commented Jan 11, 2024

@adambkaplan could you also add a lgtm label so that it can pass the CI validation? Thanks!

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jan 11, 2024
adambkaplan
adambkaplan reviewed Jan 11, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@adambkaplan adambkaplan left a comment

Choose a reason for hiding this comment

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

I gave this a bit closer scrutiny before providing lgtm.

@chriscannon are you able to squash your commits and provide a descriptive commit message once the items below are addressed?

@tektoncd/operator-maintainers fyi I think this feature would impact any operator-managed deployment of Tekton Results

Comment thread cmd/api/main.go Outdated

dbURI := fmt.Sprintf("host=%s user=%s password=%s dbname=%s port=%s sslmode=%s sslrootcert=%s", serverConfig.DB_HOST, serverConfig.DB_USER, serverConfig.DB_PASSWORD, serverConfig.DB_NAME, serverConfig.DB_PORT, serverConfig.DB_SSLMODE, serverConfig.DB_SSLROOTCERT)
gormConfig := &gorm.Config{}
gormConfig := &gorm.Config{NamingStrategy: schema.NamingStrategy{
Copy link
Copy Markdown
Contributor

@adambkaplan adambkaplan Jan 11, 2024

Choose a reason for hiding this comment

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

It is not readily clear from the code that this is how you set the Postgresql "schema" using gorm. Can you please add a comment with a link to the relevant docs in gorm?

Comment thread config/base/env/config
DB_HOST=
DB_PORT=5432
DB_NAME=
DB_SCHEMA=public
Copy link
Copy Markdown
Contributor

@adambkaplan adambkaplan Jan 11, 2024

Choose a reason for hiding this comment

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

This becomes the default "table prefix" value in our distribution. Will this break the database initialization/auto-migration phase of the deployment on upgrade? Is there risk of data being "orphaned" because the apiserver will create a whole new schema in Postgres?

@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024
@tekton-robot
Copy link
Copy Markdown

tekton-robot commented Jan 29, 2024

@chriscannon: PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alan-ghelardi alan-ghelardi Awaiting requested review from alan-ghelardi

@dibyom dibyom Awaiting requested review from dibyom

1 more reviewer

@adambkaplan adambkaplan adambkaplan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@chriscannon @tekton-robot @sayan-biswas @adambkaplan