oracle.oci.oci_devops_repository – Manage a Repository 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_repository.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Repository resource in Oracle Cloud Infrastructure

  • For state=present, creates a new repository.

  • This resource has the following action operations in the oracle.oci.oci_devops_repository_actions module: mirror.

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.
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.
default_branch
string
The default branch of the repository.
This parameter is updatable.
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
Details of the repository. Avoid entering confidential information.
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
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.
mirror_repository_config
dictionary
This parameter is updatable.
connector_id
string
Upstream git repository connection identifer.
repository_url
string
URL of external repository you want to mirror.
trigger_schedule
dictionary
custom_schedule
string
Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size.
schedule_type
string / required
    Choices:
  • NONE
  • DEFAULT
  • CUSTOM
Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule.
name
string
Unique name of a repository.
Required for create using state=present.
Required for 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.
project_id
string
The OCID of the DevOps project containing the repository.
Required for create using state=present.
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
Unique repository 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
repository_type
string
Type of repository. Allowed values: `MIRRORED` `HOSTED`
Required for create using state=present.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the Repository.
Use state=present to create or update a Repository.
Use state=absent to delete a Repository.
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: Create repository
  oci_devops_repository:
    # required
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    repository_type: repository_type_example

    # optional
    description: description_example
    default_branch: default_branch_example
    mirror_repository_config:
      # optional
      connector_id: "ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx"
      repository_url: repository_url_example
      trigger_schedule:
        # required
        schedule_type: NONE

        # optional
        custom_schedule: custom_schedule_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update repository
  oci_devops_repository:
    # required
    repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    description: description_example
    default_branch: default_branch_example
    repository_type: repository_type_example
    mirror_repository_config:
      # optional
      connector_id: "ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx"
      repository_url: repository_url_example
      trigger_schedule:
        # required
        schedule_type: NONE

        # optional
        custom_schedule: custom_schedule_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update repository using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_devops_repository:
    # required
    name: name_example

    # optional
    description: description_example
    default_branch: default_branch_example
    repository_type: repository_type_example
    mirror_repository_config:
      # optional
      connector_id: "ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx"
      repository_url: repository_url_example
      trigger_schedule:
        # required
        schedule_type: NONE

        # optional
        custom_schedule: custom_schedule_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete repository
  oci_devops_repository:
    # required
    repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete repository using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_devops_repository:
    # required
    name: name_example
    state: absent

Return Values

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

Key Returned Description
repository
complex
on success
Details of the Repository resource acted upon by the current operation

Sample:
{'branch_count': 56, 'commit_count': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'default_branch': 'default_branch_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'http_url': 'http_url_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'lifecyle_details': 'lifecyle_details_example', 'mirror_repository_config': {'connector_id': 'ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx', 'repository_url': 'repository_url_example', 'trigger_schedule': {'custom_schedule': 'custom_schedule_example', 'schedule_type': 'NONE'}}, 'name': 'name_example', 'namespace': 'namespace_example', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'project_name': 'project_name_example', 'repository_type': 'MIRRORED', 'size_in_bytes': 56, 'ssh_url': 'ssh_url_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'trigger_build_events': []}
 
branch_count
integer
on success
The count of the branches present in the repository.

Sample:
56
 
commit_count
integer
on success
The count of the commits present in the repository.

Sample:
56
 
compartment_id
string
on success
The OCID of the repository's compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
default_branch
string
on success
The default branch of the repository.

Sample:
default_branch_example
 
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
Details of the repository. Avoid entering confidential information.

Sample:
description_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'}
 
http_url
string
on success
HTTP URL that you use to git clone, pull and push.

Sample:
http_url_example
 
id
string
on success
The OCID of the repository. This value is unique and immutable.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the repository.

Sample:
ACTIVE
 
lifecyle_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:
lifecyle_details_example
 
mirror_repository_config
complex
on success

   
connector_id
string
on success
Upstream git repository connection identifer.

Sample:
ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx
   
repository_url
string
on success
URL of external repository you want to mirror.

Sample:
repository_url_example
   
trigger_schedule
complex
on success

     
custom_schedule
string
on success
Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size.

Sample:
custom_schedule_example
     
schedule_type
string
on success
Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule.

Sample:
NONE
 
name
string
on success
Unique name of a repository. This value is mutable.

Sample:
name_example
 
namespace
string
on success
Tenancy unique namespace.

Sample:
namespace_example
 
project_id
string
on success
The OCID of the DevOps project containing the repository.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
project_name
string
on success
Unique project name in a namespace.

Sample:
project_name_example
 
repository_type
string
on success
Type of repository: MIRRORED - Repository created by mirroring an existing repository. HOSTED - Repository created and hosted using OCI DevOps code repository.

Sample:
MIRRORED
 
size_in_bytes
integer
on success
The size of the repository in bytes.

Sample:
56
 
ssh_url
string
on success
SSH URL that you use to git clone, pull and push.

Sample:
ssh_url_example
 
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 repository was created. Format defined by RFC3339.

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

Sample:
2013-10-20T19:20:30+01:00
 
trigger_build_events
list / elements=string
on success
Trigger build events supported for this repository: PUSH - Build is triggered when a push event occurs. COMMIT_UPDATES - Build is triggered when new commits are mirrored into a repository.



Authors

  • Oracle (@oracle)