oracle.oci.oci_devops_deploy_stage_facts – Fetches details about one or multiple DeployStage resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DeployStage resources in Oracle Cloud Infrastructure

  • Retrieves a list of deployment stages.

  • If deploy_stage_id is specified, the details of a single DeployStage will be returned.

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).
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.
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.
compartment_id
string
The OCID of the compartment in which to list resources.
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.
deploy_pipeline_id
string
The ID of the parent pipeline.
deploy_stage_id
string
Unique stage identifier.
Required to get a specific deploy_stage.

aliases: id
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only deployment stages that matches the given lifecycle state.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use. Use either ascending or descending.
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

Examples

- name: Get a specific deploy_stage
  oci_devops_deploy_stage_facts:
    # required
    deploy_stage_id: "ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx"

- name: List deploy_stages
  oci_devops_deploy_stage_facts:

    # optional
    deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
deploy_stages
complex
on success
List of DeployStage resources

Sample:
[{'approval_policy': {'approval_policy_type': 'COUNT_BASED_APPROVAL', 'number_of_approvals_required': 56}, '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'}, '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': {}, '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_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_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}, '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
Returned for get operation

   
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
 
blue_backend_ips
complex
on success
Returned for get operation

   
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
Returned for get operation

   
ingress_name
string
on success
Name of the Ingress resource.

Sample:
ingress_name_example
   
namespace_a
string
on success
Namespace A for deployment.

Sample:
namespace_a_example
   
namespace_b
string
on success
Namespace B for deployment.

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

Sample:
NGINX_BLUE_GREEN_STRATEGY
 
canary_strategy
complex
on success
Returned for get operation

   
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.

Sample:
namespace_example
   
strategy_type
string
on success
Canary strategy type.

Sample:
NGINX_CANARY_STRATEGY
 
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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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

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

 
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.
Returned for get operation

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

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

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

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.
Returned for get operation

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.
Returned for get operation

Sample:
ocid1.dockerimagedeployartifact.oc1..xxxxxxEXAMPLExxxxxx
 
failure_policy
complex
on success
Returned for get operation

   
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.
Returned for get operation

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

Sample:
56
 
green_backend_ips
complex
on success
Returned for get operation

   
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.
Returned for get operation

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.
Returned for get operation

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

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

 
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
Returned for get operation

   
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_memory_in_mbs
integer
on success
Maximum usable memory for the Function (in MB).
Returned for get operation

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

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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

Sample:
ocid1.okeclusterdeployenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
production_load_balancer_config
complex
on success
Returned for get operation

   
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.
Returned for get operation

Sample:
release_name_example
 
rollback_policy
complex
on success
Returned for get operation

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

Sample:
AUTOMATED_STAGE_ROLLBACK_POLICY
 
rollout_policy
complex
on success
Returned for get operation

   
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
 
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
Returned for get operation

   
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.
Returned for get operation

Sample:
56
 
traffic_shift_target
string
on success
Specifies the target or destination backend set.
Returned for get operation

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

 
wait_criteria
complex
on success
Returned for get operation

   
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)