oracle.oci.oci_functions_application – Manage an Application resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new application.

  • This resource has the following action operations in the oracle.oci.oci_functions_application_actions module: change_compartment.

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).
application_id
string
The OCID of this application.
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
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.
compartment_id
string
The OCID of the compartment to create the application within.
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
dictionary
Application configuration. These values are passed on to the function as environment variables, functions may override application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
This parameter is updatable.
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.
display_name
string
The display name of the application. The display name must be unique within the compartment containing the application. Avoid entering confidential information.
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
    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
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_policy_config
dictionary
This parameter is updatable.
is_policy_enabled
boolean / required
    Choices:
  • no
  • yes
Define if image signature verification policy is enabled for the application.
key_details
list / elements=dictionary
A list of KMS key details.
kms_key_id
string / required
The OCIDs of the KMS key that will be used to verify the image signature.
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.
network_security_group_ids
list / elements=string
The OCIDs of the Network Security Groups to add the application to.
This parameter is updatable.
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.
shape
string
    Choices:
  • GENERIC_X86
  • GENERIC_ARM
  • GENERIC_X86_ARM
Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM`
state
string
    Choices:
  • present ←
  • absent
The state of the Application.
Use state=present to create or update an Application.
Use state=absent to delete an Application.
subnet_ids
list / elements=string
The OCIDs of the subnets in which to run functions in the application.
Required for create using state=present.
syslog_url
string
A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.
Example: `tcp://logserver.myserver:1234`
This parameter is updatable.
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
trace_config
dictionary
This parameter is updatable.
domain_id
string
The OCID of the collector (e.g. an APM Domain) trace events will be sent to.
is_enabled
boolean
    Choices:
  • no
  • yes
Define if tracing is enabled for the resource.
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 application
  oci_functions_application:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    subnet_ids: [ "subnet_ids_example" ]

    # optional
    shape: GENERIC_X86
    config: null
    network_security_group_ids: [ "network_security_group_ids_example" ]
    syslog_url: syslog_url_example
    trace_config:
      # optional
      is_enabled: true
      domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    image_policy_config:
      # required
      is_policy_enabled: true

      # optional
      key_details:
      - # required
        kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update application
  oci_functions_application:
    # required
    application_id: "ocid1.application.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    config: null
    network_security_group_ids: [ "network_security_group_ids_example" ]
    syslog_url: syslog_url_example
    trace_config:
      # optional
      is_enabled: true
      domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    image_policy_config:
      # required
      is_policy_enabled: true

      # optional
      key_details:
      - # required
        kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update application using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_functions_application:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    config: null
    network_security_group_ids: [ "network_security_group_ids_example" ]
    syslog_url: syslog_url_example
    trace_config:
      # optional
      is_enabled: true
      domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    image_policy_config:
      # required
      is_policy_enabled: true

      # optional
      key_details:
      - # required
        kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete application
  oci_functions_application:
    # required
    application_id: "ocid1.application.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'config': {}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_policy_config': {'is_policy_enabled': True, 'key_details': [{'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'lifecycle_state': 'CREATING', 'network_security_group_ids': [], 'shape': 'GENERIC_X86', 'subnet_ids': [], 'syslog_url': 'syslog_url_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'trace_config': {'domain_id': 'ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True}}
 
compartment_id
string
on success
The OCID of the compartment that contains the application.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
config
dictionary
on success
Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
 
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'}}
 
display_name
string
on success
The display name of the application. The display name is unique within the compartment containing the application.

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 application.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
image_policy_config
complex
on success

   
is_policy_enabled
boolean
on success
Define if image signature verification policy is enabled for the application.

Sample:
True
   
key_details
complex
on success
A list of KMS key details.
     
kms_key_id
string
on success
The OCIDs of the KMS key that will be used to verify the image signature.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the application.

Sample:
CREATING
 
network_security_group_ids
list / elements=string
on success
The OCIDs of the Network Security Groups to add the application to.
 
shape
string
on success
Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM`

Sample:
GENERIC_X86
 
subnet_ids
list / elements=string
on success
The OCIDs of the subnets in which to run functions in the application.
 
syslog_url
string
on success
A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.
Example: `tcp://logserver.myserver:1234`

Sample:
syslog_url_example
 
time_created
string
on success
The time the application was created, expressed in RFC 3339 timestamp format.
Example: `2018-09-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the application was updated, expressed in RFC 3339 timestamp format. Example: `2018-09-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00
 
trace_config
complex
on success

   
domain_id
string
on success
The OCID of the collector (e.g. an APM Domain) trace events will be sent to.

Sample:
ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx
   
is_enabled
boolean
on success
Define if tracing is enabled for the resource.

Sample:
True


Authors

  • Oracle (@oracle)