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.

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

add: Migration from Caching to Valkey #508

Merged
merged 4 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: Migrate Aiven for Caching or Valkey to Aiven for Valkey™
---
import ConsoleLabel from "@site/src/components/ConsoleIcons"
import ConsoleIcon from "@site/src/components/ConsoleIcons"

Migrate your Aiven for Caching or Valkey databases to Aiven for Valkey™ using the Aiven Console migration tool.

## Prerequisites

Before starting the migration process, ensure the following:

- A target [Aiven for Valkey service](/docs/products/valkey/get-started).
- Source database details:
- **Hostname or connection string**: The public hostname, connection string, or
IP address used to connect to the database.
- **Port**: The port used to connect to the database.
- **Username**: The username with sufficient permissions to access the data.
- **Password**: The password used to connect to the database.
- Firewall rules updated or temporarily disabled to allow traffic between source and
target databases.
- A source Caching or Valkey service secured with SSL.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
- A publicly accessible source Caching or Valkey service or one with a VPC peering
connection between private networks. You'll need the VPC ID and cloud name.

## Database migration steps

1. Log in to the [Aiven Console](https://console.aiven.io/) and select the
Aiven for Valkey service for your migration.
1. Go to <ConsoleLabel name="service settings"/> from the sidebar.
1. Scroll to <ConsoleLabel name="actions"/> > **Migrate database** to start the
migration.
1. Follow the wizard to guide you through the migration process.

### Step 1: Configure

Review the prerequisites and click **Get started** to begin.
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

### Step 2: Validate

In the migration screen, enter the connection details:

- Hostname
- Port
- Username
- Password

Select **SSL encryption recommended** for a secure connection, and click **Run check**.

The [Aiven Console](https://console.aiven.io/) validates the database configurations. If
any errors occur, follow the on-screen instructions to resolve them and rerun the check.

:::note
The migration does not include service user accounts or commands in progress.
:::
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

### Step 3: Migrate

Once validation is complete, click **Start migration** to begin migrating data to
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved
Aiven for Valkey.

### Step 4: Replicate

While the migration is in progress:

- You can close the migration wizard and monitor the progress later from the
<ConsoleIcon name="overview"/> page.
- To stop the migration, click **Stop migration** in the migration progress window.
Data already transferred to Aiven for Valkey is preserved.

To prevent conflicts during replication:

- Do not create or delete databases on the source service.
- Avoid network or configuration changes that might disrupt the connection between source
and target databases, such as firewall modifications.

If the migration fails, resolve the issue and click **Start over**.

### Step 5: Close and complete the migration

After the migration:
harshini-rangaswamy marked this conversation as resolved.
Show resolved Hide resolved

- **Stop replication**: If no further synchronization is needed, and you are ready
to switch to Aiven for Valkey after testing.
- **Keep replicating**: If continuous data synchronization is needed. Avoid system
updates or configuration changes during active replication to prevent unintended
migrations.

:::note
When replication is active, Aiven for Valkey ensures your data stays in sync by
continuously synchronizing new writes from the source database.
7 changes: 7 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1895,6 +1895,13 @@ const sidebars: SidebarsConfig = {
'products/valkey/howto/connect-java',
],
},
{
type: 'category',
label: 'Data migration',
items: [
'products/valkey/howto/migrate-caching-valkey-to-aiven-for-valkey',
],
},
{
type: 'category',
label: 'Read replica',
Expand Down