Helm Chart requirements.yaml

From NovaOrdis Knowledge Base
Revision as of 16:35, 9 September 2019 by Ovidiu (talk | contribs) (→‎Overview)
Jump to navigation Jump to search

External

Internal

Overview

requirements.yaml is an optional metadata file that contains the immediate dependencies for the chart, expressed as a list of name, version and repository URL tuples. Note that the immediate dependencies might have dependencies on their own, which are not expressed in the chart's requirements.yaml file. Helm manages those as well, and after they are discovered, they are written in requirements.lock file. For a general discussion on chart dependencies, see Helm Dependencies.

Structure

dependencies:
- name: blue
  version: 1.2.3
  repository: http://example.com/charts
  alias: something
  condition: something.enabled, global. something.enabled
  tags:
  - front-end
  - big    
- name: green
  version 3.2.1
  repository: http://another.example.com/charts

Example

dependencies:
  - name: postgresql
    version: 6.3.2
    repository: https://kubernetes-charts.storage.googleapis.com

requirements.lock

Transitive Dependencies and requirements.lock File

Fields

name

The dependency chart name.

version

The dependency chart version.

repository

The dependency chart repository full URL. Note that helm repo add must be used to add the repository locally.

alias

TODO: https://helm.sh/docs/developing_charts/#alias-field-in-requirements-yaml

condition

TODO:https://helm.sh/docs/developing_charts/#tags-and-condition-fields-in-requirements-yaml

tags

TODO: https://helm.sh/docs/developing_charts/#tags-and-condition-fields-in-requirements-yaml