Skip to content
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
9 changes: 9 additions & 0 deletions macros/data-orchestrator/upload-workflow.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
macro: upload-workflow
---

The workflow upload window is displayed during the creation of a workflow or when clicking **Edit** from a workflow in Code view.

1. Click **Upload**.
2. Select the YAML file to use as the workflow definition.
3. Click **Save changes** to finish, or click **Save and run** if you want to save and run the workflow.
87 changes: 87 additions & 0 deletions pages/data-orchestrator/how-to/create-workflow.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: How to create a workflow using Data Orchestrator
description: This page explains how to create a Data Orchestrator workflow on the Scaleway console.
tags: data-orchestrator workflow
dates:
posted: 2026-04-01
---
import Requirements from '@macros/iam/requirements.mdx'
import UploadWorkflow from '@macros/data-orchestrator/upload-workflow.mdx'

<Message type="note">
Data Orchestrator is currently in Private Beta. During this Beta period, the workflows only run Scaleway Serverless Jobs.
</Message>

<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
- A [Container Registry namespace](/container-registry/how-to/create-namespace/)
- An image [pushed](/container-registry/how-to/push-images/) to your namespace (for task execution)
- Created at least three [Serverless Jobs](/serverless-jobs/how-to/create-job/)
- Basic familiarity with YAML syntax
- Basic familiarity with [Serverless workflow.io](https://serverlessworkflow.io/) language

## Create a workflow definition YAML file

Data Orchestrator requires the user to upload a YAML file to use as a workflow definition.

<Message type="tip">
This is a basic example of a sequential workflow, more examples will be available soon.
</Message>

1. Create a YAML file, copy/paste the following content into the file.
```yaml
document:
dsl: 1.0.0
namespace: <namespace_name>
name: <workflow_name>
version: 1.0.0
do:
- task1:
call: "serverless_job"
metadata:
description: "The first job"
with:
id: "<Serverless_job1_ID>"
region: "fr-par"
- task2:
call: "serverless_job"
metadata:
description: "The second job"
with:
id: "<Serverless_job2_ID>"
region: "fr-par"
- task3:
call: "serverless_job"
metadata:
description: "The third job"
with:
id: "<Serverless_job3_ID>"
region: "fr-par"
```
2. Replace the ID placeholders with the IDs of your Serverless Jobs. You can copy them from the [Serverless Jobs page](https://console.scaleway.com/serverless-jobs/).
<Message type="note">
The fields `namespace` and `name` are required. They can be used as metadata to help organize your YAML files.
</Message>
3. Save the YAML file.

## Create a Data Orchestrator workflow

1. Click **Data Orchestrator** in the **Data & Analytics** section of the [console](https://console.scaleway.com/) side menu. The list of your workflows displays.
2. Click **+ Create workflow**. The Data Orchestrator workflow creation wizard displays.
3. Select the region in which your workflow will be created.
Comment thread
Loic-kd marked this conversation as resolved.
4. Enter a name or use the automatically generated one.
5. Enter a description (optional)
6. Click **Create workflow only** to finish, or click **Create workflow and add tasks** if you want to upload a workflow next.

## Upload the workflow definition

<UploadWorkflow />

## Run a workflow

1. Click **Data Orchestrator** in the **Data & Analytics** section of the [console](https://console.scaleway.com/) side menu. The list of your workflows displays.
2. Click **+ Create workflow**. The Data Orchestrator workflow creation wizard displays.
3. Click the name of the workflow you want to run. The workflow **Overview** tab displays.
4. Click the **Actions** button, then click **Run** in the drop-down menu. Your workflow starts, and a new entry appears in the **Runs** tab.
4 changes: 4 additions & 0 deletions pages/data-orchestrator/how-to/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Data Orchestrator - How Tos
description: Practical guides for using Scaleway Data Orchestrator.
---
7 changes: 7 additions & 0 deletions pages/data-orchestrator/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ description: Comprehensive documentation on Scaleway Data Orchestrator.
label="View Concepts"
url="/data-orchestrator/concepts/"
/>
<SummaryCard
title="How-Tos"
icon="help-circle-outline"
description="Learn how to use Data Orchestrator and create your first workflow."
label="View How-Tos"
url="/data-orchestrator/how-to/"
/>
</Grid>

## Changelog
Expand Down
10 changes: 10 additions & 0 deletions pages/data-orchestrator/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ export const dataOrchestratorMenu = {
label: 'Concepts',
slug: 'concepts',
},
{
items: [
{
label: 'Create a workflow',
slug: 'create-workflow',
},
],
label: 'How to',
slug: 'how-to',
},
],
label: 'Data Orchestrator',
slug: 'data-orchestrator',
Expand Down
Loading