github.com/darkowlzz/helm@v2.5.1-0.20171213183701-6707fe0468d4+incompatible/docs/man/man1/helm_dependency.1 (about)

     1  .TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" "" 
     2  .nh
     3  .ad l
     4  
     5  
     6  .SH NAME
     7  .PP
     8  helm\-dependency \- manage a chart's dependencies
     9  
    10  
    11  .SH SYNOPSIS
    12  .PP
    13  \fBhelm dependency update|build|list\fP
    14  
    15  
    16  .SH DESCRIPTION
    17  .PP
    18  Manage the dependencies of a chart.
    19  
    20  .PP
    21  Helm charts store their dependencies in 'charts/'. For chart developers, it is
    22  often easier to manage a single dependency file ('requirements.yaml')
    23  which declares all dependencies.
    24  
    25  .PP
    26  The dependency commands operate on that file, making it easy to synchronize
    27  between the desired dependencies and the actual dependencies stored in the
    28  'charts/' directory.
    29  
    30  .PP
    31  A 'requirements.yaml' file is a YAML file in which developers can declare chart
    32  dependencies, along with the location of the chart and the desired version.
    33  For example, this requirements file declares two dependencies:
    34  
    35  .PP
    36  .RS
    37  
    38  .nf
    39  # requirements.yaml
    40  dependencies:
    41  \- name: nginx
    42    version: "1.2.3"
    43    repository: "https://example.com/charts"
    44  \- name: memcached
    45    version: "3.2.1"
    46    repository: "https://another.example.com/charts"
    47  
    48  .fi
    49  .RE
    50  
    51  .PP
    52  The 'name' should be the name of a chart, where that name must match the name
    53  in that chart's 'Chart.yaml' file.
    54  
    55  .PP
    56  The 'version' field should contain a semantic version or version range.
    57  
    58  .PP
    59  The 'repository' URL should point to a Chart Repository. Helm expects that by
    60  appending '/index.yaml' to the URL, it should be able to retrieve the chart
    61  repository's index. Note: 'repository' cannot be a repository alias. It must be
    62  a URL.
    63  
    64  .PP
    65  Starting from 2.2.0, repository can be defined as the path to the directory of
    66  the dependency charts stored locally. The path should start with a prefix of
    67  "file://". For example,
    68  
    69  .PP
    70  .RS
    71  
    72  .nf
    73  # requirements.yaml
    74  dependencies:
    75  \- name: nginx
    76    version: "1.2.3"
    77    repository: "file://../dependency\_chart/nginx"
    78  
    79  .fi
    80  .RE
    81  
    82  .PP
    83  If the dependency chart is retrieved locally, it is not required to have the
    84  repository added to helm by "helm add repo". Version matching is also supported
    85  for this case.
    86  
    87  
    88  .SH OPTIONS INHERITED FROM PARENT COMMANDS
    89  .PP
    90  \fB\-\-debug\fP[=false]
    91      enable verbose output
    92  
    93  .PP
    94  \fB\-\-home\fP="~/.helm"
    95      location of your Helm config. Overrides $HELM\_HOME
    96  
    97  .PP
    98  \fB\-\-host\fP="localhost:44134"
    99      address of tiller. Overrides $HELM\_HOST
   100  
   101  .PP
   102  \fB\-\-kube\-context\fP=""
   103      name of the kubeconfig context to use
   104  
   105  .PP
   106  \fB\-\-tiller\-namespace\fP="kube\-system"
   107      namespace of tiller
   108  
   109  
   110  .SH SEE ALSO
   111  .PP
   112  \fBhelm(1)\fP, \fBhelm\-dependency\-build(1)\fP, \fBhelm\-dependency\-list(1)\fP, \fBhelm\-dependency\-update(1)\fP
   113  
   114  
   115  .SH HISTORY
   116  .PP
   117  19\-May\-2017 Auto generated by spf13/cobra