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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMPROVEMENT] List of Longhorn Helm Chart Flags #5455

Closed
zackbradys opened this issue Feb 28, 2023 · 6 comments
Closed

[IMPROVEMENT] List of Longhorn Helm Chart Flags #5455

zackbradys opened this issue Feb 28, 2023 · 6 comments
Assignees
Labels
area/chart Helm chart related kind/doc Doc request priority/0 Must be fixed in this release (managed by PO) require/doc Require updating the longhorn.io documentation
Milestone

Comments

@zackbradys
Copy link

zackbradys commented Feb 28, 2023

Is your improvement request related to a feature? Please describe (馃憤 if you like this request)

Difficult to easily view a list of all possible helm chart flags. Of course, you are able to manually determine these using the helm chart values, but like other rancher products, there usually is a list of the flags within the docs or chart readme.

Describe the solution you'd like

Add the list of helm chart flags to the longhorn docs and helm chart readme.

Describe alternatives you've considered

Current alternative to this feature improvement request is to manually go through the helm chart values file to determine to helm install flags.

Additional context

I'd be will to submit a draft of these changes/additions. No other additional context to provide to this request!

@zackbradys zackbradys added the kind/improvement Request for improvement of existing function label Feb 28, 2023
@zackbradys zackbradys changed the title [IMPROVEMENT] [IMPROVEMENT] List of Longhorn Helm Chart Flags Feb 28, 2023
@shuo-wu
Copy link
Contributor

shuo-wu commented Mar 2, 2023

Do you mean values for the Helm? Currently, you can check this value YAML file first. And thank you for your willing to contribute!

cc @innobead

@zackbradys
Copy link
Author

zackbradys commented Mar 2, 2023

Yes, the helm values. Most helm chart repos have the values represented in a table within the readme. You are correct, you're able to view the values.yaml, but having the values in documentation.

It would be nice to have it implemented for longhorn to match the rest of the rancher products (MCM, NV, etc..)

@innobead innobead added this to the v1.5.0 milestone Mar 2, 2023
@innobead innobead added kind/doc Doc request require/doc Require updating the longhorn.io documentation and removed kind/improvement Request for improvement of existing function labels Mar 2, 2023
@innobead innobead added the area/chart Helm chart related label Mar 2, 2023
@innobead innobead assigned ChanYiLin and unassigned ChanYiLin Apr 13, 2023
@innobead innobead modified the milestones: v1.5.0, v1.6.0 Apr 13, 2023
@zackbradys
Copy link
Author

Hey @innobead / @ChanYiLin, are we still on track to complete this in the Longhorn v1.6.0 release?

@ChanYiLin
Copy link
Contributor

Hi @zackbradys
Yes, this feature request will be in Longhorn v1.6.0 which will be released in December.

@zackbradys
Copy link
Author

thanks for the update!

@longhorn-io-github-bot
Copy link

longhorn-io-github-bot commented Sep 6, 2023

Pre Ready-For-Testing Checklist

* [ ] Where is the reproduce steps/test steps documented?
The reproduce steps/test steps are at:

@innobead innobead added the priority/0 Must be fixed in this release (managed by PO) label Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/chart Helm chart related kind/doc Doc request priority/0 Must be fixed in this release (managed by PO) require/doc Require updating the longhorn.io documentation
Projects
Status: Resolved/Scheduled
Development

No branches or pull requests

5 participants