Class OkeHelmChartDeployStage

Specifies the OKE cluster deployment stage using helm charts.

Inheritance
object
DeployStage
OkeHelmChartDeployStage
Inherited Members
Namespace: Oci.DevopsService.Models
Assembly: OCI.DotNetSDK.Devops.dll
Syntax
public class OkeHelmChartDeployStage : DeployStage

Properties

AreHooksEnabled

Declaration
[JsonProperty(PropertyName = "areHooksEnabled")]
public bool? AreHooksEnabled { get; set; }
Property Value
Type Description
bool?

Disable pre/post upgrade hooks. Set to false by default.

HelmChartDeployArtifactId

Declaration
[Required(ErrorMessage = "HelmChartDeployArtifactId is required.")]
[JsonProperty(PropertyName = "helmChartDeployArtifactId")]
public string HelmChartDeployArtifactId { get; set; }
Property Value
Type Description
string

Helm chart artifact OCID.
Remarks

Required

HelmCommandArtifactIds

Declaration
[JsonProperty(PropertyName = "helmCommandArtifactIds")]
public List<string> HelmCommandArtifactIds { get; set; }
Property Value
Type Description
List<string>

List of Helm command artifact OCIDs.

IsDebugEnabled

Declaration
[JsonProperty(PropertyName = "isDebugEnabled")]
public bool? IsDebugEnabled { get; set; }
Property Value
Type Description
bool?

Enables helm --debug option to stream output to tf stdout. Set to false by default.

IsForceEnabled

Declaration
[JsonProperty(PropertyName = "isForceEnabled")]
public bool? IsForceEnabled { get; set; }
Property Value
Type Description
bool?

Force resource update through delete; or if required, recreate. Set to false by default.

IsUninstallOnStageDelete

Declaration
[JsonProperty(PropertyName = "isUninstallOnStageDelete")]
public bool? IsUninstallOnStageDelete { get; set; }
Property Value
Type Description
bool?

Uninstall the Helm chart release on deleting the stage.

MaxHistory

Declaration
[JsonProperty(PropertyName = "maxHistory")]
public int? MaxHistory { get; set; }
Property Value
Type Description
int?

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

Namespace

Declaration
[JsonProperty(PropertyName = "namespace")]
public string Namespace { get; set; }
Property Value
Type Description
string

Default namespace to be used for Kubernetes deployment when not specified in the manifest.

OkeClusterDeployEnvironmentId

Declaration
[Required(ErrorMessage = "OkeClusterDeployEnvironmentId is required.")]
[JsonProperty(PropertyName = "okeClusterDeployEnvironmentId")]
public string OkeClusterDeployEnvironmentId { get; set; }
Property Value
Type Description
string

Kubernetes cluster environment OCID for deployment.
Remarks

Required

Purpose

Declaration
[JsonProperty(PropertyName = "purpose")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OkeHelmChartDeployStage.PurposeEnum? Purpose { get; set; }
Property Value
Type Description
OkeHelmChartDeployStage.PurposeEnum?

The purpose of running this Helm stage

ReleaseName

Declaration
[Required(ErrorMessage = "ReleaseName is required.")]
[JsonProperty(PropertyName = "releaseName")]
public string ReleaseName { get; set; }
Property Value
Type Description
string

Release name of the Helm chart.
Remarks

Required

RollbackPolicy

Declaration
[JsonProperty(PropertyName = "rollbackPolicy")]
public DeployStageRollbackPolicy RollbackPolicy { get; set; }
Property Value
Type Description
DeployStageRollbackPolicy

SetString

Declaration
[JsonProperty(PropertyName = "setString")]
public HelmSetValueCollection SetString { get; set; }
Property Value
Type Description
HelmSetValueCollection

SetValues

Declaration
[JsonProperty(PropertyName = "setValues")]
public HelmSetValueCollection SetValues { get; set; }
Property Value
Type Description
HelmSetValueCollection

ShouldCleanupOnFail

Declaration
[JsonProperty(PropertyName = "shouldCleanupOnFail")]
public bool? ShouldCleanupOnFail { get; set; }
Property Value
Type Description
bool?

Allow deletion of new resources created during when an upgrade fails. Set to false by default.

ShouldNotWait

Declaration
[JsonProperty(PropertyName = "shouldNotWait")]
public bool? ShouldNotWait { get; set; }
Property Value
Type Description
bool?

Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

ShouldResetValues

Declaration
[JsonProperty(PropertyName = "shouldResetValues")]
public bool? ShouldResetValues { get; set; }
Property Value
Type Description
bool?

During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

ShouldReuseValues

Declaration
[JsonProperty(PropertyName = "shouldReuseValues")]
public bool? ShouldReuseValues { get; set; }
Property Value
Type Description
bool?

During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

ShouldSkipCrds

Declaration
[JsonProperty(PropertyName = "shouldSkipCrds")]
public bool? ShouldSkipCrds { get; set; }
Property Value
Type Description
bool?

If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

ShouldSkipRenderSubchartNotes

Declaration
[JsonProperty(PropertyName = "shouldSkipRenderSubchartNotes")]
public bool? ShouldSkipRenderSubchartNotes { get; set; }
Property Value
Type Description
bool?

If set, renders subchart notes along with the parent. Set to false by default.

TimeoutInSeconds

Declaration
[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }
Property Value
Type Description
int?

Time to wait for execution of a helm stage. Defaults to 300 seconds.

ValuesArtifactIds

Declaration
[JsonProperty(PropertyName = "valuesArtifactIds")]
public List<string> ValuesArtifactIds { get; set; }
Property Value
Type Description
List<string>

List of values.yaml file artifact OCIDs.