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

Improve VTOrc config handling to support dynamic variables #17218

Merged
merged 23 commits into from
Dec 3, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Nov 12, 2024

Description

This PR changes how config files are handled in VTOrc, moving them to use viper instead of the custom solution previously employed. This change allows the following parameters to be dynamically loaded -

  1. instance-poll-time
  2. prevent-cross-cell-failover
  3. snapshot-topology-interval
  4. reasonable-replication-lag
  5. audit-to-backend
  6. audit-to-syslog
  7. audit-purge-duration
  8. wait-replicas-timeout
  9. tolerable-replication-lag
  10. topo-information-refresh-duration
  11. recovery-poll-duration
  12. allow-emergency-reparent
  13. change-tablets-with-errant-gtid-to-drained

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Nov 12, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Nov 12, 2024
@GuptaManan100 GuptaManan100 added Type: Feature Component: VTorc Vitess Orchestrator integration and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Nov 12, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 12, 2024
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

Attention: Patch coverage is 41.48148% with 79 lines in your changes missing coverage. Please review.

Project coverage is 67.39%. Comparing base (0726ea6) to head (85fbc91).
Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/config/config.go 36.58% 52 Missing ⚠️
go/vt/vtorc/server/api.go 9.09% 10 Missing ⚠️
go/vt/vtorc/logic/vtorc.go 0.00% 6 Missing ⚠️
go/viperutil/debug/debug.go 0.00% 4 Missing ⚠️
go/cmd/vtorc/cli/cli.go 0.00% 2 Missing ⚠️
go/vt/servenv/servenv.go 81.81% 2 Missing ⚠️
go/vt/vtorc/discovery/queue.go 0.00% 1 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 87.50% 1 Missing ⚠️
go/vt/vtorc/logic/tablet_discovery.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17218      +/-   ##
==========================================
- Coverage   67.40%   67.39%   -0.02%     
==========================================
  Files        1574     1574              
  Lines      253221   253251      +30     
==========================================
- Hits       170690   170670      -20     
- Misses      82531    82581      +50     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

viperutil.Options[time.Duration]{
FlagName: "instance-poll-time",
Default: 5 * time.Second,
Dynamic: true,
Copy link
Member Author

@GuptaManan100 GuptaManan100 Nov 14, 2024

Choose a reason for hiding this comment

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

This makes the field dynamic

}

// acceptSighupSignal registers for SIGHUP signal from the OS to reload the configuration files.
func acceptSighupSignal() {
Copy link
Contributor

Choose a reason for hiding this comment

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

@GuptaManan100 double-checking: the 3rd party library handles SIGHUP reload?

Copy link
Member Author

Choose a reason for hiding this comment

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

SIGHUP is not even required anymore. Viper has a watcher on the file, and if it changes, it automatically reloads the configurations.

Copy link
Contributor

@timvaillancourt timvaillancourt left a comment

Choose a reason for hiding this comment

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

@GuptaManan100 looks good to me, added one question re: SIGHUP reload that I assume still functions

Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

We should add tests to replace the ones that were deleted. Ideally an e2e test that changes the file contents and verifies that the in-memory value does change.

examples/common/scripts/vtorc-up.sh Outdated Show resolved Hide resolved
changelog/22.0/22.0.0/summary.md Outdated Show resolved Hide resolved
changelog/22.0/22.0.0/summary.md Outdated Show resolved Hide resolved
go/test/endtoend/vtorc/api/api_test.go Outdated Show resolved Hide resolved
go/vt/vtorc/config/config.go Show resolved Hide resolved
@GuptaManan100
Copy link
Member Author

I added a e2e test to check that the configs are indeed reloading dynamically. I, however, only added it for one of the configs. Would you prefer if I added one for each of the reloadable configurations?

go/vt/vtorc/config/config.go Outdated Show resolved Hide resolved
Signed-off-by: Manan Gupta <[email protected]>
@deepthi
Copy link
Member

deepthi commented Nov 22, 2024

I added a e2e test to check that the configs are indeed reloading dynamically. I, however, only added it for one of the configs. Would you prefer if I added one for each of the reloadable configurations?

we can add all of the configs into the same test.

Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

A couple of small suggestions. Otherwise LGTM

changelog/22.0/22.0.0/summary.md Outdated Show resolved Hide resolved
examples/common/vtorc/config.yaml Show resolved Hide resolved
@GuptaManan100 GuptaManan100 merged commit 1058621 into vitessio:main Dec 3, 2024
100 checks passed
@GuptaManan100 GuptaManan100 deleted the vtorc-config-reloadable branch December 3, 2024 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTorc Vitess Orchestrator integration Type: Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Handle config in VTOrc using Viper
4 participants