Skip to content

docs(srv): mongoDB backups using jobs tutorial MTA-6155 #5128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions tutorials/backup-mongodb-jobs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
meta:
title: &title Create snapshots of a Managed MongoDB® database with Serverless Jobs and the Scaleway CLI
description: &description This step-by-step tutorial will help you automate the creation of snapshots of your Instance using Serverless Jobs and the Scaleway CLI
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: &description This step-by-step tutorial will help you automate the creation of snapshots of your Instance using Serverless Jobs and the Scaleway CLI
description: &description This step-by-step tutorial will help you automate the creation of snapshots of your MongoDB using Serverless Jobs and the Scaleway CLI

content:
h1: *title
paragraph: *description
tags: serverless jobs instance snapshot backup image disk storage cli
categories:
- mongodb
- jobs
dates:
validation: 2025-06-17
posted: 2025-06-17
---
[Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of creating snapshots of a [Scaleway Managed MongoDB® database](/managed-mongodb-databases/quickstart/) on a recurring schedule using a Serverless Job.

Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com).
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization.
- Created a [Managed MongoDB® database](/managed-mongodb-databases/how-to/create-a-database-instance/).

## Creating the job definition

1. In the [Scaleway console](https://console.scaleway.com), click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.

2. Click **Create job**. The job creation wizard displays.

3. For **Container Image**, select **External**, and in **Image URL**, set: `scaleway/cli:latest`.

4. Enter a name or use the automatically generated one.

5. Select the region in which your job will be created.

6. Keep the default **resources** values, as this job requires little compute capability.

7. Set **cron schedule** to `0 18 * * *` and select the relevant time zone to run the job every evening at 18:00 p.m. Refer to the [cron schedules documentation](/serverless-jobs/reference-content/cron-schedules/) for more information.

8. Define the following environment variables:
- `SCW_ACCESS_KEY`: your API access key.
- `SCW_SECRET_KEY`: your API secret key.
- `SCW_DEFAULT_PROJECT_ID`: your Project ID.
- `SCW_DEFAULT_ORGANIZATION_ID`: your Organization ID.
- `SCW_DEFAULT_REGION`: concerned region.

<Message type="note">
We recommend using Secret Manager to store the `SCW_ACCESS_KEY` and `SCW_SECRET_KEY`.
</Message>

For more details about variables used by `cli`, refer to the [CLI config documentation](https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/config.md).

9. In the **Execution** tab, define the command below, and replace the placeholders with the ID of your Managed MongoDB® Database Instance ID and the name of your snapshot:
```sh
scw mongodb snapshot create <MONGO_INSTANCE_ID> name="snapshot_$(date +%Y%m%d_%H%M%S)" expires-at=30d
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomas-tacquet do we want a specific format for the snapshot name ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

your proposal is fine 👌

```

10. Click **Create job**.

Your job will automatically create a snapshot named `snapshot_<DATE_TIME>` with a 30-day retention period every day at 18:00 p.m.

## Running the job

From the **Overview** tab of the Serverless job you just created, click **Actions**, then select **Run job** from the contextual menu.

The execution appears in the **Job runs** section. You can access the logs of your job by clicking <Icon name="more" /> next to the job run ID, and selecting **See on Cockpit**.

## Possible improvements

This tutorial is a lightweight example of how to create recurring snapshots of a Database Instance. You can go further by:
- Using it to manage all your Database Instances' snapshots
- Setting up an alerting system in case of unexpected behavior
- Explore [scaleway/serverless-examples repository](https://github.com/scaleway/serverless-examples) for advanced automation examples

## Additional resources

- [Serverless Jobs Documentation](/serverless-jobs/how-to/create-job/)
- [Other methods to deploy Jobs](/serverless-jobs/reference-content/deploy-job/)
- [API keys documentation](/iam/how-to/create-api-keys/)
- [CRON schedule reference](/serverless-jobs/reference-content/cron-schedules/)