-
Notifications
You must be signed in to change notification settings - Fork 274
feat(data-orchestrator): add how to create workflow MTA-7013 #6438
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 all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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,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. |
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,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. | ||
| 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. | ||
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,4 @@ | ||
| --- | ||
| title: Data Orchestrator - How Tos | ||
| description: Practical guides for using Scaleway Data Orchestrator. | ||
| --- |
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
Oops, something went wrong.
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.