Skip to content

Commit

Permalink
docs(srv): jobs several updates before pb MTA-3999 (#2525)
Browse files Browse the repository at this point in the history
* docs(srv): jobs several updates before pb MTA-3999

* docs(srv): add stop job page

* docs(srv): fix

* docs(srv): fix

* docs(srv): docs review
  • Loading branch information
SamyOubouaziz authored Dec 14, 2023
1 parent cce1505 commit 05a8e27
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 16 deletions.
14 changes: 9 additions & 5 deletions menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -1445,23 +1445,27 @@
{
"items": [
{
"label": "Create a Job from the Scaleway Registry",
"label": "Create a job from the Scaleway Registry",
"slug": "create-job-from-scaleway-registry"
},
{
"label": "Create a Job from an external registry",
"label": "Create a job from an external registry",
"slug": "create-job-from-external-registry"
},
{
"label": "Run a Job",
"label": "Run a job",
"slug": "run-job"
},
{
"label": "Monitor a Job",
"label": "Stop a job",
"slug": "stop-job"
},
{
"label": "Monitor a job",
"slug": "monitor-job"
},
{
"label": "Delete a Job",
"label": "Delete a job",
"slug": "delete-job"
}
],
Expand Down
8 changes: 5 additions & 3 deletions serverless/jobs/how-to/create-job-from-external-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ categories:
- jobs
---

Scaleway allows you to create jobs from several container [registries](/containers/container-registry/concepts/#registry), including external public registries, such as Docker Hub, AWS Container registries, GitLab container registry, etc.
Scaleway allows you to create jobs from external public [container registries](/containers/container-registry/concepts/#registry), such as Docker Hub, AWS container registries, GitLab container registry, etc.

<Message type="note">
Private container registries are currently not supported.
</Message>

<Macro id="iam-requirements" />

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
- Your container image is available without authentication
</Message>

1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Scaleway's Serverless Jobs allows you to create jobs from several container [reg

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
- You have [created a Container Registry namespace](/containers/container-registry/how-to/create-namespace/) and [pushed a container image](/containers/container-registry/how-to/push-images/) to it
</Message>

Expand Down
3 changes: 1 addition & 2 deletions serverless/jobs/how-to/delete-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ This page shows you how to delete a Serverless Job.

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
- You have [created a job](/serverless/jobs/how-to/create-job-from-scaleway-registry/)
</Message>

Expand All @@ -37,5 +36,5 @@ This page shows you how to delete a Serverless Job.
</Message>

<Navigation>
<PreviousButton to="/serverless/jobs/how-to/monitor-job/">How to monitor a Serverless Job</PreviousButton>
<PreviousButton to="/serverless/jobs/how-to/stop-job/">How to stop a Serverless Job</PreviousButton>
</Navigation>
3 changes: 1 addition & 2 deletions serverless/jobs/how-to/monitor-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ You can monitor the activity of your Serverless Jobs using the [Scaleway console

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
- You have [created a Serverless Job](/serverless/jobs/how-to/create-job-from-scaleway-registry/)
</Message>

Expand Down Expand Up @@ -76,5 +75,5 @@ To view your Serverless Jobs logs, use the Grafana dashboard which is accessible

<Navigation>
<PreviousButton to="/serverless/jobs/how-to/run-job/">How to run a Serverless Job</PreviousButton>
<NextButton to="/serverless/jobs/how-to/delete-job/">How to delete a Serverless Job</NextButton>
<NextButton to="/serverless/jobs/how-to/stop-job/">How to stop a Serverless Job</NextButton>
</Navigation>
1 change: 0 additions & 1 deletion serverless/jobs/how-to/run-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ This page shows you how to manually run a Serverless Job from the Scaleway conso

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
- You have [created a job](/serverless/jobs/how-to/create-job-from-scaleway-registry/)
</Message>

Expand Down
41 changes: 41 additions & 0 deletions serverless/jobs/how-to/stop-job.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
meta:
title: How to stop a Serverless Job
description: This page explains how to stop a Serverless Job
content:
h1: How to stop a Serverless Job
paragraph: This page explains how to stop a Serverless Job
tags: stop execute abort start serverless job scaleway
dates:
validation: 2023-12-12
posted: 2021-12-12
categories:
- serverless
- jobs
---

This page shows you how to manually stop a Serverless Job from the Scaleway console.

<Macro id="iam-requirements" />

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com)
- You have [a job currently running](/serverless/jobs/how-to/run-job/)
</Message>

1. Click **Jobs** in the **Serverless** section of the side menu. The Serverless Jobs page displays.

2. Click the name of the job you want to stop. The job **Overview** tab displays.

3. From the **Job runs** section, click the <Icon name="more" /> icon next to the job you want to stop, and select **Stop job** from the drop-down menu.

The status of you job changes to `canceled`.

<Message type="note">
A stopped job cannot be resumed.
</Message>

<Navigation>
<PreviousButton to="/serverless/jobs/how-to/monitor-job/">How to monitor a Serverless Job</PreviousButton>
<NextButton to="/serverless/jobs/how-to/delete-job/">How to delete a Serverless Job</NextButton>
</Navigation>
3 changes: 1 addition & 2 deletions serverless/jobs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@ This page explains how to create a job definition with the latest Alpine Linux i

<Message type="requirement">
- You have an account and are logged into the [Scaleway console](https://console.scaleway.com/)
- You have [signed up to the private beta](https://www.scaleway.com/en/betas/#serverless-jobs) and received a confirmation email.
</Message>

## How to create a job definition

To keep this quickstart simple, we will create a job from an external registry. To create a job from the Scaleway Container Registry, refer to [this documentation](/serverless/jobs/how-to/create-job-from-scaleway-registry).
To keep this quickstart simple, we will create a job from a public external registry. To create a job from the Scaleway Container Registry, refer to [this documentation](/serverless/jobs/how-to/create-job-from-scaleway-registry).

1. Click **Jobs** in the **Serverless** section of the side menu. The Jobs page displays.

Expand Down

0 comments on commit 05a8e27

Please sign in to comment.