Skip to content

Commit bbc4829

Browse files
fix(rbd): add regionalization changes to docs
1 parent aa93549 commit bbc4829

22 files changed

+166
-134
lines changed

pages/managed-databases-for-postgresql-and-mysql/how-to/add-a-database.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ categories:
2020
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/)
2121

2222
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
23-
2. Click the Database Instance name or <Icon name="more" /> > **More info** to access the Database Instance information page.
24-
3. Go to the **Databases** tab. A list of your databases displays. The list includes the database created by default upon Database Instance creation.
25-
4. Click **+ Create database** to create a new one. A pop-up appears.
26-
5. Enter a name for your database.
27-
6. Click **Create database** to confirm.
23+
2. Select the geographical region of the Instance you want to manage from the drop-down.
24+
3. Click the Database Instance name or <Icon name="more" /> > **More info** to access the Database Instance information page.
25+
4. Go to the **Databases** tab. A list of your databases displays. The list includes the database created by default upon Database Instance creation.
26+
5. Click **+ Create database** to create a new one. A pop-up appears.
27+
6. Enter a name for your database.
28+
7. Click **Create database** to confirm.
2829

2930
The new database appears in the list of your databases.

pages/managed-databases-for-postgresql-and-mysql/how-to/add-users.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,15 @@ Users can connect to a database and access its data. Each one has a different se
2323
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/)
2424

2525
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
26-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
27-
3. Go to the **Users** tab. A list of users displays. If it is the first time you create a user, your list will display the user you set up during the creation of your Database Instance.
28-
4. Click **+ Create user** to create a new user, if you wish to.
29-
5. Click <Icon name="toggle" /> to grant admin rights to the user.
26+
2. Select the geographical region of the Instance you want to manage from the drop-down.
27+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
28+
4. Go to the **Users** tab. A list of users displays. If it is the first time you create a user, your list will display the user you set up during the creation of your Database Instance.
29+
5. Click **+ Create user** to create a new user, if you wish to.
30+
6. Click <Icon name="toggle" /> to grant admin rights to the user.
3031
<Message type="note">
3132
Admin rights allow a user to create logical databases and users. These right do not override the permissions configured for the logical databases. Logical database permissions must be set up in the Permissions tab.
3233
</Message>
33-
6. Enter a **username** and **password**.
34+
7. Enter a **username** and **password**.
3435
<Message type="note">
3536
Optionally, you can configure the appropriate permissions according to the user.
3637
Three types of permissions are available:
@@ -40,7 +41,7 @@ Users can connect to a database and access its data. Each one has a different se
4041
You can select the permission type in the Permissions tab.
4142

4243
</Message>
43-
7. Click **Create user** to confirm.
44+
8. Click **Create user** to confirm.
4445

4546
Once the user is created, it is displayed in the user list.
4647

pages/managed-databases-for-postgresql-and-mysql/how-to/apply-maintenance.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ These maintenance operations are set up, run, and scheduled by Scaleway, but you
2525
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/) scheduled for maintenance
2626

2727
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
28-
2. Look for an orange info icon to identify which Database Instances are scheduled for maintenance.
29-
3. Click the Database Instance name or <Icon name="more" /> > **More info** to access the database information page.
28+
2. Select the geographical region of the Instance you want to manage from the drop-down.
29+
3. Look for an orange info icon to identify which Database Instances are scheduled for maintenance.
30+
4. Click the Database Instance name or <Icon name="more" /> > **More info** to access the database information page.
3031

3132
If your Database Instance is scheduled for maintenance, you will see a banner on the top of the page informing you when the scheduled maintenance will take place. You can either wait for the maintenance to be applied automatically at the expected date and time, or you can apply it immediately.
3233

@@ -35,7 +36,7 @@ These maintenance operations are set up, run, and scheduled by Scaleway, but you
3536
</Message>
3637

3738

38-
4. Click **Apply maintenance now** to apply the maintenance immediately. You are redirected to a screen that shows you the status of the maintenance. If you want a more detailed maintenance status, you can [use the API](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/#path-database-instances-apply-database-instance-maintenance).
39+
5. Click **Apply maintenance now** to apply the maintenance immediately. You are redirected to a screen that shows you the status of the maintenance. If you want a more detailed maintenance status, you can [use the API](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/#path-database-instances-apply-database-instance-maintenance).
3940

4041
<Message type="important">
4142
Your Database Instance will be unavailable during the maintenance. This might take a few minutes.

pages/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,17 @@ It is possible to change your [volume type](/managed-databases-for-postgresql-an
2323
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/) with local Storage
2424

2525
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
26-
2. Click the name of the Database Instance you want to edit. The database's Overview page displays.
27-
3. Scroll down to **Volume settings**, then click **Change volume type**.
26+
2. Select the geographical region of the Instance you want to manage from the drop-down.
27+
3. Click the name of the Database Instance you want to edit. The database's Overview page displays.
28+
4. Scroll down to **Volume settings**, then click **Change volume type**.
2829
<Message type="important">
2930
Before changing the volume type, make sure your Instance is in one of the following states:
3031
- `READY` (represented as "Running" in the Scaleway console)
3132
- `DISK_FULL`
3233
</Message>
3334
A pop-up appears.
34-
4. Select **Block Storage** from the drop-down menu.
35-
5. Click **Update volume type** to confirm.
35+
5. Select **Block Storage** from the drop-down menu.
36+
6. Click **Update volume type** to confirm.
3637

3738
The Database Instance goes into the `Initializing` state.
3839

pages/managed-databases-for-postgresql-and-mysql/how-to/clone-a-database-instance.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,18 @@ The clone feature allows you to create a new Database Instance from an existing
2929
## How to clone a Database Instance
3030

3131
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
32-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
33-
3. Scroll down to the **Clone** section.
34-
4. Click **Clone Database Instance**. A pop-up displays.
35-
5. Enter a name for your database or leave the default name suggested by the Scaleway console.
36-
6. Select a node type. You can keep the same node type, or upgrade to a bigger one.
32+
2. Select the geographical region of the Instance you want to manage from the drop-down.
33+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
34+
4. Scroll down to the **Clone** section.
35+
5. Click **Clone Database Instance**. A pop-up displays.
36+
6. Enter a name for your database or leave the default name suggested by the Scaleway console.
37+
7. Select a node type. You can keep the same node type, or upgrade to a bigger one.
3738
<Message type="important">
3839
If you have a new-generation Database Instance using a Local volume node type and want to upgrade to an Instance that uses Block volumes node type, you must [change the volume type](/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type/) to Block Storage first. <br /><br />
3940

4041
Similarly, if you have a new-generation Database Instance using a [Block volume](/managed-databases-for-postgresql-and-mysql/concepts/#block-storage) and want to create a clone on a first-generation Instance, you must first change the volume type to [Block Storage Legacy](/managed-databases-for-postgresql-and-mysql/concepts/#block-storage-legacy).
4142
</Message>
42-
7. Click **Clone Database Instance**.
43+
8. Click **Clone Database Instance**.
4344

4445
<Message type="important">
4546
The source Database Instance remains available during the cloning process in **Backing up mode**. Some actions are not available during this time. <br /><br />

pages/managed-databases-for-postgresql-and-mysql/how-to/configure-advanced-settings.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ Advanced settings allow you to modify the default configuration of your database
2727
</Message>
2828

2929
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
30-
2. Click the Database Instance name or <Icon name="more" /> > **More info** to access the database information page.
31-
3. Click the **Advanced settings** tab.
30+
2. Select the geographical region of the Instance you want to manage from the drop-down.
31+
3. Click the Database Instance name or <Icon name="more" /> > **More info** to access the database information page.
32+
4. Click the **Advanced settings** tab.
3233

3334
To add advanced settings, follow these steps:
3435

pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-instance.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ categories:
2121
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/)
2222

2323
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
24-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
25-
3. Retrieve the Database Instance IP and port from the Database Instance information section.
24+
2. Select the geographical region of the Instance you want to manage from the drop-down.
25+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
26+
4. Retrieve the Database Instance IP and port from the Database Instance information section.
2627
<Message type="note">
2728
Alternatively, you can click the **copy icon** under **Connection** to retrieve the database client connection command. This already includes your database IP and port.
2829
</Message>
29-
4. Connect to your database with the database client of your engine.
30+
5. Connect to your database with the database client of your engine.
3031

3132
For MySQL, run the following command:
3233
```bash
@@ -37,7 +38,7 @@ categories:
3738
```bash
3839
psql -h <ip-address> -p <port> -U <username> -d rdb
3940
```
40-
5. Enter the password that you defined upon [Database Instance creation](/managed-databases-for-postgresql-and-mysql/how-to/create-a-database/).
41+
6. Enter the password that you defined upon [Database Instance creation](/managed-databases-for-postgresql-and-mysql/how-to/create-a-database/).
4142

4243
You are now connected to your Managed Database.
4344

pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,14 @@ You can create new Database Instances to attach to your Private Network, or atta
3636
</Message>
3737

3838
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
39-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
40-
3. Scroll to the **Network** section.
39+
2. Select the geographical region of the Instance you want to manage from the drop-down.
40+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
41+
4. Scroll to the **Network** section.
4142
<Message type="note">
4243
Alternatively, you can follow the next steps from the **Private Networks** tab. Click **+ Attach to a Private Network** to open the configuration pop-up.
4344
</Message>
44-
4. Click **Attach Private Network** next to **Private endpoint**. A pop-up appears.
45-
5. Choose whether to:
45+
5. Click **Attach Private Network** next to **Private endpoint**. A pop-up appears.
46+
6. Choose whether to:
4647
- Select and attach an existing Private Network and select the network from the drop-down list.
4748
<Message type="important">
4849
The Database Instance must be attached to a Private Network in the same region.
@@ -55,7 +56,7 @@ You can create new Database Instances to attach to your Private Network, or atta
5556
<Message type="note">
5657
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/OpenTofu.
5758
</Message>
58-
6. Click **Attach to Private Network** to conclude.
59+
7. Click **Attach to Private Network** to conclude.
5960

6061
## How to connect to a Database Instance through a Public Gateway
6162

@@ -64,10 +65,11 @@ You can create new Database Instances to attach to your Private Network, or atta
6465
## How to detach a Database Instance from a Private Network
6566

6667
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
67-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
68-
3. Click the **Private Networks** tabs. The Private Network configuration displays.
69-
4. Click <Icon name="unlink" /> next to the static IP that you want to unlink from your Database Instance.
70-
5. Click **Detach resource** to remove the Instance from your Private Network.
68+
2. Select the geographical region of the Instance you want to manage from the drop-down.
69+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
70+
4. Click the **Private Networks** tabs. The Private Network configuration displays.
71+
5. Click <Icon name="unlink" /> next to the static IP that you want to unlink from your Database Instance.
72+
6. Click **Detach resource** to remove the Instance from your Private Network.
7173

7274
<Message type="note">
7375
This action takes a few moments to complete. During this time, your Database Instance:

pages/managed-databases-for-postgresql-and-mysql/how-to/create-a-database.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ Compared to traditional database management, which requires customers to provide
2626
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2727

2828
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. If you do not have a database already created, the creation page displays.
29-
2. Click **Create Database Instance**. The creation wizard displays.
30-
3. Complete the following steps in the wizard:
29+
2. Select the geographical region of the Instance you want to manage from the drop-down.
30+
3. Click **Create Database Instance**. The creation wizard displays.
31+
4. Complete the following steps in the wizard:
3132
- Select a database engine. **PostgreSQL** and **MySQL** are available.
3233
- Choose a region. This is the geographical location where your database will be deployed.
3334
- Select a database configuration. You can choose between:
@@ -68,4 +69,4 @@ Compared to traditional database management, which requires customers to provide
6869
- one number
6970
</Message>
7071
- Enter a name for your Instance.
71-
4. Click **Create Database Instance** to confirm your choices and launch creation.
72+
5. Click **Create Database Instance** to confirm your choices and launch creation.

pages/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,16 @@ Read Replicas allow you to scale your Database Instance for read-heavy database
2525
- A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/)
2626

2727
1. Click **PostgreSQL and MySQL** under **Databases** on the side menu. A list of your Database Instances displays.
28-
2. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
29-
3. Scroll down to the **Read Replica** section.
30-
4. Click **Create Read Replica**. A pop-up displays.
31-
5. Select the Availability Zone (AZ) configuration. Two configurations are available:
28+
2. Select the geographical region of the Instance you want to manage from the drop-down.
29+
3. Click the database name or <Icon name="more" /> > **More info** to access the Database Instance information page.
30+
4. Scroll down to the **Read Replica** section.
31+
5. Click **Create Read Replica**. A pop-up displays.
32+
6. Select the Availability Zone (AZ) configuration. Two configurations are available:
3233

3334
- **Same AZ**: Your Read Replica is hosted in the same AZ as your main Database Instance. We recommend this option for low-latency workflows.
3435
- **Multi-AZ**: Your Read Replica is hosted in a different AZ, ensuring the resilience of your Replica. We recommend this option for ensuring the availability of your infrastructure, and improving your disaster recovery plan.
3536

36-
6. Select the network type. Two types are available:
37+
7. Select the network type. Two types are available:
3738

3839
- **Public network** - Resources in a public network are publicly visible by default. The default Access Control List (ACL) settings allow anybody to connect to resources in your network. You can restrict access by configuring ACLs in the Allowed IPs section.
3940
- **Private Networks** - Private Networks allow you to create virtual Private Networks for your Databases, enabling them to communicate in an isolated network without the need for a public IP address. If you select this option, you must select an existing Private Network to attach to your Read Replica.
@@ -45,7 +46,7 @@ Read Replicas allow you to scale your Database Instance for read-heavy database
4546
<Message type="important">
4647
If you select **Public network**, you can [attach a Private Network](/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replica/#how-to-manage-private-networks) to your Read Replica after its creation. If you choose to attach your Read Replica to a Private Network, you will not be able to add a Public Network to the same Read Replica later via the Scaleway console. You can, however, use the [Managed Databases API](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/) to do so via a command line or Terraform/OpenTofu.
4748
</Message>
48-
7. Click **Create Read Replica**. A list of your Read Replicas displays.
49+
8. Click **Create Read Replica**. A list of your Read Replicas displays.
4950
<Message type="important">
5051
Read Replicas have the same node types as the main node. For example, if your main node is of the DB-GP-S type, so is your Read Replica. The Replica also inherits the main node's configuration. The data of your main node is fully replicated in the Read Replica.
5152
</Message>

0 commit comments

Comments
 (0)