oracle.oci.oci_devops_build_run_actions – Perform actions on a BuildRun resource 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_build_run_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a BuildRun resource in Oracle Cloud Infrastructure

  • For action=cancel, cancels the build run based on the build run ID provided in the request.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • cancel
The action to perform on the BuildRun.
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_run_id
string / required
Unique build run identifier.

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.
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.
reason
string / required
The reason for canceling the build run.
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.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
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: Perform action cancel on build_run
  oci_devops_build_run_actions:
    # required
    reason: reason_example
    build_run_id: "ocid1.buildrun.oc1..xxxxxxEXAMPLExxxxxx"
    action: cancel

Return Values

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

Key Returned Description
build_run
complex
on success
Details of the BuildRun resource acted upon by the current operation

Sample:
{'build_outputs': {'artifact_override_parameters': {'items': [{'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'value': 'value_example'}]}, 'delivered_artifacts': {'items': [{'artifact_repository_id': 'ocid1.artifactrepository.oc1..xxxxxxEXAMPLExxxxxx', 'artifact_type': 'GENERIC_ARTIFACT', 'delivered_artifact_hash': 'delivered_artifact_hash_example', 'delivered_artifact_id': 'ocid1.deliveredartifact.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'image_uri': 'image_uri_example', 'output_artifact_name': 'output_artifact_name_example', 'path': 'path_example', 'version': 'version_example'}]}, 'exported_variables': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'vulnerability_audit_summary_collection': {'items': [{'build_stage_id': 'ocid1.buildstage.oc1..xxxxxxEXAMPLExxxxxx', 'commit_hash': 'commit_hash_example', 'vulnerability_audit_id': 'ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx'}]}}, 'build_pipeline_id': 'ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx', 'build_run_arguments': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'build_run_progress': {'build_pipeline_stage_run_progress': {'actual_build_runner_shape': 'actual_build_runner_shape_example', 'actual_build_runner_shape_config': {'memory_in_gbs': 1.2, 'ocpus': 1.2}, 'artifact_override_parameters': {'items': [{'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'value': 'value_example'}]}, 'build_pipeline_stage_id': 'ocid1.buildpipelinestage.oc1..xxxxxxEXAMPLExxxxxx', 'build_pipeline_stage_predecessors': {'items': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'build_pipeline_stage_type': 'BUILD', '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', 'delivered_artifacts': {'items': [{'artifact_repository_id': 'ocid1.artifactrepository.oc1..xxxxxxEXAMPLExxxxxx', 'artifact_type': 'GENERIC_ARTIFACT', 'delivered_artifact_hash': 'delivered_artifact_hash_example', 'delivered_artifact_id': 'ocid1.deliveredartifact.oc1..xxxxxxEXAMPLExxxxxx', 'deploy_artifact_id': 'ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx', 'image_uri': 'image_uri_example', 'output_artifact_name': 'output_artifact_name_example', 'path': 'path_example', 'version': 'version_example'}]}, 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'exported_variables': {'items': [{'name': 'name_example', 'value': 'value_example'}]}, 'image': 'OL7_X86_64_STANDARD_10', 'primary_build_source': 'primary_build_source_example', 'private_access_config': {'network_channel_type': 'PRIVATE_ENDPOINT_CHANNEL', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'stage_display_name': 'stage_display_name_example', 'stage_execution_timeout_in_seconds': 56, 'status': 'ACCEPTED', 'steps': [{'name': 'name_example', 'state': 'WAITING', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'build_run_source': {'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'MANUAL', 'trigger_id': 'ocid1.trigger.oc1..xxxxxxEXAMPLExxxxxx', 'trigger_info': {'actions': [{'build_pipeline_id': 'ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx', 'filter': {'events': [], 'exclude': {'file_filter': {'file_paths': []}}, 'include': {'base_ref': 'base_ref_example', 'file_filter': {'file_paths': []}, 'head_ref': 'head_ref_example', 'repository_name': 'repository_name_example'}, 'trigger_source': 'BITBUCKET_CLOUD'}, 'type': 'TRIGGER_BUILD_PIPELINE'}], 'display_name': 'display_name_example'}}, 'commit_info': {'commit_hash': 'commit_hash_example', 'repository_branch': 'repository_branch_example', 'repository_url': 'repository_url_example'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', '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'}
 
build_outputs
complex
on success

   
artifact_override_parameters
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
   
delivered_artifacts
complex
on success

     
items
complex
on success
List of artifacts delivered through the Deliver Artifacts stage.

       
artifact_repository_id
string
on success
The OCID of the artifact registry repository used by the DeliverArtifactStage

Sample:
ocid1.artifactrepository.oc1..xxxxxxEXAMPLExxxxxx
       
artifact_type
string
on success
Type of artifact delivered.

Sample:
GENERIC_ARTIFACT
       
delivered_artifact_hash
string
on success
The hash of the container registry artifact pushed by the Deliver Artifacts stage.

Sample:
delivered_artifact_hash_example
       
delivered_artifact_id
string
on success
The OCID of the artifact pushed by the Deliver Artifacts stage.

Sample:
ocid1.deliveredartifact.oc1..xxxxxxEXAMPLExxxxxx
       
deploy_artifact_id
string
on success
The OCID of the deployment artifact definition.

Sample:
ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx
       
image_uri
string
on success
The imageUri of the OCIR artifact pushed by the DeliverArtifactStage

Sample:
image_uri_example
       
output_artifact_name
string
on success
Name of the output artifact defined in the build specification file.

Sample:
output_artifact_name_example
       
path
string
on success
Path of the repository where artifact was pushed

Sample:
path_example
       
version
string
on success
Version of the artifact pushed

Sample:
version_example
   
exported_variables
complex
on success

     
items
complex
on success
List of exported variables.

       
name
string
on success
Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.

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

Sample:
value_example
   
vulnerability_audit_summary_collection
complex
on success

     
items
complex
on success
List of vulnerability audit summary.

       
build_stage_id
string
on success
Build stage OCID where scan was configured.

Sample:
ocid1.buildstage.oc1..xxxxxxEXAMPLExxxxxx
       
commit_hash
string
on success
Commit hash used while retrieving the pom file for vulnerabilityAudit.

Sample:
commit_hash_example
       
vulnerability_audit_id
string
on success
The OCID of the vulnerability audit.

Sample:
ocid1.vulnerabilityaudit.oc1..xxxxxxEXAMPLExxxxxx
 
build_pipeline_id
string
on success
The OCID of the build pipeline.

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

   
items
complex
on success
List of arguments provided at the time of running the build.

     
name
string
on success
Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

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

Sample:
value_example
 
build_run_progress
complex
on success

   
build_pipeline_stage_run_progress
complex
on success
Map of stage OCIDs to build pipeline stage run progress model.

     
actual_build_runner_shape
string
on success
Name of Build Runner shape where this Build Stage is running.

Sample:
actual_build_runner_shape_example
     
actual_build_runner_shape_config
complex
on success

       
memory_in_gbs
float
on success
The total amount of memory set for the instance in gigabytes.

Sample:
1.2
       
ocpus
float
on success
The total number of OCPUs set for the instance.

Sample:
1.2
     
artifact_override_parameters
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
     
build_pipeline_stage_id
string
on success
The stage OCID.

Sample:
ocid1.buildpipelinestage.oc1..xxxxxxEXAMPLExxxxxx
     
build_pipeline_stage_predecessors
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
Stage types.

Sample:
BUILD
     
build_source_collection
complex
on success

       
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 if not specified is build_spec.yaml

Sample:
build_spec_file_example
     
delivered_artifacts
complex
on success

       
items
complex
on success
List of artifacts delivered through the Deliver Artifacts stage.

         
artifact_repository_id
string
on success
The OCID of the artifact registry repository used by the DeliverArtifactStage

Sample:
ocid1.artifactrepository.oc1..xxxxxxEXAMPLExxxxxx
         
artifact_type
string
on success
Type of artifact delivered.

Sample:
GENERIC_ARTIFACT
         
delivered_artifact_hash
string
on success
The hash of the container registry artifact pushed by the Deliver Artifacts stage.

Sample:
delivered_artifact_hash_example
         
delivered_artifact_id
string
on success
The OCID of the artifact pushed by the Deliver Artifacts stage.

Sample:
ocid1.deliveredartifact.oc1..xxxxxxEXAMPLExxxxxx
         
deploy_artifact_id
string
on success
The OCID of the deployment artifact definition.

Sample:
ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx
         
image_uri
string
on success
The imageUri of the OCIR artifact pushed by the DeliverArtifactStage

Sample:
image_uri_example
         
output_artifact_name
string
on success
Name of the output artifact defined in the build specification file.

Sample:
output_artifact_name_example
         
path
string
on success
Path of the repository where artifact was pushed

Sample:
path_example
         
version
string
on success
Version of the artifact pushed

Sample:
version_example
     
deployment_id
string
on success
Identifier of the deployment triggered.

Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
     
exported_variables
complex
on success

       
items
complex
on success
List of exported variables.

         
name
string
on success
Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$.

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

Sample:
value_example
     
image
string
on success
Image name for the Build Environment

Sample:
OL7_X86_64_STANDARD_10
     
primary_build_source
string
on success
Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary.

Sample:
primary_build_source_example
     
private_access_config
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
     
stage_display_name
string
on success
Build Run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Sample:
stage_display_name_example
     
stage_execution_timeout_in_seconds
integer
on success
Timeout for the Build Stage Execution. Value in seconds.

Sample:
56
     
status
string
on success
The current status of the stage.

Sample:
ACCEPTED
     
steps
complex
on success
The details about all the steps in a Build stage

       
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
     
time_finished
string
on success
The time the stage finished executing. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
     
time_started
string
on success
The time the stage started executing. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
time_finished
string
on success
The time the build run finished. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
time_started
string
on success
The time the build run started. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
build_run_source
complex
on success

   
repository_id
string
on success
The DevOps code repository identifier that invoked the build run.

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
   
source_type
string
on success
The source from which the build run is triggered.

Sample:
MANUAL
   
trigger_id
string
on success
The trigger that invoked the build run.

Sample:
ocid1.trigger.oc1..xxxxxxEXAMPLExxxxxx
   
trigger_info
complex
on success

     
actions
complex
on success
The list of actions that are to be performed for this Trigger

       
build_pipeline_id
string
on success
The OCID of the build pipeline to be triggered.

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

         
events
list / elements=string
on success
The events, for example, PUSH, PULL_REQUEST_MERGE.

         
exclude
complex
on success

           
file_filter
complex
on success

             
file_paths
list / elements=string
on success
The file paths/glob pattern for files.

         
include
complex
on success

           
base_ref
string
on success
The target branch for pull requests; not applicable for push requests.

Sample:
base_ref_example
           
file_filter
complex
on success

             
file_paths
list / elements=string
on success
The file paths/glob pattern for files.

           
head_ref
string
on success
Branch for push event; source branch for pull requests.

Sample:
head_ref_example
           
repository_name
string
on success
The repository name for trigger events.

Sample:
repository_name_example
         
trigger_source
string
on success
Source of the trigger. Allowed values are, GITHUB and GITLAB.

Sample:
BITBUCKET_CLOUD
       
type
string
on success
The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE.

Sample:
TRIGGER_BUILD_PIPELINE
     
display_name
string
on success
Name for Trigger.

Sample:
display_name_example
 
commit_info
complex
on success

   
commit_hash
string
on success
Commit hash pertinent to the repository URL and the specified branch.

Sample:
commit_hash_example
   
repository_branch
string
on success
Name of the repository branch.

Sample:
repository_branch_example
   
repository_url
string
on success
Repository URL.

Sample:
repository_url_example
 
compartment_id
string
on success
The OCID of the compartment where the build is running.

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'}}
 
display_name
string
on success
Build run 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
 
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 build run.

Sample:
ACCEPTED
 
project_id
string
on success
The OCID of the DevOps 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
The time the build run was created. Format defined by RFC3339.

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

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)