-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update docs to follow the latest version of the HIP
See helm/community#321 Signed-off-by: Dominykas Blyžė <[email protected]>
- Loading branch information
Showing
1 changed file
with
11 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -73,34 +73,32 @@ repository added to helm by "helm add repo". 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. | ||
"git+" followed by a valid git repository URL. | ||
# Chart.yaml | ||
dependencies: | ||
- name: helm-chart | ||
version: "main" | ||
repository: "git://https://github.com/helm/helm-chart.git" | ||
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://[email protected]:helm/helm-chart.git' or | ||
'git://https://github.com/helm/helm-chart.git' | ||
For example 'git+ssh://[email protected]:helm/helm-chart.git' or | ||
'git+https://github.com/helm/helm-chart.git' | ||
When using a 'git://' repository, the 'version' must be a valid semantic tag or branch | ||
name for the git repo. For example 'master'. | ||
When using a 'git://' repository, the 'version' must be a valid semantic tag | ||
or branch name for the git repo, for example 'main'. | ||
Limitations when working with git repositories: | ||
* Helm will use the 'git' executable on your system to retrieve 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. | ||
username/password 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. Authentication can be | ||
configured by using a git credentials helper which can read the credentials | ||
from environment variables, from operating system keychain, etc. | ||
` | ||
|
||
const dependencyListDesc = ` | ||
|