Interface IHelmChartOptions
Helm Chart options.
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IHelmChartOptions
Syntax (vb)
Public Interface IHelmChartOptions
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.S3.Assets;
Cluster cluster;
var chartAsset = new Asset(this, "ChartAsset", new AssetProps {
Path = "/path/to/asset"
});
cluster.AddHelmChart("test-chart", new HelmChartOptions {
ChartAsset = chartAsset
});
Synopsis
Properties
Atomic | Whether or not Helm should treat this operation as atomic; |
Chart | The name of the chart. |
ChartAsset | The chart in the form of an asset. |
CreateNamespace | create namespace if not exist. |
Namespace | The Kubernetes namespace scope of the requests. |
Release | The name of the release. |
Repository | The repository which contains the chart. |
SkipCrds | if set, no CRDs will be installed. |
Timeout | Amount of time to wait for any individual Kubernetes operation. |
Values | The values to be used by the chart. |
Version | The chart version to install. |
Wait | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. |
Properties
Atomic
Whether or not Helm should treat this operation as atomic;
virtual Nullable<bool> Atomic { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used.
Default: false
Chart
The name of the chart.
virtual string Chart { get; }
Property Value
System.String
Remarks
Either this or chartAsset
must be specified.
Default: - No chart name. Implies chartAsset
is used.
ChartAsset
The chart in the form of an asset.
virtual Asset ChartAsset { get; }
Property Value
Remarks
Either this or chart
must be specified.
Default: - No chart asset. Implies chart
is used.
CreateNamespace
create namespace if not exist.
virtual Nullable<bool> CreateNamespace { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Namespace
The Kubernetes namespace scope of the requests.
virtual string Namespace { get; }
Property Value
System.String
Remarks
Default: default
Release
The name of the release.
virtual string Release { get; }
Property Value
System.String
Remarks
Default: - If no release name is given, it will use the last 53 characters of the node's unique id.
Repository
The repository which contains the chart.
virtual string Repository { get; }
Property Value
System.String
Remarks
For example: https://charts.helm.sh/stable/
Default: - No repository will be used, which means that the chart needs to be an absolute URL.
SkipCrds
if set, no CRDs will be installed.
virtual Nullable<bool> SkipCrds { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - CRDs are installed if not already present
Timeout
Amount of time to wait for any individual Kubernetes operation.
virtual Duration Timeout { get; }
Property Value
Remarks
Maximum 15 minutes.
Default: Duration.minutes(5)
Values
The values to be used by the chart.
virtual IDictionary<string, object> Values { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
For nested values use a nested dictionary. For example: values: { installationCRDs: true, webhook: { port: 9443 } }
Default: - No values are provided to the chart.
Version
The chart version to install.
virtual string Version { get; }
Property Value
System.String
Remarks
Default: - If this is not specified, the latest version is installed
Wait
Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful.
virtual Nullable<bool> Wait { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - Helm will not wait before marking release as successful