Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: OpenSearch CCR pro platform tag #79

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update: OpenSearch CCR pro platform tag #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 35 additions & 46 deletions docs/products/opensearch/concepts/cross-cluster-replication-opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,61 +1,50 @@
---
title: OpenSearch® cross-cluster replication
limited: true
pro: true
---

:::important
Aiven for OpenSearch® cross-cluster replication (CCR) is a
[limited availability feature](/docs/platform/concepts/beta_services). If you're interested in trying out this feature, contact
the sales team at [[email protected]](mailto:[email protected]).
:::

Cross-cluster replication in Aiven for OpenSearch allows you to
replicate the entire cluster, including all of its indexes, mappings,
and metadata, from one service to another across different regions and
cloud providers.

Cross-cluster replication follows an `active-passive` model
where the follower service pulls all data and indexes from the leader
service. Once you have a
[cross-cluster replication setup](/docs/products/opensearch/howto/setup-cross-cluster-replication-opensearch), the leader cluster automatically replicates data to all its
follower clusters. You can set up follower clusters in different regions
and on different cloud providers. For simplicity, all index creation,
deletion, new data, metadata, and configuration will be replicated
automatically.
Cross-cluster replication in Aiven for OpenSearch allows you to replicate the entire cluster, including its indexes, mappings, and metadata, from one service to another across different regions and cloud providers.

## How CCR works

Cross-cluster replication operates on an active-passive model. The follower service
retrieves all data and indexes from the leader service. Once you
[set up cross-cluster replication](/docs/products/opensearch/howto/setup-cross-cluster-replication-opensearch), the leader cluster actively
replicates data to all follower clusters. You can establish follower clusters
in various regions and across different cloud providers. All index operations, data,
metadata, and configurations are replicated automatically.

## Benefits of cross-cluster replication

Some of the key benefits of cross-cluster replication include the
following:

- **Data locality/proximity:** Replicating data to a cluster closer to
the user's geographical location helps reduce latency and response
time.
- **Horizontal scalability:** Splits a query-heavy workload across
multiple replica clusters to improve application availability.
- **High availability and Disaster recovery (active-passive):** With
tolerance for outages or complete failure of clusters, cross-cluster
replication ensures uninterrupted service availability with the
ability to failover to an alternate cluster.
- **Centralized reporting cluster:** Having a single replica cluster
as a single source of truth between different master cluster
Cross-cluster replication offers key benefits, including:

- **Data locality/proximity:** Replicating data to a cluster closer to
the user's geographical location helps reduce latency and response
time.
- **Horizontal scalability:** Splits a query-heavy workload across
multiple replica clusters to improve application availability.
- **High availability and Disaster recovery (active-passive):** With
tolerance for outages or complete failure of clusters, cross-cluster
replication ensures uninterrupted service availability with the
ability to failover to an alternate cluster.
- **Centralized reporting cluster:** Having a single replica cluster
as a single source of truth between different master cluster

## Limitations {#ccr-limitatons}

Some limitations include:

- Cross cluster replication is not available for Hobbyist and Startup
plans.
- During creation, the follower cluster service must have the same
service plan as the leader cluster service. This ensures the
follower cluster service has as much memory as the leader cluster.
You can change the service plan as required later.
- To delete the cross cluster replication integration,
**delete** the follower cluster service.
- Maintenance upgrade, major version upgrade needs to be done manually
for both Leader and Follower service.
- In case of a node recycle event, replication will be paused until
the service is running again.
- This feature requires `[Pro Platform](/docs/platform/concepts/pro-platform)`.
- Hobbyist and Startup plans do not support cross-cluster replication.
- When creating the follower cluster service, it should match the memory of the leader
cluster service. The service plan can be changed later if needed.
- To remove the cross-cluster replication integration, you must delete the follower
cluster service.
- Manually perform maintenance and major version upgrades for leader and follower services.
- If a node recycle event occurs, the replication process is paused and resumes once
the service is back up and running

## Related pages

[Set up cross-cluster replication for Aiven for OpenSearch®](/docs/products/opensearch/howto/setup-cross-cluster-replication-opensearch).
- [Set up cross-cluster replication for Aiven for OpenSearch®](/docs/products/opensearch/howto/setup-cross-cluster-replication-opensearch).
62 changes: 30 additions & 32 deletions docs/products/opensearch/howto/setup-cross-cluster-replication-opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,28 @@
---
title: Setup cross cluster replication for Aiven for OpenSearch®
limited: true
pro: true
---

:::important
Aiven for OpenSearch® cross-cluster replication (CCR) is a
[limited availability feature](/docs/platform/concepts/beta_services). If you're interested in trying out this feature, contact
the sales team at [[email protected]](mailto:[email protected]).
:::
Learn how to set up Cross-cluster replication in Aiven for OpenSearch and replicate indexes, mappings, and metadata across multiple regions and cloud providers.

:::note
- Cross cluster replication is not available for the Hobbyist and
Startup plans.
:::
## Set up CCR using the Aiven Console

Follow these steps to set up
[cross cluster replication](/docs/products/opensearch/concepts/cross-cluster-replication-opensearch) for your Aiven for OpenSearch service:

1. Log in to the [Aiven Console](https://console.aiven.io/), and select
the Aiven for OpenSearch service for which you want to set up cross
cluster replication.
1. Log in to the [Aiven Console](https://console.aiven.io/), and select
the Aiven for OpenSearch service for which you want to set up cross
cluster replication.
1. In the service's **Overview** screen, scroll to the **Cross cluster replications**
section and select **Create follower**.

2. In the service's **Overview** screen, scroll to the **Cross cluster
replications** section and select **Create follower**.
1. In the **Create OpenSearch follower cluster** page:

3. In the **Create OpenSearch follower cluster** page:

- Enter a name for the follower cluster.
- Select the desired cloud provider.
- Select the desired cloud region.
- Select the service plan.
- Enter a name for the follower cluster.
- Select the desired cloud provider.
- Select the desired cloud region.
- Select the service plan.

:::note
During creation, the follower cluster service must have the same
Expand All @@ -37,28 +31,32 @@ Follow these steps to set up
You can change the service plan as required later.
:::

- Add additional disk storage based on your business requirements
- Add additional disk storage based on your business requirements

4. Select **Create**.
1. Select **Create**.

The follower cluster service will be in a `Rebuilding` state, and, once
complete, the follower cluster will be ready to pull all data and
indexes from the leader service.
The follower cluster is initially in a `Rebuilding` state and, once complete, can pull
all data and indexes from the leader service.

:::note
To learn about the current limitations with cross cluster replications
for Aiven for OpenSearch, see the
[Limitations](/docs/products/opensearch/concepts/cross-cluster-replication-opensearch#ccr-limitatons) section.
:::

## View follower cluster services
### View follower clusters

To view the follower clusters set up for your Aiven for OpenSearch service:

- Go to the service’s **Overview** page.
- Scroll down to the **Cross cluster replication** section where you can view all
the active follower clusters configured.
- Click on a follower cluster to view its OpenSearch service the details.
While you can perform all service-related operations on these follower services,
creating a follower from another follower service is not allowed.

You can view all the follower cluster services configured for your
OpenSearch service either from the **Service integration** section on
the service **Overview** screen or in the **Integrations** tab.
Additionally, the OpenSearch services display **Leader** and
**Follower** tags below the service name to help identify leader cluster
and follower cluster services.
To help you identify the services, Aiven for OpenSearch services display **Leader** and
**Follower** tags below the service name.

## Setup cross-cluster replication via API

Expand Down