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

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

Conversation

GuptaManan100
Copy link
Member

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. InstancePollTime
  2. PreventCrossCellFailover
  3. SnapshotTopologyInterval
  4. ReasonableReplicationLag
  5. AuditToBackend
  6. AuditToSyslog
  7. AuditPurgeDuration
  8. WaitReplicasTimeout
  9. TolerableReplicationLag
  10. TopoInformationRefreshDuration
  11. RecoveryPollDuration

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

Signed-off-by: Manan Gupta <manan@planetscale.com>
…nce poll seconds

Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
…o viper

Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
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.96429% with 65 lines in your changes missing coverage. Please review.

Project coverage is 67.41%. Comparing base (0403d54) to head (897ab10).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/config/config.go 42.25% 41 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% 1 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.34%   67.41%   +0.07%     
==========================================
  Files        1570     1570              
  Lines      252734   252867     +133     
==========================================
+ Hits       170204   170471     +267     
+ Misses      82530    82396     -134     

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

Signed-off-by: Manan Gupta <manan@planetscale.com>
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
1 participant