Skip to content

Commit 540bf00

Browse files
committed
🚧 wip(hello_seqera): first part of run_with_cli.md
1 parent d22dca6 commit 540bf00

File tree

6 files changed

+79
-83
lines changed

6 files changed

+79
-83
lines changed

β€Ždocs/hello_nextflow/10_hello_seqera.mdβ€Ž

Lines changed: 8 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,24 @@
1-
# Part 9: Hello Seqera
2-
31
---
4-
5-
title: Seqera Platform
2+
title: Hello Seqera
63
description: Get started with Seqera Platform
7-
84
---
95

10-
# Get started with Seqera Platform
11-
12-
Seqera Platform, previously known as Nextflow Tower, is the centralized command post for data management and workflows. It brings monitoring, logging and observability to distributed workflows and simplifies the deployment of workflows on any cloud, cluster or laptop. In Seqera Platform terminology, a workflow is what we've been working on so far, and pipelines are pre-configured workflows that can be used by all users in a workspace. It is composed of a workflow repository, launch parameters, and a compute environment. We'll stick to these definitions in this section.
13-
14-
Seqera core features include:
6+
# Part 9: Hello Seqera
157

16-
- The launching of pre-configured pipelines with ease.
17-
- Programmatic integration to meet the needs of an organization.
18-
- Publishing pipelines to shared workspaces.
19-
- Management of the infrastructure required to run data analysis at scale.
8+
So far we've been running Nextflow workflows on our local machine using the command line interface.
9+
In this section, we'll introduce you to Seqera Platform, a powerful cloud-based platform for running, monitoring, and sharing Nextflow workflows.
2010

2111
!!! tip
2212

2313
[Sign up](https://cloud.seqera.io/) to try Seqera for free or request a [demo](https://seqera.io/demo/) for deployments in your own on-premise or cloud environment.
2414

25-
You can use Seqera Platform via either the **CLI**, through the **online GUI** or through the **API**.
26-
27-
## CLI
28-
29-
You will need to set up your environment to use Seqera Platform. This is a one-time setup.
30-
31-
Create an account and login into Seqera Platform.
32-
33-
**1. Create a new token**
34-
35-
You can access your tokens from the **Settings** drop-down menu:
36-
37-
![Create a token](img/usage_create_token.png)
38-
39-
**2. Name your token**
40-
41-
![Name your token](img/usage_name_token.png)
42-
43-
**3. Save your token safely**
44-
45-
Copy and keep your new token in a safe place.
46-
47-
![Save token](img/usage_token.png)
48-
49-
**4. Export your token**
50-
51-
Once your token has been created, open a terminal and type:
15+
You'll learn how to use Seqera Platform within Nextflow CLI, the Seqera Platform GUI, and the API.
5216

53-
```bash
54-
export TOWER_ACCESS_TOKEN=eyxxxxxxxxxxxxxxxQ1ZTE=
55-
```
56-
57-
Where `eyxxxxxxxxxxxxxxxQ1ZTE=` is the token you have just created.
58-
59-
!!! note
60-
61-
Check your `nextflow -version`. Bearer tokens require Nextflow version 20.10.0 or later and can be set with the second command shown above. You can change the version if necessary.
62-
63-
To submit a pipeline to a [Workspace](https://docs.seqera.io/platform/24.1/getting-started/workspace-setup) using the Nextflow command-line tool, add the workspace ID to your environment. For example:
64-
65-
```bash
66-
export TOWER_WORKSPACE_ID=000000000000000
67-
```
68-
69-
The workspace ID can be found on the organization’s Workspaces overview page.
70-
71-
**5. Run Nextflow with Seqera Platform**
72-
73-
Run your Nextflow workflows as usual with the addition of the `-with-tower` command:
74-
75-
```bash
76-
nextflow run hello.nf -with-tower
77-
```
78-
79-
You will see and be able to monitor your **Nextflow jobs** in Seqera Platform.
80-
81-
To configure and execute Nextflow jobs in **Cloud environments**, visit the [Compute environments section](https://docs.seqera.io/platform/24.1/compute-envs/overview).
82-
83-
!!! exercise
84-
85-
Run the RNA-Seq `script7.nf` using the `-with-tower` flag, after correctly completing the token settings outlined above.
86-
87-
??? tip
88-
89-
Go to <https://cloud.seqera.io/>, login, then click the run tab, and select the run that you just submitted. If you can’t find it, double check your token was entered correctly.
90-
91-
!!! cboard-list-2 "Summary"
17+
You can use Seqera Platform via either the **CLI**, through the **online GUI** or through the **API**.
9218

93-
In this step you have learned:
19+
## 1. Use Seqera Platform to capture and monitor Nextflow jobs launched from the CLI
9420

95-
1. How to create and add your token and workspace.
96-
2. How to launch a pipeline with Seqera Platform.
21+
--8<-- "./seqera/01_run_with_cli.md"
9722

9823
## Online GUI
9924

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
We'll start by using the Nextflow CLI to launch a pipeline and monitor it in Seqera Platform.
2+
Start by logging into the [Seqera Platform](https://cloud.seqera.io/).
3+
4+
!!! info "Nextflow Tower"
5+
Seqera Platform was previously known as Nextflow Tower.
6+
You'll still see references to the previous name in environment variable and cli option names.
7+
8+
### 1.1. Set up your Seqera Platform token by exporting it to your environment
9+
10+
Follow these steps to set up your token:
11+
12+
1. Create a new token by clicking on the **Settings** drop-down menu:
13+
14+
![Create a token](img/usage_create_token.png)
15+
16+
2. Name your token:
17+
18+
![Name your token](img/usage_name_token.png)
19+
20+
3. Save your token safely:
21+
22+
![Save token](img/usage_token.png)
23+
24+
!!! note
25+
26+
Leave this browser tab open as we will need the token once more to store it as a Nextflow secret.
27+
28+
4. Export your token:
29+
30+
Open a terminal and type:
31+
32+
```bash
33+
export TOWER_ACCESS_TOKEN=eyxxxxxxxxxxxxxxxQ1ZTE=
34+
```
35+
36+
Where `eyxxxxxxxxxxxxxxxQ1ZTE=` is the token you have just created.
37+
38+
### 1.2. Run Nextflow cli with Seqera Platform visualizing and capturing logs
39+
40+
Run your Nextflow workflows as usual with the addition of the `-with-tower` command:
41+
42+
```bash
43+
nextflow run nextflow-io/hello -with-tower
44+
```
45+
46+
You will see the following output:
47+
48+
```console title="Output"
49+
N E X T F L O W ~ version 24.04.4
50+
51+
Launching `https://github.com/nextflow-io/hello` [evil_engelbart] DSL2 - revision: afff16a9b4 [master]
52+
53+
Downloading plugin [email protected]
54+
Monitor the execution with Seqera Platform using this URL: https://cloud.seqera.io/user/kenbrewer/watch/5Gs0qqV9Y9rguE
55+
executor > local (4)
56+
[80/810411] process > sayHello (1) [100%] 4 of 4 βœ”
57+
Ciao world!
58+
59+
Bonjour world!
60+
61+
Hola world!
62+
63+
Hello world!
64+
```
65+
66+
Use ++ctrl+click++ or ++cmd+click++ on the link to open it in your browser.
67+
You'll see the Seqera Platform interface with the job finished and the logs captured.
68+
69+
![Seqera Platform](img/run_with_tower.png)
70+
71+
You will see and be able to monitor your **Nextflow jobs** in Seqera Platform.
88.9 KB
Loading
211 KB
Loading
193 KB
Loading
259 KB
Loading

0 commit comments

Comments
Β (0)