Skip to content

docs(srv): Jobs x Instances power cycle tuto MTA-6097 #5091

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

Merged
merged 2 commits into from
Jun 11, 2025
Merged
Show file tree
Hide file tree
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
123 changes: 123 additions & 0 deletions tutorials/power-on-off-instances-jobs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
meta:
title: Power your Instance on and off with Serverless Jobs and the Scaleway CLI
description: This step-by-step tutorial will help you automate the startup and shutdown of your Instance using Serverless Jobs and the Scaleway CLI
content:
h1: Power your Instance on and off with Serverless Jobs and the Scaleway CLI
paragraph: This step-by-step tutorial will help you automate the startup and shutdown of your Instance using Serverless Jobs and the Scaleway CLI
tags: serverless jobs instance cli turn on off power start stop reboot
categories:
- instances
- jobs
dates:
validation: 2025-06-09
posted: 2025-06-09
---
[Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of powering a [Scaleway Instance](/instances/quickstart/) on and off, 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 an [Instance](/instances/how-to/create-an-instance/).

## Creating the job definitions

### Serverless Job to power on the Instance

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 9 * * 1-5` and select the relevant time zone to run the job every morning at 9:00 a.m (09:00) from Monday through Friday. 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`: the preferred 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://cli.scaleway.com/instance/#power-on-server).

9. In the **Execution** tab, enter the command below, and replace the placeholder with your Instance ID:

```
scw instance server start 11111111-1111-1111-1111-111111111111
```

10. Click **Create job**.

### Serverless Job to power off the Instance

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 * * 1-5` and select the relevant time zone to run the job every evening at 6:00 p.m (18:00) from Monday through Friday. 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`: the preferred 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://cli.scaleway.com/instance/#power-on-server).

9. In the **Execution** tab, enter the command below, and replace the placeholder with your Instance ID:

```
scw instance server stop 11111111-1111-1111-1111-111111111111
```

10. Click **Create job**.

## Testing the jobs

According to the current state of your Instance, run either the **Power on** or **Power off** job first.

From the **Overview** tab of each 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 jobs 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 manage the power cycle of an Instance. You can go further by:
- Using it to manage all your Instances' power cycles
- Using Jobs to create [snapshots of your Instances](/tutorials/snapshot-instances-jobs/)
- Setting up an alerting system in case of unexpected behavior
- Exploring [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/)
2 changes: 1 addition & 1 deletion tutorials/snapshot-instances-jobs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ categories:
- instances
- jobs
dates:
validation: 2025-12-03
validation: 2025-03-12
posted: 2024-06-19
---
[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 Instance](/instances/quickstart/) on a recurring schedule using a Serverless Job.
Expand Down