diff --git a/docs/helm/helm_dependency.md b/docs/helm/helm_dependency.md index 3a508764c..f3e50c402 100644 --- a/docs/helm/helm_dependency.md +++ b/docs/helm/helm_dependency.md @@ -52,6 +52,36 @@ If the dependency chart is retrieved locally, it is not required to have the repository added to helm by "helm repo add". Version matching is also supported for this case. +A repository can be defined as a git URL. The path must start with a prefix of +"git:" followed by a valid git repository URL. + +# requirements.yaml +dependencies: +- name: nginx + version: "master" + repository: "git:https://github.com/helm/helm-chart.git" + +The 'repository' can be the https or ssh URL that you would use to clone a git +repo or add as a git remote, prefixed with 'git:'. +For example 'git:git@github.com:helm/helm-chart.git' or +'git:https://github.com/helm/helm-chart.git' + +When using a 'git:' repository, the 'version' must be a valid tag or branch +name for the git repo. For example 'master'. + +Limitations when working with git repositories: +* Helm will use the 'git' executable on your system to retreive information +about the repo. The 'git' command must be properly configured and available +on the PATH. +* When specifying a private repo, if git tries to query the user for +username/passowrd for an HTTPS url, or for a certificate password for an SSH +url, it may cause Helm to hang. Input is not forwarded to the child git +process, so it will not be able to receive user input. For private repos +it is recommended to use an SSH git url, and have your git client configured +with an SSH cert that does not require a password. +* The helm chart and 'Chart.yaml' must be in the root of the git repo. +The chart cannot be loaded from a subdirectory. + ### Options @@ -78,4 +108,4 @@ for this case. * [helm dependency list](helm_dependency_list.md) - List the dependencies for the given chart * [helm dependency update](helm_dependency_update.md) - Update charts/ based on the contents of requirements.yaml -###### Auto generated by spf13/cobra on 16-May-2019 +###### Auto generated by spf13/cobra on 21-Oct-2019