oracle.oci.oci_devops_deployment_facts – Fetches details about one or multiple Deployment resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_deployment_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Deployment resources in Oracle Cloud Infrastructure
Returns a list of deployments.
If deployment_id is specified, the details of a single Deployment will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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.
|
|
deployment_id
string
|
Unique deployment identifier.
Required to get a specific deployment.
aliases: id |
|
display_name
string
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only Deployments that matches the given lifecycleState.
|
project_id
string
|
unique project identifier
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
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
|
|
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 |
|
time_created_greater_than_or_equal_to
string
|
Search for DevOps resources that were created after a specific date. Specifying this parameter corresponding to `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all security assessments created after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC3339.
|
|
time_created_less_than
string
|
Search for DevOps resources that were created before a specific date. Specifying this parameter corresponding to `timeCreatedLessThan` parameter will retrieve all assessments created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC3339.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific deployment
oci_devops_deployment_facts:
# required
deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List deployments
oci_devops_deployment_facts:
# optional
deploy_pipeline_id: "ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: ACCEPTED
display_name: display_name_example
sort_order: ASC
sort_by: timeCreated
time_created_less_than: 2013-10-20T19:20:30+01:00
time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||||
---|---|---|---|---|---|---|---|
deployments
complex
|
on success |
List of Deployment resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deploy_artifact_override_arguments': {'items': [{'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'value': 'value_example'}]}, 'deploy_pipeline_artifacts': {'items': [{'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_pipeline_stages': {'items': [{'deploy_stage_id': 'ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example'}]}, 'display_name': 'display_name_example'}]}, 'deploy_pipeline_environments': {'items': [{'deploy_environment_id': 'ocid1.deployenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_pipeline_stages': {'items': [{'deploy_stage_id': 'ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example'}]}, 'display_name': 'display_name_example'}]}, 'deploy_pipeline_id': 'ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_stage_id': 'ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_stage_override_arguments': {'items': [{'deploy_stage_id': 'ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'value': 'value_example'}]}, 'deployment_arguments': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'deployment_execution_progress': {'deploy_stage_execution_progress': {'approval_actions': [{'action': 'APPROVE', 'reason': 'reason_example', 'subject_id': 'ocid1.subject.oc1..xxxxxxEXAMPLExxxxxx'}], 'chart_url': 'chart_url_example', 'deploy_stage_display_name': 'deploy_stage_display_name_example', 'deploy_stage_execution_progress_details': [{'rollback_steps': [{'name': 'name_example', 'state': 'WAITING', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'steps': [{'name': 'name_example', 'state': 'WAITING', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'target_group': 'target_group_example', 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx'}], 'deploy_stage_id': 'ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_stage_predecessors': {'items': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'deploy_stage_type': 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT', 'environment_id': 'ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx', 'helm_diff': 'helm_diff_example', 'namespace': 'namespace_example', 'release_name': 'release_name_example', 'status': 'ACCEPTED', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}, 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'deployment_type': 'PIPELINE_DEPLOYMENT', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', 'previous_deployment_id': 'ocid1.previousdeployment.oc1..xxxxxxEXAMPLExxxxxx', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|||||
compartment_id
string
|
on success |
The OCID of a compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
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_override_arguments
complex
|
on success |
|
|||||
items
complex
|
on success |
List of artifact override arguments at the time of deployment.
|
|||||
deploy_artifact_id
string
|
on success |
The OCID of the artifact to which this parameter applies.
Sample:
ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
name
string
|
on success |
Name of the parameter (case-sensitive).
Sample:
name_example
|
|||||
value
string
|
on success |
Value of the parameter.
Sample:
value_example
|
|||||
deploy_pipeline_artifacts
complex
|
on success |
Returned for get operation
|
|||||
items
complex
|
on success |
List of all artifacts used in the pipeline.
|
|||||
deploy_artifact_id
string
|
on success |
The OCID of an artifact
Sample:
ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_pipeline_stages
complex
|
on success |
|
|||||
items
complex
|
on success |
List of stages.
|
|||||
deploy_stage_id
string
|
on success |
The OCID of a stage
Sample:
ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
display_name
string
|
on success |
Display name of the stage. Avoid entering confidential information.
Sample:
display_name_example
|
|||||
display_name
string
|
on success |
Display name of the artifact. Avoid entering confidential information.
Sample:
display_name_example
|
|||||
deploy_pipeline_environments
complex
|
on success |
Returned for get operation
|
|||||
items
complex
|
on success |
List of all environments used in the pipeline.
|
|||||
deploy_environment_id
string
|
on success |
The OCID of an Environment
Sample:
ocid1.deployenvironment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_pipeline_stages
complex
|
on success |
|
|||||
items
complex
|
on success |
List of stages.
|
|||||
deploy_stage_id
string
|
on success |
The OCID of a stage
Sample:
ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
display_name
string
|
on success |
Display name of the stage. Avoid entering confidential information.
Sample:
display_name_example
|
|||||
display_name
string
|
on success |
Display name of the environment. Avoid entering confidential information.
Sample:
display_name_example
|
|||||
deploy_pipeline_id
string
|
on success |
The OCID of a pipeline.
Sample:
ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_stage_id
string
|
on success |
Specifies the OCID of the stage to be deployed.
Returned for get operation
Sample:
ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_stage_override_arguments
complex
|
on success |
|
|||||
items
complex
|
on success |
List of artifact override arguments at the time of deployment.
|
|||||
deploy_stage_id
string
|
on success |
The OCID of the stage.
Sample:
ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
name
string
|
on success |
Name of the parameter (case-sensitive).
Sample:
name_example
|
|||||
value
string
|
on success |
Value of the parameter.
Sample:
value_example
|
|||||
deployment_arguments
complex
|
on success |
|
|||||
items
complex
|
on success |
List of arguments provided at the time of deployment.
|
|||||
name
string
|
on success |
Name of the parameter (case-sensitive).
Sample:
name_example
|
|||||
value
string
|
on success |
value of the argument.
Sample:
value_example
|
|||||
deployment_execution_progress
complex
|
on success |
Returned for get operation
|
|||||
deploy_stage_execution_progress
complex
|
on success |
Map of stage OCIDs to deploy stage execution progress model.
|
|||||
approval_actions
complex
|
on success |
Specifies the Canary approval actions.
|
|||||
action
string
|
on success |
The action of the user on the DevOps deployment stage.
Sample:
APPROVE
|
|||||
reason
string
|
on success |
The reason for approving or rejecting the deployment.
Sample:
reason_example
|
|||||
subject_id
string
|
on success |
The subject ID of the user who approves or disapproves a DevOps deployment stage.
Sample:
ocid1.subject.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
chart_url
string
|
on success |
The URL of an OCIR repository.
Sample:
chart_url_example
|
|||||
deploy_stage_display_name
string
|
on success |
Stage display name. Avoid entering confidential information.
Sample:
deploy_stage_display_name_example
|
|||||
deploy_stage_execution_progress_details
complex
|
on success |
Details about stage execution for all the target environments.
|
|||||
rollback_steps
complex
|
on success |
Details about all the rollback steps for one target environment.
|
|||||
name
string
|
on success |
Name of the step.
Sample:
name_example
|
|||||
state
string
|
on success |
State of the step.
Sample:
WAITING
|
|||||
time_finished
string
|
on success |
Time when the step finished.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_started
string
|
on success |
Time when the step started.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
steps
complex
|
on success |
Details about all the steps for one target environment.
|
|||||
name
string
|
on success |
Name of the step.
Sample:
name_example
|
|||||
state
string
|
on success |
State of the step.
Sample:
WAITING
|
|||||
time_finished
string
|
on success |
Time when the step finished.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_started
string
|
on success |
Time when the step started.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
target_group
string
|
on success |
Group for the target environment for example, the batch number for an Instance Group deployment.
Sample:
target_group_example
|
|||||
target_id
string
|
on success |
The function ID, instance ID or the cluster ID. For Wait stage it will be the stage ID.
Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_stage_id
string
|
on success |
The OCID of the stage.
Sample:
ocid1.deploystage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
deploy_stage_predecessors
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:
COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT
|
|||||
environment_id
string
|
on success |
The OCID of the environment where the artifacts were deployed.
Sample:
ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
helm_diff
string
|
on success |
Helm Diff output Example: Helm diff was successful data: - greeting: Version 1.0 + greeting: Version 1.1
Sample:
helm_diff_example
|
|||||
namespace
string
|
on success |
Namespace either environment A or environment B where artifacts are deployed. Example: blue - Name of the namespace where blue artifacts were deployed. green - Name of the namespace where green artifacts were deployed.
Sample:
namespace_example
|
|||||
release_name
string
|
on success |
Release name of the Helm chart.
Sample:
release_name_example
|
|||||
status
string
|
on success |
The current state of the stage.
Sample:
ACCEPTED
|
|||||
time_finished
string
|
on success |
Time the stage finished executing. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_started
string
|
on success |
Time the stage started executing. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
version
string
|
on success |
The version of the helm chart stored in OCIR repository.
Sample:
version_example
|
|||||
time_finished
string
|
on success |
Time the deployment is finished. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_started
string
|
on success |
Time the deployment is started. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
deployment_type
string
|
on success |
Specifies type of deployment.
Sample:
PIPELINE_DEPLOYMENT
|
|||||
display_name
string
|
on success |
Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information.
Sample:
display_name_example
|
|||||
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'}
|
|||||
id
string
|
on success |
Unique identifier that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
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.
Sample:
ACCEPTED
|
|||||
previous_deployment_id
string
|
on success |
Specifies the OCID of the previous deployment to be redeployed.
Returned for get operation
Sample:
ocid1.previousdeployment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
project_id
string
|
on success |
The OCID of a project.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
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"}}`
|
|||||
time_created
string
|
on success |
Time the deployment was created. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_updated
string
|
on success |
Time the deployment was updated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)