Set up cross-cluster replication for Aiven for OpenSearch® Limited availability

Set up cross-cluster replication (CCR) for your Aiven for OpenSearch service to synchronize data across regions and cloud providers efficiently.

note

Cross cluster replication is not available for the Hobbyist and Startup plans.

Steps to set up CCR

Aiven Console

1. Log in to the Aiven Console, and select the Aiven for OpenSearch service.

2. On the service's Overview page, scroll to the Cross cluster replication section.

3. Click Create follower.

4. On the Create OpenSearch follower cluster page:

   • Enter a name for the follower service.
   • Select the cloud provider, region, and service plan.
   • Add additional disk storage if required.
   note

   The follower service must use the same service plan as the leader service during creation to ensure sufficient memory. You can change the service plan later.

5. Click Create.

Aiven API

To set up cross-cluster replication using the Aiven API, use the service integration endpoint and specify the integration_type as opensearch_cross_cluster_replication. For more information, see Create service integration.

curl -X POST https://api.aiven.io/v1/project/<PROJECT_NAME>/integration \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "source_service": "<LEADER_SERVICE_NAME>",
    "dest_service": "<FOLLOWER_SERVICE_NAME>",
    "integration_type": "opensearch_cross_cluster_replication"
  }'

Parameters:

• <PROJECT_NAME>: Aiven project name.
• <LEADER_SERVICE_NAME>: Leader (source) service name.
• <FOLLOWER_SERVICE_NAME>: Follower (destination) service name.
• <API_TOKEN>: API authentication token.

Aiven CLI

To set up cross-cluster replication with the Aiven CLI, use the avn service integration-create command and specify the integration-type as opensearch_cross_cluster_replication.

avn service integration-create \
  --project <PROJECT_NAME> \
  --source-service <LEADER_SERVICE_NAME> \
  --dest-service <FOLLOWER_SERVICE_NAME> \
  --integration-type opensearch_cross_cluster_replication

Parameters:

• <PROJECT_NAME>: Aiven project name.
• <LEADER_SERVICE_NAME>: Leader (source) service name.
• <FOLLOWER_SERVICE_NAME>: Follower (destination) service name.

Terraform

To set up cross-cluster replication with Terraform, configure the Aiven Provider for Terraform and set the integration-type to opensearch_cross_cluster_replication in the service integration resource. For example:

resource "aiven_service_integration" "ccr" {
  project                  = "<PROJECT_NAME>"
  integration_type         = "opensearch_cross_cluster_replication"
  source_service_name      = "<LEADER_SERVICE_NAME>"
  destination_service_name = "<FOLLOWER_SERVICE_NAME>"
}

Parameters:

• <PROJECT_NAME>: Aiven project name.
• <LEADER_SERVICE_NAME>: Leader (source) service name.
• <FOLLOWER_SERVICE_NAME>: Follower (destination) service name.

For detailed information, see the Service Integration resource documentation.

note

To learn about the limitations with cross-cluster replications for Aiven for OpenSearch, see the Limitations section.

View follower services

To view the follower services configured for your Aiven for OpenSearch service:

1. Go to the Overview page of your service.
2. Scroll to the Cross-cluster replication section.
3. Click a follower service name to view its details.

The Leader and Follower chips below the service names identify the service roles.

Promote a follower service to a standalone service

You can promote a follower service to standalone status to make it work independently, without replicating data from a leader service. This is helpful in disaster recovery situations where replication needs to stop, and the service must function on its own.

note

Promoting a follower service to standalone stops replication and deletes the replication integration. A standalone service cannot be reverted to a follower service.

Aiven Console

1. Log in to the Aiven Console, and select the Aiven for OpenSearch service.
2. On the service's Overview page, scroll to the Cross-cluster replica status section.
3. Click the follower Aiven for OpenSearch service to promote.
4. On the follower service's Overview page, click Promote to standalone in the Cross-cluster replica status.
5. Click Confirm to complete the promotion.

The follower service is now a standalone service and can accept writes. You can set up replication again if needed.

Aiven API

To promote a follower service to standalone using the Aiven API, delete the opensearch_cross_cluster_replication integration from the service.

curl -X DELETE https://api.aiven.io/v1/project/<PROJECT_NAME>/integration/<INTEGRATION_ID> \
  -H "Authorization: Bearer <API_TOKEN>"

Parameters:

• <PROJECT_NAME>: Aiven project name.
• <INTEGRATION_ID>: ID of the opensearch_cross_cluster_replication integration.
• <API_TOKEN>: API authentication token.

Removing the integration transitions the follower service to a standalone service.

Aiven CLI

To promote a follower service to standalone using the Aiven CLI, delete the opensearch_cross_cluster_replication integration with the following command:

avn service integration-delete \
  --project <PROJECT_NAME> \
  --integration-id <INTEGRATION_ID>

Parameters:

• <PROJECT_NAME>: Aiven project name.
• <INTEGRATION_ID>: ID of the opensearch_cross_cluster_replication integration.

Deleting the integration transitions the follower service to a standalone service.

Terraform

To promote a follower service to standalone using Terraform, delete the opensearch_cross_cluster_replication integration from your configuration.

resource "aiven_service_integration" "ccr" {
  project                  = "<PROJECT_NAME>"
  integration_type         = "opensearch_cross_cluster_replication"
  source_service_name      = "<LEADER_SERVICE_NAME>"
  destination_service_name = "<FOLLOWER_SERVICE_NAME>"
}

Run terraform apply to apply the changes. After the changes are applied, the follower service transitions to a standalone service.