Oracle Cloud Infrastructure Documentation

Add a Cross Cluster Connection

Add a cross cluster connection to enable cross cluster operations for a cluster.

You must add a cross cluster connections to perform cross cluster search and cross cluster replication in OCI Search with OpenSearch.

    1. On the Clusters list page, find the cluster that you want to work with. If you need help finding the list page or the cluster, see Listing OpenSearch Clusters.
    2. Select Cross cluster connections.
    3. Select Add connection.
    4. If the cluster you selected in step 3 is the outbound cluster, select Inbound, and specify the cluster OCID for the inbound cluster you want to connect to from the current cluster. To add connections for more clusters, click Add cluster.
      If the cluster you selected in step 3 is the inbound cluster, select Outbound, specify a name for the cross cluster connection, and then specify the OCID for the outbound cluster.
      Tip

      You must add the inbound cluster on the Inbound page for the outbound cluster before you can configure the cross cluster connection on the Outbound page for the inbound cluster.
    5. Specify the value for Ping schedule and whether to skip the remote cluster if the nodes are unavailable during the search.
      Note

      The configuration in the Mode selection box isn't currently used by OCI Search with OpenSearch and doesn't impact how you use the cross cluster connection.
    6. Select Add cluster and repeat steps 6 to 8 for any other clusters you want to configure connections for.
    7. Select Submit.

  • Use the configureoutboundcluster command and required parameters to add a cross cluster connection:

    oci opensearch cluster configureoutboundcluster --inbound-cluster-ids file://<inbound-clusterIDs-file>.json --opensearch-cluster-id <cluster_ocid>

    The following is an example of the json for a file containing the inbound cluster IDs:

    { "inboundClusterIds": ["ocid1.opensearchcluster.oc1.iad.<inbound_cluster1_unique_id>"], "opensearchClusterId": "ocid1.opensearchcluster.oc1.iad.<inbound_cluster2_unique_id>" }

    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 ConfigureOutboundCluster to add a cross cluster connection.

    Run the UpdateOpensearchCluster operation to configure the cross cluster connections for the cluster.