oracle.oci.oci_devops_build_pipeline_stage_facts – Fetches details about one or multiple BuildPipelineStage resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of all stages in a compartment or build pipeline.

  • If build_pipeline_stage_id is specified, the details of a single BuildPipelineStage 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.
build_pipeline_id
string
The OCID of the parent build pipeline.
build_pipeline_stage_id
string
Unique stage identifier.
Required to get a specific build_pipeline_stage.

aliases: id
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.
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 the 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 build_pipeline_stage
  oci_devops_build_pipeline_stage_facts:
    # required
    build_pipeline_stage_id: "ocid1.buildpipelinestage.oc1..xxxxxxEXAMPLExxxxxx"

- name: List build_pipeline_stages
  oci_devops_build_pipeline_stage_facts:

    # optional
    build_pipeline_id: "ocid1.buildpipeline.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
build_pipeline_stages
complex
on success
List of BuildPipelineStage resources

Sample:
[{'build_pipeline_id': 'ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx', 'build_pipeline_stage_predecessor_collection': {'items': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'build_pipeline_stage_type': 'WAIT', 'build_source_collection': {'items': [{'branch': 'branch_example', 'connection_id': 'ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx', 'connection_type': 'GITHUB', 'name': 'name_example', 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'repository_url': 'repository_url_example'}]}, 'build_spec_file': 'build_spec_file_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deliver_artifact_collection': {'items': [{'artifact_id': 'ocid1.artifact.oc1..xxxxxxEXAMPLExxxxxx', 'artifact_name': 'artifact_name_example'}]}, 'deploy_pipeline_id': 'ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image': 'OL7_X86_64_STANDARD_10', 'is_pass_all_parameters_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'primary_build_source': 'primary_build_source_example', 'private_access_config': {'network_channel_type': 'PRIVATE_ENDPOINT_CHANNEL', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'stage_execution_timeout_in_seconds': 56, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'wait_criteria': {'wait_duration': 'wait_duration_example', 'wait_type': 'ABSOLUTE_WAIT'}}]
 
build_pipeline_id
string
on success
The OCID of the build pipeline.

Sample:
ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx
 
build_pipeline_stage_predecessor_collection
complex
on success

   
items
complex
on success
A list of build pipeline 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
 
build_pipeline_stage_type
string
on success
Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.

Sample:
WAIT
 
build_source_collection
complex
on success
Returned for get operation

   
items
complex
on success
Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported.

     
branch
string
on success
Branch name.

Sample:
branch_example
     
connection_id
string
on success
Connection identifier pertinent to Bitbucket Cloud source provider

Sample:
ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx
     
connection_type
string
on success
The type of source provider.

Sample:
GITHUB
     
name
string
on success
Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository.

Sample:
name_example
     
repository_id
string
on success
The DevOps code repository ID.

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
     
repository_url
string
on success
URL for the repository.

Sample:
repository_url_example
 
build_spec_file
string
on success
The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml.
Returned for get operation

Sample:
build_spec_file_example
 
compartment_id
string
on success
The OCID of the compartment where the pipeline is created.

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'}}
 
deliver_artifact_collection
complex
on success
Returned for get operation

   
items
complex
on success
Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported.

     
artifact_id
string
on success
Artifact identifier that contains the artifact definition.

Sample:
ocid1.artifact.oc1..xxxxxxEXAMPLExxxxxx
     
artifact_name
string
on success
Name of the artifact specified in the build_spec.yaml file.

Sample:
artifact_name_example
 
deploy_pipeline_id
string
on success
A target deployment pipeline OCID that will run in this stage.
Returned for get operation

Sample:
ocid1.deploypipeline.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
Optional description about the build stage.

Sample:
description_example
 
display_name
string
on success
Stage display name, 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
 
image
string
on success
Image name for the build environment.
Returned for get operation

Sample:
OL7_X86_64_STANDARD_10
 
is_pass_all_parameters_enabled
boolean
on success
A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered.
Returned for get operation

Sample:
True
 
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 stage.

Sample:
CREATING
 
primary_build_source
string
on success
Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source.
Returned for get operation

Sample:
primary_build_source_example
 
private_access_config
complex
on success
Returned for get operation

   
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
 
project_id
string
on success
The OCID of the DevOps project.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
stage_execution_timeout_in_seconds
integer
on success
Timeout for the build stage execution. Specify value in seconds.
Returned for get operation

Sample:
56
 
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
The time the stage was created. Format defined by RFC3339.

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

Sample:
2013-10-20T19:20:30+01:00
 
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)