oracle.oci.oci_devops_deploy_artifact_facts – Fetches details about one or multiple DeployArtifact resources 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_deploy_artifact_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DeployArtifact resources in Oracle Cloud Infrastructure

  • Returns a list of deployment artifacts.

  • If deploy_artifact_id is specified, the details of a single DeployArtifact will be returned.

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.
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.
deploy_artifact_id
string
Unique artifact identifier.
Required to get a specific deploy_artifact.

aliases: id
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only DeployArtifacts that matches the given lifecycleState.
project_id
string
unique project identifier
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.
sort_order
string
    Choices:
  • ASC
  • DESC
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

Examples

- name: Get a specific deploy_artifact
  oci_devops_deploy_artifact_facts:
    # required
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"

- name: List deploy_artifacts
  oci_devops_deploy_artifact_facts:

    # optional
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    display_name: display_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
deploy_artifacts
complex
on success
List of DeployArtifact resources

Sample:
[{'argument_substitution_mode': 'NONE', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deploy_artifact_source': {'base64_encoded_content': None, 'chart_url': 'chart_url_example', 'deploy_artifact_path': 'deploy_artifact_path_example', 'deploy_artifact_source_type': 'INLINE', 'deploy_artifact_version': 'deploy_artifact_version_example', 'image_digest': 'image_digest_example', 'image_uri': 'image_uri_example', 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx'}, 'deploy_artifact_type': 'DEPLOYMENT_SPEC', 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
argument_substitution_mode
string
on success
Mode for artifact parameter substitution.

Sample:
NONE
 
compartment_id
string
on success
The OCID of a compartment.

Sample:
ocid1.compartment.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'}}
 
deploy_artifact_source
complex
on success

   
base64_encoded_content
string
on success
base64 Encoded String

Sample:
null
   
chart_url
string
on success
The URL of an OCIR repository.

Sample:
chart_url_example
   
deploy_artifact_path
string
on success
Specifies the artifact path in the repository.

Sample:
deploy_artifact_path_example
   
deploy_artifact_source_type
string
on success
Specifies types of artifact sources.

Sample:
INLINE
   
deploy_artifact_version
string
on success
Users can set this as a placeholder value that refers to a pipeline parameter, for example, ${appVersion}.

Sample:
deploy_artifact_version_example
   
image_digest
string
on success
Specifies image digest for the version of the image.

Sample:
image_digest_example
   
image_uri
string
on success
Specifies OCIR image path - optionally include tag.

Sample:
image_uri_example
   
repository_id
string
on success
The OCID of a repository.

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
 
deploy_artifact_type
string
on success
Type of the deployment artifact.

Sample:
DEPLOYMENT_SPEC
 
description
string
on success
Optional description about the artifact to be deployed.

Sample:
description_example
 
display_name
string
on success
Deployment artifact identifier, which can be renamed and is not necessarily unique. 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 detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Current state of the deployment artifact.

Sample:
CREATING
 
project_id
string
on success
The OCID of a project.

Sample:
ocid1.project.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
Time the deployment artifact was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Time the deployment artifact was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)