Introduction

Managed Database for FerretDB provides fully-managed document Database Instances. The resource allows you to focus on development rather than administration or configuration. It comes with a high-availability mode, data replication, and automatic snapshots.

Compared to traditional database management, which requires users to provide the infrastructure and resources to manage their databases, Managed Database for FerretDB offers users access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features such as High Availability, automated snapshots, user management, and more.

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to Managed Database for FerretDB.

Quickstart

1. Configure your environment variables.

   Note:

   This is an optional step that seeks to simplify your usage of the APIs.

   export SCW_ACCESS_KEY="<API access key>"
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_REGION="<Scaleway region>"Copy

2. Edit the POST request payload you will use to create your Database Instance. Replace the parameters in the following example:

     '{
     "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
     "name": "myDB",
     "engine": "FerretDB-1.0.0",
     "tags": ["donnerstag"],
     "is_ha_cluster": true,
     "node_type": "db-play-beta",
     "disable_backup": false,
     "user_name": "my_initial_user",
     "password": "thiZ_is_v0ry_s3cret",
     "volume_type": "bssd",
     "volume_size": "30000000000"
     }'Copy

   Parameter	Description
   project_id	The ID of the Project you want to create your Database Instance in. To find your Project ID you can list the projects or consult the Scaleway console.
   engine	REQUIRED Version ID of the database engine. To check the list of available engines you can use the folowing endpoint: https://api.scaleway.com/document-db/v1beta1/regions/$SCW_REGION/database-engines
   name	Name of the Database Instance
   node_type	REQUIRED The node type. To check the list of available node types you can use the folowing endpoint: https://api.scaleway.com/document-db/v1beta1/regions/$SCW_REGION/node-types
   is_ha_cluster	BOOLEAN Defines whether High Availability is enabled for the Database Instance
   disable_backup	BOOLEAN Defines whether automated backups are disabled for the Database Instance
   tags	The list of tags ["tag1", "tag2", ...] that will be associated with the Database Instance. Tags can be appended to the query of the List Database Instances call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that posess all the appended tags.
   user_name	REQUIRED Identifier of the default user, which is created concurrently with the Database Instance
   password	REQUIRED Password for the default user
   volume_type	Type of volume where data is stored. You can specify either local volume (lssd) or block volume (bssd). The default value is lssd
   volume_size	Volume size when volume_type is bssd. The value should be expressed in bytes. For example 30GB is expressed as 30000000000

3. Create a Database Instance by running the following command. Make sure you include the payload you edited in the previous step.

   curl -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "Content-Type: application/json" \
     https://api.scaleway.com/document-db/v1beta1/regions/$SCW_REGION/instances \
     -d '{
       "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
       "name": "myDB",
       "engine": "FerretDB-1.0.0",
       "tags": ["donnerstag"],
       "is_ha_cluster": true,
       "node_type": "db-play-beta",
       "disable_backup": false,
       "user_name": "my_initial_user",
       "password": "thiZ_is_v0ry_s3cret",
       "volume_type": "bssd",
       "volume_size": "30000000000"
     }'Copy

4. List your Database Instances.

   curl -X GET \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" https://api.scaleway.com/document-db/v1beta1/regions/$SCW_REGION/instancesCopy

   You should get a response like the following:

   Note:

   This is a response example, the UUIDs and IP address displayed are not real.

   {
         "id": "f5122f66-fb50-4cef-aa02-487ef4fc1af0",
         "name": "myDB",
         "organization_id": "895693aa-3915-4896-8761-c2923b008be7",
         "project_id": "d8e65f2b-cce9-40b7-80fc-6a2902db6826",
         "status": "ready",
         "engine": "FerretDB-1.0.0",
         "endpoint": {
           "ip": "198.51.100.0",
           "port": 22245,
           "name": null
         },
         "tags": [
           "donnerstag"
         ],
         "settings": [],
         "backup_schedule": {
           "frequency": 24,
           "retention": 7,
           "disabled": true
         },
         "is_ha_cluster": true,
         "read_replicas": [],
         "node_type": "db-play-beta",
         "volume": {
           "type": "bssd",
           "size": 30000000000
         }
         "created_at": "2019-04-19T16:24:52.591417Z",
         "region": "fr-par"
   }Copy

5. Retrieve your Database Instance IP and port from the response.

   Note:

   In the example above, the IP and port are 198.51.100.0 and 22245, respectively.

6. Get your TLS certificate in the console.

7. Connect to your Database Instance with the mongosh client.

   mongosh --tls --tlsCAFile rdb-myDB.pem 'mongodb://<username>@<ip-address>:<port>/rdb?authMechanism=PLAIN'Copy

8. Enter the database password that you defined upon creation.

You are now connected to your Managed Database.

Technical Information

Regions

Scaleway's infrastructure is spread across different regions and Availability Zones.

Managed Database for FerretDB is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:

• fr-par
• nl-ams
• pl-waw

FerretDB specifications

Versions

Scaleway Database supports FerretDB in version 1.X

User Management

• users with an admin role have access to all logical databases and can create new ones.
• users created via the API are authenticated using the default authentication plugin, which can be changed in the settings.

Going Further

For more information about Managed Database for FerretDB, you can check out the following pages:

• Managed Database for FerretDB Documentation
• Scaleway Slack Community join the #database channel
• Contact our support team.

Engines

Database Instances

Read Replicas

ACLs

Instance Settings

Privileges

Users

Databases

NodeTypes

Snapshots

Endpoints