oracle.oci.oci_artifacts_container_image – Manage a ContainerImage resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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_image.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • This resource has the following action operations in the oracle.oci.oci_artifacts_container_image_actions module: remove_container_version, restore.

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
  • security_token
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
image_id
string / required
The OCID of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`

aliases: id
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
state
string
    Choices:
  • present ←
  • absent
The state of the ContainerImage.
Use state=present to update an existing a ContainerImage.
Use state=absent to delete a ContainerImage.
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: Update container_image
  oci_artifacts_container_image:
    # required
    image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"

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

- name: Delete container_image
  oci_artifacts_container_image:
    # required
    image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
container_image
complex
on success
Details of the ContainerImage resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'digest': 'digest_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'layers': [{'digest': 'digest_example', 'size_in_bytes': 56, 'time_created': '2013-10-20T19:20:30+01:00'}], 'layers_size_in_bytes': 56, 'lifecycle_state': 'AVAILABLE', 'manifest_size_in_bytes': 56, 'pull_count': 56, 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'repository_name': 'repository_name_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_pulled': '2013-10-20T19:20:30+01:00', 'version': 'version_example', 'versions': [{'created_by': 'created_by_example', 'time_created': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]}
 
compartment_id
string
on success
The compartment OCID to which the container image belongs. Inferred from the container repository.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The OCID of the user or principal that created the resource.

Sample:
created_by_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
digest
string
on success
The container image digest.

Sample:
digest_example
 
display_name
string
on success
The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version.
Example: `ubuntu:latest` or `ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
layers
complex
on success
Layers of which the image is composed, ordered by the layer digest.
   
digest
string
on success
The sha256 digest of the image layer.

Sample:
digest_example
   
size_in_bytes
integer
on success
The size of the layer in bytes.

Sample:
56
   
time_created
string
on success
An RFC 3339 timestamp indicating when the layer was created.

Sample:
2013-10-20T19:20:30+01:00
 
layers_size_in_bytes
integer
on success
The total size of the container image layers in bytes.

Sample:
56
 
lifecycle_state
string
on success
The current state of the container image.

Sample:
AVAILABLE
 
manifest_size_in_bytes
integer
on success
The size of the container image manifest in bytes.

Sample:
56
 
pull_count
integer
on success
Total number of pulls.

Sample:
56
 
repository_id
string
on success
The OCID of the container repository.

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
 
repository_name
string
on success
The container repository name.

Sample:
repository_name_example
 
system_tags
dictionary
on success
The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
An RFC 3339 timestamp indicating when the image was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_last_pulled
string
on success
An RFC 3339 timestamp indicating when the image was last pulled.

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
The most recent version associated with this image.

Sample:
version_example
 
versions
complex
on success
The versions associated with this image.
   
created_by
string
on success
The OCID of the user or principal that pushed the version.

Sample:
created_by_example
   
time_created
string
on success
The creation time of the version.

Sample:
2013-10-20T19:20:30+01:00
   
version
string
on success
The version name.

Sample:
version_example


Authors

  • Oracle (@oracle)