Skip to content
Draft
Show file tree
Hide file tree
Changes from all 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
6 changes: 3 additions & 3 deletions docs/content/preview/yugabyte-voyager/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ Use YugabyteDB Voyager to manage end-to-end database migration, including cluste

{{< sections/text-with-right-image
title="Get Started"
description="Install YugabyteDB Voyager on different operating systems (RHEL, Ubuntu, macOS), or via environments such as Docker or an Airgapped installation."
description="Install YugabyteDB Voyager and perform an end-to-end offline migration with our quick start guide."
imageTransparent=true
buttonText="Install"
buttonUrl="install-yb-voyager/"
buttonText="Quick start"
buttonUrl="quickstart/"
imageTransparent=true
imageAlt="YugabyteDB Voyager" imageUrl="/images/homepage/voyager-transparent.svg"
>}}
Expand Down
44 changes: 44 additions & 0 deletions docs/content/preview/yugabyte-voyager/install-yb-voyager.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,24 @@ The node where you'll run the yb-voyager command should:

YugabyteDB Voyager consists of the yb-voyager command line executable.

<ul class="nav nav-tabs nav-tabs-yb">
<li>
<a href="#local-machine" class="nav-link active" id="local-machine-tab" data-bs-toggle="tab" role="tab" aria-controls="local-machine" aria-selected="true">
<img src="/icons/database.svg" alt="Server Icon">
Local machine
</a>
</li>
<li>
<a href="#yugabytedb-aeon" class="nav-link" id="yugabytedb-aeon-tab" data-bs-toggle="tab" role="tab" aria-controls="yugabytedb-aeon" aria-selected="false">
<img src="/icons/cloud.svg" alt="Cloud Icon">
YugabyteDB Aeon
</a>
</li>
</ul>

<div class="tab-content">
<div id="local-machine" class="tab-pane fade show active" role="tabpanel" aria-labelledby="local-machine-tab">

Install yb-voyager on a machine which satisfies the [Prerequisites](#prerequisites) using one of the following options:

<ul class="nav nav-tabs nav-tabs-yb">
Expand Down Expand Up @@ -383,6 +401,32 @@ You can download the oracle instant client RPM packages from the following links
</div>
</div>

</div>
<div id="yugabytedb-aeon" class="tab-pane fade" role="tabpanel" aria-labelledby="yugabytedb-aeon-tab">

To install YugabyteDB Voyager via YugabyteDB Aeon, do the following:

1. Create a YugabyteDB Aeon cluster as follows:

1. [Sign up](https://cloud.yugabyte.com) for YugabyteDB Aeon.

1. Create a cluster:
- Log in to your YugabyteDB Aeon account.
- Click **Create a Free cluster** on the welcome screen, or click **Add Cluster** on the **Clusters** page to open the **Create Cluster** wizard.
- Select **Sandbox** for testing or **Dedicated** for production.
- Enter a cluster name, choose your cloud provider (AWS or GCP) and region in which to deploy the cluster, then click **Next**.
- Click **Add Current IP Address** to allow connections from your machine, and click **Next**.
- Click **Download credentials**. The default credentials are for a database user named "admin". You'll use these credentials when connecting to your YugabyteDB database.
- Click **Create Cluster**.

1. Install YugabyteDB Voyager on your machine as follows:

1. In your YugabyteDB Aeon cluster page, click **Migrations**, and select **Migrate Database**.
1. In **Prepare Voyager**, choose your operating system, run the installation commands on your machine, and verify the installation.

</div>
</div>

## Collect diagnostics

By default, yb-voyager captures a [diagnostics report](../reference/diagnostics-report/) using the YugabyteDB diagnostics service that runs each time you use the yb-voyager command. If you don't want to send diagnostics when you run yb-voyager, set the [--send-diagnostics flag](../reference/diagnostics-report/#configure-diagnostics-collection) to false.
Expand Down
52 changes: 49 additions & 3 deletions docs/content/preview/yugabyte-voyager/migrate/migrate-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,25 @@ target:

Refer to the [offline-migration.yaml](https://github.com/yugabyte/yb-voyager/blob/{{< yb-voyager-release >}}/yb-voyager/config-templates/offline-migration.yaml) template for more information on the available global, source, and target configuration parameters supported by Voyager.

## Configure yugabyted UI
## Configure control plane

<ul class="nav nav-tabs nav-tabs-yb">
<li>
<a href="#yugabyted" class="nav-link active" id="yugabyted-tab" data-bs-toggle="tab" role="tab" aria-controls="yugabyted" aria-selected="true">
<img src="/icons/database.svg" alt="Server Icon">
yugabyted
</a>
</li>
<li>
<a href="#yugabyted-aeon" class="nav-link" id="yugabyted-aeon-tab" data-bs-toggle="tab" role="tab" aria-controls="yugabyted-aeon" aria-selected="false">
<img src="/icons/cloud.svg" alt="Cloud Icon">
yugabyted Aeon
</a>
</li>
</ul>

<div class="tab-content">
<div id="yugabyted" class="tab-pane fade show active" role="tabpanel" aria-labelledby="yugabyted-tab">

You can use [yugabyted UI](/preview/reference/configuration/yugabyted/) to view the migration assessment report, and to visualize and review the database migration workflow performed by YugabyteDB Voyager.

Expand All @@ -212,10 +230,38 @@ Configure the yugabyted UI as follows:
yugabyted-db-conn-string: postgresql://yugabyte:yugabyte@127.0.0.1:5433
```

{{< note title="Note" >}}
{{< note title="Note" >}}

Don't include the `dbname` parameter in the connection string; the default `yugabyte` database is used to store the meta information for showing the migration in the yugabyted UI.
{{< /note >}}

</div>
<div id="yugabyted-aeon" class="tab-pane fade" role="tabpanel" aria-labelledby="yugabyted-aeon-tab">

You can use [YugabyteDB Aeon](/preview/reference/configuration/yugabyted/) to view the migration assessment report, and to visualize and review the database migration workflow performed by YugabyteDB Voyager.

Configure YugabyteDB Aeon as follows:

1. Start a YugabyteDB Aeon cluster. Refer to the steps described in [Create your Sandbox cluster](/preview/yugabyte-cloud/cloud-quickstart/#create-your-sandbox-cluster). Skip this step if you already have a YugabyteDB Aeon cluster as your [target database](#prepare-the-target-database).

1. To see the Voyager migration workflow details in the UI, set the following configuration parameters before starting the migration:

```yaml
### Control plane type refers to the deployment type of YugabyteDB
control-plane-type: yugabyted aeon

### YSQL connection string
### Provide the standard PostgreSQL connection parameters, including user name, host name, and port. For example, postgresql://yugabyte:yugabyte@127.0.0.1:5433
yugabyted-db-conn-string: postgresql://yugabyte:yugabyte@127.0.0.1:5433
```

{{< note title="Note" >}}

Don't include the `dbname` parameter in the connection string; the default `yugabyte` database is used to store the meta information for showing the migration in the yugabyted UI.
{{< /note >}}
{{< /note >}}

</div>
</div>

## Assess migration

Expand Down
Loading