oracle.oci.oci_opensearch_cluster – Manage an OpensearchCluster resource 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_opensearch_cluster.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new OpensearchCluster.

  • This resource has the following action operations in the oracle.oci.oci_opensearch_cluster_actions module: backup, opensearch_cluster_restore, resize_opensearch_cluster_horizontal, resize_opensearch_cluster_vertical.

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 to create the cluster in.
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_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.
data_node_count
integer
The number of data nodes to configure for the cluster.
Required for create using state=present.
data_node_host_bare_metal_shape
string
The bare metal shape for the cluster's data nodes.
data_node_host_memory_gb
integer
The amount of memory in GB, to configure per node for the cluster's data nodes.
Required for create using state=present.
data_node_host_ocpu_count
integer
The number of OCPUs to configure for the cluster's data nodes.
Required for create using state=present.
data_node_host_type
string
    Choices:
  • FLEX
  • BM
TThe instance type for the cluster's data nodes.
Required for create using state=present.
data_node_storage_gb
integer
The amount of storage in GB, to configure per node for the cluster's data nodes.
Required for create using state=present.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
The name of the cluster. Avoid entering confidential information.
Required for create using state=present, update using state=present with opensearch_cluster_id present.
Required for 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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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.
master_node_count
integer
The number of master nodes to configure for the cluster.
Required for create using state=present.
master_node_host_bare_metal_shape
string
The bare metal shape for the cluster's master nodes.
master_node_host_memory_gb
integer
The amount of memory in GB, to configure per node for the cluster's master nodes.
Required for create using state=present.
master_node_host_ocpu_count
integer
The number of OCPUs to configure for the cluser's master nodes.
Required for create using state=present.
master_node_host_type
string
    Choices:
  • FLEX
  • BM
The instance type for the cluster's master nodes.
Required for create using state=present.
opendashboard_node_count
integer
The number of OpenSearch Dashboard nodes to configure for the cluster.
Required for create using state=present.
opendashboard_node_host_memory_gb
integer
The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
Required for create using state=present.
opendashboard_node_host_ocpu_count
integer
The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.
Required for create using state=present.
opensearch_cluster_id
string
unique OpensearchCluster 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
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.
software_version
string
The version of the software the cluster is running.
Required for create using state=present.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the OpensearchCluster.
Use state=present to create or update an OpensearchCluster.
Use state=absent to delete an OpensearchCluster.
subnet_compartment_id
string
The OCID for the compartment where the cluster's subnet is located.
Required for create using state=present.
subnet_id
string
The OCID of the cluster's subnet.
Required for create using state=present.
system_tags
dictionary
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
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
vcn_compartment_id
string
The OCID for the compartment where the cluster's VCN is located.
Required for create using state=present.
vcn_id
string
The OCID of the cluster's VCN.
Required for create using state=present.
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 opensearch_cluster
  oci_opensearch_cluster:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    master_node_count: 56
    master_node_host_type: FLEX
    master_node_host_ocpu_count: 56
    master_node_host_memory_gb: 56
    data_node_count: 56
    data_node_host_type: FLEX
    data_node_host_ocpu_count: 56
    data_node_host_memory_gb: 56
    data_node_storage_gb: 56
    opendashboard_node_count: 56
    opendashboard_node_host_ocpu_count: 56
    opendashboard_node_host_memory_gb: 56
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    vcn_compartment_id: "ocid1.vcncompartment.oc1..xxxxxxEXAMPLExxxxxx"
    subnet_compartment_id: "ocid1.subnetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    software_version: software_version_example

    # optional
    master_node_host_bare_metal_shape: master_node_host_bare_metal_shape_example
    data_node_host_bare_metal_shape: data_node_host_bare_metal_shape_example
    system_tags: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update opensearch_cluster
  oci_opensearch_cluster:
    # required
    display_name: display_name_example
    opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"

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

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

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

- name: Delete opensearch_cluster
  oci_opensearch_cluster:
    # required
    opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Sample:
{'availability_domains': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'data_node_count': 56, 'data_node_host_bare_metal_shape': 'data_node_host_bare_metal_shape_example', 'data_node_host_memory_gb': 56, 'data_node_host_ocpu_count': 56, 'data_node_host_type': 'FLEX', 'data_node_storage_gb': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'fqdn': 'fqdn_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'master_node_count': 56, 'master_node_host_bare_metal_shape': 'master_node_host_bare_metal_shape_example', 'master_node_host_memory_gb': 56, 'master_node_host_ocpu_count': 56, 'master_node_host_type': 'FLEX', 'opendashboard_fqdn': 'opendashboard_fqdn_example', 'opendashboard_node_count': 56, 'opendashboard_node_host_memory_gb': 56, 'opendashboard_node_host_ocpu_count': 56, 'opendashboard_private_ip': 'opendashboard_private_ip_example', 'opensearch_fqdn': 'opensearch_fqdn_example', 'opensearch_private_ip': 'opensearch_private_ip_example', 'software_version': 'software_version_example', 'subnet_compartment_id': 'ocid1.subnetcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_deleted': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_storage_gb': 56, 'vcn_compartment_id': 'ocid1.vcncompartment.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
 
availability_domains
list / elements=string
on success
The availability domains to distribute the cluser nodes across.

 
compartment_id
string
on success
The OCID of the compartment where the cluster is located.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
data_node_count
integer
on success
The number of data nodes configured for the cluster.

Sample:
56
 
data_node_host_bare_metal_shape
string
on success
The bare metal shape for the cluster's data nodes.

Sample:
data_node_host_bare_metal_shape_example
 
data_node_host_memory_gb
integer
on success
The amount of memory in GB, for the cluster's data nodes.

Sample:
56
 
data_node_host_ocpu_count
integer
on success
The number of OCPUs configured for the cluster's data nodes.

Sample:
56
 
data_node_host_type
string
on success
The instance type for the cluster's data nodes.

Sample:
FLEX
 
data_node_storage_gb
integer
on success
The amount of storage in GB, to configure per node for the cluster's data nodes.

Sample:
56
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The name of the cluster. Avoid entering confidential information.

Sample:
display_name_example
 
fqdn
string
on success
The fully qualified domain name (FQDN) for the cluster's API endpoint.

Sample:
fqdn_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. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the cluster.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current lifecycle state of the cluster.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the cluster.

Sample:
ACTIVE
 
master_node_count
integer
on success
The number of master nodes configured for the cluster.

Sample:
56
 
master_node_host_bare_metal_shape
string
on success
The bare metal shape for the cluster's master nodes.

Sample:
master_node_host_bare_metal_shape_example
 
master_node_host_memory_gb
integer
on success
The amount of memory in GB, for the cluster's master nodes.

Sample:
56
 
master_node_host_ocpu_count
integer
on success
The number of OCPUs configured for cluster's master nodes.

Sample:
56
 
master_node_host_type
string
on success
The instance type for the cluster's master nodes.

Sample:
FLEX
 
opendashboard_fqdn
string
on success
The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

Sample:
opendashboard_fqdn_example
 
opendashboard_node_count
integer
on success
The number of OpenSearch Dashboard nodes configured for the cluster.

Sample:
56
 
opendashboard_node_host_memory_gb
integer
on success
The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Sample:
56
 
opendashboard_node_host_ocpu_count
integer
on success
The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Sample:
56
 
opendashboard_private_ip
string
on success
The private IP address for the cluster's OpenSearch Dashboard.

Sample:
opendashboard_private_ip_example
 
opensearch_fqdn
string
on success
The fully qualified domain name (FQDN) for the cluster's API endpoint.

Sample:
opensearch_fqdn_example
 
opensearch_private_ip
string
on success
The cluster's private IP address.

Sample:
opensearch_private_ip_example
 
software_version
string
on success
The software version the cluster is running.

Sample:
software_version_example
 
subnet_compartment_id
string
on success
The OCID for the compartment where the cluster's subnet is located.

Sample:
ocid1.subnetcompartment.oc1..xxxxxxEXAMPLExxxxxx
 
subnet_id
string
on success
The OCID of the cluster's subnet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
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 amount of time in milliseconds since the cluster was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_deleted
string
on success
The amount of time in milliseconds since the cluster was updated.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The amount of time in milliseconds since the cluster was updated.

Sample:
2013-10-20T19:20:30+01:00
 
total_storage_gb
integer
on success
The size in GB of the cluster's total storage.

Sample:
56
 
vcn_compartment_id
string
on success
The OCID for the compartment where the cluster's VCN is located.

Sample:
ocid1.vcncompartment.oc1..xxxxxxEXAMPLExxxxxx
 
vcn_id
string
on success
The OCID of the cluster's VCN.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)