oracle.oci.oci_devops_trigger – Manage a Trigger resource 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_trigger
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Trigger resource in Oracle Cloud Infrastructure
For state=present, creates a new trigger.
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 | ||||
---|---|---|---|---|---|---|
actions
list
/ elements=dictionary
|
The list of actions that are to be performed for this trigger.
Required for create using state=present.
This parameter is updatable.
Applicable when trigger_source is one of ['DEVOPS_CODE_REPOSITORY', 'BITBUCKET_SERVER', 'VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB_SERVER', 'GITLAB']
|
|||||
build_pipeline_id
string
/ required
|
The OCID of the build pipeline to be triggered.
|
|||||
filter
dictionary
|
||||||
events
list
/ elements=string
|
|
The events, for example, PUSH, PULL_REQUEST_MERGE.
|
||||
exclude
dictionary
|
Applicable when trigger_source is one of ['DEVOPS_CODE_REPOSITORY', 'VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB_SERVER', 'GITLAB']
|
|||||
file_filter
dictionary
|
Applicable when trigger_source is one of ['DEVOPS_CODE_REPOSITORY', 'VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB_SERVER', 'GITLAB']
|
|||||
file_paths
list
/ elements=string
|
The file paths/glob pattern for files.
Applicable when trigger_source is 'VBS'
|
|||||
include
dictionary
|
||||||
base_ref
string
|
The target branch for pull requests; not applicable for push requests.
Applicable when trigger_source is one of ['BITBUCKET_SERVER', 'VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB_SERVER', 'GITLAB']
|
|||||
file_filter
dictionary
|
Applicable when trigger_source is one of ['DEVOPS_CODE_REPOSITORY', 'VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB_SERVER', 'GITLAB']
|
|||||
file_paths
list
/ elements=string
|
The file paths/glob pattern for files.
Applicable when trigger_source is 'VBS'
|
|||||
head_ref
string
|
Branch for push event; source branch for pull requests.
|
|||||
repository_name
string
|
The repository name for trigger events.
Applicable when trigger_source is 'VBS'
|
|||||
trigger_source
string
/ required
|
|
Source of the trigger. Allowed values are, GITHUB and GITLAB.
|
||||
type
string
/ required
|
|
The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE.
|
||||
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.
|
|||||
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 . |
|||||
connection_id
string
|
The OCID of the connection resource used to get details for triggered events.
This parameter is updatable.
Applicable when trigger_source is one of ['VBS', 'BITBUCKET_CLOUD', 'GITHUB', 'GITLAB']
|
|||||
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.
|
|||||
description
string
|
Optional description about the trigger.
This parameter is updatable.
|
|||||
display_name
string
|
Trigger display name. 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 |
|||||
force_create
boolean
|
|
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.
|
|||||
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.
|
|||||
project_id
string
|
The OCID of the DevOps project to which the trigger belongs to.
Required for create using state=present.
|
|||||
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. |
|||||
repository_id
string
|
The OCID of the DevOps code repository.
This parameter is updatable.
Applicable when trigger_source is 'DEVOPS_CODE_REPOSITORY'
|
|||||
state
string
|
|
The state of the Trigger.
Use state=present to create or update a Trigger.
Use state=absent to delete a Trigger.
|
||||
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 |
|||||
trigger_id
string
|
Unique trigger 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 |
|||||
trigger_source
string
|
|
Source of the trigger. Allowed values are, GITHUB and GITLAB.
Required for create using state=present, update using state=present with trigger_id present.
|
||||
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create trigger with trigger_source = GITHUB
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: GITHUB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Create trigger with trigger_source = VBS
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: VBS
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Create trigger with trigger_source = DEVOPS_CODE_REPOSITORY
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: DEVOPS_CODE_REPOSITORY
# optional
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Create trigger with trigger_source = BITBUCKET_CLOUD
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: BITBUCKET_CLOUD
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Create trigger with trigger_source = GITLAB_SERVER
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: GITLAB_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Create trigger with trigger_source = GITLAB
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: GITLAB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Create trigger with trigger_source = BITBUCKET_SERVER
oci_devops_trigger:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
trigger_source: BITBUCKET_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger with trigger_source = GITHUB
oci_devops_trigger:
# required
trigger_source: GITHUB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger with trigger_source = VBS
oci_devops_trigger:
# required
trigger_source: VBS
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger with trigger_source = DEVOPS_CODE_REPOSITORY
oci_devops_trigger:
# required
trigger_source: DEVOPS_CODE_REPOSITORY
# optional
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger with trigger_source = BITBUCKET_CLOUD
oci_devops_trigger:
# required
trigger_source: BITBUCKET_CLOUD
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger with trigger_source = GITLAB_SERVER
oci_devops_trigger:
# required
trigger_source: GITLAB_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger with trigger_source = GITLAB
oci_devops_trigger:
# required
trigger_source: GITLAB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger with trigger_source = BITBUCKET_SERVER
oci_devops_trigger:
# required
trigger_source: BITBUCKET_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = GITHUB
oci_devops_trigger:
# required
trigger_source: GITHUB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = VBS
oci_devops_trigger:
# required
trigger_source: VBS
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = DEVOPS_CODE_REPOSITORY
oci_devops_trigger:
# required
trigger_source: DEVOPS_CODE_REPOSITORY
# optional
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = BITBUCKET_CLOUD
oci_devops_trigger:
# required
trigger_source: BITBUCKET_CLOUD
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = GITLAB_SERVER
oci_devops_trigger:
# required
trigger_source: GITLAB_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = GITLAB
oci_devops_trigger:
# required
trigger_source: GITLAB
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with trigger_source = BITBUCKET_SERVER
oci_devops_trigger:
# required
trigger_source: BITBUCKET_SERVER
# optional
display_name: display_name_example
description: description_example
actions:
- # required
type: TRIGGER_BUILD_PIPELINE
build_pipeline_id: "ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx"
# optional
filter:
# required
trigger_source: VBS
# optional
events: [ "PUSH" ]
include:
# optional
repository_name: repository_name_example
head_ref: head_ref_example
base_ref: base_ref_example
file_filter:
# optional
file_paths: [ "file_paths_example" ]
exclude:
# optional
file_filter:
# optional
file_paths: [ "file_paths_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete trigger
oci_devops_trigger:
# required
trigger_id: "ocid1.trigger.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete trigger using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_devops_trigger:
# 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 | |||||
---|---|---|---|---|---|---|---|
trigger
complex
|
on success |
Details of the Trigger resource acted upon by the current operation
Sample:
{'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'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_id': 'ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'trigger_source': 'GITHUB', 'trigger_url': 'trigger_url_example'}
|
|||||
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
|
|||||
compartment_id
string
|
on success |
The OCID of the compartment that contains the trigger.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
connection_id
string
|
on success |
The OCID of the connection resource used to get details for triggered events.
Sample:
ocid1.connection.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'}}
|
|||||
description
string
|
on success |
Description about the trigger.
Sample:
description_example
|
|||||
display_name
string
|
on success |
Trigger display name. 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 trigger.
Sample:
ACTIVE
|
|||||
project_id
string
|
on success |
The OCID of the DevOps project to which the trigger belongs to.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
repository_id
string
|
on success |
The OCID of the DevOps code repository.
Sample:
ocid1.repository.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 trigger was created. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
time_updated
string
|
on success |
The time the trigger was updated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||||
trigger_source
string
|
on success |
Source of the trigger.
Sample:
GITHUB
|
|||||
trigger_url
string
|
on success |
The endpoint that listens to trigger events.
Sample:
trigger_url_example
|
Authors¶
Oracle (@oracle)