https://github.com/ewels/node-red-contrib-seqera
Seqera Platform automation on Node-RED
https://github.com/ewels/node-red-contrib-seqera
Last synced: 19 days ago
JSON representation
Seqera Platform automation on Node-RED
- Host: GitHub
- URL: https://github.com/ewels/node-red-contrib-seqera
- Owner: ewels
- License: mit
- Created: 2025-04-28T08:23:10.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-05-07T23:19:44.000Z (22 days ago)
- Last Synced: 2025-05-11T06:38:44.395Z (19 days ago)
- Language: JavaScript
- Size: 251 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Node-RED node for interacting with the Seqera Platform API.
Gives new Node-RED node types for your automation workflows, which are designed to work together:
- [Create Dataset](#create-dataset)
- [Launch and Monitor a Run](#launch-and-monitor-a-run)
Also [Launch](#launch) and [Workflow](#workflow) nodes for more custom workflows where polling workflow status is not required and it's helpful to have full control.
# Installation
Install via the Node-RED palette manager _or_ from the command line inside your Node-RED user directory (`~/.node-red`):
```bash
npm install node-red-contrib-seqera
```
# Use cases
- Integration with events _coming from_ and _going to_ third-party services (AWS, Slack, and [>5000 others](https://flows.nodered.org/search?type=node))
- Stack events and build automation logic using a graphical builder
- Chain workflows, launching downstream automatically
- Use with [Home Assistant](https://community.home-assistant.io/t/home-assistant-community-add-on-node-red/55023) to make your office lights go into disco mode when a pipeline completes 🪩 🕺🏻 🎉
# Usage
## Seqera Config Node
Create a Seqera Config node to store your API credentials and default settings.
- **Base URL**: The base URL for the Seqera API (default: https://api.cloud.seqera.io)
- **Workspace ID**: Your Seqera workspace ID
- **Token**: Your Seqera API token
## Create Dataset
Creates a new dataset and uploads its file contents in one step.
### Inputs
- `datasetName`: Name of the dataset to create
- `fileContents`: CSV/TSV (string or Buffer) to upload. Defaults to `msg.payload`.
- `fileType`: _csv_ or _tsv_ – Select the MIME type for the upload (defaults to **csv**). This is required by Seqera Platform to validate the file contents.
- `description`: Optional description string for the dataset
- `workspaceId`: Override the workspace ID from the \* config node
### Outputs (one output)
Fired once when the upload completes successfully.
- `msg.payload`: Upload response from the API
- `msg.datasetId`: The ID of the created dataset
- `msg._seqera_request`: Details of the dataset creation request (for debugging)
- `msg._seqera_upload_request`: Details of the file-upload request (for debugging)
## Launch and Monitor a Run
Launches a workflow and then periodically checks its status until completion.
### Inputs
- `pollInterval`: How frequently to check workflow status (in seconds)
- `launchpadName`: The Human-readable name of a pipeline in the launchpad to use
- `params`: JSON object containing parameters to merge with the launchpad's default parameters
- `workspaceId`: Override the workspace ID from the \* config node
- `sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
Alternative input:
- `msg.body`: A full launch request body (alternative to using launchpadName)
### Outputs (three outputs)
1. Sent on every status poll (only when workflow is active)
2. Sent once when the workflow completes successfully
3. Sent once when the workflow fails, is cancelled, or any non-success terminal state
Each message contains:
- `msg.payload`: The workflow details from the API
- `msg.workflowId`: The ID of the workflow
- `msg._seqera_request`: The request details sent to the API (when error occurs)
- `msg._seqera_error`: Error details (when error occurs)
## Launch
Launches a workflow using the Seqera API.
### Inputs
- `launchpadName`: The Human-readable name of a pipeline in the launchpad to use
- `params`: JSON object containing parameters to merge with the launchpad's default parameters
- `workspaceId`: Override the workspace ID from the \* config node
- `sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
Alternative input:
- `msg.body`: A full launch request body (alternative to using launchpadName)
### Outputs (one output)
- `msg.payload`: The launch response from the API
- `msg.workflowId`: The ID of the launched workflow
- `msg._seqera_request`: The request details sent to the API (when error occurs)
- `msg._seqera_error`: Any error details if the request fails
## Workflow
Queries the status of a workflow.
### Inputs
- **workflowId**: The ID of the workflow to query
- **workspaceId**: Override the workspace ID from the \* config node
### Outputs (two outputs)
1. Only receives messages when the workflow is active (submitted, running, or pending)
2. Receives messages when the workflow has completed (success or failure) OR when an API error occurs
Each message contains:
- `msg.payload`: The workflow details from the API
- `msg.workflowId`: The ID of the workflow
- `msg._seqera_request`: The request details sent to the API (when error occurs)
- `msg._seqera_error`: Error details (when error occurs)
# License
MIT