github.com/koderover/helm@v2.17.0+incompatible/docs/helm/helm_dependency.md (about)

     1  ## helm dependency
     2  
     3  Manage a chart's dependencies
     4  
     5  ### Synopsis
     6  
     7  
     8  Manage the dependencies of a chart.
     9  
    10  Helm charts store their dependencies in 'charts/'. For chart developers, it is
    11  often easier to manage a single dependency file ('requirements.yaml')
    12  which declares all dependencies.
    13  
    14  The dependency commands operate on that file, making it easy to synchronize
    15  between the desired dependencies and the actual dependencies stored in the
    16  'charts/' directory.
    17  
    18  A 'requirements.yaml' file is a YAML file in which developers can declare chart
    19  dependencies, along with the location of the chart and the desired version.
    20  For example, this requirements file declares two dependencies:
    21  
    22      # requirements.yaml
    23      dependencies:
    24      - name: nginx
    25        version: "1.2.3"
    26        repository: "https://example.com/charts"
    27      - name: memcached
    28        version: "3.2.1"
    29        repository: "https://another.example.com/charts"
    30  
    31  The 'name' should be the name of a chart, where that name must match the name
    32  in that chart's 'Chart.yaml' file.
    33  
    34  The 'version' field should contain a semantic version or version range.
    35  
    36  The 'repository' URL should point to a Chart Repository. Helm expects that by
    37  appending '/index.yaml' to the URL, it should be able to retrieve the chart
    38  repository's index. Note: 'repository' can be an alias. The alias must start
    39  with 'alias:' or '@'.
    40  
    41  Starting from 2.2.0, repository can be defined as the path to the directory of
    42  the dependency charts stored locally. The path should start with a prefix of
    43  "file://". For example,
    44  
    45      # requirements.yaml
    46      dependencies:
    47      - name: nginx
    48        version: "1.2.3"
    49        repository: "file://../dependency_chart/nginx"
    50  
    51  If the dependency chart is retrieved locally, it is not required to have the
    52  repository added to helm by "helm repo add". Version matching is also supported
    53  for this case.
    54  
    55  
    56  ### Options
    57  
    58  ```
    59    -h, --help   help for dependency
    60  ```
    61  
    62  ### Options inherited from parent commands
    63  
    64  ```
    65        --debug                           Enable verbose output
    66        --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
    67        --host string                     Address of Tiller. Overrides $HELM_HOST
    68        --kube-context string             Name of the kubeconfig context to use
    69        --kubeconfig string               Absolute path of the kubeconfig file to be used
    70        --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
    71        --tiller-namespace string         Namespace of Tiller (default "kube-system")
    72  ```
    73  
    74  ### SEE ALSO
    75  
    76  * [helm](helm.md)	 - The Helm package manager for Kubernetes.
    77  * [helm dependency build](helm_dependency_build.md)	 - Rebuild the charts/ directory based on the requirements.lock file
    78  * [helm dependency list](helm_dependency_list.md)	 - List the dependencies for the given chart
    79  * [helm dependency update](helm_dependency_update.md)	 - Update charts/ based on the contents of requirements.yaml
    80  
    81  ###### Auto generated by spf13/cobra on 16-May-2019