Helm Chart Chart.yaml: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 31: Line 31:
====version====
====version====


Required element; [[Software_Development#Semantic_Versioning|SemVer 2]] chart version number. Non-SemVer names are explicitly disallowed by the system. For more details, see [[Helm_Concepts#Chart_Versioning|Chart Versioning]].
Required element. Represents the [[Software_Development#Semantic_Versioning|SemVer 2]] [[Helm Concepts#Chart_Version|chart version]] number. Non-SemVer names are explicitly disallowed by the system. For more details, see [[Helm_Concepts#Chart_Versioning|Chart Versioning]].


====appVersion====
====appVersion====


Optional element; the version of the application packaged in this chart. It does not need to be [[Software_Development#Semantic_Versioning|SemVer 2]]. For more details, see [[Helm_Concepts#Chart_Versioning|Chart Versioning]].
Optional element. Represents the [[Helm Concepts#Application_Version|application version]]: the version of the application packaged in this chart. It does not need to be [[Software_Development#Semantic_Versioning|SemVer 2]]. For more details, see [[Helm_Concepts#Chart_Versioning|Chart Versioning]].


====description====
====description====

Revision as of 20:33, 28 August 2019

External

Internal

Overview

The chart's main metadata file. It is required to be present. Some of the required and optional elements are presented below, unknown elements will be silently ignored.

Example

apiVersion: v1
name: archaeopteryx
version: 0.1.0
appVersion: "1.0"
description: archaeopteryx Helm chart

Elements

apiVersion

Required element; the chart API version, always "v1".

name

Required element. Represents the name of the chart.

version

Required element. Represents the SemVer 2 chart version number. Non-SemVer names are explicitly disallowed by the system. For more details, see Chart Versioning.

appVersion

Optional element. Represents the application version: the version of the application packaged in this chart. It does not need to be SemVer 2. For more details, see Chart Versioning.

description

Optional element; the single-sentence description of this project.

keywords

home

sources

maintainers

engine

icon

deprecated

TODO: https://helm.sh/docs/developing_charts/#deprecating-charts.