oracle.oci.oci_artifacts_container_repository – Manage a ContainerRepository resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_artifacts_container_repository
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ContainerRepository resource in Oracle Cloud Infrastructure
For state=present, create a new empty container repository. Avoid entering confidential information.
This resource has the following action operations in the oracle.oci.oci_artifacts_container_repository_actions module: change_compartment.
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 create the resource.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
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
|
The container repository name.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is 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.
|
|
is_immutable
boolean
|
|
Whether the repository is immutable. Images cannot be overwritten in an immutable repository.
This parameter is updatable.
|
|
is_public
boolean
|
|
Whether the repository is public. A public repository allows unauthenticated access.
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.
|
||
readme
dictionary
|
This parameter is updatable.
|
||
content
string
/ required
|
Readme content. Avoid entering confidential information.
|
||
format
string
/ required
|
|
Readme format. Supported formats are text/plain and text/markdown.
|
|
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 container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
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 |
||
state
string
|
|
The state of the ContainerRepository.
Use state=present to create or update a ContainerRepository.
Use state=absent to delete a ContainerRepository.
|
|
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
|
|
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 container_repository
oci_artifacts_container_repository:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
is_immutable: true
is_public: true
readme:
# required
content: content_example
format: TEXT_MARKDOWN
- name: Update container_repository
oci_artifacts_container_repository:
# required
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
# optional
is_immutable: true
is_public: true
readme:
# required
content: content_example
format: TEXT_MARKDOWN
- name: Update container_repository using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_artifacts_container_repository:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
is_immutable: true
is_public: true
readme:
# required
content: content_example
format: TEXT_MARKDOWN
- name: Delete container_repository
oci_artifacts_container_repository:
# required
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete container_repository using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_artifacts_container_repository:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
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 | ||
---|---|---|---|---|
container_repository
complex
|
on success |
Details of the ContainerRepository resource acted upon by the current operation
Sample:
{'billable_size_in_gbs': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_count': 56, 'is_immutable': True, 'is_public': True, 'layer_count': 56, 'layers_size_in_bytes': 56, 'lifecycle_state': 'AVAILABLE', 'readme': {'content': 'content_example', 'format': 'TEXT_MARKDOWN'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_pushed': '2013-10-20T19:20:30+01:00'}
|
||
billable_size_in_gbs
integer
|
on success |
Total storage size in GBs that will be charged.
Sample:
56
|
||
compartment_id
string
|
on success |
The OCID of the compartment in which the container repository exists.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
created_by
string
|
on success |
The id of the user or principal that created the resource.
Sample:
created_by_example
|
||
display_name
string
|
on success |
The container repository name.
Sample:
display_name_example
|
||
id
string
|
on success |
The OCID of the container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
image_count
integer
|
on success |
Total number of images.
Sample:
56
|
||
is_immutable
boolean
|
on success |
Whether the repository is immutable. Images cannot be overwritten in an immutable repository.
Sample:
True
|
||
is_public
boolean
|
on success |
Whether the repository is public. A public repository allows unauthenticated access.
Sample:
True
|
||
layer_count
integer
|
on success |
Total number of layers.
Sample:
56
|
||
layers_size_in_bytes
integer
|
on success |
Total storage in bytes consumed by layers.
Sample:
56
|
||
lifecycle_state
string
|
on success |
The current state of the container repository.
Sample:
AVAILABLE
|
||
readme
complex
|
on success |
|
||
content
string
|
on success |
Readme content. Avoid entering confidential information.
Sample:
content_example
|
||
format
string
|
on success |
Readme format. Supported formats are text/plain and text/markdown.
Sample:
TEXT_MARKDOWN
|
||
time_created
string
|
on success |
An RFC 3339 timestamp indicating when the repository was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_last_pushed
string
|
on success |
An RFC 3339 timestamp indicating when an image was last pushed to the repository.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)