Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OkeHelmChartDeployStage

Specifies the OKE cluster deployment stage using helm charts.

Properties

Optional areHooksEnabled

areHooksEnabled: undefined | false | true

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

compartmentId

compartmentId: string

The OCID of a compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

deployPipelineId

deployPipelineId: string

The OCID of a pipeline.

Optional deployStagePredecessorCollection

deployStagePredecessorCollection: model.DeployStagePredecessorCollection

Const deployStageType

deployStageType: string = "OKE_HELM_CHART_DEPLOYMENT"

Optional description

description: undefined | string

Optional description about the deployment stage.

Optional displayName

displayName: undefined | string

Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {@code {"bar-key": "value"}}

helmChartDeployArtifactId

helmChartDeployArtifactId: string

Helm chart artifact OCID.

Optional helmCommandArtifactIds

helmCommandArtifactIds: Array<string>

List of Helm command artifact OCIDs.

id

id: string

Unique identifier that is immutable on creation.

Optional isDebugEnabled

isDebugEnabled: undefined | false | true

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

Optional isForceEnabled

isForceEnabled: undefined | false | true

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

Optional isUninstallOnStageDelete

isUninstallOnStageDelete: undefined | false | true

Uninstall the Helm chart release on deleting the stage.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the deployment stage.

Optional maxHistory

maxHistory: undefined | number

Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional namespace

namespace: undefined | string

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

okeClusterDeployEnvironmentId

okeClusterDeployEnvironmentId: string

Kubernetes cluster environment OCID for deployment.

projectId

projectId: string

The OCID of a project.

Optional purpose

purpose: Purpose

The purpose of running this Helm stage

releaseName

releaseName: string

Release name of the Helm chart.

Optional rollbackPolicy

Optional setString

setString: model.HelmSetValueCollection

Optional setValues

setValues: model.HelmSetValueCollection

Optional shouldCleanupOnFail

shouldCleanupOnFail: undefined | false | true

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

Optional shouldNotWait

shouldNotWait: undefined | false | true

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

Optional shouldResetValues

shouldResetValues: undefined | false | true

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

Optional shouldReuseValues

shouldReuseValues: undefined | false | true

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

Optional shouldSkipCrds

shouldSkipCrds: undefined | false | true

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

Optional shouldSkipRenderSubchartNotes

shouldSkipRenderSubchartNotes: undefined | false | true

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

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

Time the deployment stage was created. Format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

Time the deployment stage was updated. Format defined by RFC3339.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

Time to wait for execution of a helm stage. Defaults to 300 seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional valuesArtifactIds

valuesArtifactIds: Array<string>

List of values.yaml file artifact OCIDs.

Methods

getDeserializedJsonObj

getJsonObj