Oracle Cloud Infrastructure Documentation

OpenSearch Clusters

OCI Search with OpenSearch lets you create OpenSearch clusters for your search solutions.

After you've created your OpenSearch cluster, Search with OpenSearch handles most of the management and operations of search clusters, including operations such as security updates, upgrades, resizing, and scheduled backups.

You can perform the following OpenSearch cluster tasks:

List the OpenSearch clusters in a compartment.

Create a new OpenSearch cluster.

Get an OpenSearch cluster's details.

Rename an OpenSearch cluster.

Resize an OpenSearch cluster.

OpenSearch Cluster Software Upgrades.

Delete an OpenSearch cluster from your tenancy.

IAM Policy

To use Oracle Cloud Infrastructure, you must be granted security access in a policy  by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don’t have permission or are unauthorized, verify with your administrator what type of access you have and which compartment  to work in.

To create or manage a cluster, you need to configure permissions to grant access for users to create and manage the required Networking resources, in addition to users permissions to create and manage Search with OpenSearch resources. The Networking permissions need to be configured for the compartment that contains the Networking resources, so if the cluster is in a different compartment from the VCN and subnet, ensure that the Networking permissions are configured for the compartment containing the VCN and subnet.

The following policy example includes the required permissions for a custom group SearchOpenSearchAdmins: 

Allow group SearchOpenSearchAdmins to manage vnics in compartment <NETWORK_RESOURCES_COMPARTMENT>
Allow group SearchOpenSearchAdmins to manage vcns in compartment <NETWORK_RESOURCES_COMPARTMENT>
Allow group SearchOpenSearchAdmins to manage subnets in compartment <NETWORK_RESOURCES_COMPARTMENT>
Allow group SearchOpenSearchAdmins to use network-security-groups in compartment <NETWORK_RESOURCES_COMPARTMENT>
Allow group SearchOpenSearchAdmins to manage opensearch-family in compartment <CLUSTER_RESOURCES_COMPARTMENT>
Tip

The SearchOpenSearchAdmins group in this example refers to a custom group that you create. See Managing Groups for more information.

The permissions to Networking resources included in this example are required as specified. You can configure the permissions for Search with OpenSearch resources, specified in the last line in this example, with more granularity.

If you're new to policies, see Getting Started with Policies and Common Policies.

Tagging Resources

You can apply tags to your resources to help you organize them according to your business needs. You can apply tags at the time you create a resource, or you can update the resource later with the wanted tags. For general information about applying tags, see Overview of Tagging.

Listing OpenSearch Clusters

View a list of the OpenSearch clusters in a Oracle Cloud Infrastructure compartment.

    1. Open the navigation menu  and select Databases. Under OpenSearch, select Clusters.
      The Clusters list page opens. All clusters in the selected compartment are displayed in a table.
    2. To view the OpenSearch clusters in a different compartment, use the Compartment filter to switch compartments.

      You must have permission to work in a compartment to see the resources in it. If you're not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.

    Filtering List Results

    Use filters to limit the OpenSearch clusters in the list. Perform one of the following actions depending on the options that you see:

    • From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that aren't shown in the table. The Compartment filter is always displayed next to Applied filters.
    • On the left side of the list page, select a value from one of the available filters, such as compartment, state, or tags.

    Change the order of the items in the list table by using the sort icons next to the column names.

    For information about searching for resources and managing the columns in the list table, if those features are available, see Listing Resources.

    Actions

    In the list table, select the name of a OpenSearch cluster to open its details page, where you can view its status and perform other tasks.

    To perform an action on a OpenSearch cluster directly from the list table, select an available option from the Actions menu in the row for that OpenSearch cluster:

    To create an OpenSearch cluster, select Create cluster.

  • Use the oci opensearch cluster list command and required parameters to list the clusters in a compartment:

    oci opensearch cluster list --compartment-id compartment_id [OPTIONS]

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the ListOpensearchClusters operation to list the clusters in a compartment.