oracle.oci.oci_devops_repository_facts – Fetches details about one or multiple Repository resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Repository resources in Oracle Cloud Infrastructure
Returns a list of repositories given a compartment ID or a project ID.
If repository_id is specified, the details of a single Repository 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 . |
|
fields
list
/ elements=string
|
|
Fields parameter can contain multiple flags useful in deciding the API functionality.
|
lifecycle_state
string
|
|
A filter to return only resources whose lifecycle state matches the given lifecycle state.
|
name
string
|
A filter to return only resources that match the entire name given.
|
|
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. |
|
repository_id
string
|
Unique repository identifier.
Required to get a specific repository.
aliases: id |
|
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 name is ascending. If no value is specified time created is default.
|
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 |
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 repository
oci_devops_repository_facts:
# required
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
# optional
fields: [ "branchCount" ]
- name: List repositories
oci_devops_repository_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: ACTIVE
name: 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 | |||
---|---|---|---|---|---|
repositories
complex
|
on success |
List of Repository resources
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_details': 'lifecycle_details_example', '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.
Returned for get operation
Sample:
56
|
|||
commit_count
integer
|
on success |
The count of the commits present in the repository.
Returned for get operation
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_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.
Returned for list operation
Sample:
lifecycle_details_example
|
|||
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.
Returned for get operation
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.
Returned for get operation
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.
Returned for get operation
|
Authors¶
Oracle (@oracle)