oci_opensearch_opensearch_cluster

This resource provides the Opensearch Cluster resource in Oracle Cloud Infrastructure Opensearch service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/opensearch/latest/OpensearchCluster

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/opensearch

Creates a new OpensearchCluster.

Prerequisites

The below policies must be created in compartment before creating OpensearchCluster

{Compartment-Name} - Name of your compartment
Allow service opensearch to manage vnics in compartment {Compartment-Name}
Allow service opensearch to use subnets in compartment {Compartment-Name}
Allow service opensearch to use network-security-groups in compartment {Compartment-Name}
Allow service opensearch to manage vcns in compartment {Compartment-Name}

For latest documentation on OpenSearch use please refer to https://docs.oracle.com/en-us/iaas/Content/search-opensearch/home.htm
Required permissions: https://docs.oracle.com/en-us/iaas/Content/search-opensearch/Concepts/ocisearchpermissions.htm

Example Usage

resource "oci_opensearch_opensearch_cluster" "test_opensearch_cluster" {
	#Required
	compartment_id = var.compartment_id
	data_node_count = var.opensearch_cluster_data_node_count
	data_node_host_memory_gb = var.opensearch_cluster_data_node_host_memory_gb
	data_node_host_ocpu_count = var.opensearch_cluster_data_node_host_ocpu_count
	data_node_host_type = var.opensearch_cluster_data_node_host_type
	data_node_storage_gb = var.opensearch_cluster_data_node_storage_gb
	display_name = var.opensearch_cluster_display_name
	master_node_count = var.opensearch_cluster_master_node_count
	master_node_host_memory_gb = var.opensearch_cluster_master_node_host_memory_gb
	master_node_host_ocpu_count = var.opensearch_cluster_master_node_host_ocpu_count
	master_node_host_type = var.opensearch_cluster_master_node_host_type
	opendashboard_node_count = var.opensearch_cluster_opendashboard_node_count
	opendashboard_node_host_memory_gb = var.opensearch_cluster_opendashboard_node_host_memory_gb
	opendashboard_node_host_ocpu_count = var.opensearch_cluster_opendashboard_node_host_ocpu_count
	software_version = var.opensearch_cluster_software_version
	subnet_compartment_id = oci_identity_compartment.test_compartment.id
	subnet_id = oci_core_subnet.test_subnet.id
	vcn_compartment_id = oci_identity_compartment.test_compartment.id
	vcn_id = oci_core_vcn.test_vcn.id

	#Optional
	certificate_config {

		#Optional
		cluster_certificate_mode = var.opensearch_cluster_certificate_config_cluster_certificate_mode
		dashboard_certificate_mode = var.opensearch_cluster_certificate_config_dashboard_certificate_mode
		open_search_api_certificate_id = oci_apigateway_certificate.test_certificate.id
		open_search_dashboard_certificate_id = oci_apigateway_certificate.test_certificate.id
	}
	coordinator_node_count = var.opensearch_cluster_coordinator_node_count
	coordinator_node_host_memory_gb = var.opensearch_cluster_coordinator_node_host_memory_gb
	coordinator_node_host_ocpu_count = var.opensearch_cluster_coordinator_node_host_ocpu_count
	coordinator_node_host_shape = var.opensearch_cluster_coordinator_node_host_shape
	coordinator_node_host_type = var.opensearch_cluster_coordinator_node_host_type
	data_node_host_bare_metal_shape = var.opensearch_cluster_data_node_host_bare_metal_shape
	data_node_host_shape = var.opensearch_cluster_data_node_host_shape
	defined_tags = {"foo-namespace.bar-key"= "value"}
	freeform_tags = {"bar-key"= "value"}
	inbound_cluster_ids = var.opensearch_cluster_inbound_cluster_ids
	load_balancer_config {
		#Required
		load_balancer_service_type = var.opensearch_cluster_load_balancer_config_load_balancer_service_type

		#Optional
		load_balancer_max_bandwidth_in_mbps = var.opensearch_cluster_load_balancer_config_load_balancer_max_bandwidth_in_mbps
		load_balancer_min_bandwidth_in_mbps = var.opensearch_cluster_load_balancer_config_load_balancer_min_bandwidth_in_mbps
	}
	maintenance_details {

		#Optional
		notification_email_ids = var.opensearch_cluster_maintenance_details_notification_email_ids
	}
	master_node_host_bare_metal_shape = var.opensearch_cluster_master_node_host_bare_metal_shape
	master_node_host_shape = var.opensearch_cluster_master_node_host_shape
	ml_node_count = var.opensearch_cluster_ml_node_count
	ml_node_host_memory_gb = var.opensearch_cluster_ml_node_host_memory_gb
	ml_node_host_ocpu_count = var.opensearch_cluster_ml_node_host_ocpu_count
	ml_node_host_shape = var.opensearch_cluster_ml_node_host_shape
	ml_node_host_type = var.opensearch_cluster_ml_node_host_type
	ml_node_storage_gb = var.opensearch_cluster_ml_node_storage_gb
	nsg_id = oci_opensearch_nsg.test_nsg.id
	opendashboard_node_host_shape = var.opensearch_cluster_opendashboard_node_host_shape
	outbound_cluster_config {
		#Required
		is_enabled = var.opensearch_cluster_outbound_cluster_config_is_enabled
		outbound_clusters {
			#Required
			display_name = var.opensearch_cluster_outbound_cluster_config_outbound_clusters_display_name
			seed_cluster_id = oci_opensearch_opensearch_cluster.test_opensearch_cluster.id

			#Optional
			is_skip_unavailable = var.opensearch_cluster_outbound_cluster_config_outbound_clusters_is_skip_unavailable
			mode = var.opensearch_cluster_outbound_cluster_config_outbound_clusters_mode
			ping_schedule = var.opensearch_cluster_outbound_cluster_config_outbound_clusters_ping_schedule
		}
	}
	reverse_connection_endpoint_customer_ips = var.opensearch_cluster_reverse_connection_endpoint_customer_ips
	search_node_count = var.opensearch_cluster_search_node_count
	search_node_host_memory_gb = var.opensearch_cluster_search_node_host_memory_gb
	search_node_host_ocpu_count = var.opensearch_cluster_search_node_host_ocpu_count
	search_node_host_shape = var.opensearch_cluster_search_node_host_shape
	search_node_host_type = var.opensearch_cluster_search_node_host_type
	search_node_storage_gb = var.opensearch_cluster_search_node_storage_gb
	security_attributes = var.opensearch_cluster_security_attributes
	security_master_user_name = oci_identity_user.test_user.name
	security_master_user_password_hash = var.opensearch_cluster_security_master_user_password_hash
	security_mode = var.opensearch_cluster_security_mode
	system_tags = var.opensearch_cluster_system_tags
}

Argument Reference

The following arguments are supported:

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 45 minutes), when creating the Opensearch Cluster * update - (Defaults to 45 minutes), when updating the Opensearch Cluster * delete - (Defaults to 45 minutes), when destroying the Opensearch Cluster

Import

OpensearchClusters can be imported using the id, e.g.

$ terraform import oci_opensearch_opensearch_cluster.test_opensearch_cluster "id"