Creating an OpenSearch Cluster

• Console
• CLI
• API

• On the Clusters list page, select Create load cluster. If you need help finding the list page, see Listing Clusters.

  Creating an OpenSearch cluster consists of the following pages:

  • 1. Configure cluster

  • 2. Configure security

  • 3. Configure nodes

  • 4. Configure networking

  • 5. Review step

  Run each of the following workflows in order. You can return to a previous page by selecting Previous.

  1. Configure cluster

  The Configure cluster page is where you provide the basic configuration information for the cluster.

  Enter the following information:

  • Name: Accept the default name or enter a friendly name for the cluster.

  • Create in compartment: Select the compartment where the cluster resides from the list.

  • Software version: Select the software version from the list.

  • Tag namespace: (Optional) Enter tagging information.

    If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

  Contact

  The specified contact receives operational notifications and announcements regarding the cluster.

  • Contact email: Enter the email address of the contact.

  Tagging

  If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

  Select Next.

  2. Configure security

  The Configure security page is where you enter the sign-in credentials for the cluster's primary account.

  You use this account to connect to the cluster and the cluster's OpenSearch Dashboard. You can then configure other users and roles for the cluster. For more information, see Role-Based Access Control in Search with OpenSearch.

  • Username: Enter your username.

  • Password: Enter your password.

  • Confirm password: Reenter your password. It must match the password you entered earlier.

  Select Next.

  3. Configure nodes

  The Configure nodes page is where you select the appropriate node optimization option for your scenario.

  Enter the following information:

  Node optimization profiles

  Select one of the following node types. Review their descriptions in the Console to decide which node type is best for your needs:

  • Development:

  • Application Search:

  • Log Analytics:

  After you select the node type, configure the node. OpenSearch applies default settings depending on which node type you selected. But you can update any setting as needed.

  Data node configuration

  Enter the following information:

  • Dedicated data nodes: Enter the number of dedicated data nodes. The value must be between 1 and 10.

  • Data node OCPU count: Enter the number of data node OCPUs. The value must be between 1 and 32.

  • Data node memory (GB): Enter the amount of memory for the data nodes in gigabytes. The value must be between 20 and 1024.

  • Data node storage (GB): Enter the amount of storage for the data nodes in gigabytes. The value must be between 50 and 314572.

  Leader node configuration

  Enter the following information:

  • Dedicated leader nodes: Enter the number of dedicated leader nodes. The value must be between 1 and 3.

  • Leader node OCPU count: Enter the number of leader node OCPUs. The value must be between 1 and 32.

  • Leader node memory (GB): Enter the amount of memory for the leader nodes in gigabytes. The value must be between 20 and 1024.

  Configure OpenSearch Dashboards

  Enter the following information:

  • OpenSearch Dashboard nodes: Enter the number of Dashboard nodes. The value must be between 1 and 3.

  • OpenSearch Dashboard node OCPU count: Enter the number of Dashboard node OCPUs. The value must be between 1 and 32.

  • OpenSearch Dashboard node memory (GB): Enter the amount of memory for the Dashboard nodes in gigabytes. The value must be between 8 and 1024.

  Select Next.

  4. Configuring Networking

  The Configure networking page is where specify the virtual cloud network (VCN) and subnet for the cluster. Decide whether you want to use an existing VCN and subnet, create a new VCN or subnet, or specify the OCID for an existing subnet.

  Network

  Select one of the following network options and then complete their configurations:

  • Select existing virtual cloud network. Enter the following information:

    • Virtual cloud network in <compartment>: Select one of the VCNs from the list within the specified compartment.

  • Create virtual cloud network. Enter the following information:

    • Create virtual cloud network: Accept the default name or enter a friendly name for the VCN you're creating.

    • Create in compartment: Select the compartment where the VCN resides from the list.

      Note
      
      

      If you decide to create a new VCN, you must also create a new subnet for it. You can't assign an existing subnet to a newly-created VCN.

  Subnet

  A subnet within the cloud network to which the instance is attached. The subnets are either public or private. Private means that the instances in that subnet can't have public IP addresses. For more information, see Access to the Internet.

  Subnets can also be either availability domain specific or regional. Regional ones have "regional" after the name. We recommend using regional subnets. For more information, see About Regional Subnets.

  Select one of the following subnet options and then complete their configurations:

  • Select existing subnet. Enter the following information:

    • Subnet in <compartment>: Select one of the subnets from the list within the specified compartment.

      Note
      
      

      You can't assign an existing subnet to a newly-created VCN. You must create a new subnet for it.

  • Create public subnet. Enter the following information:

    • New subnet name: Accept the default name or enter a friendly name for the subnet you're creating.

    • Create in compartment: Select the compartment where the subnet resides from the list.

    • CIDR: Enter a single, contiguous CIDR block for the subnet (for example, 172.16.0.0/24). Ensure that it's within the cloud network's CIDR block and doesn't overlap with any other subnets. You can't change this value later. See Allowed VCN Size and Address Ranges and this CIDR calculator.

  Select Next.

  5. Review step

  Review the contents of the Review step page. Select Previous to return to previous screens to add or change information. When the settings are fully verified, select Create cluster.

  The OpenSearch cluster you created appears in the Clusters list page.

• Use the oci opensearch cluster create command and required parameters to create a cluster:

  oci opensearch cluster create --compartment-id compartment_ocid --data-node-count data_node_count 
  --data-node-host-memory-gb data_node_host_memory_gb --data-node-host-ocpu-count data_node_host_ocpu_count 
  --data-node-host-type BM|FLEX --data-node-storage-gb data_node_storage_gb 
  --display-name display_name --master-node-count master_node_count --master-node-host-memory-gb master_node_host_memory_gb 
  --master-node-host-ocpu-count master_node_host_ocpu_count --master-node-host-type BM|FLEX 
  --opendashboard-node-count opendashboard_node_count --opendashboard-node-host-memory-gb opendashboard_node_host_memory_gb 
  --opendashboard-node-host-ocpu-count opendashboard_node_host_ocpu_count --software-version software_version 
  --subnet-compartment-id subnet_compartment_ocid --subnet-id subnet_ocid --vcn-compartment-id vcn_compartment_ocid 
  --vcn-id vcn_ocid [OPTIONS]

  where the following variables are:

  display_name: Enter a friendly name for the cluster.

  compartment_ocid: Enter the compartment OCID where the cluster resides.

  software_version: Enter the software version of the cluster.

  data_node_count: Enter the number of dedicated data nodes. The value must be between 1 and 10.

  data_node_host_ocpu_count: Enter the number of data node OCPUs. The value must be between 1 and 32.

  data_node_host_memory_gb: Enter the amount of memory for the data nodes in gigabytes. The value must be between 20 and 1024.

  data_node_host_type: Accepted values are: BM or FLEX.

  data_node_storage_gb: Enter the amount of storage for the data nodes in gigabytes. The value must be between 50 and 314572.

  master_node_count: Enter the number of dedicated master nodes. The value must be between 1 and 3.

  master_node_host_ocpu_count: Enter the number of master node OCPUs. The value must be between 1 and 32.

  master-node-host-type: Accepted values are: BM or FLEX.

  master_node_host_memory_gb: Enter the amount of memory for the master nodes in gigabytes. The value must be between 20 and 1024.

  opendashboard_node_count: Enter the number of Dashboard nodes. The value must be between 1 and 3.

  opendashboard_node_host_ocpu_count: Enter the number of Dashboard node OCPUs. The value must be between 1 and 32.

  opendashboard_node_host_memory_gb: Enter the amount of memory for the Dashboard nodes in gigabytes. The value must be between 8 and 1024.

  vcn_ocid: Enter the OCID of the cluster's VCN.

  vcn_compartment_ocid: Enter the compartment OCID where the cluster's VCN resides.

  subnet_compartment_ocid: Enter the compartment OCID where the cluster's subnet resides.

  subnet_ocid: Enter the OCID of the cluster's subnet.

  For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  Generating a Password Hash

  If you're including the optional security-master-user-password-hash parameter to use with the optional security-master-user-name parameter, you need to generate the password hash:

  1. Download the following file:
     oci-crypto-common-1.0.0-SNAPSHOT.jar
  2. Open a command prompt and run the following command:
     java -jar oci-crypto-common-1.0.0-SNAPSHOT.jar pbkdf2_stretch_1000 <password-in-plain-text>

     where <password-in-plain-text> is a password of your choosing.

     You must have Java installed on your computer before running this command.

  3. Record the generated password hash.
  4. Include the generated password hash as the value for the security-master-user-password-hash parameter.
     Use single quotes around the password. For example:

     oci opensearch cluster create ... --security-master-user-name MyUser --security-master-user-password-hash 'pbkdf2_...MNUT5No='

• Run the CreateOpensearchCluster operation to create a cluster.