NavigationContentFooter
Jump toSuggest an edit

How to manage Read Replicas

Reviewed on 27 March 2024Published on 21 September 2021

Before you start

To complete the actions presented below, you must have:

  • A Scaleway account logged into the console
  • Owner status or IAM permissions allowing you to perform actions in the intended Organization
  • A PostgreSQL or MySQL Database Instance
  • Created a Read Replica

How to resync a Read Replica

When you resync a Read Replica, first it is reset, and then its data is resynchronized from the primary node. Your Read Replica will be unavailable during the resync process. The duration of this process is proportional to your Database Instance size. The configured endpoints will not change.

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.
  2. Click the database name or «See more Icon» > More info to access the Database Instance information page.
  3. Scroll down to the Read Replica section.
  4. Click «See more Icon» > Resync next to the name of the Read Replica you want to resync. A pop-up displays.
  5. Make sure you have selected the correct Read Replica and click Resync. The list of your Read Replicas displays.
Important

Your Read Replica will be unavailable during the resync process. The duration of this process is proportional to your Database Instance size. The configured endpoints will not change.

How to promote a Read Replica

It is possible to promote a Read Replica node to a standalone Database Instance.

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.

  2. Click the database name or «See more Icon» > More info to access the Database Instance information page.

  3. Scroll down to the Read Replica section.

  4. Click «See more Icon» > Promote Read Replica next to the name of the Read Replica you want to promote. A pop-up displays.

    Important

    Promoting a Read Replica is irreversible. Make sure that the main Database Instance node has completed all ongoing operations, and that the Read Replica lag is down to zero before promoting it. This helps ensure that the promoted Read Replica contains all operations from the main node.

    Note

    If the Read Replica you promote is attached to a Private Network, the resulting node will also be attached to the same Private Network. It will maintain the same private endpoint.

  5. Click Promote Read Replica.

  6. Go back to the list of your Database Instances. The promoted Read Replica appears.

    Important

    The new Instance originating from the Read Replica promotion will bear the prefix promoted, followed by the name of the original Database Instance that was replicated. You can change the name of your Database Instance on its overview page anytime. To do so, click «Edit Icon» next to its name.

How to manage Private Networks

You can attach and detach your Read Replica to a Private Network even after its creation.

Attach your Read Replica to a new Private Network

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.
  2. Click the database name or «See more Icon» > More info to access the Database Instance information page.
  3. Scroll down to the Read Replica section.
  4. Click «See more Icon» > Attach Private Network next to the name of your selected Read Replica. A pop-up displays.
  5. Select Create and attach a new Private Network.
    Important

    Your private IP addresses are automatically allocated. They are managed via an IP Address Manager (IPAM). You can retrieve them on the Private Network tab of your Database Instance. To allocate IPs manually, you can use the Scaleway API and CLI, or Terraform.

  6. Click Attach Private Network.

Attach your Read Replica to an existing Private Network

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.
  2. Click the Database Instance name or «See more Icon» > More info to access the Database Instance information page.
  3. Scroll down to the Read Replica section.
  4. Click «See more Icon» > Attach Private Network next to the name of your selected Read Replica. A pop-up displays.
  5. Select an existing Private Network to attach to your Read Replica.
    Important

    Your private IP addresses are automatically allocated. They are managed via an IP Address Manager (IPAM). You can retrieve them on the Private Network tab of your Database Instance. To allocate IPs manually, you can use the Scaleway API and CLI, or Terraform.

  6. Click Attach to Private Network to confirm.

Detach your Read Replica from a Private Network

If you already have an attached Private Network, you can detach it from your Read Replica.

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.
  2. Click the database name or «See more Icon» > More info to access the Database Instance information page.
  3. Scroll down to the Read Replica section.
  4. Click «See more Icon» > Detach Private Network next to the name of your selected Read Replica. A pop-up displays to ask if you are sure you want to detach the Private Network.
  5. Click Detach Private Network to proceed. The list of your Read Replicas displays. The private endpoint is removed.

How to delete a public endpoint

Refer to the How to delete a public endpoint documentation page to do so for your Read Replica.

How to delete Read Replicas

  1. Click PostgreSQL and MySQL under Managed Databases on the side menu. A list of your Database Instances displays.
  2. Click the database name or «See more Icon» > More info to access the Database Instance information page.
  3. Scroll down to the Read Replica section.
  4. Click «See more Icon» > Delete. A pop-up appears.
    Important

    This is an irreversible that action permanently deletes your Read Replica and all its associated endpoints.

  5. Click Delete Read Replica to do so. The list of your Read Replicas displays.
See also
How to create Read ReplicasHow to delete a database
Docs APIScaleway consoleDedibox consoleScaleway LearningScaleway.comPricingBlogCarreer
© 2023-2024 – Scaleway