oracle.oci.oci_devops_deploy_artifact – Manage a DeployArtifact resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new deployment artifact.

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).
argument_substitution_mode
string
Mode for artifact parameter substitution.
Required for create using state=present.
This parameter is updatable.
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.
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.
deploy_artifact_id
string
Unique artifact 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
deploy_artifact_source
dictionary
Required for create using state=present.
This parameter is updatable.
base64_encoded_content
string
base64 Encoded String
Required when deploy_artifact_source_type is 'INLINE'
chart_url
string
The URL of an OCIR repository.
Required when deploy_artifact_source_type is 'HELM_CHART'
deploy_artifact_path
string
Specifies the artifact path in the repository.
Required when deploy_artifact_source_type is 'GENERIC_ARTIFACT'
deploy_artifact_source_type
string / required
    Choices:
  • GENERIC_ARTIFACT
  • HELM_CHART
  • OCIR
  • INLINE
Specifies types of artifact sources.
deploy_artifact_version
string
Users can set this as a placeholder value that refers to a pipeline parameter, for example, ${appVersion}.
Required when deploy_artifact_source_type is one of ['GENERIC_ARTIFACT', 'HELM_CHART']
helm_verification_key_source
dictionary
Applicable when deploy_artifact_source_type is 'HELM_CHART'
current_public_key
string
Current version of Base64 encoding of the public key which is in binary GPG exported format.
Required when verification_key_source_type is 'INLINE_PUBLIC_KEY'
previous_public_key
string
Previous version of Base64 encoding of the public key which is in binary GPG exported format. This would be used for key rotation scenarios.
Applicable when verification_key_source_type is 'INLINE_PUBLIC_KEY'
vault_secret_id
string
The OCID of the Vault Secret containing the verification key versions.
Required when verification_key_source_type is 'VAULT_SECRET'
verification_key_source_type
string / required
    Choices:
  • INLINE_PUBLIC_KEY
  • VAULT_SECRET
  • NONE
Specifies type of verification material.
image_digest
string
Specifies image digest for the version of the image.
Applicable when deploy_artifact_source_type is 'OCIR'
image_uri
string
Specifies OCIR image path - optionally include tag.
Required when deploy_artifact_source_type is 'OCIR'
repository_id
string
The OCID of a repository.
Required when deploy_artifact_source_type is 'GENERIC_ARTIFACT'
deploy_artifact_type
string
Type of the deployment artifact.
Required for create using state=present.
This parameter is updatable.
description
string
Optional description about the deployment artifact.
This parameter is updatable.
display_name
string
Deployment artifact display name. Avoid entering confidential information.
Required for create, 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.

aliases: name
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.
project_id
string
The OCID of a project.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the DeployArtifact.
Use state=present to create or update a DeployArtifact.
Use state=absent to delete a DeployArtifact.
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 deploy_artifact
  oci_devops_deploy_artifact:
    # required
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    deploy_artifact_type: deploy_artifact_type_example
    deploy_artifact_source:
      # required
      repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
      deploy_artifact_path: deploy_artifact_path_example
      deploy_artifact_version: deploy_artifact_version_example
      deploy_artifact_source_type: GENERIC_ARTIFACT
    argument_substitution_mode: argument_substitution_mode_example

    # optional
    description: description_example
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_artifact
  oci_devops_deploy_artifact:
    # required
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    display_name: display_name_example
    deploy_artifact_type: deploy_artifact_type_example
    deploy_artifact_source:
      # required
      repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
      deploy_artifact_path: deploy_artifact_path_example
      deploy_artifact_version: deploy_artifact_version_example
      deploy_artifact_source_type: GENERIC_ARTIFACT
    argument_substitution_mode: argument_substitution_mode_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update deploy_artifact using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_devops_deploy_artifact:
    # required
    display_name: display_name_example

    # optional
    description: description_example
    deploy_artifact_type: deploy_artifact_type_example
    deploy_artifact_source:
      # required
      repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
      deploy_artifact_path: deploy_artifact_path_example
      deploy_artifact_version: deploy_artifact_version_example
      deploy_artifact_source_type: GENERIC_ARTIFACT
    argument_substitution_mode: argument_substitution_mode_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete deploy_artifact
  oci_devops_deploy_artifact:
    # required
    deploy_artifact_id: "ocid1.deployartifact.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete deploy_artifact using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_devops_deploy_artifact:
    # required
    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
deploy_artifact
complex
on success
Details of the DeployArtifact resource acted upon by the current operation

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', 'helm_verification_key_source': {'current_public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...', 'previous_public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...', 'vault_secret_id': 'ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx', 'verification_key_source_type': 'VAULT_SECRET'}, '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
   
helm_verification_key_source
complex
on success

     
current_public_key
string
on success
Current version of Base64 encoding of the public key which is in binary GPG exported format.

Sample:
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
     
previous_public_key
string
on success
Previous version of Base64 encoding of the public key which is in binary GPG exported format. This would be used for key rotation scenarios.

Sample:
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
     
vault_secret_id
string
on success
The OCID of the Vault Secret containing the verification key versions.

Sample:
ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx
     
verification_key_source_type
string
on success
Specifies type of verification material.

Sample:
VAULT_SECRET
   
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)