Skip to content

Commit 1612828

Browse files
ldecarvalho-docldecarvalho-doc
authored
feat(mdb): updates for GA - MTA-5872 (#4995)
1 parent cd0a8d4 commit 1612828

File tree

10 files changed

+124
-49
lines changed

10 files changed

+124
-49
lines changed

‎pages/managed-mongodb-databases/api-cli/backup-and-restore.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ categories:
1111
- postgresql-and-mysql
1212
---
1313

14-
<Message type="important">
15-
Managed MongoDB® is currently in private beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
16-
</Message>
17-
1814
Managed MongoDB® provides fully-managed document Database Instances, with a MongoDB®-compatible API layer over a PostgreSQL engine to store and retrieve data.
1915

2016
This means you can use MongoDB® command line tools to use and manage your MongoDB® Databases.

‎pages/managed-mongodb-databases/concepts.mdx‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ categories:
1010
- managed-databases
1111
---
1212

13-
<Message type="important">
14-
Managed MongoDB® is currently in private beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
15-
</Message>
16-
1713
## Block Storage Legacy
1814

1915
Block Storage Legacy is a volume type that is decoupled from your compute resources. You can increase your storage space to up to 10 TB without changing your node type.
@@ -60,10 +56,6 @@ Compared to traditional database management, which requires customers to provisi
6056

6157
<Macro id="region-and-az" />
6258

63-
<Message type="requirement">
64-
During the MongoDB® Private Beta, only the France region is available.
65-
</Message>
66-
6759
## Replica-set 1-node
6860

6961
An Instance of MongoDB® that runs as a single server and does not provide redundancy or high availability.

‎pages/managed-mongodb-databases/how-to/connect-database-instance.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
<Macro id="requirements" />
2117

2218
- A Scaleway account logged into the [console](https://console.scaleway.com)

‎pages/managed-mongodb-databases/how-to/create-a-database-instance.mdx‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
Managed MongoDB® provides fully-managed document Database Instances, with MongoDB® as a database engine.
2117

2218
Document databases enable users to store and retrieve data in a document format, such as `json`. Compared to traditional relational databases where data is stored in a table-like format, document-type storage supports storing multiple nested keys and values in each document key.
@@ -41,7 +37,7 @@ Document databases enable users to store and retrieve data in a document format,
4137
- Configure storage settings. You can:
4238
- Choose the [IOPS](/block-storage/concepts/#iops) setting, between **5k** and **15k**.
4339
- Define your volume size. Block Storage volumes can increase up to 10 TB.
44-
- Review the snapshot configuration. During the private beta, only manual snapshots are available.
40+
- Review the snapshot configuration.
4541
4. Configure your Network. Choose one or both of the options below:
4642
- **Attach to Private Network**: allows your databases to communicate in an isolated and secure network without requiring a public IP address. If you select this option, you must either:
4743
- Select and attach an existing Private Network and select the network from the drop-down list.

‎pages/managed-mongodb-databases/how-to/delete-a-database-instance.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
<Macro id="requirements" />
2117

2218
- A Scaleway account logged into the [console](https://console.scaleway.com)

‎pages/managed-mongodb-databases/how-to/increase-volume.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
You can increase the Block Storage volume of your MongoDB® Database Instance in the Scaleway console anytime.
2117

2218
<Macro id="requirements" />

‎pages/managed-mongodb-databases/how-to/manage-snapshots.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
[Snapshots](/managed-mongodb-databases/how-to/manage-snapshots/) allow you to restore data in a new Database Instance.
2117

2218
You can have up to 100 snapshots per Instance and project (depending on quotas).

‎pages/managed-mongodb-databases/how-to/manage-users.mdx‎

Lines changed: 123 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,13 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. Click [here](https://www.scaleway.com/en/managed-mongodb/) to join the waiting list.
18-
</Message>
19-
2016
Users can connect to a database and access its data.
2117

22-
<Message type="important">
23-
During the MongoDB® private beta, you can have only one user per Instance. The default user has admin rights on the Database Instance. The name and password of this default user can be set upon Database Instance creation.
24-
</Message>
25-
2618
<Macro id="requirements" />
2719

2820
- A Scaleway account logged into the [console](https://console.scaleway.com)
2921
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
22+
- A valid [API key](/iam/how-to/create-api-keys/)
3023
- A [MongoDB® Database Instance](/managed-mongodb-databases/quickstart)
3124

3225
## How to change the password of your user
@@ -37,3 +30,125 @@ Users can connect to a database and access its data.
3730
4. Click **Change password** to do so. A pop-up appears.
3831
5. Enter your new password and confirm.
3932

33+
## How to create multi-users via the API
34+
35+
When you create your MongoDB® Database Instance, the first user is created by default and has admin rights.
36+
37+
You can create more users and grant them pre-set roles via the [Scaleway Managed MongoDB® API](https://www.scaleway.com/en/developers/api/managed-database-mongodb/).
38+
39+
<Message type="important">
40+
All users you create have at first administrator roles, which can be changed after creation with the [Apply user roles](https://www.scaleway.com/en/developers/api/managed-database-mongodb/#path-users-apply-user-roles) call. The default user's role cannot be changed.
41+
</Message>
42+
43+
### How to create a user
44+
45+
1. Edit the POST request payload you will use to create your user. Replace the values of each parameter with your values of choice following the parameter descriptions below.
46+
```
47+
{
48+
"name": "<username>",
49+
"password": "<password>",
50+
}
51+
```
52+
53+
| Parameter | Description |
54+
| :--------------- | :----------------------------------------------------------------- |
55+
| `name` | Set a name for the database user. |
56+
| `password` | Set a password for the database user.|
57+
58+
2. Run the following command to create a user. Make sure you include the payload you edited in the previous step. `{instance_id}` corresponds to the UUID of the Managed MongoDB®.
59+
```
60+
curl -X POST \
61+
-H "X-Auth-Token: $SCW_SECRET_KEY" \
62+
-H "Content-Type: application/json" \
63+
-d '{
64+
"name": "<username>",
65+
"password": "<password>",
66+
}' \
67+
"https://api.scaleway.com/mongodb/v1alpha1/regions/$SCW_REGION/par/instances/{instance_id}/users"
68+
```
69+
70+
You should get a response like the following:
71+
```
72+
{
73+
"name": "<username>",
74+
"password": "<password>",
75+
"roles": [
76+
{
77+
"role": "read_write",
78+
"any_database": true
79+
},
80+
{
81+
"role": "db_admin",
82+
"any_database": true
83+
},
84+
{
85+
"role": "sync",
86+
"any_database": true
87+
}
88+
]
89+
}
90+
```
91+
92+
All users you create will have the `read_write`, `db_admin` and `sync` roles on all databases by default.
93+
94+
You can follow the steps below to update a user's role(s) to the one(s) of your choice.
95+
96+
### How to apply a role to a user
97+
98+
1. Edit the POST request payload you will use to update the user role. Replace the values of each parameter with your values of choice following the parameter descriptions below.
99+
100+
In this example, we define a single `read_write` role for the user. This role applies only in the `example-db` database.
101+
102+
<Message type="tip">
103+
To grant the user this role in all databases, you can set `any_database` to true.
104+
</Message>
105+
106+
```
107+
{
108+
"name": "<username>",
109+
"roles": [
110+
{
111+
"role": "read_write",
112+
"database": "example-db",
113+
"any_database": false
114+
}
115+
]
116+
}
117+
```
118+
119+
| Role | Description |
120+
| :--------------- | :----------------------------------------------------------------- |
121+
| `read` | Read privileges on all non-system collections and the `system.js` collection. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-read) for an extensive list of the privileges granted to this role. |
122+
| `read_write` | Read and write privileges on all non-system collections and the `system.js` collection. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-readWrite) for an extensive list of the privileges granted to this role. |
123+
| `db_admin` | Privileges to perform administrative tasks on the database, such as schema-related tasks, indexing, and gathering statistics. This role does not grant privileges for user and role management. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-dbAdmin) for an extensive list of the privileges granted to this role. |
124+
| `sync` | Role that aggregates three MongoDB roles: |
125+
| | `clusterMonitor` - Read-only access to monitoring tools. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/upcoming/reference/built-in-roles/#mongodb-authrole-clusterMonitor) for an extensive list of the privileges granted to this role. |
126+
| | `backup` - Grants the minimal privileges needed to back up data. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/upcoming/reference/built-in-roles/#mongodb-authrole-backup) for an extensive list of the privileges granted to this role. |
127+
| | `restore` - Grants the privileges needed to restore data from backups. Refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/upcoming/reference/built-in-roles/#mongodb-authrole-restore) for an extensive list of the privileges granted to this role. |
128+
129+
2. Run the following command to apply a new role to the user. Make sure you include the payload you edited in the previous step and that you replace the parameters in the call with your information. `{instance_id}` corresponds to the UUID of the Managed MongoDB®.
130+
131+
```
132+
curl -X PUT \
133+
-H "X-Auth-Token: $SCW_SECRET_KEY" \
134+
-H "Content-Type: application/json" \
135+
-d '{
136+
"name": "<username>",
137+
"roles": [
138+
{
139+
"role": "read_write",
140+
"database": "<name_of_database>"
141+
"any_database": false
142+
}
143+
]
144+
}' \
145+
"https://api.scaleway.com/mongodb/v1alpha1/regions/$SCW_REGION/instances/{instance_id}/roles"
146+
```
147+
148+
If the call was successful, you will get the payload with the new role(s) as a response.
149+
150+
<Message type="note">
151+
Assigning roles upon user creation will be possible by the second half of 2025. Refer to the [Scaleway Changelog](/docs/changelog/?product=mongodb) to keep up with the latest Managed MongoDB® updates.
152+
</Message>
153+
154+

‎pages/managed-mongodb-databases/index.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@ content:
1515
label="Managed MongoDB® Quickstart"
1616
/>
1717

18-
<Message type="important">
19-
Managed MongoDB® is currently in public beta. [Fill out the form](https://www.scaleway.com/en/managed-mongodb-form/) to be notified of the General Availability or if you want to get in touch with our team about Managed MongoDB®.
20-
</Message>
21-
2218
## Getting Started
2319

2420
<Grid>

‎pages/managed-mongodb-databases/quickstart.mdx‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ categories:
1313
- managed-databases
1414
---
1515

16-
<Message type="important">
17-
Managed MongoDB® is currently in public beta. [Fill out the form](https://www.scaleway.com/en/managed-mongodb/) to be notified of the General Availability or if you want to get in touch with our team about Managed MongoDB®.
18-
</Message>
19-
2016
Managed MongoDB® provides fully-managed document Database Instances, with MongoDB® as a database engine.
2117

2218
MongoDB® databases enable users to store and retrieve data in a document format, such as `json`. Compared to traditional relational databases where data is stored in a table-like format, document-type storage supports storing multiple nested keys and values in each document key.

0 commit comments

Comments
 (0)