OkeHelmChartDeployStageSummary¶
-
class
oci.devops.models.
OkeHelmChartDeployStageSummary
(**kwargs)¶ Bases:
oci.devops.models.deploy_stage_summary.DeployStageSummary
Specifies the OKE cluster deployment stage using Helm charts.
Attributes
PURPOSE_EXECUTE_HELM_COMMAND
A constant which can be used with the purpose property of a OkeHelmChartDeployStageSummary. PURPOSE_EXECUTE_HELM_UPGRADE
A constant which can be used with the purpose property of a OkeHelmChartDeployStageSummary. are_hooks_enabled
Gets the are_hooks_enabled of this OkeHelmChartDeployStageSummary. compartment_id
[Required] Gets the compartment_id of this DeployStageSummary. defined_tags
Gets the defined_tags of this DeployStageSummary. deploy_pipeline_id
[Required] Gets the deploy_pipeline_id of this DeployStageSummary. deploy_stage_predecessor_collection
Gets the deploy_stage_predecessor_collection of this DeployStageSummary. deploy_stage_type
[Required] Gets the deploy_stage_type of this DeployStageSummary. description
Gets the description of this DeployStageSummary. display_name
Gets the display_name of this DeployStageSummary. freeform_tags
Gets the freeform_tags of this DeployStageSummary. helm_chart_deploy_artifact_id
[Required] Gets the helm_chart_deploy_artifact_id of this OkeHelmChartDeployStageSummary. helm_command_artifact_ids
Gets the helm_command_artifact_ids of this OkeHelmChartDeployStageSummary. id
[Required] Gets the id of this DeployStageSummary. is_debug_enabled
Gets the is_debug_enabled of this OkeHelmChartDeployStageSummary. is_force_enabled
Gets the is_force_enabled of this OkeHelmChartDeployStageSummary. is_uninstall_on_stage_delete
Gets the is_uninstall_on_stage_delete of this OkeHelmChartDeployStageSummary. lifecycle_details
Gets the lifecycle_details of this DeployStageSummary. lifecycle_state
Gets the lifecycle_state of this DeployStageSummary. max_history
Gets the max_history of this OkeHelmChartDeployStageSummary. namespace
Gets the namespace of this OkeHelmChartDeployStageSummary. oke_cluster_deploy_environment_id
[Required] Gets the oke_cluster_deploy_environment_id of this OkeHelmChartDeployStageSummary. project_id
[Required] Gets the project_id of this DeployStageSummary. purpose
Gets the purpose of this OkeHelmChartDeployStageSummary. release_name
[Required] Gets the release_name of this OkeHelmChartDeployStageSummary. rollback_policy
Gets the rollback_policy of this OkeHelmChartDeployStageSummary. set_string
Gets the set_string of this OkeHelmChartDeployStageSummary. set_values
Gets the set_values of this OkeHelmChartDeployStageSummary. should_cleanup_on_fail
Gets the should_cleanup_on_fail of this OkeHelmChartDeployStageSummary. should_not_wait
Gets the should_not_wait of this OkeHelmChartDeployStageSummary. should_reset_values
Gets the should_reset_values of this OkeHelmChartDeployStageSummary. should_reuse_values
Gets the should_reuse_values of this OkeHelmChartDeployStageSummary. should_skip_crds
Gets the should_skip_crds of this OkeHelmChartDeployStageSummary. should_skip_render_subchart_notes
Gets the should_skip_render_subchart_notes of this OkeHelmChartDeployStageSummary. system_tags
Gets the system_tags of this DeployStageSummary. time_created
Gets the time_created of this DeployStageSummary. time_updated
Gets the time_updated of this DeployStageSummary. timeout_in_seconds
Gets the timeout_in_seconds of this OkeHelmChartDeployStageSummary. values_artifact_ids
Gets the values_artifact_ids of this OkeHelmChartDeployStageSummary. Methods
__init__
(**kwargs)Initializes a new OkeHelmChartDeployStageSummary 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 OkeHelmChartDeployStageSummary. 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 OkeHelmChartDeployStageSummary. This constant has a value of “EXECUTE_HELM_UPGRADE”
-
__init__
(**kwargs)¶ Initializes a new OkeHelmChartDeployStageSummary object with values from keyword arguments. The default value of the
deploy_stage_type
attribute of this class isOKE_HELM_CHART_DEPLOYMENT
and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):Parameters: - id (str) – The value to assign to the id property of this OkeHelmChartDeployStageSummary.
- description (str) – The value to assign to the description property of this OkeHelmChartDeployStageSummary.
- display_name (str) – The value to assign to the display_name property of this OkeHelmChartDeployStageSummary.
- project_id (str) – The value to assign to the project_id property of this OkeHelmChartDeployStageSummary.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this OkeHelmChartDeployStageSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this OkeHelmChartDeployStageSummary.
- deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this OkeHelmChartDeployStageSummary.
- time_created (datetime) – The value to assign to the time_created property of this OkeHelmChartDeployStageSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this OkeHelmChartDeployStageSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this OkeHelmChartDeployStageSummary.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this OkeHelmChartDeployStageSummary.
- deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this OkeHelmChartDeployStageSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OkeHelmChartDeployStageSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OkeHelmChartDeployStageSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OkeHelmChartDeployStageSummary.
- oke_cluster_deploy_environment_id (str) – The value to assign to the oke_cluster_deploy_environment_id property of this OkeHelmChartDeployStageSummary.
- helm_chart_deploy_artifact_id (str) – The value to assign to the helm_chart_deploy_artifact_id property of this OkeHelmChartDeployStageSummary.
- values_artifact_ids (list[str]) – The value to assign to the values_artifact_ids property of this OkeHelmChartDeployStageSummary.
- release_name (str) – The value to assign to the release_name property of this OkeHelmChartDeployStageSummary.
- is_uninstall_on_stage_delete (bool) – The value to assign to the is_uninstall_on_stage_delete property of this OkeHelmChartDeployStageSummary.
- helm_command_artifact_ids (list[str]) – The value to assign to the helm_command_artifact_ids property of this OkeHelmChartDeployStageSummary.
- purpose (str) – The value to assign to the purpose property of this OkeHelmChartDeployStageSummary. Allowed values for this property are: “EXECUTE_HELM_UPGRADE”, “EXECUTE_HELM_COMMAND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- namespace (str) – The value to assign to the namespace property of this OkeHelmChartDeployStageSummary.
- timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this OkeHelmChartDeployStageSummary.
- rollback_policy (oci.devops.models.DeployStageRollbackPolicy) – The value to assign to the rollback_policy property of this OkeHelmChartDeployStageSummary.
- set_values (oci.devops.models.HelmSetValueCollection) – The value to assign to the set_values property of this OkeHelmChartDeployStageSummary.
- set_string (oci.devops.models.HelmSetValueCollection) – The value to assign to the set_string property of this OkeHelmChartDeployStageSummary.
- are_hooks_enabled (bool) – The value to assign to the are_hooks_enabled property of this OkeHelmChartDeployStageSummary.
- should_reuse_values (bool) – The value to assign to the should_reuse_values property of this OkeHelmChartDeployStageSummary.
- should_reset_values (bool) – The value to assign to the should_reset_values property of this OkeHelmChartDeployStageSummary.
- is_force_enabled (bool) – The value to assign to the is_force_enabled property of this OkeHelmChartDeployStageSummary.
- should_cleanup_on_fail (bool) – The value to assign to the should_cleanup_on_fail property of this OkeHelmChartDeployStageSummary.
- max_history (int) – The value to assign to the max_history property of this OkeHelmChartDeployStageSummary.
- should_skip_crds (bool) – The value to assign to the should_skip_crds property of this OkeHelmChartDeployStageSummary.
- should_skip_render_subchart_notes (bool) – The value to assign to the should_skip_render_subchart_notes property of this OkeHelmChartDeployStageSummary.
- should_not_wait (bool) – The value to assign to the should_not_wait property of this OkeHelmChartDeployStageSummary.
- is_debug_enabled (bool) – The value to assign to the is_debug_enabled property of this OkeHelmChartDeployStageSummary.
-
are_hooks_enabled
¶ Gets the are_hooks_enabled of this OkeHelmChartDeployStageSummary. Disable pre/post upgrade hooks.
Returns: The are_hooks_enabled of this OkeHelmChartDeployStageSummary. Return type: bool
-
compartment_id
¶ [Required] Gets the compartment_id of this DeployStageSummary. The OCID of a compartment.
Returns: The compartment_id of this DeployStageSummary. Return type: str
Gets the defined_tags of this DeployStageSummary. 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 DeployStageSummary. Return type: dict(str, dict(str, object))
-
deploy_pipeline_id
¶ [Required] Gets the deploy_pipeline_id of this DeployStageSummary. The OCID of a pipeline.
Returns: The deploy_pipeline_id of this DeployStageSummary. Return type: str
-
deploy_stage_predecessor_collection
¶ Gets the deploy_stage_predecessor_collection of this DeployStageSummary.
Returns: The deploy_stage_predecessor_collection of this DeployStageSummary. Return type: oci.devops.models.DeployStagePredecessorCollection
-
deploy_stage_type
¶ [Required] Gets the deploy_stage_type of this DeployStageSummary. Deployment stage type.
Returns: The deploy_stage_type of this DeployStageSummary. Return type: str
-
description
¶ Gets the description of this DeployStageSummary. Optional description about the deployment stage.
Returns: The description of this DeployStageSummary. Return type: str
-
display_name
¶ Gets the display_name of this DeployStageSummary. Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Returns: The display_name of this DeployStageSummary. Return type: str
Gets the freeform_tags of this DeployStageSummary. 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 DeployStageSummary. 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 OkeHelmChartDeployStageSummary. Helm chart artifact OCID.
Returns: The helm_chart_deploy_artifact_id of this OkeHelmChartDeployStageSummary. Return type: str
-
helm_command_artifact_ids
¶ Gets the helm_command_artifact_ids of this OkeHelmChartDeployStageSummary. List of Helm command artifact OCIDs.
Returns: The helm_command_artifact_ids of this OkeHelmChartDeployStageSummary. Return type: list[str]
-
id
¶ [Required] Gets the id of this DeployStageSummary. Unique identifier that is immutable on creation.
Returns: The id of this DeployStageSummary. Return type: str
-
is_debug_enabled
¶ Gets the is_debug_enabled of this OkeHelmChartDeployStageSummary. Enables helm –debug option to stream output. Set to false by default.
Returns: The is_debug_enabled of this OkeHelmChartDeployStageSummary. Return type: bool
-
is_force_enabled
¶ Gets the is_force_enabled of this OkeHelmChartDeployStageSummary. Force resource update through delete; or if required, recreate. Set to false by default.
Returns: The is_force_enabled of this OkeHelmChartDeployStageSummary. Return type: bool
-
is_uninstall_on_stage_delete
¶ Gets the is_uninstall_on_stage_delete of this OkeHelmChartDeployStageSummary. Uninstall the Helm chart release on deleting the stage.
Returns: The is_uninstall_on_stage_delete of this OkeHelmChartDeployStageSummary. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this DeployStageSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Returns: The lifecycle_details of this DeployStageSummary. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this DeployStageSummary. The current state of the deployment stage.
Returns: The lifecycle_state of this DeployStageSummary. Return type: str
-
max_history
¶ Gets the max_history of this OkeHelmChartDeployStageSummary. 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 OkeHelmChartDeployStageSummary. Return type: int
-
namespace
¶ Gets the namespace of this OkeHelmChartDeployStageSummary. Default namespace to be used for Kubernetes deployment when not specified in the manifest.
Returns: The namespace of this OkeHelmChartDeployStageSummary. Return type: str
-
oke_cluster_deploy_environment_id
¶ [Required] Gets the oke_cluster_deploy_environment_id of this OkeHelmChartDeployStageSummary. Kubernetes cluster environment OCID for deployment.
Returns: The oke_cluster_deploy_environment_id of this OkeHelmChartDeployStageSummary. Return type: str
-
project_id
¶ [Required] Gets the project_id of this DeployStageSummary. The OCID of a project.
Returns: The project_id of this DeployStageSummary. Return type: str
-
purpose
¶ Gets the purpose of this OkeHelmChartDeployStageSummary. The purpose of running this Helm stage
Allowed values for this property are: “EXECUTE_HELM_UPGRADE”, “EXECUTE_HELM_COMMAND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The purpose of this OkeHelmChartDeployStageSummary. Return type: str
-
release_name
¶ [Required] Gets the release_name of this OkeHelmChartDeployStageSummary. Release name of the Helm chart.
Returns: The release_name of this OkeHelmChartDeployStageSummary. Return type: str
-
rollback_policy
¶ Gets the rollback_policy of this OkeHelmChartDeployStageSummary.
Returns: The rollback_policy of this OkeHelmChartDeployStageSummary. Return type: oci.devops.models.DeployStageRollbackPolicy
-
set_string
¶ Gets the set_string of this OkeHelmChartDeployStageSummary.
Returns: The set_string of this OkeHelmChartDeployStageSummary. Return type: oci.devops.models.HelmSetValueCollection
-
set_values
¶ Gets the set_values of this OkeHelmChartDeployStageSummary.
Returns: The set_values of this OkeHelmChartDeployStageSummary. Return type: oci.devops.models.HelmSetValueCollection
-
should_cleanup_on_fail
¶ Gets the should_cleanup_on_fail of this OkeHelmChartDeployStageSummary. Allow deletion of new resources created during when an upgrade fails. Set to false by default.
Returns: The should_cleanup_on_fail of this OkeHelmChartDeployStageSummary. Return type: bool
-
should_not_wait
¶ Gets the should_not_wait of this OkeHelmChartDeployStageSummary. Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.
Returns: The should_not_wait of this OkeHelmChartDeployStageSummary. Return type: bool
-
should_reset_values
¶ Gets the should_reset_values of this OkeHelmChartDeployStageSummary. 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 OkeHelmChartDeployStageSummary. Return type: bool
-
should_reuse_values
¶ Gets the should_reuse_values of this OkeHelmChartDeployStageSummary. 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 OkeHelmChartDeployStageSummary. Return type: bool
-
should_skip_crds
¶ Gets the should_skip_crds of this OkeHelmChartDeployStageSummary. 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 OkeHelmChartDeployStageSummary. Return type: bool
-
should_skip_render_subchart_notes
¶ Gets the should_skip_render_subchart_notes of this OkeHelmChartDeployStageSummary. If set, renders subchart notes along with the parent. Set to false by default.
Returns: The should_skip_render_subchart_notes of this OkeHelmChartDeployStageSummary. Return type: bool
Gets the system_tags of this DeployStageSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this DeployStageSummary. Return type: dict(str, dict(str, object))
-
time_created
¶ Gets the time_created of this DeployStageSummary. Time the deployment stage was created. Format defined by RFC3339.
Returns: The time_created of this DeployStageSummary. Return type: datetime
-
time_updated
¶ Gets the time_updated of this DeployStageSummary. Time the deployment stage was updated. Format defined by RFC3339.
Returns: The time_updated of this DeployStageSummary. Return type: datetime
-
timeout_in_seconds
¶ Gets the timeout_in_seconds of this OkeHelmChartDeployStageSummary. Time to wait for execution of a helm stage. Defaults to 300 seconds.
Returns: The timeout_in_seconds of this OkeHelmChartDeployStageSummary. Return type: int
-
values_artifact_ids
¶ Gets the values_artifact_ids of this OkeHelmChartDeployStageSummary. List of values.yaml file artifact OCIDs.
Returns: The values_artifact_ids of this OkeHelmChartDeployStageSummary. Return type: list[str]
-