Skip to content

Commit 18510c8

Browse files
committed
docs(srv): add SEM x Jobs documentation MTA-5199
1 parent d9cf9dc commit 18510c8

File tree

7 files changed

+98
-4
lines changed

7 files changed

+98
-4
lines changed

faq/serverless-jobs.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Serverless Jobs are billed on a pay-as-you-go basis, strictly on resource consum
6666
* *Billed resources:* 864 000 - 400 000 = 464 000 GB-s
6767
* *Cost:* 464 000 * €0.0000010 = **€0.47**
6868
* **vCPU consumption**
69-
* *Allocated vCPU conversion:* 1120mVCPU = 1.12 vCPU
69+
* *Allocated vCPU conversion:* 1120 mVCPU = 1.12 vCPU
7070
* *Resource consumption:* 432 000 s * 1.12 vCPU = 483 840 vCPU-s
7171
* *Free tier:* 200 000 vCPU-s
7272
* *Billed resources:* 483 840 - 200 000 = 283 840 vCPU-s
@@ -119,4 +119,8 @@ skopeo copy --override-os linux docker://docker.io/alpine:latest docker://rg.fr-
119119

120120
Scaleway Serverless Jobs does not currently support Scaleway VPC or Private Networks, though this feature is under development.
121121

122-
To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.
122+
To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.
123+
124+
## Can I securely use sensitive information with Serverless Jobs?
125+
126+
Yes, you can use sensitive data such as API secret keys, passwords, TLS/SSL certificates, or tokens. Serverless Jobs seamlessly integrates with [Secret Manager](/identity-and-access-management/secret-manager/), which allows you to securely reference sensible information within your jobs. Refer to the [dedicated documentation](/serverless/jobs/how-to/reference-secret-in-job/) for more information.

menu/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3929,6 +3929,10 @@
39293929
"label": "Manage the scheduling of a job",
39303930
"slug": "manage-job-schedule"
39313931
},
3932+
{
3933+
"label": "Reference secrets in a job",
3934+
"slug": "reference-secret-in-job"
3935+
},
39323936
{
39333937
"label": "Delete a job",
39343938
"slug": "delete-job"

serverless/jobs/concepts.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ The maximum duration option allows you to define the maximum execution time befo
5353

5454
A schedule (cron) is a mechanism used to automatically start a Serverless Job at a specific time on a recurring schedule. It works similarly to a traditional Linux cron job, using the `* * * * *` format. Refer to our [cron schedules reference](/serverless/jobs/reference-content/cron-schedules/) for more information.
5555

56+
## Secrets reference
57+
58+
A secret reference is a mechanism that allows you to use a secret stored in [Secret Manager](/identity-and-access-management/secret-manager/) within Serverless Jobs. It allows you to securely reference sensitive data, such as API secret keys, passwords, tokens, or certificates.
59+
5660
## Startup command
5761

5862
This optional field allows you to specify a custom command executed upon starting your job if your container image does not have one already, or if you use a public container image.

serverless/jobs/how-to/create-job-from-external-registry.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Private external container registries are currently not supported.
3939
- Choose the **resources** to be allocated to your job at runtime. These define the performance characteristics of your job.
4040
- Optionally, add a **cron schedule** in the `* * * * *` format, and select your time zone to run your job periodically. Refer to the [cron schedules documentation](/serverless/jobs/reference-content/cron-schedules/) for more information.
4141
- Define any **environment variables** you want to inject into your job in the advanced options. For each environment variable, click **+Add new variable** and enter the key/value pair.
42+
- Add the desired [secret references](/serverless/jobs/how-to/reference-secret-in-job/) to your job
4243
- Add a **startup command** to your job. It will be executed every time your job is run.
4344
- Set a **maximum duration** to your job to stop it automatically if it does not complete within this limit.
4445
- Verify the **estimated cost**.

serverless/jobs/how-to/create-job-from-scaleway-registry.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Scaleway's Serverless Jobs allows you to create jobs from several container [reg
3434
- Choose the **resources** to be allocated to your job at runtime. These define the performance characteristics of your job.
3535
- Add a **cron schedule** in the `* * * * *` format, and select your time zone to run your job periodically. Refer to the [cron schedules documentation](/serverless/jobs/reference-content/cron-schedules/) for more information.
3636
- Define any **environment variables** you want to inject into your job in the advanced options. For each environment variable, click **+Add new variable** and enter the key/value pair.
37+
- Add the desired [secret references](/serverless/jobs/how-to/reference-secret-in-job/) to your job.
3738
- Add a **startup command** to your job. It will be executed every time your job is run.
3839
- Set a **maximum duration** to your job to stop it automatically if it does not complete within this limit.
3940
- Verify the **estimated cost**.
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
meta:
3+
title: How to reference secrets in Serverless Jobs
4+
description: Steps to reference secrets from Secret Manager in your Serverless Jobs.
5+
content:
6+
h1: How to reference secrets in Serverless Jobs
7+
paragraph: Steps to reference secrets from Secret Manager in your Serverless Jobs.
8+
tags: serverless jobs secrets secret-manager reference environment variable
9+
dates:
10+
validation: 2024-10-27
11+
posted: 2024-10-27
12+
categories:
13+
- serverless
14+
- jobs
15+
---
16+
17+
Serverless Jobs seamlessly integrates with [Secret Manager](/identity-and-access-management/secret-manager/), which allows you to store, manage, and access sensitive information, such as credentials, SSH keys, SSL/TLS certificates, or any key/value pairs you need to secure.
18+
19+
You can reference any secret stored in Secret Manager in a job, without having to hardcode any sensible data.
20+
21+
<Macro id="requirements" />
22+
23+
- A Scaleway account logged into the [console](https://console.scaleway.com)
24+
- [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
25+
- [Created a Serverless Job](/serverless/jobs/how-to/create-job-from-scaleway-registry/)
26+
- [Created a secret](/identity-and-access-management/secret-manager/how-to/create-secret/)
27+
28+
## Add a secret to a job
29+
30+
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
31+
32+
2. Click the name of the job to which you want to add a secret, then open the **Settings** tab.
33+
34+
3. In the **Secrets references** section, click **+ Add secret reference**. A pop-up displays.
35+
36+
4. Select the secret you want to reference, and the desired version, then click **Select reference method**.
37+
38+
5. Select the desired reference method:
39+
40+
- **File**: copies the encrypted value of your secret to a file stored at the indicated location within your container. This method is recommended for large or complex data. For example, if your secret is a certificate, you can store it as a file in the `/my-certificates` folder in your container.
41+
42+
- **Environment variable**: passes the encrypted value of your secret to your job as a variable. This method is recommended for small information, such as passwords, or API secret keys. For example, if you name this variable `MY_SECRET`, calling `$MY_SECRET` in your container will return the value of the selected secret in a secure way.
43+
44+
6. Click **Add reference** to add the secret to your Serverless Job. Optionally, tick the **Add another reference** to add a new secret right away, then repeat steps 4 to 6.
45+
46+
The secret is now referenced in your Serverless Job, and can be used within the container.
47+
48+
## Update a secret in a job
49+
50+
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
51+
52+
2. Click the name of the job for which you want to update a secret, then open the **Settings** tab.
53+
54+
3. In the **Secret references** section, click the <Icon name="edit" /> icon next to the secret reference you want to update. A pop-up displays.
55+
56+
4. Update the secret version if needed, then click **Update** to save your changes, or click **Select reference method** to continue.
57+
58+
5. Either update the location of the file, or the name of the environment, variable then click **Update reference** to confirm your changes.
59+
60+
<Message type="note">
61+
You cannot change the reference method of an existing secret. To do so, delete the secret reference within the job, then create it again with the desired reference method.
62+
</Message>
63+
64+
## Delete a secret reference from a job
65+
66+
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
67+
68+
2. Click the name of the job for which you want to delete a secret, then open the **Settings** tab.
69+
70+
3. In the **Secret references** section, click the <Icon name="delete" /> icon next to the secret reference you want to delete. A confirmation pop-up displays.
71+
72+
4. Click **Delete reference** to confirm.
73+
74+
The secret is no longer referenced in your Serverless Job.
75+
76+
<Message type="note">
77+
Deleting a secret from the **Settings** tab of a job only deletes the secret reference, not the secret itself. To permanently delete a secret, follow [this procedure](/identity-and-access-management/secret-manager/how-to/delete-secret/).
78+
</Message>

serverless/jobs/quickstart.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,12 @@ This page explains how to create a job definition with the latest Alpine Linux i
6262

6363
3. From the **Overview** tab, click **Run job**.
6464

65-
The execution appears in the **Job runs** section of the **Overview** tab.
65+
The execution appears in the **Job runs** section of the **Overview** tab.
66+
67+
4. Click <Icon name="more"> next to the last execution in the **Job runs** section, then click **Logs** to access your job's logs.
6668

6769
<Message type="note">
68-
Refer to [How to monitor a job](/serverless/jobs/how-to/monitor-job/) to see the logs of the job you just executed.
70+
Make sure that you [retrieved your Grafana credentials](/observability/cockpit/how-to/retrieve-grafana-credentials/) before accessing your job's logs.
6971
</Message>
7072

7173
## How to delete a job

0 commit comments

Comments
 (0)