Skip to content

Commit

Permalink
docs: remove occurrences of 'Tower'
Browse files Browse the repository at this point in the history
  • Loading branch information
ejseqera committed Nov 24, 2023
1 parent c635681 commit 841ac7e
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
# `seqeralabs/showcase` Workspace on Nextflow Tower
# `seqeralabs/showcase` Workspace on Seqera Platform

## Infrastructure as code

### Using Seqera Platform CLI

Most [Nextflow Tower](https://cloud.tower.nf/) entities such as Pipelines, Compute Environments and Datasets can be exported in JSON format via the [Nextflow Tower CLI](https://github.com/seqeralabs/tower-cli#nextflow-tower-cli). This is very useful for creating infrastructure as code to store the exact configuration options used to create these entities, and to share and track changes over time.
Most [Seqera Platform](https://seqera.io/platform/) entities such as Pipelines, Compute Environments and Datasets can be exported in JSON format via the [Seqera Platform CLI](https://github.com/seqeralabs/tower-cli#nextflow-tower-cli). This is very useful for creating infrastructure as code to store the exact configuration options used to create these entities, and to share and track changes over time.

This repository contains JSON representation of the Nextflow Tower entitites generated by the Tower CLI that were used to create the `seqeralabs/showcase` Workspace:
This repository contains JSON representation of the Seqera Platform entitites generated by the Platform CLI that were used to create the `seqeralabs/showcase` Workspace:

- [Compute Environments](compute-envs)
- [Pipelines](pipelines)
- [Datasets](datasets)

#### Scripts

The bash scripts required to programatically import and export these entities from Tower via the Tower CLI have also been provided in the [`scripts`](scripts) directory.
The bash scripts required to programatically import and export these entities from Seqera Platform via the CLI have also been provided in the [`scripts`](scripts) directory.

See Tower CLI [usage docs](https://github.com/seqeralabs/tower-cli/blob/master/USAGE.md#usage-examples) for more examples.
See Seqera Platform CLI [usage docs](https://github.com/seqeralabs/tower-cli/blob/master/USAGE.md#usage-examples) for more examples.

#### Prerequisites

1. [Nextflow Tower CLI](https://github.com/seqeralabs/tower-cli#1-installation)
1. [Seqera Platform CLI](https://github.com/seqeralabs/tower-cli#1-installation)
2. [`jq`](https://stedolan.github.io/jq/)

#### Assumptions

- Tower CLI has been installed and `tw info` has been configured
- Seqera Platform CLI has been installed and `tw info` has been configured
- `TOWER_API_ENDPOINT` and `TOWER_ACCESS_TOKEN` have been injected into the executing environment
- Credentials have already been set-up in Tower
- Credentials have already been set-up in Seqera Platform

### Using `seqerakit`

The [Nextflow Tower](https://https://seqera.io/platform/) entities represented above in JSON can also be represented as YAML configuration files. These configuration YAMLs can be used by `seqerakit`, a Python package wrapping the Seqera Platform CLI, to define and automate how entities should be created.
The [Seqera Platform](https://https://seqera.io/platform/) entities represented above in JSON can also be represented as YAML configuration files. These configuration YAMLs can be used by `seqerakit`, a Python package wrapping the Seqera Platform CLI, to define and automate how entities should be created.

This repository also contains YAML configuration files defining creation of Seqera Platform entities on the `seqeralabs/showcase` Workspace with `seqerakit`:

Expand All @@ -41,7 +41,13 @@ This repository also contains YAML configuration files defining creation of Seqe

#### Prerequisites

To use `seqerakit`, you will need to have the [Seqera Platform CLI](https://github.com/seqeralabs/tower-cli#1-installation) installed, in addition to the package installed via `pip install seqerakit` or `conda install seqerakit`. Please refer to the package's [installation guide](docs/installation.md) for more details on the required dependencies.
To use `seqerakit`, you will need to have:

- The [Seqera Platform CLI](https://github.com/seqeralabs/tower-cli#1-installation) installed
- `TOWER_API_ENDPOINT` and `TOWER_ACCESS_TOKEN` have been injected into the executing environment
- The package installed via `pip install seqerakit` or `conda install seqerakit`.

Please refer to the package's [installation guide](docs/installation.md) for more details on the required dependencies.

#### Running `seqerakit`

Expand Down

0 comments on commit 841ac7e

Please sign in to comment.