Updating a Cross-Cluster Connection in Search with OpenSearch

Edit the settings for a cross cluster connection.

Edit an existing Outbound cross-cluster connection on the cluster where the alias is configured: the cross-cluster search (CCS) coordinating cluster or cross-cluster replication (CCR) follower. Inbound connections do not offer the Edit action.

For initial setup, see the complete CCS and CCR setup examples. The CLI and API update operation can also create the initial alias.

1. On the Clusters list page, find the OpenSearch cluster that you want to work with. If you need help finding the list page or the cluster, see Listing Clusters.
  Open the CCS coordinating cluster or CCR follower cluster.
2. Select Cross cluster connections.
3. Find the Outbound connection, open its actions menu, and select Edit.
  
  You can update the name, ping schedule, and whether to skip the cluster if the nodes are unavailable during the search.
4. Select Save to update the connection settings.

Use the oci opensearch cluster update command on the cluster holding the alias: the CCS coordinator or CCR follower. Include every outboundClusters entry that you want to retain. Use the current cluster display name:

oci opensearch cluster update --from-json file://<Config_File_Name>.json --display-name "<current_cluster_display_name>" --wait-for-state SUCCEEDED

The following is an example of the JSON for a cross cluster connection config file:

{
  "outboundClusterConfig": {
    "isEnabled": true,
    "outboundClusters": [
      {
        "displayName": "remote-cluster",
        "isSkipUnavailable": true,
        "seedClusterId": "ocid1.opensearchcluster.oc1.iad.<accepting_cluster_unique_id>",
        "mode": "SEARCH_AND_REPLICATION"
      }
    ]
  },
"opensearchClusterId": "ocid1.opensearchcluster.oc1.iad.<connecting_cluster_unique_id>"
}

For a complete list of parameters and values for CLI commands, see the CLI Command 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 UpdateOpensearchCluster operation to edit the configuration for a cross cluster connection.

Run the update on the cluster holding the alias: the CCS coordinator or CCR follower. Supply the complete outboundClusters list to retain. For initial alias creation, see the complete CCS and CCR setup examples.

Oracle Cloud Infrastructure Documentation

Updating a Cross-Cluster Connection in Search with OpenSearch