Skip to content

Commit c2a3714

Browse files
thomas-tacquetRoRoJSamyOubouazizjcirinosclwynerda-codes
authored
feat(jobs): permissions precisions (#5657)
* feat(jobs): permissions precisions * Apply suggestions from code review Co-authored-by: Rowena Jones <[email protected]> * Update pages/serverless-jobs/how-to/create-job.mdx Co-authored-by: Jessica <[email protected]> * Update pages/serverless-jobs/how-to/create-job.mdx Co-authored-by: Jessica <[email protected]> * fix(srv): doc review * Update pages/serverless-jobs/how-to/create-job.mdx Co-authored-by: Néda <[email protected]> * Update pages/serverless-jobs/how-to/create-job.mdx Co-authored-by: Néda <[email protected]> * Update pages/serverless-jobs/how-to/run-job.mdx Co-authored-by: Néda <[email protected]> * Update pages/serverless-jobs/how-to/run-job.mdx Co-authored-by: Néda <[email protected]> * fix(srv): doc review --------- Co-authored-by: Rowena Jones <[email protected]> Co-authored-by: SamyOubouaziz <[email protected]> Co-authored-by: Jessica <[email protected]> Co-authored-by: Néda <[email protected]>
1 parent 4c2f952 commit c2a3714

File tree

4 files changed

+19
-9
lines changed

4 files changed

+19
-9
lines changed

pages/iam/reference-content/permission-sets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Below is a list of the permission sets available at Scaleway.
229229

230230
| Permission set | Description |
231231
| :--------------------------: | :-----------------------------------------------------------------------------------: |
232-
| ServerlessJobsFullAccess | Full access to create, read, list, edit and delete job definition/run |
232+
| ServerlessJobsFullAccess | Full access to create, read, list, edit and delete job definition/run. Does not include permissions for Container Registry and Secret Manager |
233233
| ServerlessJobsReadOnly | List and read access to job definition/run |
234234

235235
### Databases

pages/serverless-jobs/how-to/create-job.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Scaleway's Serverless Jobs allows you to create jobs from several container [reg
4949
<Tabs>
5050
<TabsTab label="Data">
5151
1. Declare [environment variables](/serverless-jobs/concepts/#environment-variables) you want to inject into your job. For each environment variable, click **+Add variable** and enter the key/value pair.
52-
2. Add [secrets references](/serverless-functions/concepts/#secrets) for your Job. Secret references are environment variables fetched from [Scaleway Secret Manager](/secret-manager/) that are injected into your job, but the values are not retained or displayed by Scaleway after initial validation.
52+
2. Add [secret references](/serverless-functions/concepts/#secrets) for your job. Secret references are environment variables fetched from [Scaleway Secret Manager](/secret-manager/) that are injected into your job, but the values are not retained or displayed by Scaleway after initial validation.
5353
<Message type="note">
5454
Encode your environment variables and secrets to `base64` if they are too large, and contain carriage returns.
5555
</Message>
5656
</TabsTab>
5757
<TabsTab label="Storage">
58-
- Customize the ephemeral storage for your job according to your requirements. The data stored in your job is not retained once it is finished.
58+
- Customize the ephemeral storage for your job according to your requirements. The data stored in your job is not retained once it is finished.
5959
</TabsTab>
6060
<TabsTab label="Execution">
6161
1. Add a **startup command** to your job. It will be executed every time your job is run.
@@ -114,13 +114,13 @@ Private external container registries are currently not supported.
114114
<Tabs>
115115
<TabsTab label="Data">
116116
1. Declare [environment variables](/serverless-jobs/concepts/#environment-variables) you want to inject into your job. For each environment variable, click **+Add variable** and enter the key/value pair.
117-
2. Add [secrets references](/serverless-functions/concepts/#secrets) for your Job. Secret references are environment variables fetched from [Scaleway Secret Manager](/secret-manager/) that are injected into your job, but the values are not retained or displayed by Scaleway after initial validation.
117+
2. Add [secret references](/serverless-functions/concepts/#secrets) for your job. Secret references are environment variables fetched from [Scaleway Secret Manager](/secret-manager/) that are injected into your job, but the values are not retained or displayed by Scaleway after initial validation.
118118
<Message type="note">
119119
Encode your environment variables and secrets to `base64` if they are too large, and contain carriage returns.
120120
</Message>
121121
</TabsTab>
122122
<TabsTab label="Storage">
123-
- Customize the ephemeral storage for your job according to your requirements. The data stored in your job is not retained once it is finished.
123+
- Customize the ephemeral storage for your job according to your requirements. The data stored in your job is not retained once it is finished.
124124
</TabsTab>
125125
<TabsTab label="Execution">
126126
1. Add a **startup command** to your job. It will be executed every time your job is run.

pages/serverless-jobs/how-to/run-job.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,16 @@ The **Job runs** section contains basic monitoring information for your jobs:
4949
- A start date and an end date
5050
- The duration of the job execution
5151

52-
<Message type="tip">
53-
Use [Cockpit](/cockpit/quickstart/) for in-depth monitoring of the activity of your serverless jobs.
54-
</Message>
52+
## Permissions and product dependencies
53+
54+
Depending on the settings used, Serverless Jobs can have dependencies on other products, such as:
55+
56+
- **Secret Manager**: to securely inject data into jobs
57+
- **Container Registry**: to store images of jobs
58+
59+
Executing a Serverless Job can fail if some permissions are not definied properly in an [IAM policy](/iam/how-to/create-policy/), for example:
5560

61+
- If the job definition uses an image from **Container Registry**, add the `ContainerRegistryReadOnly` permission.
62+
- If the job definition consumes data from **Secret Manager**, add the `SecretManagerSecretAccess` permission.
5663

64+
Refer to the [dedicated documentation](/serverless-jobs/how-to/monitor-job/) for comprehensive information on how to monitor jobs using Scaleway Cockpit.

pages/serverless-jobs/troubleshooting/job-in-error-state.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,6 @@ My job run is in an error state.
1515

1616
- Make sure that you have built your image for an `amd64` architecture, as `arm64` is not supported. See the [Architecture](/serverless-jobs/reference-content/jobs-limitations/#architecture) documentation for more information.
1717

18-
- Make sure that your deployment does not exceed the limitations of [Serverless Jobs](/serverless-jobs/reference-content/jobs-limitations/).
18+
- Make sure that your deployment does not exceed the limitations of [Serverless Jobs](/serverless-jobs/reference-content/jobs-limitations/).
19+
20+
- Make sure to use the correct permissions when other products are involved - see the [permissions and product dependencies documentation](/serverless-jobs/how-to/run-job/#permissions-and-product-dependencies).

0 commit comments

Comments
 (0)