-
Notifications
You must be signed in to change notification settings - Fork 459
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
DOCS-1021: Attempting to add autoyaml docs for Helm charts #1827
Conversation
Let's have test passing to approve it:
|
OK @pjuarezd if this looks good we can merge it here, and I can finish the import work on the actual docs PR. Assuming all changes work. |
Looks good to me, we need another approver to merge tho |
#1852 should resolve the testing errors. |
that PR is merged already, could you rebase please @ravindk89? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple typos and a reword for your consideration. 🚀
Co-authored-by: Andrea Longo <[email protected]>
# export MINIO_ROOT_PASSWORD=ROOTUSERPASSWORD | ||
# | ||
existingSecret: | ||
name: myminio-env-configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please revise this change. I couldn't find any usage of .Values.existingSecret
in tenant Helm templates. There's usage of .Values.secrets.existingSecret
instead.
Part of supporting minio/docs#1021
Summary
We've had an increase of requests for guidance in deploying via Helm.
This attempts to formalize the documentation structure for the Values.yaml in a format that can be automatically parsed by Sphinx into some form of web documentation.
It also attempts to synchronize some of the functionality between the Chart and the CRD.
Before merging either of these, we need to validate that the chart deployment itself is unaffected by the comments.
I've left comments for those areas which were unclear in their functionality.