docs: explain how to fetch values files when installing from OCI#2
Merged
Merged
Conversation
The previous OCI install instructions jumped from "helm install oci://..." to "-f values-azure.yaml" without explaining how to retrieve the values files. Clients pulling the chart through OCI do not have the values-<cloud>.yaml on disk by default. Rework the "From the public OCI registry" section into 3 explicit steps: 1. helm pull oci://... --untar -> fetches Chart.yaml, values.yaml, all values-<cloud>.yaml and the values-client-template.yaml 2. cp values-client-template.yaml values-mycompany.yaml + edit TODOs 3. helm install ./visual-tom -f visual-tom/values-<cloud>.yaml ... Add a short "Upgrades" note describing the upgrade workflow with a later --version.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The current OCI install section jumps from
helm install oci://...to-f values-azure.yamlwithout explaining how to retrieve the values files. Clients pulling through OCI do not have thevalues-<cloud>.yamlon disk by default, so the instructions are not self-sufficient.This PR rewrites the "From the public OCI registry" section in both
README.md(EN) andREADME-fr.md(FR) into 3 explicit steps:helm pull oci://... --untar(fetchesChart.yaml,values.yaml, allvalues-<cloud>.yaml, thevalues-client-template.yamland thetemplates/)cp values-client-template.yaml values-mycompany.yaml+ fill in the# TODOhelm install visual-tom ./visual-tom -f visual-tom/values-<cloud>.yaml -f values-mycompany.yaml ...Also adds a short "Upgrades" note describing the upgrade workflow (
helm pull --version X.Y.Z+helm upgrade).Test plan