Share via


HelmChart Class

Definition

Represents a Helm Chart metadata definition with properties corresponding to the chart.yaml specification.

[YamlDotNet.Serialization.YamlSerializable]
public sealed class HelmChart
[<YamlDotNet.Serialization.YamlSerializable>]
type HelmChart = class
Public NotInheritable Class HelmChart
Inheritance
HelmChart
Attributes
YamlDotNet.Serialization.YamlSerializableAttribute

Remarks

This class is used to define and serialize Helm Chart metadata into YAML format. It includes information about the chart's version, dependencies, maintainers, app version, and other key details.

Constructors

HelmChart()

Properties

Annotations

Represents a collection of annotations associated with the Helm chart. These annotations provide metadata or additional information in the form of key-value pairs.

ApiVersion

Represents the API version of the Helm chart.

AppVersion

Represents the version of the application for which this Helm chart is designed. This property typically aligns with the application's semantic versioning.

Dependencies

Represents the list of dependencies for the Helm chart. Dependencies specify other Helm charts that this chart relies on, including their configurations, such as name, version, repository, and additional metadata.

Deprecated

Indicates whether the Helm chart is deprecated. When set to true, it specifies that the chart is no longer recommended for use and may not receive updates or support.

Description

Gets or sets the description of the Helm Chart. This provides a brief summary or details about the chart's purpose and functionality.

Home

Gets or sets the URL of the Helm chart's home page or project website.

Icon

Gets or sets the URL pointing to the icon of the Helm chart. This property is typically used to display a visual representation of the chart in user interfaces.

Keywords

Represents a collection of keywords associated with the Helm chart, providing descriptors or tags to categorize or identify the chart.

KubeVersion

Specifies the required Kubernetes version for the Helm Chart. This property allows you to define the compatibility of the chart with a specific Kubernetes version or version range.

Maintainers

Represents the list of maintainers for the Helm chart.

Name

Gets or sets the name of the Helm Chart.

Sources

Represents a collection of URLs or references pointing to the source repositories or locations associated with the Helm chart. These sources are useful for understanding or confirming the origins of the chart, reviewing its code, or obtaining additional related information.

Type

Specifies the type of the Helm Chart. This property is optional and can be used to define the classification or category of the Helm Chart, such as application, library, or a custom type.

Version

Gets or sets the version of the Helm chart. Represents the specific version of the Helm chart as defined in the Chart.yaml file. This property is critical for versioning and managing release updates of the Kubernetes resources.

Applies to