CreateOkeHelmChartDeployStageDetails¶

class oci.devops.models.CreateOkeHelmChartDeployStageDetails(**kwargs)¶

Bases: oci.devops.models.create_deploy_stage_details.CreateDeployStageDetails

Specifies the Helm chart deployment to a Kubernetes cluster stage.

Attributes

`PURPOSE_EXECUTE_HELM_COMMAND`	A constant which can be used with the purpose property of a CreateOkeHelmChartDeployStageDetails.
`PURPOSE_EXECUTE_HELM_UPGRADE`	A constant which can be used with the purpose property of a CreateOkeHelmChartDeployStageDetails.
`are_hooks_enabled`	Gets the are_hooks_enabled of this CreateOkeHelmChartDeployStageDetails.
`defined_tags`	Gets the defined_tags of this CreateDeployStageDetails.
`deploy_pipeline_id`	[Required] Gets the deploy_pipeline_id of this CreateDeployStageDetails.
`deploy_stage_predecessor_collection`	[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.
`deploy_stage_type`	[Required] Gets the deploy_stage_type of this CreateDeployStageDetails.
`description`	Gets the description of this CreateDeployStageDetails.
`display_name`	Gets the display_name of this CreateDeployStageDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDeployStageDetails.
`helm_chart_deploy_artifact_id`	[Required] Gets the helm_chart_deploy_artifact_id of this CreateOkeHelmChartDeployStageDetails.
`helm_command_artifact_ids`	Gets the helm_command_artifact_ids of this CreateOkeHelmChartDeployStageDetails.
`is_debug_enabled`	Gets the is_debug_enabled of this CreateOkeHelmChartDeployStageDetails.
`is_force_enabled`	Gets the is_force_enabled of this CreateOkeHelmChartDeployStageDetails.
`is_uninstall_on_stage_delete`	Gets the is_uninstall_on_stage_delete of this CreateOkeHelmChartDeployStageDetails.
`max_history`	Gets the max_history of this CreateOkeHelmChartDeployStageDetails.
`namespace`	Gets the namespace of this CreateOkeHelmChartDeployStageDetails.
`oke_cluster_deploy_environment_id`	[Required] Gets the oke_cluster_deploy_environment_id of this CreateOkeHelmChartDeployStageDetails.
`purpose`	Gets the purpose of this CreateOkeHelmChartDeployStageDetails.
`release_name`	[Required] Gets the release_name of this CreateOkeHelmChartDeployStageDetails.
`rollback_policy`	Gets the rollback_policy of this CreateOkeHelmChartDeployStageDetails.
`set_string`	Gets the set_string of this CreateOkeHelmChartDeployStageDetails.
`set_values`	Gets the set_values of this CreateOkeHelmChartDeployStageDetails.
`should_cleanup_on_fail`	Gets the should_cleanup_on_fail of this CreateOkeHelmChartDeployStageDetails.
`should_not_wait`	Gets the should_not_wait of this CreateOkeHelmChartDeployStageDetails.
`should_reset_values`	Gets the should_reset_values of this CreateOkeHelmChartDeployStageDetails.
`should_reuse_values`	Gets the should_reuse_values of this CreateOkeHelmChartDeployStageDetails.
`should_skip_crds`	Gets the should_skip_crds of this CreateOkeHelmChartDeployStageDetails.
`should_skip_render_subchart_notes`	Gets the should_skip_render_subchart_notes of this CreateOkeHelmChartDeployStageDetails.
`timeout_in_seconds`	Gets the timeout_in_seconds of this CreateOkeHelmChartDeployStageDetails.
`values_artifact_ids`	Gets the values_artifact_ids of this CreateOkeHelmChartDeployStageDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateOkeHelmChartDeployStageDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

PURPOSE_EXECUTE_HELM_COMMAND = 'EXECUTE_HELM_COMMAND'¶: A constant which can be used with the purpose property of a CreateOkeHelmChartDeployStageDetails. This constant has a value of “EXECUTE_HELM_COMMAND”

PURPOSE_EXECUTE_HELM_UPGRADE = 'EXECUTE_HELM_UPGRADE'¶: A constant which can be used with the purpose property of a CreateOkeHelmChartDeployStageDetails. This constant has a value of “EXECUTE_HELM_UPGRADE”

__init__(**kwargs)¶

Initializes a new CreateOkeHelmChartDeployStageDetails object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is OKE_HELM_CHART_DEPLOYMENT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this CreateOkeHelmChartDeployStageDetails.
display_name (str) – The value to assign to the display_name property of this CreateOkeHelmChartDeployStageDetails.
deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateOkeHelmChartDeployStageDetails.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateOkeHelmChartDeployStageDetails.
deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateOkeHelmChartDeployStageDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOkeHelmChartDeployStageDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOkeHelmChartDeployStageDetails.
oke_cluster_deploy_environment_id (str) – The value to assign to the oke_cluster_deploy_environment_id property of this CreateOkeHelmChartDeployStageDetails.
helm_chart_deploy_artifact_id (str) – The value to assign to the helm_chart_deploy_artifact_id property of this CreateOkeHelmChartDeployStageDetails.
values_artifact_ids (list[str]) – The value to assign to the values_artifact_ids property of this CreateOkeHelmChartDeployStageDetails.
release_name (str) – The value to assign to the release_name property of this CreateOkeHelmChartDeployStageDetails.
is_uninstall_on_stage_delete (bool) – The value to assign to the is_uninstall_on_stage_delete property of this CreateOkeHelmChartDeployStageDetails.
helm_command_artifact_ids (list[str]) – The value to assign to the helm_command_artifact_ids property of this CreateOkeHelmChartDeployStageDetails.
purpose (str) – The value to assign to the purpose property of this CreateOkeHelmChartDeployStageDetails. Allowed values for this property are: “EXECUTE_HELM_UPGRADE”, “EXECUTE_HELM_COMMAND”
namespace (str) – The value to assign to the namespace property of this CreateOkeHelmChartDeployStageDetails.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this CreateOkeHelmChartDeployStageDetails.
rollback_policy (oci.devops.models.DeployStageRollbackPolicy) – The value to assign to the rollback_policy property of this CreateOkeHelmChartDeployStageDetails.
set_values (oci.devops.models.HelmSetValueCollection) – The value to assign to the set_values property of this CreateOkeHelmChartDeployStageDetails.
set_string (oci.devops.models.HelmSetValueCollection) – The value to assign to the set_string property of this CreateOkeHelmChartDeployStageDetails.
are_hooks_enabled (bool) – The value to assign to the are_hooks_enabled property of this CreateOkeHelmChartDeployStageDetails.
should_reuse_values (bool) – The value to assign to the should_reuse_values property of this CreateOkeHelmChartDeployStageDetails.
should_reset_values (bool) – The value to assign to the should_reset_values property of this CreateOkeHelmChartDeployStageDetails.
is_force_enabled (bool) – The value to assign to the is_force_enabled property of this CreateOkeHelmChartDeployStageDetails.
should_cleanup_on_fail (bool) – The value to assign to the should_cleanup_on_fail property of this CreateOkeHelmChartDeployStageDetails.
max_history (int) – The value to assign to the max_history property of this CreateOkeHelmChartDeployStageDetails.
should_skip_crds (bool) – The value to assign to the should_skip_crds property of this CreateOkeHelmChartDeployStageDetails.
should_skip_render_subchart_notes (bool) – The value to assign to the should_skip_render_subchart_notes property of this CreateOkeHelmChartDeployStageDetails.
should_not_wait (bool) – The value to assign to the should_not_wait property of this CreateOkeHelmChartDeployStageDetails.
is_debug_enabled (bool) – The value to assign to the is_debug_enabled property of this CreateOkeHelmChartDeployStageDetails.

are_hooks_enabled¶

Gets the are_hooks_enabled of this CreateOkeHelmChartDeployStageDetails. Disable pre/post upgrade hooks. Set to false by default.

Returns:	The are_hooks_enabled of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

defined_tags¶

Gets the defined_tags of this CreateDeployStageDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateDeployStageDetails.
Return type:	dict(str, dict(str, object))

deploy_pipeline_id¶

[Required] Gets the deploy_pipeline_id of this CreateDeployStageDetails. The OCID of a pipeline.

Returns:	The deploy_pipeline_id of this CreateDeployStageDetails.
Return type:	str

deploy_stage_predecessor_collection¶

[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.

Returns:	The deploy_stage_predecessor_collection of this CreateDeployStageDetails.
Return type:	oci.devops.models.DeployStagePredecessorCollection

deploy_stage_type¶

[Required] Gets the deploy_stage_type of this CreateDeployStageDetails. Deployment stage type.

Returns:	The deploy_stage_type of this CreateDeployStageDetails.
Return type:	str

description¶

Gets the description of this CreateDeployStageDetails. Optional description about the deployment stage.

Returns:	The description of this CreateDeployStageDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateDeployStageDetails. Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Returns:	The display_name of this CreateDeployStageDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateDeployStageDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateDeployStageDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

helm_chart_deploy_artifact_id¶

[Required] Gets the helm_chart_deploy_artifact_id of this CreateOkeHelmChartDeployStageDetails. Helm chart artifact OCID.

Returns:	The helm_chart_deploy_artifact_id of this CreateOkeHelmChartDeployStageDetails.
Return type:	str

helm_command_artifact_ids¶

Gets the helm_command_artifact_ids of this CreateOkeHelmChartDeployStageDetails. List of Helm command artifact OCIDs.

Returns:	The helm_command_artifact_ids of this CreateOkeHelmChartDeployStageDetails.
Return type:	list[str]

is_debug_enabled¶

Gets the is_debug_enabled of this CreateOkeHelmChartDeployStageDetails. Enables helm –debug option to stream output to tf stdout. Set to false by default.

Returns:	The is_debug_enabled of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

is_force_enabled¶

Gets the is_force_enabled of this CreateOkeHelmChartDeployStageDetails. Force resource update through delete; or if required, recreate. Set to false by default.

Returns:	The is_force_enabled of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

is_uninstall_on_stage_delete¶

Gets the is_uninstall_on_stage_delete of this CreateOkeHelmChartDeployStageDetails. Uninstall the Helm chart release on deleting the stage.

Returns:	The is_uninstall_on_stage_delete of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

max_history¶

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

Returns:	The max_history of this CreateOkeHelmChartDeployStageDetails.
Return type:	int

namespace¶

Gets the namespace of this CreateOkeHelmChartDeployStageDetails. Default namespace to be used for Kubernetes deployment when not specified in the manifest.

Returns:	The namespace of this CreateOkeHelmChartDeployStageDetails.
Return type:	str

oke_cluster_deploy_environment_id¶

[Required] Gets the oke_cluster_deploy_environment_id of this CreateOkeHelmChartDeployStageDetails. Kubernetes cluster environment OCID for deployment.

Returns:	The oke_cluster_deploy_environment_id of this CreateOkeHelmChartDeployStageDetails.
Return type:	str

purpose¶

Gets the purpose of this CreateOkeHelmChartDeployStageDetails. The purpose of running this Helm stage

Allowed values for this property are: “EXECUTE_HELM_UPGRADE”, “EXECUTE_HELM_COMMAND”

Returns:	The purpose of this CreateOkeHelmChartDeployStageDetails.
Return type:	str

release_name¶

[Required] Gets the release_name of this CreateOkeHelmChartDeployStageDetails. Default name of the chart instance. Must be unique within a Kubernetes namespace.

Returns:	The release_name of this CreateOkeHelmChartDeployStageDetails.
Return type:	str

rollback_policy¶

Gets the rollback_policy of this CreateOkeHelmChartDeployStageDetails.

Returns:	The rollback_policy of this CreateOkeHelmChartDeployStageDetails.
Return type:	oci.devops.models.DeployStageRollbackPolicy

set_string¶

Gets the set_string of this CreateOkeHelmChartDeployStageDetails.

Returns:	The set_string of this CreateOkeHelmChartDeployStageDetails.
Return type:	oci.devops.models.HelmSetValueCollection

set_values¶

Gets the set_values of this CreateOkeHelmChartDeployStageDetails.

Returns:	The set_values of this CreateOkeHelmChartDeployStageDetails.
Return type:	oci.devops.models.HelmSetValueCollection

should_cleanup_on_fail¶

Gets the should_cleanup_on_fail of this CreateOkeHelmChartDeployStageDetails. Allow deletion of new resources created during when an upgrade fails. Set to false by default.

Returns:	The should_cleanup_on_fail of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

should_not_wait¶

Gets the should_not_wait of this CreateOkeHelmChartDeployStageDetails. Does not wait until all the resources are in a ready state to mark the release as successful if set to true. Set to false by default.

Returns:	The should_not_wait of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

should_reset_values¶

Gets the should_reset_values of this CreateOkeHelmChartDeployStageDetails. During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

Returns:	The should_reset_values of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

should_reuse_values¶

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

Returns:	The should_reuse_values of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

should_skip_crds¶

Gets the should_skip_crds of this CreateOkeHelmChartDeployStageDetails. If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

Returns:	The should_skip_crds of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

should_skip_render_subchart_notes¶

Gets the should_skip_render_subchart_notes of this CreateOkeHelmChartDeployStageDetails. If set, renders subchart notes along with the parent. Set to false by default.

Returns:	The should_skip_render_subchart_notes of this CreateOkeHelmChartDeployStageDetails.
Return type:	bool

timeout_in_seconds¶

Gets the timeout_in_seconds of this CreateOkeHelmChartDeployStageDetails. Time to wait for execution of a helm stage. Defaults to 300 seconds.

Returns:	The timeout_in_seconds of this CreateOkeHelmChartDeployStageDetails.
Return type:	int

values_artifact_ids¶

Gets the values_artifact_ids of this CreateOkeHelmChartDeployStageDetails. List of values.yaml file artifact OCIDs.

Returns:	The values_artifact_ids of this CreateOkeHelmChartDeployStageDetails.
Return type:	list[str]