Oracle Cloud Infrastructure Documentation

Creating an OpenSearch Cluster

Create an OpenSearch cluster with OCI Search with OpenSearch.

When you create an OpenSearch cluster, Search with OpenSearch creates the set of Compute instances that provide the OpenSearch functionality. Each cluster is composed of one or more data nodes, leader nodes, and OpenSearch Dashboard nodes, based on the options that you specify when you create the cluster.

    1. Open the navigation menu and click Databases. Under OpenSearch, click Clusters.

    2. Click Create cluster.

    3. On the Configure cluster page, enter a name for the cluster, then select the compartment to create the cluster in.

    4. Enter a valid email address in Contact email.

    5. (Optional) Tags: Click Show tagging options to add tags to the cluster.

      Tags: 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 are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator.

    6. Click Next.

    7. On the Configure security page, enter a username and password for the cluster's primary account. Enter the password again for confirmation.

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

    8. Click Next.

    9. On the Configure nodes page, select the appropriate node optimization option for your scenario.

    10. (Optional) Customize the default node configuration for the cluster's data nodes, leader nodes, and OpenSearch Dashboard nodes.

      In Configure OpenSearch, click Edit for the node configuration that you want to customize and then update the settings as needed.

      The minimum memory configuration required for cluster nodes are as follows:
      • Data node: 20 GB
      • Leader node: 20 GB
      • OpenSearch Dashboard node: 8 GB

    11. Click Next.

    12. On the Configure networking page, 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.

      Select existing virtual cloud network: If you select this option, enter the following information:

      • Virtual cloud network: The cloud network to create the instance in.

      • Subnet: A subnet within the cloud network that the instance is attached to. 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.

        To use an existing subnet, select Select existing subnet, and then select the subnet.

        To create a new subnet, select Create new public subnet, and then enter the following information:

        • New subnet name: A name for the subnet. It doesn't have to be unique, and it can be changed later. Avoid entering confidential information.
        • Create in compartment: The compartment where you want to put the subnet.
        • CIDR block: 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.

      Create new virtual cloud network: If you select this option, enter the following information:

      • New virtual cloud network name: A name for the network. Avoid entering confidential information.

      • Create in compartment: The compartment where you want to put the new network.

      • Create new public subnet: A subnet within the cloud network to attach the instance to. 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.

        Enter the following information:

        • New subnet name: A name for the subnet. It doesn't have to be unique, and it can be changed later. Avoid entering confidential information.
        • Create in compartment: The compartment where you want to put the subnet.
        • CIDR block: 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.

      Enter subnet OCID: If you select this option, enter the subnet OCID.

    13. Click Next.

    14. Review the cluster confirmation details on the Summary page, and then click Create cluster.

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

    oci opensearch cluster create [OPTIONS]

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

  • For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

    Run the CreateOpensearchCluster operation to create a cluster.