Skip to content

Commit e4b2f43

Browse files
committed
New simple example, better organisation and updates
1 parent ad9792c commit e4b2f43

13 files changed

Lines changed: 167 additions & 9 deletions

docs/README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,35 @@ You can find the Seqera nodes in the sidebar on the left, under the heading "Seq
1010

1111
![Importing examples](img/import_examples.png)
1212

13-
## Launch on file upload
13+
## 01 - Simple launch & monitor
1414

15-
`examples/poll_file_present.json`
15+
`examples/01 - Simple launch + monitor.json`
1616

17-
![poll_file_present.json](img/poll_file_present.png)
17+
![01 - Simple launch + monitor.json](img/example_flow_01.png)
18+
19+
This is the most basic example workflow that demonstrates the core _Launch workflow_ and _Monitor workflow_ nodes.
20+
21+
The flow consists of a simple sequence:
22+
23+
1. **Manual trigger** - Click the inject node to start the process
24+
2. **Launch workflow** - Launches a pipeline using a Seqera Platform Launchpad configuration
25+
3. **Monitor workflow** - Continuously polls the workflow status until completion
26+
4. **Debug outputs** - Shows the running status updates and final completion message
27+
28+
### Setup
29+
30+
To get this example working, you'll need to configure:
31+
32+
- **Seqera configuration** - Add your Platform API token and endpoint to both Seqera nodes
33+
- **Launch workflow node** - Set the correct launchpad name and update any pipeline parameters as needed
34+
35+
Once configured, click "Deploy" in Node-RED, then click the inject node to trigger a workflow launch. You can follow the progress in the Debug panel on the right sidebar.
36+
37+
## 02 - Launch on file upload
38+
39+
`examples/02 - Launch on file upload.json`
40+
41+
![02 - Launch on file upload.json](img/example_flow_02.png)
1842

1943
This flow uses the _Poll files_ node to periodically check for the presence
2044
of a file called `RTAcomplete.txt` within a Seqera Data Link (eg. an s3 bucket).
@@ -39,11 +63,11 @@ Some configuration is needed to make this flow work:
3963
- _Create dataset_ needs a dataset name to be set somehow (dynamically to avoid name clashes)
4064
- _Launch workflow_ needs configuring with the name of a Launchpad pipeline, and parameters.
4165

42-
## Pipeline → Create Studio → Slack webhook
66+
## 03 - Pipeline → Create Studio → Slack webhook
4367

44-
`pipeline_studios_slack.json`
68+
`examples/03 - Studio on run fail + Slack webhook.json`
4569

46-
![Slack webhook](img/pipeline_studios_slack.png)
70+
![03 - Studio on run fail + Slack webhook.json](img/example_flow_03.png)
4771

4872
This workflow has three parts to it:
4973

@@ -57,7 +81,7 @@ This workflow has three parts to it:
5781

5882
If all goes well, you'll get messages in Slack that look like this:
5983

60-
<img alt="Slack webhook" src="img/slack_message.png" width=500>
84+
<img alt="Slack webhook" src="img/example_flow_03_slack_message.png" width=500>
6185

6286
Clicking "Open link" will take you directly to a Studio running VS Code, with your pipeline's work directory mounted and ready to debug.
6387

@@ -72,8 +96,8 @@ This workflow needs some setup:
7296
To make the automated Slack message, first you need to create a Slack Workflow.
7397
Selelct _"From a webhook"_ as the trigger:
7498

75-
![Create Slack workflow](img/slack_workflow_create.png)
99+
![Create Slack workflow](img/example_flow_03_slack_workflow_create.png)
76100

77101
Then configure with some input variables and a button, and copy the webhook URL. You'll need this later!
78102

79-
![Slack workflow](img/slack_workflow.png)
103+
![Slack workflow](img/example_flow_03_slack_workflow.png)

docs/img/example_flow_01.png

58.6 KB
Loading

docs/img/example_flow_02.png

54.4 KB
Loading

docs/img/example_flow_03.png

105 KB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/img/import_examples.png

-1.15 KB
Loading
-88.2 KB
Binary file not shown.

docs/img/poll_file_present.png

-30.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)