github.com/migueleliasweb/helm@v2.6.1+incompatible/docs/chart_best_practices/requirements.md (about)

     1  # Requirements Files
     2  
     3  This section of the guide covers best practices for `requirements.yaml` files.
     4  
     5  ## Versions
     6  
     7  Where possible, use version ranges instead of pinning to an exact version. The suggested default is to use a patch-level version match:
     8  
     9  ```yaml
    10  version: ^1.2.0
    11  ```
    12  
    13  This will match version 1.2.0 and any patches to that release (1.2.1, 1.2.999, and so on)
    14  
    15  ### Repository URLs
    16  
    17  Where possible, use `https://` repository URLs, followed by `http://` URLs.
    18  
    19  If the repository has been added to the repository index file, the repository name can be used as an alias of URL. Use `alias:` or `@` followed by repository names.
    20  
    21  File URLs (`file://...`) are considered a "special case" for charts that are assembled by a fixed deployment pipeline. Charts that use `file://` in a `requirements.yaml` file are not allowed in the official Helm repository.
    22  
    23  ## Conditions and Tags
    24  
    25  Conditions or tags should be added to any dependencies that _are optional_.
    26  
    27  The preferred form of a condition is:
    28  
    29  ```yaml
    30  condition: somechart.enabled
    31  ```
    32  
    33  Where `somechart` is the chart name of the dependency.
    34  
    35  When multiple subcharts (dependencies) together provide an optional or swappable feature, those charts should share the same tags.
    36  
    37  For example, if both `nginx` and `memcached` together provided performance optimizations for the main app in the chart, and were required to both be present when that feature is enabled, then they might both have a
    38  tags section like this:
    39  
    40  ```
    41  tags:
    42    - webaccelerator
    43  ```
    44  
    45  This allows a user to turn that feature on and off with one tag.