oracle.oci.oci_container_engine_addon_option_facts – Fetches details about one or multiple AddonOption resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Get list of supported addons for a specific kubernetes version.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
addon_name
string
The name of the addon.
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.
kubernetes_version
string / required
The kubernetes version to fetch the addons.
name
string
Use name along with the other options to return only resources that match the given name exactly.
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.
sort_by
string
    Choices:
  • NAME
  • TIME_CREATED
The optional field to sort the results by.
sort_order
string
    Choices:
  • ASC
  • DESC
The optional order in which to sort the results.
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: List addon_options
  oci_container_engine_addon_option_facts:
    # required
    kubernetes_version: kubernetes_version_example

    # optional
    addon_name: addon_name_example
    sort_order: ASC
    sort_by: NAME

Return Values

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

Key Returned Description
addon_options
complex
on success
List of AddonOption resources

Sample:
[{'addon_group': 'addon_group_example', 'addon_schema_version': 'addon_schema_version_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'is_essential': True, 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'versions': [{'configurations': [{'description': 'description_example', 'display_name': 'display_name_example', 'is_required': True, 'key': 'key_example', 'value': 'value_example'}], 'description': 'description_example', 'kubernetes_version_filters': {'exact_kubernetes_versions': [], 'maximum_version': 'maximum_version_example', 'minimal_version': 'minimal_version_example'}, 'status': 'ACTIVE', 'version_number': 'version_number_example'}]}]
 
addon_group
string
on success
Addon group info, a namespace concept that groups addons with similar functionalities.

Sample:
addon_group_example
 
addon_schema_version
string
on success
Addon definition schema version to validate addon.

Sample:
addon_schema_version_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'}}
 
description
string
on success
Description on the addon.

Sample:
description_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'}
 
is_essential
boolean
on success
Is it an essential addon for cluster operation or not.

Sample:
True
 
lifecycle_state
string
on success
The life cycle state of the addon.

Sample:
ACTIVE
 
name
string
on success
Name of the addon and it would be unique.

Sample:
name_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the work request was created.

Sample:
2013-10-20T19:20:30+01:00
 
versions
complex
on success
The resources this work request affects.
   
configurations
complex
on success
Addon version configuration details.
     
description
string
on success
Information about the addon version configuration.

Sample:
description_example
     
display_name
string
on success
Display name of addon version.

Sample:
display_name_example
     
is_required
boolean
on success
If the the configuration is required or not.

Sample:
True
     
key
string
on success
Addon configuration key

Sample:
key_example
     
value
string
on success
Addon configuration value

Sample:
value_example
   
description
string
on success
Information about the addon version.

Sample:
description_example
   
kubernetes_version_filters
complex
on success
The range of kubernetes versions an addon can be configured.
     
exact_kubernetes_versions
list / elements=string
on success
The exact version of kubernetes that are compatible.
     
maximum_version
string
on success
The latest kubernetes version.

Sample:
maximum_version_example
     
minimal_version
string
on success
The earliest kubernetes version.

Sample:
minimal_version_example
   
status
string
on success
Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.

Sample:
ACTIVE
   
version_number
string
on success
Version number, need be comparable within an addon.

Sample:
version_number_example


Authors

  • Oracle (@oracle)