diff --git a/managed-databases/mongodb/api-cli/backup-and-restore.mdx b/managed-databases/mongodb/api-cli/backup-and-restore.mdx new file mode 100644 index 0000000000..3fea15d63c --- /dev/null +++ b/managed-databases/mongodb/api-cli/backup-and-restore.mdx @@ -0,0 +1,114 @@ +--- +meta: + title: Back up and restore MongoDB® Databases with MongoDB® tools + description: This page shows you how to back up and restore MongoDB® Databases with MongoDB® command line tools +content: + h1: Back up and restore MongoDB® Databases with MongoDB® tools + paragraph: This page shows you how to back up and restore MongoDB® Databases with MongoDB® command line tools +tags: databases mongodb mongodb document backup database-nodes +categories: + - managed-databases + - postgresql-and-mysql +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +Managed MongoDB® Databases provide fully-managed document Database Instances, with a MongoDB®-compatible API layer over a PostgreSQL engine to store and retrieve data. + +This means you can use MongoDB® command line tools to use and manage your MongoDB® Databases. + +This tutorial shows how to backup and restore your MongoDB® Databases with the MongoDB® `mongodump` and `mongorestore` command line database tools. + + + + + - You have an account and are logged into the [Scaleway console](https://console.scaleway.com/) + - You have a [MongoDB®-compatible client](https://www.mongodb.com/try/download/shell) installed + - You have [created a MongoDB® Database Instance](/managed-databases/mongodb/how-to/create-a-database-instance/) + - You have [mongodump and mongorestore tools](https://www.mongodb.com/docs/database-tools/installation/installation/) installed + + + + This tutorial shows you basic restore and backup operations. If you need additional options for the operations, refer to the [official MongoDB® documentation](https://www.mongodb.com/docs/manual/tutorial/backup-and-restore-tools/). + + Make sure you keep the `--ssl` and `--sslCAFile=` options in your commands, as you will need to authenticate using the default SSL certificate when you connect to your Database Instance. + + +## How to back up a MongoDB® Database Instance + +To create backups, we will use the `mongodump` tool, which can create backups for an entire Database Instance, logical database or collection. It can also use a query to back up part of a collection. + +1. Navigate to the [Scaleway console](https://console.scaleway.com/). +2. Click **MongoDB® Databases** under **Managed Databases** on the side menu. A list of your Database Instances displays. +3. Click the database name or > **More info** to access the Database Instance information page. +4. Download the Database Instance's SSL certificate. + + Make sure you know the path to the certificate on your local machine, as it will be used in a later step. + +5. Run the following command, replacing the values according to the table below. + ``` + mongodump \ + --host= \ + --port= \ + --username= \ + --password="" \ + --out=/path/to/backup \ + --ssl \ + --sslCAFile= \ + --authenticationMechanism=PLAIN + ``` + + `host` + : the IP address of your Database Instance + + `port` + : the connection port of your Database Instance + + `username` + : the username of the database user created upon Database Instance creation + + `password` + : the password of the database user created upon Database Instance creation + + `out` + : the path to the folder where you want the backups to be stored on your machine + + `sslCAFile` + : the path to where your SSL certificate is stored + + `authenticationMechanism` + : the list of authentication mechanisms the server accepts + + If no response is returned, the operation was successful. You can make sure the backup occurred by checking that new files were added to the destination folder. + +## How to restore from a backup + +You can restore either an entire database backup or a subset of a backup using `mongorestore`. + +The tool restores binary backups created using `mongodump`. + +You can restore the backed up data to any database within any Database Instance. + +Run the following command, replacing the values according to the table above. You must specify the name of the destination `db`. +``` +mongorestore \ + --host= \ + --port= \ + --username= \ + --password= \ + /path/to/backup \ + --db=rdb \ + --ssl \ + --sslCAFile= \ + --authenticationMechanism=PLAIN +``` +`db` +: the name of the database to which you want to restore the backup + +If the procedure was successful, you will see an output like the following: + +``` +2023-09-04T17:50:29.893+0200 1 document(s) restored successfully. 0 document(s) failed to restore. +``` diff --git a/managed-databases/mongodb/api-cli/index.mdx b/managed-databases/mongodb/api-cli/index.mdx new file mode 100644 index 0000000000..58632032a4 --- /dev/null +++ b/managed-databases/mongodb/api-cli/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Managed MongoDB® Databases - API/CLI Documentation + description: Managed MongoDB® Databases API/CLI Documentation +content: + h1: Managed MongoDB® Databases - API/CLI Documentation + paragraph: Managed MongoDB® Databases API/CLI Documentation +--- diff --git a/managed-databases/mongodb/concepts.mdx b/managed-databases/mongodb/concepts.mdx new file mode 100644 index 0000000000..afde2e5cd7 --- /dev/null +++ b/managed-databases/mongodb/concepts.mdx @@ -0,0 +1,69 @@ +--- +meta: + title: Managed MongoDB® Databases - Concepts + description: This page explains all the concepts related to Managed MongoDB® Databases. +content: + h1: Managed MongoDB® Databases - Concepts + paragraph: This page explains all the concepts related to Managed MongoDB® Databases. +tags: concepts managed-databases ferredb mongodb document +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +## Block Storage Low Latency + +Block Storage Low Latency is a storage type similar to [Basic Block Storage](#basic-block-storage) that provides lower latency and high resiliency through 5k IOPS. You can increase your volume size to up to 10 TB. + +Refer to the [Block Storage Low Latency documentation section](/storage/block/concepts/) to learn more about this volume type. + + + Block Low Latency volumes are only available with new-generation node types and in the PAR and AMS regions. + + +## Database Instance + +A Database Instance is made up of multiple (at least 1) dedicated compute nodes, and is running a single Database Engine. Exactly one database engine is running on each node. + +## Database snapshot + +A [Snapshot](/managed-databases/mongodb/how-to/manage-snapshots/) is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Snapshots can only be stored in the same location as the original data. + +## Document database + +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. + +## Endpoint + +A point of connection to a database. The endpoint is associated with an IPv4 address and a port, and determines whether the endpoint is read-write or not. + +## Engine + +A database engine is the software component that stores and retrieves your data from a database. Currently, MongoDB® 7.0.11 and 7.0.12 are available. + +## Logs + +Logs can contain useful information for debugging or to know more about the behavior and activity of your databases. + +## Managed Database + +Compared to traditional database management, which requires customers to provision their infrastructure and resources to manage their databases, managed databases offer the user access to a Database Instance without setting up the hardware or configuring the software. + +## Region and Availability Zone + + + + + During the MongoDB® Private Beta, only the France region is available. + + +## Replica-set 1-node + +An Instance of MongoDB® that runs as a single server and does not provide redundancy or high availability. + +## Replica-set 3-nodes + +A group of 3 MongoDB® servers (1 primary and 2 standby nodes) that maintain the same data set. Replica sets provide redundancy and high availability and are the basis for all production deployments. If the main node fails for any reason, one of the remaining standby nodes is assigned and can take over requests, reducing downtime. diff --git a/managed-databases/mongodb/how-to/assets/scaleway-create-instance-from-snapshot.webp b/managed-databases/mongodb/how-to/assets/scaleway-create-instance-from-snapshot.webp new file mode 100644 index 0000000000..0876303c3c Binary files /dev/null and b/managed-databases/mongodb/how-to/assets/scaleway-create-instance-from-snapshot.webp differ diff --git a/managed-databases/mongodb/how-to/assets/scaleway-dbaas-backup.webp b/managed-databases/mongodb/how-to/assets/scaleway-dbaas-backup.webp new file mode 100644 index 0000000000..057d7dbb90 Binary files /dev/null and b/managed-databases/mongodb/how-to/assets/scaleway-dbaas-backup.webp differ diff --git a/managed-databases/mongodb/how-to/assets/scaleway-dbaas-pn-attached.webp b/managed-databases/mongodb/how-to/assets/scaleway-dbaas-pn-attached.webp new file mode 100644 index 0000000000..8e8c4bd9aa Binary files /dev/null and b/managed-databases/mongodb/how-to/assets/scaleway-dbaas-pn-attached.webp differ diff --git a/managed-databases/mongodb/how-to/assets/scaleway-rdb-engine-version-upgrade.webp b/managed-databases/mongodb/how-to/assets/scaleway-rdb-engine-version-upgrade.webp new file mode 100644 index 0000000000..f1841d2716 Binary files /dev/null and b/managed-databases/mongodb/how-to/assets/scaleway-rdb-engine-version-upgrade.webp differ diff --git a/managed-databases/mongodb/how-to/connect-database-instance.mdx b/managed-databases/mongodb/how-to/connect-database-instance.mdx new file mode 100644 index 0000000000..1c17484b49 --- /dev/null +++ b/managed-databases/mongodb/how-to/connect-database-instance.mdx @@ -0,0 +1,275 @@ +--- +meta: + title: How to connect to a MongoDB® Database Instance + description: This page explains how to connect to a MongoDB® Database Instance +content: + h1: How to connect to a MongoDB® Database Instance + paragraph: This page explains how to connect to a MongoDB® Database Instance +tags: mongodb mongodb document database-instance managed-database database +dates: + validation: 2024-09-18 + posted: 2024-09-18 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB® Database Instance](/managed-databases/mongodb/quickstart/) +- Installed either [mongosh](https://www.mongodb.com/docs/mongodb-shell/), or the [pymongo](https://pymongo.readthedocs.io/en/stable/) distribution for Python, or the Node.js [mongodb module](https://www.npmjs.com/package/mongodb) or the [mongo driver for Go](https://github.com/mongodb/mongo-go-driver), or [Mongoose](https://mongoosejs.com/) on your local machine + + +## How to connect via a database client + +1. Click **MongoDB®** under **Managed Databases** on the side menu. A list of your Database Instances displays. +2. Click the database name or > **More info** to access the Database Instance information page. +3. Click next to the **TLS certificate** to download it. +4. Transfer the file to where you will execute the connection command. +5. Return to the console and click **Connect** in the **Connect Database Instance** section. A pop-up appears. +6. Select a connection mode. The following modes are available: `mongosh`, `Python`, `Go`, `Node.js` and `Mongoose`. +7. Replace the variables in the commands with your information. + +Find below a detailed description of each connection mode: + +### mongosh + +To connect to a public endpoint using the MongoDB® shell: + +1. Replace the following variables in the command as described: + ```sh + mongosh "mongodb+srv://{instance_id}.mgdb.{region}.scw.cloud" --tlsCAFile {your_certificate.pem} -u {username + ``` + + - `{your-certificate.pem}` - the TLS certificate downloaded on **step 3**. + - `{username}` - the username you defined upon Database Instance creation. + - `{db-instance-id}` - the UUID of your Database Instance. + - `{region}` - the database name you entered upon Database Instance creation. The default is called `rdb`. + +2. Run the command. +3. Enter your password when prompted. + +If the connection is successful, you should see the following message display on your console, and be able to write queries: + ```sh + The server generated these startup warnings when booting + Powered by MongoDB® v0.9.0 and PostgreSQL 14.6. + ``` + +Follow the same procedure to connect to a private endpoint for one node, replacing `{privateNetorkName}` with the name of your Private Network: + + ```sh + mongosh "mongodb://{instance_id}-0.{privateNetworkName}" -u {username} + ``` + +For multiple nodes, replace `{db-instance-id}` with the Database Instance UUID of each respective Instance, and `{privateNetworkName}` with the names of your Private Network: + + ```sh + "mongodb://{instance_id}-0.{privateNetworkName},{instance_id}-1.{privateNetworkName},{instance_id}-2.{privateNetworkName}" -u {username} + ``` + +### Python + +The following code shows you how to use the `pymongo` library to connect using TLS. + +```python +from pymongo import MongoClient + +# Replace with your MongoDB® connection details +username = "your_username" +password = "your_password" # it is best to use environment variables to manage sensitive data +instance_id = "your_instance_id" +region = "your_region" #the region of your database instance. "fr-par" if Paris +tls_certificate = "path/to/your_tls_certificate.pem" # path to your TLS certificate file +database_name = "databaseName" + +# Construct the connection string +connection_string = f"mongodb+srv://{username}:{password}@{instance_id}.mgdb.{region}.scw.cloud/?tls=true&tlsCAFile={tls_certificate}" + +# Establish a connection + +client = MongoClient(connection_string) + +# Access a specific database + +db = client[database_name] + +# Example: Access a specific collection + +collection = db['your_collection_name'] + +# Now you can interact with the collection, e.g., find documents + +documents = collection.find({}) +for doc in documents: + print(doc) +``` + +### Node.js + +The following code shows you how to use the `mongodb` module to connect using TLS. + +```js +const { MongoClient } = require('mongodb'); +const path = require('path'); + +// Replace with your MongoDB® connection details +const username = encodeURIComponent('your_username'); +const password = encodeURIComponent('your_password'); +const region = "your_region" // "fr-par" for Paris. +const instanceId = 'your_instance_id'; // your instance id +const databaseName = 'databaseName' + +// Path to your TLS certificate file +const tlsCertificatePath = path.resolve(__dirname, 'path/to/your_tls_certificate.pem'); + +// Construct the connection string +const connectionString = `mongodb+srv://${username}:${password}@${instanceId}.mgdb.${region}.scw.cloud`; + +// Create a new MongoClient +const client = new MongoClient(connectionString, { + useNewUrlParser: true, + useUnifiedTopology: true, + tls: true, // Enable TLS/SSL + tlsCAFile: tlsCertificatePath, // Path to the CA certificate file +}); + +async function run() { + try { + // Connect to the MongoDB® server + await client.connect(); + console.log('Connected to MongoDB!'); + + // Access the database and collection + const db = client.db(databaseName); + const collection = db.collection('your_collection_name'); + + // Example: Find documents in the collection + const documents = await collection.find({}).toArray(); + console.log('Documents:', documents); + } catch (err) { + console.error(err); + } finally { + // Close the connection + await client.close(); + console.log('Connection to MongoDB® closed.'); + } +} + +run().catch(console.dir); +``` + +### Go + +The following code shows you how to use the `mongo` driver to connect using TLS. +```go +package main + +import ( + "context" + "fmt" + "go.mongodb.org/mongo-driver/mongo" + "go.mongodb.org/mongo-driver/mongo/options" +) + +func main() { + + username := "" + password := "" + host := "" + port := 1234 // replace with endpoint port number + caCertPath := "" + // prepare the uri for the connection + uri := fmt.Sprintf( + "mongodb://%s:%s@%s:%d/rdb?tls=true&tlsCACert=%s&authMechanism=PLAIN", + username, + password, + host, + port, + caCertPath, + ) + ctx := context.Background() + // connect to the database + client, _ := mongo.Connect(ctx, options.Client().ApplyURI(uri)) + // get the database + db := client.Database("rdb") + // get the collection + cars := db.Collection("cars") + // insert a document + carToInsert := Car{Name: "Supercar", Year: 2020} + cars.InsertOne(ctx, carToInsert) + + // read the document + carToRead := Car{} + cars.FindOne(ctx, map[string]interface{}{"name": "Supercar"}).Decode(&carToRead) + + // print the document + fmt.Println(carToRead) + +} + +type Car struct { + Name string + Year int +} +``` + +### Mongoose + +The following code shows you how to use the `Mongoose` schema to connect using TLS. + +```js +const mongoose = require('mongoose'); +const path = require('path'); + +// Replace with your MongoDB® connection details +const username = encodeURIComponent('your_username'); +const password = encodeURIComponent('your_password'); +const region = "your_region" // "fr-par" for Paris. +const instanceId = 'your_instance_id'; // your instance id +const databaseName = 'databaseName' + +// Path to your TLS certificate file +const tlsCertificatePath = path.resolve(__dirname, 'path/to/your_tls_certificate.pem'); + +// Construct the connection string +const connectionString = `mongodb+srv://${username}:${password}@${instanceId}.mgdb.${region}.scw.cloud`; + +// Connect to MongoDB® using Mongoose +mongoose.connect(connectionString, { + useNewUrlParser: true, + useUnifiedTopology: true, + tls: true, // Enable TLS/SSL + tlsCAFile: tlsCertificatePath, // Path to the CA certificate file +}) +.then(() => { + console.log('Connected to MongoDB® with Mongoose!'); +}) +.catch(err => { + console.error('Connection error', err); +}); + +// Example schema and model +const exampleSchema = new mongoose.Schema({ + name: String, + age: Number, +}); + +const ExampleModel = mongoose.model('Example', exampleSchema); + +// Example: Creating a new document +const exampleDoc = new ExampleModel({ name: 'John Doe', age: 30 }); + +exampleDoc.save() +.then(doc => { + console.log('Document saved:', doc); +}) +.catch(err => { + console.error('Error saving document', err); +}); +``` \ No newline at end of file diff --git a/managed-databases/mongodb/how-to/create-a-database-instance.mdx b/managed-databases/mongodb/how-to/create-a-database-instance.mdx new file mode 100644 index 0000000000..8d9fdcc0d0 --- /dev/null +++ b/managed-databases/mongodb/how-to/create-a-database-instance.mdx @@ -0,0 +1,53 @@ +--- +meta: + title: How to create a MongoDB® Database Instance + description: This page explains how to create a MongoDB® Database Instance +content: + h1: How to create a MongoDB® Database Instance + paragraph: This page explains how to create a MongoDB® Database Instance +tags: postgresql mongodb mongodb database-instance managed-database database +dates: + validation: 2024-10-01 + posted: 2024-10-01 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +Managed MongoDB® Databases provide fully-managed document Database Instances, with MongoDB® as a database engine. + +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. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization + + +## How to create a database + +1. Click **MongoDB®** under **Managed Databases** on the side menu, if you do not have a Database Instance already created, the creation page displays. +2. Click **Create a Database Instance**. The creation wizard displays. +3. Complete the following steps in the wizard: + - Select **MongoDB®** as a database engine. + - Choose a region. This is the geographical location where your database will be deployed. + - Select a replica set configuration. You can choose between: + - **Replica-set 1-node** - an instance of MongoDB® that runs as a single server and does not provide redundancy or high availability. + - **Replica-set 3-nodes** - a group of 3 MongoDB® servers (1 primary and 2 standby nodes) that maintain the same data set. Replica sets provide redundancy and high availability and are the basis for all production deployments. If the main node fails for any reason, one of the remaining standby nodes is assigned and can take over requests, reducing downtime. + - Select a node type. + - Define the size of your Block Storage volume. You can increase your storage space without changing your node type, with no downtime. You can increase your volume size to up to 10 TB. + - Add a name and set a password for your user. + + Your username must adhere to specific criteria. + - Length must be between 1 and 63 characters + - First character must be an alphabetic character (**a-Za-Z**) + - It can not start with **_rdb** + - Only **a-zA-Z0-9_$-** characters are accepted + + - Enter a name for your Database Instance. +4. Click **Create a Database Instance** to confirm your choices and launch creation. + + You are taken to the **Overview** tab for your Database Instance. \ No newline at end of file diff --git a/managed-databases/mongodb/how-to/delete-a-database-instance.mdx b/managed-databases/mongodb/how-to/delete-a-database-instance.mdx new file mode 100644 index 0000000000..fa0bbadb5c --- /dev/null +++ b/managed-databases/mongodb/how-to/delete-a-database-instance.mdx @@ -0,0 +1,36 @@ +--- +meta: + title: How to delete a MongoDB® Database Instance + description: This page explains how to delete a Database +content: + h1: How to delete a MongoDB® Database Instance + paragraph: This page explains how to delete a Database +tags: managed-database postgresql mongodb mongodb document database-instance +dates: + validation: 2024-10-01 + posted: 2024-10-01 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB® Database Instance](/managed-databases/mongodb/quickstart) + + +1. Click **MongoDB®** under **Managed Databases** on the side menu. A list of your Database Instances displays. +2. Click the database name or > **More info** to access the Database Instance information page. +3. Click the **Settings** tab, scroll down to the **Delete Database Instance** section and click **Delete Instance**. A pop-up appears to inform you that: + + This will permanently destroy your Instance, and all your data will be lost. This action is irreversible. + +4. Type **DELETE** to confirm and click **Delete this Instance**. + + Alternatively, you can delete your Instance from the Database Instances list by clicking next to the Instance name and then **Delete**. + diff --git a/managed-databases/mongodb/how-to/increase-volume.mdx b/managed-databases/mongodb/how-to/increase-volume.mdx new file mode 100644 index 0000000000..060bf42464 --- /dev/null +++ b/managed-databases/mongodb/how-to/increase-volume.mdx @@ -0,0 +1,39 @@ +--- +meta: + title: How to increase the storage of a Managed MongoDB® database + description: Guide to increasing the block volume of your Managed MongoDB® Database Instance at Scaleway. +content: + h1: How to increase the storage of a Managed MongoDB® database + paragraph: Guide to increasing the block volume of your Managed MongoDB® Database Instance at Scaleway. +tags: managed-database postgresql mysql upgrade +dates: + validation: 2024-10-01 + posted: 2024-10-01 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +You can increase the Block Storage volume of your MongoDB® Database Instance in the Scaleway console anytime. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB® Database Instance](/managed-databases/mongodb/quickstart) + + +## How to increase a Block Storage volume + +1. Click **MongoDB®** under **Managed Databases** on the side menu. A list of your Database Instances displays. +2. Click the name of the Database Instance you want to configure. The Database Instance overview page displays. +3. Scroll down to **Volume settings**. +4. Specify your volume capacity (in GB). The amount you define will be your new volume capacity. + + - You can increase your Block Storage volume to up to 10 TB. + - Block volume sizes cannot be decreased. + +5. Click **Increase volume size** to confirm. \ No newline at end of file diff --git a/managed-databases/mongodb/how-to/index.mdx b/managed-databases/mongodb/how-to/index.mdx new file mode 100644 index 0000000000..c1c6b7583c --- /dev/null +++ b/managed-databases/mongodb/how-to/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Managed MongoDB® Databases - How Tos + description: Managed MongoDB® Databases How Tos +content: + h1: Managed MongoDB® Databases - How Tos + paragraph: Managed MongoDB® Databases How Tos +--- diff --git a/managed-databases/mongodb/how-to/manage-snapshots.mdx b/managed-databases/mongodb/how-to/manage-snapshots.mdx new file mode 100644 index 0000000000..fdc37b476a --- /dev/null +++ b/managed-databases/mongodb/how-to/manage-snapshots.mdx @@ -0,0 +1,76 @@ +--- +meta: + title: How to manage MongoDB® Database snapshots + description: This page explains how to manage database snapshots +content: + h1: How to manage MongoDB® Database snapshots + paragraph: This page explains how to manage database snapshots +tags: managed-database database database-snapshot mongodb mongodb document +dates: + validation: 2024-10-01 + posted: 2024-10-01 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +[Snapshots](/managed-databases/mongodb/how-to/manage-snapshots/) allow you to restore data in a new Database Instance. + +You can have up to 100 snapshots per Instance and project (depending on quotas). + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB® Database Instance](/managed-databases/mongodb/quickstart) + +## How to create snapshots + +1. Go to the **Snapshots** tab of your Database Instance of choice. +2. Click **+ Create snapshot**. + + Make sure your Instance is in `READY` state before creating a snapshot. + + A pop-up displays. +3. Enter a name for your snapshot and set up the expiration date and time. + + The default retention period for snapshots is 365 days. + +4. Click **Create snapshot** to confirm. + +## How to create a Database Instance from a snapshot + +You can restore the data contained in a snapshot to a Database Instance. When you do so, a new Database Instance is created and billed to your account. + +1. Go to the **Snapshots** tab of your Database Instance of choice. +2. Click the next to the name of the snapshot. +3. Click **Create Database Instance from snapshot**. A pop-up appears. +4. Enter a name for your new Instance. +5. Choose a node type. + + It is possible to select a different (larger or smaller) node type for your new Instance. However, the block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory. + +6. Select a replica set configuration. You can choose between: + - **Replica-set 1-node** - an instance of MongoDB® that runs as a single server and does not provide redundancy or high availability. + - **Replica-set 3-nodes** - a group of 3 MongoDB® servers (1 primary and 2 standby nodes) that maintain the same data set. Replica sets provide redundancy and high availability and are the basis for all production deployments. If the main node fails for any reason, one of the remaining standby nodes is assigned and can take over requests, reducing downtime. +7. Review the estimated cost. +8. Click **Create Instance** to confirm. + + You can see the new Instance in your Database Instances list. + +## How to delete snapshots + +When you delete a Database Instance, the associated snapshots are not deleted. Snapshots will be deleted after the retention period defined. + +If you do not wish to wait for the snapshot to expire, you can delete it manually. + +1. Go to the **Snapshots** tab of your Database Instance of choice. +2. Click next to the name of the snapshot. +3. Click **Delete**. A pop-up displays to warn you that: + + This action is irreversible and will permanently destroy your snapshot and all its data. + +4. Type **DELETE** and click **Delete snapshot** if you wish to continue. diff --git a/managed-databases/mongodb/how-to/manage-users.mdx b/managed-databases/mongodb/how-to/manage-users.mdx new file mode 100644 index 0000000000..63fd1f9403 --- /dev/null +++ b/managed-databases/mongodb/how-to/manage-users.mdx @@ -0,0 +1,39 @@ +--- +meta: + title: How to manage a MongoDB® Database Instance user + description: This page explains how to manage the MongoDB® Database Instance default user +content: + h1: How to manage a MongoDB® Database Instance user + paragraph: This page explains how to manage the MongoDB® Database Instance default user +tags: managed-database database postgresql mongodb database-instance mongodb +dates: + validation: 2024-10-01 + posted: 2024-10-01 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +Users can connect to a database and access its data. + + + 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. + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB® Database Instance](/managed-databases/mongodb/quickstart) + +## How to change the password of your user + +1. Click **MongoDB® Databases** under **Managed Databases** on the side menu. A list of your Database Instances displays. +2. Click the database name or > **More info** to access the Database Instance information page. +3. Go to the **Users** tab. Your default user displays. +4. Click **Change password** to do so. A pop-up appears. +5. Enter your new password and confirm. + diff --git a/managed-databases/mongodb/index.mdx b/managed-databases/mongodb/index.mdx new file mode 100644 index 0000000000..9cf523176f --- /dev/null +++ b/managed-databases/mongodb/index.mdx @@ -0,0 +1,75 @@ +--- +meta: + title: Managed MongoDB® Databases Documentation + description: Dive into Scaleway Managed MongoDB® Databases with our quickstart guides, how-tos, tutorials and more. +content: + h1: Managed MongoDB® Databases Documentation + paragraph: Dive into Scaleway Managed MongoDB® Databases with our quickstart guides, how-tos, tutorials and more. +--- + + + +## Getting Started + + + + + + + + + +## API and CLI + + + + + + + +## Changelog + + diff --git a/managed-databases/mongodb/quickstart.mdx b/managed-databases/mongodb/quickstart.mdx new file mode 100644 index 0000000000..6b63a2469a --- /dev/null +++ b/managed-databases/mongodb/quickstart.mdx @@ -0,0 +1,100 @@ +--- +meta: + title: Managed MongoDB® Databases - Quickstart + description: This page shows you how to get started with Managed MongoDB® Databases. +content: + h1: Managed MongoDB® Databases - Quickstart + paragraph: This page shows you how to get started with Managed MongoDB® Databases. +tags: document managed-database database mongodb +dates: + validation: 2024-09-12 + posted: 2024-09-12 +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +Managed MongoDB® Databases provide fully-managed document Database Instances, with MongoDB® as a database engine. + +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. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [MongoDB®-compatible client](https://www.mongodb.com/try/download/shell) installed + +## How to create a Database Instance + +1. Click **MongoDB®** under **Managed Databases** on the side menu, if you do not have a Database Instance already created, the creation page displays. +2. Click **Create a Database Instance**. The creation wizard displays. +3. Complete the following steps in the wizard: + - Select **MongoDB®** as a database engine. + - Choose a region. This is the geographical location where your database will be deployed. + - Select a replica set configuration. You can choose between: + - **Replica-set 1-node** - an instance of MongoDB® that runs as a single server and does not provide redundancy or high availability. + - **Replica-set 3-nodes** - a group of 3 MongoDB® servers (1 primary and 2 standby nodes) that maintain the same data set. Replica sets provide redundancy and high availability and are the basis for all production deployments. If the main node fails for any reason, one of the remaining standby nodes is assigned and can take over requests, reducing downtime. + - Select a node type. + - Define the size of your Block Storage volume. You can increase your storage space without changing your node type, with no downtime. You can increase your volume to up to 10 TB. + - Add a name and set a password for your user. + + Your username must adhere to specific criteria. + - Length must be between 1 and 63 characters + - First character must be an alphabetic character (**a-Za-Z**) + - It can not start with **_rdb** + - Only **a-zA-Z0-9_$-** characters are accepted + + - Enter a name for your Database Instance. +4. Click **Create a Database Instance** to confirm your choices and launch creation. + + You are taken to the **Overview** tab for your Database Instance. + +## How to connect via database client with mongosh + +1. Click **MongoDB®** under **Managed Databases** on the side menu. A list of your Database Instances displays. +2. Click the database name or > **More info** to access the Database Instance information page. +3. Click next to the **TLS certificate** to download it. +4. Transfer the file to where you will execute the connection command. +5. Return to the console and click **Connect** in the **Connect Database Instance** section. +6. Select a connection mode. The following modes are available: `mongosh`, `Python`, `Go`, `Node.js` and `Mongoose`. In this tutorial we use `mongosh`. +7. Replace the variables in the commands with your information. + +### Connect to a public endpoint + +1. Replace the following variables in the command as described: + ```sh + mongosh "mongodb+srv://{instance_id}.mgdb.{region}.scw.cloud" --tlsCAFile {your_certificate.pem} -u {username} + ``` + + - `{your-certificate.pem}` - the TLS certificate downloaded on **step 3**. + - `{username}` - the username you defined upon Database Instance creation. + - `{db-instance-id}` - the UUID of your Database Instance. + - `{region}` - the database name you entered upon Database Instance creation. The default is called `rdb`. + + ``` +2. Run the command. +3. Enter your password when prompted. + +If the connection is successful, you should see the following message display on your console, and be able to write queries: + ```sh + The server generated these startup warnings when booting + Powered by MongoDB® v0.9.0 and PostgreSQL 14.6. + ``` + +### Connect to a private endpoint + +Follow the same procedure as above to connect to a private endpoint for one node, replacing `{privateNetorkName}` with the name of your Private Network: + + ```sh + mongosh "mongodb://{instance_id}-0.{privateNetworkName}" -u {username} + ``` +### Connect to a private endpoint with mulitple nodes + +For multiple nodes, replace `{db-instance-id}` with the Database Instance UUID of each respective Instance, and `{privateNetworkName}` with the names of your Private Network: + + ```sh + "mongodb://{instance_id}-0.{privateNetworkName},{instance_id}-1.{privateNetworkName},{instance_id}-2.{privateNetworkName}" -u {username} + ``` \ No newline at end of file diff --git a/managed-databases/mongodb/reference-content/autohealing.mdx b/managed-databases/mongodb/reference-content/autohealing.mdx new file mode 100644 index 0000000000..759e9f990e --- /dev/null +++ b/managed-databases/mongodb/reference-content/autohealing.mdx @@ -0,0 +1,29 @@ +--- +meta: + title: Understanding the autohealing feature + description: Learn more about the autohealing feature for Managed MongoDB® Databases +content: + h1: Understanding the autohealing feature + paragraph: Learn more about the autohealing feature for Managed MongoDB® Database +tags: databases ha high-availability autohealing database-nodes +categories: + - managed-databases +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +At Scaleway, High Availability (HA) Database Instances are continuously monitored and benefit from the autohealing feature. + +This feature is what guarantees your Database Instance will remain available even when one of its nodes is down. + +If your main database node goes down, the standby node will begin handling write operations in 30 to 60 seconds, depending on the type of failure. Intense writing activity may result in an increase of the failover time. + +Your Database Instance then goes into autohealing mode and switches to the `AUTOHEALING` status (represented by a blue dot in the Scaleway console). + +Your Database Instance will work only with the standby node for at most 700 seconds. + +After 700 seconds, if your main database node is still considered as down, a new node is spawned and automatically configured as a standby database node. Your initial standby node becomes the main one. + +Once this process is complete, your Database Instance goes back to `READY` status (represented by the green dot in the Scaleway console). \ No newline at end of file diff --git a/managed-databases/mongodb/reference-content/index.mdx b/managed-databases/mongodb/reference-content/index.mdx new file mode 100644 index 0000000000..26c20a6bc6 --- /dev/null +++ b/managed-databases/mongodb/reference-content/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Managed MongoDB® Databases - Additional content + description: Managed MongoDB® Databases additional content +content: + h1: Managed MongoDB® Databases - Additional content + paragraph: Managed MongoDB® Databases additional content +--- diff --git a/managed-databases/mongodb/troubleshooting/disk-full.mdx b/managed-databases/mongodb/troubleshooting/disk-full.mdx new file mode 100644 index 0000000000..c9de3e6a00 --- /dev/null +++ b/managed-databases/mongodb/troubleshooting/disk-full.mdx @@ -0,0 +1,33 @@ +--- +meta: + title: Dealing with disk_full mode in a Database Instance + description: This page helps you troubleshoot issues that occurr when your Database Instance volume is near full capacity. +content: + h1: Dealing with disk_full mode in a Database Instance + paragraph: This page helps you troubleshoot issues that occurr when your Database Instance volume is near full capacity. +tags: disk-full databases +dates: + validation: 2023-12-18 + posted: 2023-02-16 +categories: + - managed-databases + - postgresql-and-mysql +--- + + +Managed MongoDB® is currently in closed beta, and is not open for registration yet. + + +Whenever your Database Instance volume is close to reaching full capacity, your Database Instance switches to `disk_full` mode. + +The Database Instance switches to `disk_full` mode when the amount of free space in the volume falls under 2% of the total volume size. + +For Database Instances where 2% of the volume size is more than 2 GB, this threshold is 2 GB. + +When the Database Instance switches to `disk_full` state, the default transaction mode automatically switches to `read only`. This allows your applications to still access its data, while preventing new data from being added. + +This state allows you to increase your volume or [upgrade your node type](/managed-databases/mongodb/how-to/upgrade-a-database-instance/). You are also able to clear some space in your volume to increase your capacity. + + + Failing to clear out some of your data, or forcing insertions while the database is in `disk_full` mode leads to downtime + diff --git a/managed-databases/mongodb/troubleshooting/index.mdx b/managed-databases/mongodb/troubleshooting/index.mdx new file mode 100644 index 0000000000..2779b5e142 --- /dev/null +++ b/managed-databases/mongodb/troubleshooting/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Managed MongoDB® Databases - Troubleshooting + description: Managed MongoDB® Databases Troubleshooting +content: + h1: Managed MongoDB® Databases - Troubleshooting + paragraph: Managed MongoDB® Databases Troubleshooting +--- diff --git a/menu/navigation.json b/menu/navigation.json index 25d90e0ff1..571115ae16 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -2340,6 +2340,74 @@ ], "label": "Redis™", "slug": "redis" + }, + { + "items": [ + { + "label": "MongoDB® Overview", + "slug": "../mongodb" + }, + { + "label": "Concepts", + "slug": "concepts" + }, + { + "label": "Quickstart", + "slug": "quickstart" + }, + { + "items": [ + { + "label": "Create a Database Instance", + "slug": "create-a-database-instance" + }, + { + "label": "Connect to a Database Instance", + "slug": "connect-database-instance" + }, + { + "label": "Manage users", + "slug": "manage-users" + }, + { + "label": "Manage snapshots", + "slug": "manage-snapshots" + }, + { + "label": "Increase the storage size", + "slug": "increase-volume" + }, + { + "label": "Delete a Database Instance", + "slug": "delete-a-database-instance" + } + ], + "label": "How to", + "slug": "how-to" + }, + { + "items": [ + { + "label": "Understanding the autohealing feature", + "slug": "autohealing" + } + ], + "label": "Additional Content", + "slug": "reference-content" + }, + { + "items": [ + { + "label": "Dealing with disk_full state in a Database Instance", + "slug": "disk-full" + } + ], + "label": "Troubleshooting", + "slug": "troubleshooting" + } + ], + "label": "MongoDB®", + "slug": "mongodb" } ], "label": "Managed Databases", diff --git a/tutorials/install-parse-server/index.mdx b/tutorials/install-parse-server/index.mdx index 456377f70c..ee3b14562b 100644 --- a/tutorials/install-parse-server/index.mdx +++ b/tutorials/install-parse-server/index.mdx @@ -25,7 +25,7 @@ Parse provides a cloud-based backend service to build data-driven mobile applica ## Installing MongoDB -MongoDB is a document-oriented database that is free and open-source. It is considered one of the most popular NoSQL database engines because it is scalable, powerful, reliable, and easy to use. In contrast to relational databases, MongoDB does not require a deep predefined schema before you can add data since it can be altered at any time. +MongoDB® is a document-oriented database that is free and open-source. It is considered one of the most popular NoSQL database engines because it is scalable, powerful, reliable, and easy to use. In contrast to relational databases, MongoDB® does not require a deep predefined schema before you can add data since it can be altered at any time. 1. Update the Ubuntu package manager: ``` @@ -35,11 +35,11 @@ MongoDB is a document-oriented database that is free and open-source. It is cons ``` apt upgrade ``` -3. Install MongoDB. By default, MongoDB is available in the Ubuntu 20.04 default repository. +3. Install MongoDB. By default, MongoDB® is available in the Ubuntu 20.04 default repository. ``` apt install mongodb-server -y ``` -4. Verify MongoDB status. +4. Verify MongoDB® status. ``` systemctl status mongodb.service ``` @@ -138,7 +138,7 @@ These steps should install Node.js efficiently on your system. Additionally, you The configuration details are as follows: - `appName`: Set any name for your Parse server - - `databaseURI`: Connection string to the MongoDB database + - `databaseURI`: Connection string to the MongoDB® database - `appID`: Set a random string as appID, which will be used to connect the server. - `masterKey`: Set a random string for the master key. - `serverURL`: Set a URL for your parse server diff --git a/tutorials/mongodb-ubuntu-1604/index.mdx b/tutorials/mongodb-ubuntu-1604/index.mdx index 135368ee02..0bdf549954 100644 --- a/tutorials/mongodb-ubuntu-1604/index.mdx +++ b/tutorials/mongodb-ubuntu-1604/index.mdx @@ -1,10 +1,10 @@ --- meta: - title: Install and secure MongoDB on Ubuntu 22.04 Jammy Jellyfish - description: Follow a 3-step tutorial to install and secure MongoDB on Ubuntu 22.04 Jammy Jellyfish for robust database management. + title: Install and secure MongoDB® on Ubuntu 22.04 Jammy Jellyfish + description: Follow a 3-step tutorial to install and secure MongoDB® on Ubuntu 22.04 Jammy Jellyfish for robust database management. content: - h1: Install and secure MongoDB on Ubuntu 22.04 Jammy Jellyfish - paragraph: Follow a 3-step tutorial to install and secure MongoDB on Ubuntu 22.04 Jammy Jellyfish for robust database management. + h1: Install and secure MongoDB® on Ubuntu 22.04 Jammy Jellyfish + paragraph: Follow a 3-step tutorial to install and secure MongoDB® on Ubuntu 22.04 Jammy Jellyfish for robust database management. tags: database mysql mongoDB UFW bindIP categories: - instances @@ -13,9 +13,9 @@ dates: posted: 2018-06-25 --- -MongoDB is a document-oriented database that is free and open-source. It is considered one of the most popular NoSQL database engines because it is scalable, powerful, reliable, and easy to use. +MongoDB® is a document-oriented database that is free and open-source. It is considered one of the most popular NoSQL database engines because it is scalable, powerful, reliable, and easy to use. -In contrast to relational databases, MongoDB does not require a deep predefined schema before you can add data since it can be altered at any time. As it uses the NoSQL concept, data rows are stored in JSON-like documents which allows arbitrary data to be inserted. +In contrast to relational databases, MongoDB® does not require a deep predefined schema before you can add data since it can be altered at any time. As it uses the NoSQL concept, data rows are stored in JSON-like documents which allows arbitrary data to be inserted. @@ -27,10 +27,10 @@ In contrast to relational databases, MongoDB does not require a deep predefined ## Setting up MongoDB -### Adding MongoDB Repository +### Adding MongoDB® Repository - You should always use the official MongoDB `mongodb-org` packages, which are kept up-to-date with the most recent major and minor MongoDB releases. + You should always use the official MongoDB® `mongodb-org` packages, which are kept up-to-date with the most recent major and minor MongoDB® releases. 1. [Connect to your Instance](/compute/instances/how-to/connect-to-instance/) via SSH. @@ -47,13 +47,13 @@ In contrast to relational databases, MongoDB does not require a deep predefined apt upgrade -y apt install gnupg curl ``` -4. Import the key for the official MongoDB repository (Ubuntu ensures the authenticity of software packages by verifying that they are signed with GPG keys.). +4. Import the key for the official MongoDB® repository (Ubuntu ensures the authenticity of software packages by verifying that they are signed with GPG keys.). ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor ``` -5. Add the MongoDB repository details so that Ubuntu's `apt` command-line tool will know where to download the packages. Execute the following command to create a list file for MongoDB. +5. Add the MongoDB® repository details so that Ubuntu's `apt` command-line tool will know where to download the packages. Execute the following command to create a list file for MongoDB. ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-7.0.list ``` @@ -68,7 +68,7 @@ In contrast to relational databases, MongoDB does not require a deep predefined ``` apt install mongodb-org ``` -2. Press enter or type `Y` to proceed when prompted. Once the installation is completed, we start the MongoDB daemon. +2. Press enter or type `Y` to proceed when prompted. Once the installation is completed, we start the MongoDB® daemon. ``` systemctl start mongod.service ``` @@ -77,7 +77,7 @@ In contrast to relational databases, MongoDB does not require a deep predefined systemctl status mongod ``` ``` - ● mongod.service - MongoDB Database Server + ● mongod.service - MongoDB® Database Server Loaded: loaded (/lib/systemd/system/mongod.service; disabled; vendor preset: enabled) Active: active (running) since Mon 2024-06-17 11:33:47 UTC; 1s ago Docs: https://docs.mongodb.org/manual @@ -97,14 +97,14 @@ In contrast to relational databases, MongoDB does not require a deep predefined ### Securing MongoDB -The default installation of MongoDB is vulnerable because no authentication is required to interact with the database. Any user could create and destroy databases, as well as read from and write to their contents by default. To secure MongoDB, we need to create an administrative user and enable authentication. +The default installation of MongoDB® is vulnerable because no authentication is required to interact with the database. Any user could create and destroy databases, as well as read from and write to their contents by default. To secure MongoDB, we need to create an administrative user and enable authentication. 1. Connect to the Mongo shell to add a new user. ``` mongosh ``` - The legacy mongo shell was deprecated in MongoDB 5.0 and removed in MongoDB 6.0. The new MongoDB Shell, mongosh, offers numerous advantages over the legacy shell. + The legacy mongo shell was deprecated in MongoDB® 5.0 and removed in MongoDB® 6.0. The new MongoDB® Shell, mongosh, offers numerous advantages over the legacy shell. ``` Current Mongosh Log ID: 66701f399be3b0bbf2597192 @@ -119,7 +119,7 @@ The default installation of MongoDB is vulnerable because no authentication is r You can choose any preferred name for the administrative user since the privilege level is assigned from the role of `userAdminAnyDatabase`. - The `admin` database designates where the credentials are stored. You can learn more about authentication in the [MongoDB Security Authentication section](https://docs.mongodb.com/manual/core/authentication/). + The `admin` database designates where the credentials are stored. You can learn more about authentication in the [MongoDB® Security Authentication section](https://docs.mongodb.com/manual/core/authentication/). 2. Set the username of your choice and be sure to pick a secure password and substitute it in the command below: ``` use admin @@ -159,7 +159,7 @@ The default installation of MongoDB is vulnerable because no authentication is r ### Enabling authentication -To enforce authentication, we need to enable authentication and restart the MongoDB daemon. +To enforce authentication, we need to enable authentication and restart the MongoDB® daemon. 1. Open the configuration file. ``` @@ -179,7 +179,7 @@ To enforce authentication, we need to enable authentication and restart the Mong systemctl status mongod.service ``` ``` - ● mongod.service - MongoDB Database Server + ● mongod.service - MongoDB® Database Server Loaded: loaded (/lib/systemd/system/mongod.service; disabled; vendor preset: enabled) Active: active (running) since Mon 2022-11-21 12:44:17 UTC; 6min ago Docs: https://docs.mongodb.org/manual @@ -285,7 +285,7 @@ Uncomplicated Firewall (UFW), is a front-end to iptables. Its main goal is to ma OpenSSH ALLOW Anywhere OpenSSH (v6) ALLOW Anywhere (v6) ``` -6. Allow access to the default MongoDB port `27017` but restrict that access to a specific host. +6. Allow access to the default MongoDB® port `27017` but restrict that access to a specific host. ``` ufw allow from client_ip_address to any port 27017 ``` @@ -353,11 +353,11 @@ Using Mongosh: 2.2.9 ``` service mongod stop ``` -2. Remove any MongoDB packages that you had previously installed. +2. Remove any MongoDB® packages that you had previously installed. ``` apt purge mongodb-org* ``` -3. Remove MongoDB databases and log files. +3. Remove MongoDB® databases and log files. ``` rm -r /var/log/mongodb rm -r /var/lib/mongodb diff --git a/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx b/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx index f65cc442b3..6e50328754 100644 --- a/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx +++ b/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx @@ -23,7 +23,7 @@ Private Networks are a LAN-like layer 2 Ethernet network. A new network interfac To reach the goal of this tutorial, you will use four [Production-Optimized Instance](/compute/instances/reference-content/choosing-instance-type/) running **Ubuntu 22.04 (Jammy Jellyfish)** or later: - 1 POP2-2C-8G Instance as NGINX Proxy frontend, that distributes the load on the Rocket.Chat applications -- 1 POP2-8C-32G Instance as MongoDB host +- 1 POP2-8C-32G Instance as MongoDB® host - 2 POP2-4C-16G Instances running the Rocket.Chat application - A [Private Network](/network/vpc/quickstart/) between these Instances @@ -79,7 +79,7 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst 9. Configure the IP address of the private interface. In our example, we use the following IP's for our Instances: - NGINX Proxy Instance: `192.168.1.1/24` - - MongoDB Instance: `192.168.1.2/24` + - MongoDB® Instance: `192.168.1.2/24` - Rocket.Chat Instance 1: `192.168.1.3/24` - Rocket.Chat Instance 2: `192.168.1.4/24` @@ -101,17 +101,17 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst ## Installing MongoDB -1. Log into your Mongo DB instance using SSH. +1. Log into your MongoDB instance using SSH. 2. Update the APT repositories and upgrade the software already installed on the version to the latest version available in Ubuntu's official repositories: ``` root@mogodb-instance:~# apt update && apt upgrade -y ``` -3. Install the required prerequisites and the MongoDB GPG key to your system: +3. Install the required prerequisites and the MongoDB® GPG key to your system: ``` apt install -y gnupg wget -qO - https://www.mongodb.org/static/pgp/server-6.0.asc | apt-key add - ``` -4. Add the [MongoDB](/tutorials/mongodb-ubuntu-1604/) repository to your system. In this tutorial, we use MongoDB 6.0: +4. Add the [MongoDB](/tutorials/mongodb-ubuntu-1604/) repository to your system. In this tutorial, we use MongoDB® 6.0: ``` echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/6.0 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-6.0.list ``` @@ -119,7 +119,7 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst ``` apt update ``` -6. Install MongoDB using the `apt` package manager: +6. Install MongoDB® using the `apt` package manager: ``` apt install mongodb-org -y ``` @@ -152,13 +152,13 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst ``` - In this setup we limit the access to the MongoDB on an IP basis, for a production environment it is recommended to use stronger authentication methods. Refer to the [MongoDB Security Checklist](https://docs.mongodb.com/manual/administration/security-checklist/) for more information. + In this setup we limit the access to the MongoDB® on an IP basis, for a production environment it is recommended to use stronger authentication methods. Refer to the [MongoDB® Security Checklist](https://docs.mongodb.com/manual/administration/security-checklist/) for more information. -8. Enable and start the MongoDB service: +8. Enable and start the MongoDB® service: ``` systemctl enable mongod.service && systemctl start mongod.service ``` -9. Initialize the ReplicaSet on the MongoDB using the following command: +9. Initialize the ReplicaSet on the MongoDB® using the following command: ``` mongosh --eval "printjson(rs.initiate())" ``` @@ -409,7 +409,7 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst 7. Check the number of running Instances from the Rocket.Chat administration interface. -Once everything is set up and working, you can remove the public flexible IP addresses from both Rocket.Chat Instances, as well as from the MongoDB instance. They will be able to communicate securely using the Private Network. +Once everything is set up and working, you can remove the public flexible IP addresses from both Rocket.Chat Instances, as well as from the MongoDB® instance. They will be able to communicate securely using the Private Network. ## Conclusion diff --git a/tutorials/run-messaging-platform-with-rocketchat/index.mdx b/tutorials/run-messaging-platform-with-rocketchat/index.mdx index 01cedc4c11..1442e7e5a3 100644 --- a/tutorials/run-messaging-platform-with-rocketchat/index.mdx +++ b/tutorials/run-messaging-platform-with-rocketchat/index.mdx @@ -32,7 +32,7 @@ dates: ``` sudo apt update && sudo apt upgrade -y && sudo apt -y install curl ``` -2. Add the key used by apt to install the official MongoDB packages: +2. Add the key used by apt to install the official MongoDB® packages: ``` curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ @@ -104,19 +104,19 @@ dates: Replace `rocketchat.example.com` with the domain for your Rocket.Chat Instance. -## Configuring a MongoDB replica set +## Configuring a MongoDB® replica set -We recommend you use the [MongoDB replica set](https://docs.mongodb.com/manual/replication/) to improve Rocket.Chat's performance with Meteor Oplog tailing. +We recommend you use the [MongoDB® replica set](https://docs.mongodb.com/manual/replication/) to improve Rocket.Chat's performance with Meteor Oplog tailing. -1. Run the following code to add a replica set to your MongoDB configuration: +1. Run the following code to add a replica set to your MongoDB® configuration: ``` echo -e "replication:\n replSetName: \"rs01\"" | tee -a /etc/mongod.conf ``` -2. Enable and start the MongoDB service. +2. Enable and start the MongoDB® service. ``` systemctl enable mongod.service && systemctl start mongod.service ``` -3. Connect to the MongoDB shell and initiate the replica set with `rs.initiate()`. +3. Connect to the MongoDB® shell and initiate the replica set with `rs.initiate()`. ``` mongo > rs.initiate() @@ -148,7 +148,7 @@ We recommend you use the [MongoDB replica set](https://docs.mongodb.com/manual/r ``` rs01:PRIMARY> ``` -5. Leave the MongoDB shell. +5. Leave the MongoDB® shell. ``` rs01:PRIMARY> exit bye diff --git a/tutorials/setup-mongodb-on-ubuntu/index.mdx b/tutorials/setup-mongodb-on-ubuntu/index.mdx index 0b38da5fc6..b8bc97da02 100644 --- a/tutorials/setup-mongodb-on-ubuntu/index.mdx +++ b/tutorials/setup-mongodb-on-ubuntu/index.mdx @@ -1,10 +1,10 @@ --- meta: - title: Installing and Securing MongoDB on Ubuntu Noble Numbat (24.04) - description: This tutorial explains in 3 steps how to install and secure MongoDB on Ubuntu Linux + title: Installing and Securing MongoDB® on Ubuntu Focal Fossa (20.04) + description: This tutorial explains in 3 steps how to install and secure MongoDB® on Ubuntu Linux content: - h1: Installing and Securing MongoDB on Ubuntu Noble Numbat (24.04) - paragraph: This tutorial explains in 3 steps how to install and secure MongoDB on Ubuntu Linux + h1: Installing and Securing MongoDB® on Ubuntu Focal Fossa (20.04) + paragraph: This tutorial explains in 3 steps how to install and secure MongoDB® on Ubuntu Linux tags: database mysql mongoDB UFW bindIP categories: - instances @@ -15,9 +15,9 @@ dates: [MongoDB](https://www.mongodb.com/) is a document-oriented database, available for free as an open-source solution. Renowned for its scalability, robustness, reliability, and user-friendly nature, it is one of the premier choices among NoSQL database engines. -Diverging from traditional relational databases, MongoDB users no longer need an intricate predefined schema before adding data. This flexibility stems from its ability to modify schemas at any point in time. Embracing the NoSQL philosophy, it employs JSON-like documents for data storage, allowing the insertion of diverse and arbitrary data. +Diverging from traditional relational databases, MongoDB® users no longer need an intricate predefined schema before adding data. This flexibility stems from its ability to modify schemas at any point in time. Embracing the NoSQL philosophy, it employs JSON-like documents for data storage, allowing the insertion of diverse and arbitrary data. -Powerful [Production-Optimized Instance](/compute/instances/reference-content/choosing-instance-type/) comes with the compute and storage capabilities you need to run your MongoDB Instance smoothly. +Powerful [Production-Optimized Instance](/compute/instances/reference-content/choosing-instance-type/) comes with the compute and storage capabilities you need to run your MongoDB® Instance smoothly. We recommend you follow this tutorial using a [Production-Optimized Instance](/compute/instances/reference-content/choosing-instance-type/). @@ -33,7 +33,7 @@ Powerful [Production-Optimized Instance](/compute/instances/reference-content/ch ## Setting up MongoDB -### Adding MongoDB repository +### Adding MongoDB® repository Always use the official MongoDB `mongodb-org` packages, to make sure you have the latest, up-to-date major and minor MongoDB releases. @@ -57,14 +57,14 @@ Powerful [Production-Optimized Instance](/compute/instances/reference-content/ch ``` apt upgrade ``` -4. Import the key for the official MongoDB repository (Ubuntu ensures the authenticity of software packages by verifying that they are signed with GPG keys.). +4. Import the key for the official MongoDB® repository (Ubuntu ensures the authenticity of software packages by verifying that they are signed with GPG keys.). ``` curl -fsSL https://pgp.mongodb.com/server-7.0.asc | \ sudo gpg -o /etc/apt/trusted.gpg.d/mongodb-server-7.0.gpg \ --dearmor ``` The command above should respond with an `OK`. -5. Add the MongoDB repository details so that Ubuntu's `apt` command-line tool will know where to download the packages. Execute the following command to create a list file for MongoDB. +5. Add the MongoDB® repository details so that Ubuntu's `apt` command-line tool will know where to download the packages. Execute the following command to create a list file for MongoDB. ``` echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list ``` @@ -82,12 +82,12 @@ Powerful [Production-Optimized Instance](/compute/instances/reference-content/ch ``` apt install mongodb-org ``` -2. Press enter or type `Y` to proceed when prompted. Once the installation is completed, start the MongoDB daemon. +2. Press enter or type `Y` to proceed when prompted. Once the installation is completed, start the MongoDB® daemon. ``` systemctl start mongod.service ``` -3. Verify that the service has started properly. +3. Verify that the service has started properly. ``` systemctl status mongod.service ``` @@ -130,7 +130,7 @@ The default installation of MongoDB is vulnerable because no authentication is r You can choose any preferred name for the administrative user since the privilege level is assigned from the role of `userAdminAnyDatabase`. - The `admin` database designates where the credentials are stored. You can learn more about authentication in the [MongoDB Security Authentication section](https://docs.mongodb.com/manual/core/authentication/). + The `admin` database designates where the credentials are stored. You can learn more about authentication in the [MongoDB® Security Authentication section](https://docs.mongodb.com/manual/core/authentication/). 2. Set the username of your choice and pick your own secure password, then substitute them in the command below: ``` use admin @@ -174,7 +174,7 @@ To enforce authentication, you must enable authentication and restart the MongoD systemctl status mongod ``` ``` - ● mongod.service - MongoDB Database Server + ● mongod.service - MongoDB® Database Server Loaded: loaded (/lib/systemd/system/mongod.service; disabled; vendor prese> Active: active (running) since Tue 2022-03-01 10:43:45 UTC; 2s ago Docs: https://docs.mongodb.org/manual @@ -188,7 +188,7 @@ To enforce authentication, you must enable authentication and restart the MongoD systemctl status mongod.service ``` ``` - ● mongod.service - MongoDB Database Server + ● mongod.service - MongoDB® Database Server Loaded: loaded (/lib/systemd/system/mongod.service; disabled; vendor prese> Active: active (running) since Tue 2022-03-01 10:43:45 UTC; 2s ago Docs: https://docs.mongodb.org/manual @@ -302,7 +302,7 @@ Uncomplicated Firewall (UFW), is a front-end to iptables. Its main goal is to ma OpenSSH ALLOW Anywhere OpenSSH (v6) ALLOW Anywhere (v6) ``` -6. Allow access to the default MongoDB port `27017` but restrict that access to a specific host. +6. Allow access to the default MongoDB® port `27017` but restrict that access to a specific host. ``` ufw allow from client_ip_address to any port 27017 ``` @@ -375,11 +375,11 @@ For mongosh info see: https://docs.mongodb.com/mongodb-shell/ ``` service mongod stop ``` -2. Remove any MongoDB packages that you had previously installed. +2. Remove any MongoDB® packages that you had previously installed. ``` apt purge mongodb-org* ``` -3. Remove MongoDB databases and log files. +3. Remove MongoDB® databases and log files. ``` rm -r /var/log/mongodb rm -r /var/lib/mongodb