github.com/sgoings/helm@v2.0.0-alpha.2.0.20170406211108-734e92851ac3+incompatible/docs/helm/helm_dependency.md (about)

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