-
Notifications
You must be signed in to change notification settings - Fork 261
docs(CLI): add how to & macro for Jobs automation MTA-6323 #5319
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
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| macro: automate-resources-management | ||
| --- | ||
|
|
||
| import Requirements from '@macros/iam/requirements.mdx' | ||
|
|
||
|
|
||
| [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This page shows how to create jobs to perform any operation available with the [Scaleway CLI](https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/config.md) to automate the management of your Scaleway resources. | ||
|
|
||
| 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. | ||
|
|
||
| <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. | ||
|
|
||
| ## 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 a **cron schedule** in the `* * * * *` format (such as `0 0 * * *` to run the job every day at midnight), and select the relevant time zone to run the job at the desired frequency. 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`: desired region. | ||
|
|
||
| <Message type="note"> | ||
| We recommend using [Secret Manager](/secret-manager/quickstart/) 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 desired Scaleway CLI command, as shown in the examples below: | ||
| - **Power on and off Instances** | ||
| ```sh | ||
| # Power on | ||
| /scw instance server start 11111111-1111-1111-1111-111111111111 | ||
|
|
||
| # Power off | ||
| /scw instance server stop 11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
| - **Create a snapshot of an Instance volume** | ||
| ```sh | ||
| /scw instance snapshot create volume-id=11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
| - **Create a backup of an Instance** | ||
| ```sh | ||
| /scw instance server backup 11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
| 10. Click **Create job**. | ||
|
|
||
| Your Serverless Job will run the command periodically according to the [cron schedule](/serverless-jobs/reference-content/cron-schedules/) you defined. | ||
|
|
||
| ## Running the job | ||
|
|
||
| From the **Overview** tab of the Serverless job you just created, click **Actions**, then select **Run job** from the contextual menu. | ||
SamyOubouaziz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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**. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
pages/scaleway-cli/how-to/automate-resources-management.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| title: How to automate the management of your resources using the Scaleway CLI and Serverless Jobs | ||
| description: This step-by-step guide will help you automate the management of your resources using Serverless Jobs and the Scaleway CLI | ||
| tags: serverless jobs command line interface cli automate resources management | ||
| categories: | ||
| - developer-tools | ||
| - jobs | ||
| dates: | ||
| validation: 2025-06-23 | ||
| posted: 2025-06-13 | ||
| --- | ||
|
|
||
| import AutomateResourcesManagement from '@macros/serverless-jobs/automate-resources-management.mdx' | ||
|
|
||
| <AutomateResourcesManagement /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.