oracle.oci.oci_devops_deploy_stage – Manage a DeployStage resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_devops_deploy_stage.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a DeployStage resource in Oracle Cloud Infrastructure

  • For state=present, creates a new deployment stage.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
approval_policy
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL', 'MANUAL_APPROVAL', 'OKE_CANARY_APPROVAL']
Required when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL', 'MANUAL_APPROVAL', 'OKE_CANARY_APPROVAL']
approval_policy_type
string / required
    Choices:
  • COUNT_BASED_APPROVAL
Approval policy type.
number_of_approvals_required
integer / required
A minimum number of approvals required for stage to proceed.
are_hooks_enabled
boolean
    Choices:
  • no
  • yes
Disable pre/post upgrade hooks. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
blue_backend_ips
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
items
list / elements=string
The IP address of the backend server. A server could be a compute instance or a load balancer.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
blue_green_strategy
dictionary
Required when deploy_stage_type is 'OKE_BLUE_GREEN_DEPLOYMENT'
ingress_name
string / required
Name of the Ingress resource.
namespace_a
string / required
Namespace A for deployment. Example: namespaceA - first Namespace name.
namespace_b
string / required
Namespace B for deployment. Example: namespaceB - second Namespace name.
strategy_type
string / required
    Choices:
  • NGINX_BLUE_GREEN_STRATEGY
Blue-Green strategy type.
canary_strategy
dictionary
Required when deploy_stage_type is 'OKE_CANARY_DEPLOYMENT'
ingress_name
string / required
Name of the Ingress resource.
namespace
string / required
Canary namespace to be used for Kubernetes canary deployment. Example: canary - Name of the Canary namespace.
strategy_type
string / required
    Choices:
  • NGINX_CANARY_STRATEGY
Canary strategy type.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
command_spec_deploy_artifact_id
string
The OCID of the artifact that contains the command specification.
This parameter is updatable.
Applicable when deploy_stage_type is 'SHELL'
Required when deploy_stage_type is 'SHELL'
compute_instance_group_blue_green_deployment_deploy_stage_id
string
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT'
compute_instance_group_canary_deploy_stage_id
string
A compute instance group canary stage OCID for load balancer.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT'
compute_instance_group_canary_traffic_shift_deploy_stage_id
string
A compute instance group canary traffic shift stage OCID for load balancer.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL'
compute_instance_group_deploy_environment_id
string
A compute instance group environment OCID for Canary deployment.
This parameter is updatable.
Applicable when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT'
Required when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT']
config
dictionary
User provided key and value pair configuration, which is assigned through constants or parameter.
This parameter is updatable.
Applicable when deploy_stage_type is 'DEPLOY_FUNCTION'
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
container_config
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'SHELL'
Required when deploy_stage_type is 'SHELL'
availability_domain
string
Availability domain where the ContainerInstance will be created.
compartment_id
string
The OCID of the compartment where the ContainerInstance will be created.
container_config_type
string / required
    Choices:
  • CONTAINER_INSTANCE_CONFIG
Container configuration type.
network_channel
dictionary / required
network_channel_type
string / required
    Choices:
  • SERVICE_VNIC_CHANNEL
  • PRIVATE_ENDPOINT_CHANNEL
Network channel type.
nsg_ids
list / elements=string
An array of network security group OCIDs.
subnet_id
string / required
The OCID of the subnet where private resources exist.
shape_config
dictionary / required
memory_in_gbs
float
The total amount of memory available to the instance, in gigabytes.
ocpus
float / required
The total number of OCPUs available to the instance.
shape_name
string / required
The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
deploy_artifact_id
string
Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
This parameter is updatable.
Applicable when deploy_stage_type is 'INVOKE_FUNCTION'
deploy_artifact_ids
list / elements=string
The list of file artifact OCIDs to deploy.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
deploy_environment_id_a
string
First compute instance group environment OCID for deployment.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT'
deploy_environment_id_b
string
Second compute instance group environment OCID for deployment.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT'
deploy_pipeline_id
string
The OCID of a pipeline.
Required for create using state=present.
deploy_stage_id
string
Unique stage identifier.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
deploy_stage_predecessor_collection
dictionary
Required for create using state=present.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT', 'OKE_BLUE_GREEN_TRAFFIC_SHIFT', 'SHELL', 'OKE_DEPLOYMENT', 'DEPLOY_FUNCTION', 'OKE_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT', 'OKE_HELM_CHART_DEPLOYMENT', 'OKE_BLUE_GREEN_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT', 'OKE_CANARY_APPROVAL', 'COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'OKE_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL', 'MANUAL_APPROVAL', 'LOAD_BALANCER_TRAFFIC_SHIFT', 'WAIT', 'INVOKE_FUNCTION']
items
list / elements=dictionary / required
A list of stage predecessors for a stage.
Required when deploy_stage_type is 'OKE_CANARY_TRAFFIC_SHIFT'
id
string / required
The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.
Required when deploy_stage_type is 'OKE_CANARY_TRAFFIC_SHIFT'
deploy_stage_type
string
    Choices:
  • OKE_CANARY_TRAFFIC_SHIFT
  • OKE_BLUE_GREEN_TRAFFIC_SHIFT
  • COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT
  • WAIT
  • LOAD_BALANCER_TRAFFIC_SHIFT
  • SHELL
  • COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT
  • OKE_BLUE_GREEN_DEPLOYMENT
  • COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT
  • INVOKE_FUNCTION
  • DEPLOY_FUNCTION
  • OKE_CANARY_DEPLOYMENT
  • COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT
  • COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL
  • OKE_HELM_CHART_DEPLOYMENT
  • MANUAL_APPROVAL
  • OKE_DEPLOYMENT
  • COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT
  • OKE_CANARY_APPROVAL
Deployment stage type.
Required for create using state=present, update using state=present with deploy_stage_id present.
deployment_spec_deploy_artifact_id
string
The OCID of the artifact that contains the deployment specification.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
Required when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
description
string
Optional description about the deployment stage.
This parameter is updatable.
display_name
string
Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
docker_image_deploy_artifact_id
string
A Docker image artifact OCID.
This parameter is updatable.
Applicable when deploy_stage_type is 'DEPLOY_FUNCTION'
Required when deploy_stage_type is 'DEPLOY_FUNCTION'
failure_policy
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
failure_count
integer
The threshold count of failed instances in the group, which when reached or exceeded sets the stage as Failed.
Required when policy_type is 'COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_COUNT'
failure_percentage
integer
The failure percentage threshold, which when reached or exceeded sets the stage as Failed. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.
Required when policy_type is 'COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE'
policy_type
string / required
    Choices:
  • COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
  • COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_COUNT
Specifies if the failure instance size is given by absolute number or by percentage.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
function_deploy_environment_id
string
Function environment OCID.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['DEPLOY_FUNCTION', 'INVOKE_FUNCTION']
Required when deploy_stage_type is one of ['DEPLOY_FUNCTION', 'INVOKE_FUNCTION']
function_timeout_in_seconds
integer
Timeout for execution of the Function. Value in seconds.
This parameter is updatable.
Applicable when deploy_stage_type is 'DEPLOY_FUNCTION'
green_backend_ips
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
items
list / elements=string
The IP address of the backend server. A server could be a compute instance or a load balancer.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
helm_chart_deploy_artifact_id
string
Helm chart artifact OCID.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
is_async
boolean
    Choices:
  • no
  • yes
A boolean flag specifies whether this stage executes asynchronously.
This parameter is updatable.
Applicable when deploy_stage_type is 'INVOKE_FUNCTION'
Required when deploy_stage_type is 'INVOKE_FUNCTION'
is_debug_enabled
boolean
    Choices:
  • no
  • yes
Enables helm --debug option to stream output to tf stdout. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
is_force_enabled
boolean
    Choices:
  • no
  • yes
Force resource update through delete; or if required, recreate. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
is_validation_enabled
boolean
    Choices:
  • no
  • yes
A boolean flag specifies whether the invoked function should be validated.
This parameter is updatable.
Applicable when deploy_stage_type is 'INVOKE_FUNCTION'
Required when deploy_stage_type is 'INVOKE_FUNCTION'
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
kubernetes_manifest_deploy_artifact_ids
list / elements=string
List of Kubernetes manifest artifact OCIDs.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['OKE_DEPLOYMENT', 'OKE_CANARY_DEPLOYMENT', 'OKE_BLUE_GREEN_DEPLOYMENT']
Required when deploy_stage_type is one of ['OKE_DEPLOYMENT', 'OKE_CANARY_DEPLOYMENT', 'OKE_BLUE_GREEN_DEPLOYMENT']
load_balancer_config
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'LOAD_BALANCER_TRAFFIC_SHIFT']
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
backend_port
integer
Listen port for the backend server.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
listener_name
string / required
Name of the load balancer listener.
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
load_balancer_id
string / required
The OCID of the load balancer.
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
max_history
integer
Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
max_memory_in_mbs
integer
Maximum usable memory for the Function (in MB).
This parameter is updatable.
Applicable when deploy_stage_type is 'DEPLOY_FUNCTION'
namespace
string
Default namespace to be used for Kubernetes deployment when not specified in the manifest.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['OKE_DEPLOYMENT', 'OKE_HELM_CHART_DEPLOYMENT']
oke_blue_green_deploy_stage_id
string
The OCID of the upstream OKE blue-green deployment stage in this pipeline.
Required when deploy_stage_type is 'OKE_BLUE_GREEN_TRAFFIC_SHIFT'
oke_canary_deploy_stage_id
string
The OCID of an upstream OKE canary deployment stage in this pipeline.
Required when deploy_stage_type is 'OKE_CANARY_TRAFFIC_SHIFT'
oke_canary_traffic_shift_deploy_stage_id
string
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.
Required when deploy_stage_type is 'OKE_CANARY_APPROVAL'
oke_cluster_deploy_environment_id
string
Kubernetes cluster environment OCID for deployment.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['OKE_DEPLOYMENT', 'OKE_HELM_CHART_DEPLOYMENT']
Required when deploy_stage_type is one of ['OKE_DEPLOYMENT', 'OKE_CANARY_DEPLOYMENT', 'OKE_HELM_CHART_DEPLOYMENT', 'OKE_BLUE_GREEN_DEPLOYMENT']
production_load_balancer_config
dictionary
Required when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
backend_port
integer
Listen port for the backend server.
Applicable when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
listener_name
string / required
Name of the load balancer listener.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
load_balancer_id
string / required
The OCID of the load balancer.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
release_name
string
Default name of the chart instance. Must be unique within a Kubernetes namespace.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
rollback_policy
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'OKE_DEPLOYMENT', 'OKE_HELM_CHART_DEPLOYMENT', 'LOAD_BALANCER_TRAFFIC_SHIFT']
policy_type
string / required
    Choices:
  • NO_STAGE_ROLLBACK_POLICY
  • AUTOMATED_STAGE_ROLLBACK_POLICY
Specifies type of the deployment stage rollback policy.
rollout_policy
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'OKE_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT', 'LOAD_BALANCER_TRAFFIC_SHIFT']
Required when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'OKE_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT', 'LOAD_BALANCER_TRAFFIC_SHIFT']
batch_count
integer
Specifies number of batches for this stage.
Required when deploy_stage_type is one of ['OKE_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_COUNT']
batch_delay_in_seconds
integer
Specifies delay in seconds between batches. The default delay is 1 minute.
Applicable when deploy_stage_type is one of ['OKE_CANARY_TRAFFIC_SHIFT', 'COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE', 'COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_COUNT']
batch_percentage
integer
The percentage that will be used to determine how many instances will be deployed concurrently.
Required when policy_type is 'COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE'
policy_type
string
    Choices:
  • COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE
  • COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_COUNT
The type of policy used for rolling out a deployment stage.
ramp_limit_percent
float
Indicates the criteria to stop.
Applicable when deploy_stage_type is 'OKE_CANARY_TRAFFIC_SHIFT'
set_string
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
items
list / elements=dictionary / required
List of parameters defined to set helm value.
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
name
string / required
Name of the parameter (case-sensitive).
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
value
string / required
Value of the parameter.
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
set_values
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
items
list / elements=dictionary / required
List of parameters defined to set helm value.
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
name
string / required
Name of the parameter (case-sensitive).
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
value
string / required
Value of the parameter.
Required when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_cleanup_on_fail
boolean
    Choices:
  • no
  • yes
Allow deletion of new resources created during when an upgrade fails. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_not_wait
boolean
    Choices:
  • no
  • yes
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.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_reset_values
boolean
    Choices:
  • no
  • yes
During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_reuse_values
boolean
    Choices:
  • no
  • yes
During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_skip_crds
boolean
    Choices:
  • no
  • yes
If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
should_skip_render_subchart_notes
boolean
    Choices:
  • no
  • yes
If set, renders subchart notes along with the parent. Set to false by default.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
state
string
    Choices:
  • present ←
  • absent
The state of the DeployStage.
Use state=present to create or update a DeployStage.
Use state=absent to delete a DeployStage.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
test_load_balancer_config
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is one of ['COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT', 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT']
backend_port
integer
Listen port for the backend server.
Applicable when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
listener_name
string / required
Name of the load balancer listener.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
load_balancer_id
string / required
The OCID of the load balancer.
Required when deploy_stage_type is 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'
timeout_in_seconds
integer
Time to wait for execution of a shell stage. Defaults to 36000 seconds.
This parameter is updatable.
Applicable when deploy_stage_type is one of ['SHELL', 'OKE_HELM_CHART_DEPLOYMENT']
traffic_shift_target
string
Specifies the target or destination backend set. Example: BLUE - Traffic from the existing backends of managed Load Balance Listener to blue Backend IPs, as per rolloutPolicy. GREEN - Traffic from the existing backends of managed Load Balance Listener to blue Backend IPs ser as per rolloutPolicy.
This parameter is updatable.
Applicable when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
Required when deploy_stage_type is 'LOAD_BALANCER_TRAFFIC_SHIFT'
values_artifact_ids
list / elements=string
List of values.yaml file artifact OCIDs.
This parameter is updatable.
Applicable when deploy_stage_type is 'OKE_HELM_CHART_DEPLOYMENT'
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_criteria
dictionary
This parameter is updatable.
Applicable when deploy_stage_type is 'WAIT'
Required when deploy_stage_type is 'WAIT'
wait_duration
string / required
The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.
wait_type
string / required
    Choices:
  • ABSOLUTE_WAIT
Wait criteria type.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create deploy_stage with deploy_stage_type = OKE_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    oke_canary_deploy_stage_id: "ocid1.okecanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = OKE_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    oke_blue_green_deploy_stage_id: "ocid1.okebluegreendeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    production_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT

    # optional
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = WAIT
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: WAIT

    # optional
    wait_criteria:
      # required
      wait_type: ABSOLUTE_WAIT
      wait_duration: wait_duration_example
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = LOAD_BALANCER_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: LOAD_BALANCER_TRAFFIC_SHIFT

    # optional
    blue_backend_ips:
      # optional
      items: [ "items_example" ]
    green_backend_ips:
      # optional
      items: [ "items_example" ]
    traffic_shift_target: traffic_shift_target_example
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = SHELL
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: SHELL

    # optional
    container_config:
      # required
      container_config_type: CONTAINER_INSTANCE_CONFIG
      shape_name: shape_name_example
      shape_config:
        # required
        ocpus: 3.4

        # optional
        memory_in_gbs: 3.4
      network_channel:
        # required
        network_channel_type: SERVICE_VNIC_CHANNEL
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        nsg_ids: [ "nsg_ids_example" ]

        # optional
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
    command_spec_deploy_artifact_id: "ocid1.commandspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    compute_instance_group_blue_green_deployment_deploy_stage_id: "ocid1.computeinstancegroupbluegreendeploymentdeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = OKE_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    blue_green_strategy:
      # required
      strategy_type: NGINX_BLUE_GREEN_STRATEGY
      namespace_a: namespace_a_example
      namespace_b: namespace_b_example
      ingress_name: ingress_name_example
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_BLUE_GREEN_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT

    # optional
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = INVOKE_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: INVOKE_FUNCTION

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    is_async: true
    is_validation_enabled: true

- name: Create deploy_stage with deploy_stage_type = DEPLOY_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: DEPLOY_FUNCTION

    # optional
    docker_image_deploy_artifact_id: "ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    config: null
    max_memory_in_mbs: 56
    function_timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create deploy_stage with deploy_stage_type = OKE_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    canary_strategy:
      # required
      strategy_type: NGINX_CANARY_STRATEGY
      namespace: namespace_example
      ingress_name: ingress_name_example
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_CANARY_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    compute_instance_group_canary_deploy_stage_id: "ocid1.computeinstancegroupcanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    compute_instance_group_canary_traffic_shift_deploy_stage_id: "ocid1.computeinstancegroupcanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = OKE_HELM_CHART_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_HELM_CHART_DEPLOYMENT

    # optional
    helm_chart_deploy_artifact_id: "ocid1.helmchartdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    values_artifact_ids: [ "values_artifact_ids_example" ]
    release_name: release_name_example
    set_values:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    set_string:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    are_hooks_enabled: true
    should_reuse_values: true
    should_reset_values: true
    is_force_enabled: true
    should_cleanup_on_fail: true
    max_history: 56
    should_skip_crds: true
    should_skip_render_subchart_notes: true
    should_not_wait: true
    is_debug_enabled: true
    timeout_in_seconds: 56
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = MANUAL_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: MANUAL_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = OKE_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_DEPLOYMENT

    # optional
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_environment_id_a: deploy_environment_id_a_example
    deploy_environment_id_b: deploy_environment_id_b_example
    production_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT

    # optional
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create deploy_stage with deploy_stage_type = OKE_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    oke_canary_traffic_shift_deploy_stage_id: "ocid1.okecanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT

    # optional
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = WAIT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: WAIT

    # optional
    wait_criteria:
      # required
      wait_type: ABSOLUTE_WAIT
      wait_duration: wait_duration_example
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = LOAD_BALANCER_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: LOAD_BALANCER_TRAFFIC_SHIFT

    # optional
    blue_backend_ips:
      # optional
      items: [ "items_example" ]
    green_backend_ips:
      # optional
      items: [ "items_example" ]
    traffic_shift_target: traffic_shift_target_example
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = SHELL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: SHELL

    # optional
    container_config:
      # required
      container_config_type: CONTAINER_INSTANCE_CONFIG
      shape_name: shape_name_example
      shape_config:
        # required
        ocpus: 3.4

        # optional
        memory_in_gbs: 3.4
      network_channel:
        # required
        network_channel_type: SERVICE_VNIC_CHANNEL
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        nsg_ids: [ "nsg_ids_example" ]

        # optional
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
    command_spec_deploy_artifact_id: "ocid1.commandspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_BLUE_GREEN_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT

    # optional
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = INVOKE_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: INVOKE_FUNCTION

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    is_async: true
    is_validation_enabled: true

- name: Update deploy_stage with deploy_stage_type = DEPLOY_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: DEPLOY_FUNCTION

    # optional
    docker_image_deploy_artifact_id: "ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    config: null
    max_memory_in_mbs: 56
    function_timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update deploy_stage with deploy_stage_type = OKE_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_CANARY_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_HELM_CHART_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_HELM_CHART_DEPLOYMENT

    # optional
    helm_chart_deploy_artifact_id: "ocid1.helmchartdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    values_artifact_ids: [ "values_artifact_ids_example" ]
    release_name: release_name_example
    set_values:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    set_string:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    are_hooks_enabled: true
    should_reuse_values: true
    should_reset_values: true
    is_force_enabled: true
    should_cleanup_on_fail: true
    max_history: 56
    should_skip_crds: true
    should_skip_render_subchart_notes: true
    should_not_wait: true
    is_debug_enabled: true
    timeout_in_seconds: 56
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = MANUAL_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: MANUAL_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_DEPLOYMENT

    # optional
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT

    # optional
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage with deploy_stage_type = OKE_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT

    # optional
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = WAIT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: WAIT

    # optional
    wait_criteria:
      # required
      wait_type: ABSOLUTE_WAIT
      wait_duration: wait_duration_example
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = LOAD_BALANCER_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: LOAD_BALANCER_TRAFFIC_SHIFT

    # optional
    blue_backend_ips:
      # optional
      items: [ "items_example" ]
    green_backend_ips:
      # optional
      items: [ "items_example" ]
    traffic_shift_target: traffic_shift_target_example
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = SHELL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: SHELL

    # optional
    container_config:
      # required
      container_config_type: CONTAINER_INSTANCE_CONFIG
      shape_name: shape_name_example
      shape_config:
        # required
        ocpus: 3.4

        # optional
        memory_in_gbs: 3.4
      network_channel:
        # required
        network_channel_type: SERVICE_VNIC_CHANNEL
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        nsg_ids: [ "nsg_ids_example" ]

        # optional
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
    command_spec_deploy_artifact_id: "ocid1.commandspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_BLUE_GREEN_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT

    # optional
    compute_instance_group_deploy_environment_id: "ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = INVOKE_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: INVOKE_FUNCTION

    # optional
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    is_async: true
    is_validation_enabled: true

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = DEPLOY_FUNCTION
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: DEPLOY_FUNCTION

    # optional
    docker_image_deploy_artifact_id: "ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    config: null
    max_memory_in_mbs: 56
    function_timeout_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    function_deploy_environment_id: "ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_CANARY_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_stage_type: OKE_CANARY_DEPLOYMENT

    # optional
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT

    # optional
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_HELM_CHART_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_HELM_CHART_DEPLOYMENT

    # optional
    helm_chart_deploy_artifact_id: "ocid1.helmchartdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    values_artifact_ids: [ "values_artifact_ids_example" ]
    release_name: release_name_example
    set_values:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    set_string:
      # required
      items:
      - # required
        name: name_example
        value: value_example
    are_hooks_enabled: true
    should_reuse_values: true
    should_reset_values: true
    is_force_enabled: true
    should_cleanup_on_fail: true
    max_history: 56
    should_skip_crds: true
    should_skip_render_subchart_notes: true
    should_not_wait: true
    is_debug_enabled: true
    timeout_in_seconds: 56
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = MANUAL_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: MANUAL_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_DEPLOYMENT

    # optional
    oke_cluster_deploy_environment_id: "ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx"
    namespace: namespace_example
    rollback_policy:
      # required
      policy_type: NO_STAGE_ROLLBACK_POLICY
    kubernetes_manifest_deploy_artifact_ids: [ "kubernetes_manifest_deploy_artifact_ids_example" ]
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: >
    Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
    with deploy_stage_type = COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT

    # optional
    failure_policy:
      # required
      failure_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_PERCENTAGE
    deployment_spec_deploy_artifact_id: "ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_ids: [ "deploy_artifact_ids_example" ]
    test_load_balancer_config:
      # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      listener_name: listener_name_example

      # optional
      backend_port: 56
    rollout_policy:
      # required
      batch_percentage: 56
      policy_type: COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_PERCENTAGE

      # optional
      batch_delay_in_seconds: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with deploy_stage_type = OKE_CANARY_APPROVAL
  oci_devops_deploy_stage:
    # required
    deploy_stage_type: OKE_CANARY_APPROVAL

    # optional
    approval_policy:
      # required
      approval_policy_type: COUNT_BASED_APPROVAL
      number_of_approvals_required: 56
    description: description_example
    display_name: display_name_example
    deploy_stage_predecessor_collection:
      # required
      items:
      - # required
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete deploy_stage
  oci_devops_deploy_stage:
    # required
    deploy_stage_id: "ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete deploy_stage using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_devops_deploy_stage:
    # required
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
deploy_stage
complex
on success
Details of the DeployStage resource acted upon by the current operation

Sample:
{'approval_policy': {'approval_policy_type': 'COUNT_BASED_APPROVAL', 'number_of_approvals_required': 56}, 'are_hooks_enabled': True, 'blue_backend_ips': {'items': []}, 'blue_green_strategy': {'ingress_name': 'ingress_name_example', 'namespace_a': 'namespace_a_example', 'namespace_b': 'namespace_b_example', 'strategy_type': 'NGINX_BLUE_GREEN_STRATEGY'}, 'canary_strategy': {'ingress_name': 'ingress_name_example', 'namespace': 'namespace_example', 'strategy_type': 'NGINX_CANARY_STRATEGY'}, 'command_spec_deploy_artifact_id': 'ocid1.commandspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_instance_group_blue_green_deployment_deploy_stage_id': 'ocid1.computeinstancegroupbluegreendeploymentdeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'compute_instance_group_canary_deploy_stage_id': 'ocid1.computeinstancegroupcanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'compute_instance_group_canary_traffic_shift_deploy_stage_id': 'ocid1.computeinstancegroupcanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'compute_instance_group_deploy_environment_id': 'ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'config': {}, 'container_config': {'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'container_config_type': 'CONTAINER_INSTANCE_CONFIG', 'network_channel': {'network_channel_type': 'PRIVATE_ENDPOINT_CHANNEL', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'shape_config': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'shape_name': 'shape_name_example'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_artifact_ids': [], 'deploy_environment_id_a': 'deploy_environment_id_a_example', 'deploy_environment_id_b': 'deploy_environment_id_b_example', 'deploy_pipeline_id': 'ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_stage_predecessor_collection': {'items': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'deploy_stage_type': 'WAIT', 'deployment_spec_deploy_artifact_id': 'ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'docker_image_deploy_artifact_id': 'ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'failure_policy': {'failure_count': 56, 'failure_percentage': 56, 'policy_type': 'COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_COUNT'}, 'freeform_tags': {'Department': 'Finance'}, 'function_deploy_environment_id': 'ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'function_timeout_in_seconds': 56, 'green_backend_ips': {'items': []}, 'helm_chart_deploy_artifact_id': 'ocid1.helmchartdeployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_async': True, 'is_debug_enabled': True, 'is_force_enabled': True, 'is_validation_enabled': True, 'kubernetes_manifest_deploy_artifact_ids': [], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'load_balancer_config': {'backend_port': 56, 'listener_name': 'listener_name_example', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx'}, 'max_history': 56, 'max_memory_in_mbs': 56, 'namespace': 'namespace_example', 'oke_blue_green_deploy_stage_id': 'ocid1.okebluegreendeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'oke_canary_deploy_stage_id': 'ocid1.okecanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'oke_canary_traffic_shift_deploy_stage_id': 'ocid1.okecanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx', 'oke_cluster_deploy_environment_id': 'ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'production_load_balancer_config': {'backend_port': 56, 'listener_name': 'listener_name_example', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx'}, 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'release_name': 'release_name_example', 'rollback_policy': {'policy_type': 'AUTOMATED_STAGE_ROLLBACK_POLICY'}, 'rollout_policy': {'batch_count': 56, 'batch_delay_in_seconds': 56, 'batch_percentage': 56, 'policy_type': 'COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_COUNT', 'ramp_limit_percent': 3.4}, 'set_string': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'set_values': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'should_cleanup_on_fail': True, 'should_not_wait': True, 'should_reset_values': True, 'should_reuse_values': True, 'should_skip_crds': True, 'should_skip_render_subchart_notes': True, 'system_tags': {}, 'test_load_balancer_config': {'backend_port': 56, 'listener_name': 'listener_name_example', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'timeout_in_seconds': 56, 'traffic_shift_target': 'AUTO_SELECT', 'values_artifact_ids': [], 'wait_criteria': {'wait_duration': 'wait_duration_example', 'wait_type': 'ABSOLUTE_WAIT'}}
 
approval_policy
complex
on success

   
approval_policy_type
string
on success
Approval policy type.

Sample:
COUNT_BASED_APPROVAL
   
number_of_approvals_required
integer
on success
A minimum number of approvals required for stage to proceed.

Sample:
56
 
are_hooks_enabled
boolean
on success
Disable pre/post upgrade hooks. Set to false by default.

Sample:
True
 
blue_backend_ips
complex
on success

   
items
list / elements=string
on success
The IP address of the backend server. A server could be a compute instance or a load balancer.

 
blue_green_strategy
complex
on success

   
ingress_name
string
on success
Name of the Ingress resource.

Sample:
ingress_name_example
   
namespace_a
string
on success
Namespace A for deployment. Example: namespaceA - first Namespace name.

Sample:
namespace_a_example
   
namespace_b
string
on success
Namespace B for deployment. Example: namespaceB - second Namespace name.

Sample:
namespace_b_example
   
strategy_type
string
on success
Blue-Green strategy type.

Sample:
NGINX_BLUE_GREEN_STRATEGY
 
canary_strategy
complex
on success

   
ingress_name
string
on success
Name of the Ingress resource.

Sample:
ingress_name_example
   
namespace
string
on success
Canary namespace to be used for Kubernetes canary deployment. Example: canary - Name of the Canary namespace.

Sample:
namespace_example
   
strategy_type
string
on success
Canary strategy type.

Sample:
NGINX_CANARY_STRATEGY
 
command_spec_deploy_artifact_id
string
on success
The OCID of the artifact that contains the command specification.

Sample:
ocid1.commandspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of a compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
compute_instance_group_blue_green_deployment_deploy_stage_id
string
on success
The OCID of the upstream compute instance group blue-green deployment stage in this pipeline.

Sample:
ocid1.computeinstancegroupbluegreendeploymentdeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
compute_instance_group_canary_deploy_stage_id
string
on success
The OCID of an upstream compute instance group canary deployment stage ID in this pipeline.

Sample:
ocid1.computeinstancegroupcanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
compute_instance_group_canary_traffic_shift_deploy_stage_id
string
on success
A compute instance group canary traffic shift stage OCID for load balancer.

Sample:
ocid1.computeinstancegroupcanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
compute_instance_group_deploy_environment_id
string
on success
A compute instance group environment OCID for Canary deployment.

Sample:
ocid1.computeinstancegroupdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
config
dictionary
on success
User provided key and value pair configuration, which is assigned through constants or parameter.

 
container_config
complex
on success

   
availability_domain
string
on success
Availability domain where the ContainerInstance will be created.

Sample:
Uocm:PHX-AD-1
   
compartment_id
string
on success
The OCID of the compartment where the ContainerInstance will be created.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
container_config_type
string
on success
Container configuration type.

Sample:
CONTAINER_INSTANCE_CONFIG
   
network_channel
complex
on success

     
network_channel_type
string
on success
Network channel type.

Sample:
PRIVATE_ENDPOINT_CHANNEL
     
nsg_ids
list / elements=string
on success
An array of network security group OCIDs.

     
subnet_id
string
on success
The OCID of the subnet where VNIC resources will be created for private endpoint.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
shape_config
complex
on success

     
memory_in_gbs
float
on success
The total amount of memory available to the instance, in gigabytes.

Sample:
3.4
     
ocpus
float
on success
The total number of OCPUs available to the instance.

Sample:
3.4
   
shape_name
string
on success
The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance.

Sample:
shape_name_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
deploy_artifact_id
string
on success
Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

Sample:
ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
deploy_artifact_ids
list / elements=string
on success
The list of file artifact OCIDs to deploy.

 
deploy_environment_id_a
string
on success
First compute instance group environment OCID for deployment.

Sample:
deploy_environment_id_a_example
 
deploy_environment_id_b
string
on success
Second compute instance group environment OCID for deployment.

Sample:
deploy_environment_id_b_example
 
deploy_pipeline_id
string
on success
The OCID of a pipeline.

Sample:
ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx
 
deploy_stage_predecessor_collection
complex
on success

   
items
complex
on success
A list of stage predecessors for a stage.

     
id
string
on success
The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
deploy_stage_type
string
on success
Deployment stage type.

Sample:
WAIT
 
deployment_spec_deploy_artifact_id
string
on success
The OCID of the artifact that contains the deployment specification.

Sample:
ocid1.deploymentspecdeployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
Optional description about the deployment stage.

Sample:
description_example
 
display_name
string
on success
Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Sample:
display_name_example
 
docker_image_deploy_artifact_id
string
on success
A Docker image artifact OCID.

Sample:
ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
failure_policy
complex
on success

   
failure_count
integer
on success
The threshold count of failed instances in the group, which when reached or exceeded sets the stage as Failed.

Sample:
56
   
failure_percentage
integer
on success
The failure percentage threshold, which when reached or exceeded sets the stage as Failed. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group.

Sample:
56
   
policy_type
string
on success
Specifies if the failure instance size is given by absolute number or by percentage.

Sample:
COMPUTE_INSTANCE_GROUP_FAILURE_POLICY_BY_COUNT
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
function_deploy_environment_id
string
on success
Function environment OCID.

Sample:
ocid1.functiondeployenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
function_timeout_in_seconds
integer
on success
Timeout for execution of the Function. Value in seconds.

Sample:
56
 
green_backend_ips
complex
on success

   
items
list / elements=string
on success
The IP address of the backend server. A server could be a compute instance or a load balancer.

 
helm_chart_deploy_artifact_id
string
on success
Helm chart artifact OCID.

Sample:
ocid1.helmchartdeployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
Unique identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_async
boolean
on success
A boolean flag specifies whether this stage executes asynchronously.

Sample:
True
 
is_debug_enabled
boolean
on success
Enables helm --debug option to stream output to tf stdout. Set to false by default.

Sample:
True
 
is_force_enabled
boolean
on success
Force resource update through delete; or if required, recreate. Set to false by default.

Sample:
True
 
is_validation_enabled
boolean
on success
A boolean flag specifies whether the invoked function must be validated.

Sample:
True
 
kubernetes_manifest_deploy_artifact_ids
list / elements=string
on success
List of Kubernetes manifest artifact OCIDs

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

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the deployment stage.

Sample:
CREATING
 
load_balancer_config
complex
on success

   
backend_port
integer
on success
Listen port for the backend server.

Sample:
56
   
listener_name
string
on success
Name of the load balancer listener.

Sample:
listener_name_example
   
load_balancer_id
string
on success
The OCID of the load balancer.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
 
max_history
integer
on success
Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default

Sample:
56
 
max_memory_in_mbs
integer
on success
Maximum usable memory for the Function (in MB).

Sample:
56
 
namespace
string
on success
Default namespace to be used for Kubernetes deployment when not specified in the manifest.

Sample:
namespace_example
 
oke_blue_green_deploy_stage_id
string
on success
The OCID of the upstream OKE blue-green deployment stage in this pipeline.

Sample:
ocid1.okebluegreendeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
oke_canary_deploy_stage_id
string
on success
The OCID of an upstream OKE canary deployment stage in this pipeline.

Sample:
ocid1.okecanarydeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
oke_canary_traffic_shift_deploy_stage_id
string
on success
The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline.

Sample:
ocid1.okecanarytrafficshiftdeploystage.oc1..xxxxxxEXAMPLExxxxxx
 
oke_cluster_deploy_environment_id
string
on success
Kubernetes cluster environment OCID for deployment.

Sample:
ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
production_load_balancer_config
complex
on success

   
backend_port
integer
on success
Listen port for the backend server.

Sample:
56
   
listener_name
string
on success
Name of the load balancer listener.

Sample:
listener_name_example
   
load_balancer_id
string
on success
The OCID of the load balancer.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
 
project_id
string
on success
The OCID of a project.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
release_name
string
on success
Release name of the Helm chart.

Sample:
release_name_example
 
rollback_policy
complex
on success

   
policy_type
string
on success
Specifies type of the deployment stage rollback policy.

Sample:
AUTOMATED_STAGE_ROLLBACK_POLICY
 
rollout_policy
complex
on success

   
batch_count
integer
on success
The number that will be used to determine how many instances will be deployed concurrently.

Sample:
56
   
batch_delay_in_seconds
integer
on success
The duration of delay between batch rollout. The default delay is 1 minute.

Sample:
56
   
batch_percentage
integer
on success
The percentage that will be used to determine how many instances will be deployed concurrently.

Sample:
56
   
policy_type
string
on success
The type of policy used for rolling out a deployment stage.

Sample:
COMPUTE_INSTANCE_GROUP_LINEAR_ROLLOUT_POLICY_BY_COUNT
   
ramp_limit_percent
float
on success
Indicates the criteria to stop.

Sample:
3.4
 
set_string
complex
on success

   
items
complex
on success
List of parameters defined to set helm value.

     
name
string
on success
Name of the parameter (case-sensitive).

Sample:
name_example
     
value
string
on success
Value of the parameter.

Sample:
value_example
 
set_values
complex
on success

   
items
complex
on success
List of parameters defined to set helm value.

     
name
string
on success
Name of the parameter (case-sensitive).

Sample:
name_example
     
value
string
on success
Value of the parameter.

Sample:
value_example
 
should_cleanup_on_fail
boolean
on success
Allow deletion of new resources created during when an upgrade fails. Set to false by default.

Sample:
True
 
should_not_wait
boolean
on success
Waits until all the resources are in a ready state to mark the release as successful. Set to false by default.

Sample:
True
 
should_reset_values
boolean
on success
During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default.

Sample:
True
 
should_reuse_values
boolean
on success
During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default.

Sample:
True
 
should_skip_crds
boolean
on success
If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default.

Sample:
True
 
should_skip_render_subchart_notes
boolean
on success
If set, renders subchart notes along with the parent. Set to false by default.

Sample:
True
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
test_load_balancer_config
complex
on success

   
backend_port
integer
on success
Listen port for the backend server.

Sample:
56
   
listener_name
string
on success
Name of the load balancer listener.

Sample:
listener_name_example
   
load_balancer_id
string
on success
The OCID of the load balancer.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
Time the deployment stage was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Time the deployment stage was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
timeout_in_seconds
integer
on success
Time to wait for execution of a helm stage. Defaults to 300 seconds.

Sample:
56
 
traffic_shift_target
string
on success
Specifies the target or destination backend set. Example: BLUE - Traffic from the existing backends of managed Load Balance Listener to blue Backend IPs, as per rolloutPolicy. GREEN - Traffic from the existing backends of managed Load Balance Listener to green Backend IPs as per rolloutPolicy.

Sample:
AUTO_SELECT
 
values_artifact_ids
list / elements=string
on success
List of values.yaml file artifact OCIDs.

 
wait_criteria
complex
on success

   
wait_duration
string
on success
The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days.

Sample:
wait_duration_example
   
wait_type
string
on success
Wait criteria type.

Sample:
ABSOLUTE_WAIT


Authors

  • Oracle (@oracle)