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

LFX: Enhance flag support across Vitess components (Tracking Issue) #17687

Open
12 tasks
rohit-nayak-ps opened this issue Feb 3, 2025 · 0 comments
Open
12 tasks
Labels
Component: CLI Component: Documentation docs related issues/PRs Component: Examples Component: General Changes throughout the code base LFX Type: Enhancement Logical improvement (somewhere between a bug and feature)

Comments

@rohit-nayak-ps
Copy link
Contributor

rohit-nayak-ps commented Feb 3, 2025

Notes for Potential LFX Mentees:

This project is part of the LFX program. More information at https://github.com/cncf/mentoring/tree/main/lfx-mentorship. For mentees, details on how to apply are at https://github.com/cncf/mentoring/tree/main/lfx-mentorship#how-to-apply.
For those thinking of applying, the contribution guide has information on learning both golang and Vitess concepts for someone new to Vitess.

⚠️ If you're thinking about opening PRs to the project before the application period begins, please read the initial sections regarding contribution guidelines and advice from a previous gsoc project!

Also, please do not DM the mentors or other Vitess maintainers on this issue, Slack or elsewhere in this regard: your LFX application should speak for itself. 🙏🏽

Feature Description

As part of a major Vitess Flag Restructure Vitess v17 introduced viper, a library to provide unified configuration management, to the project.

This also supports dynamic flag configuration . While some parts of Vitess has been modified to take advantage of this feature, there are several components that are either yet to adopt it or have only partially adopted it.

In addition we have been deprecating flags with underscores in preference to ones with dashes. We will be completely removing the deprecated flags in v24 and hence need to make the required changes asap.

This is an umbrella issue for adding dynamic flag support and the flag renaming.

Previous PRs related to this:

Action items

This is an initial set which will be updated before the project starts.

Dynamic Flags

Flag Renaming

  • Review codebase and make required changes. It is highly recommended to use scripting to make all the edits at once versus doing them by hand.
  • Review and update Documentation on vitess.io
  • Review and update Examples
@rohit-nayak-ps rohit-nayak-ps added Needs Triage This issue needs to be correctly labelled and triaged Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base Component: Examples Component: Documentation docs related issues/PRs Component: CLI LFX and removed Needs Triage This issue needs to be correctly labelled and triaged labels Feb 3, 2025
@rohit-nayak-ps rohit-nayak-ps changed the title [Draft] Enhance flag support across Vitess components (Tracking Issue) Enhance flag support across Vitess components (Tracking Issue) Feb 3, 2025
@rohit-nayak-ps rohit-nayak-ps changed the title Enhance flag support across Vitess components (Tracking Issue) LFX: Enhance flag support across Vitess components (Tracking Issue) Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: CLI Component: Documentation docs related issues/PRs Component: Examples Component: General Changes throughout the code base LFX Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

No branches or pull requests

1 participant