tw
é a plataforma Seqera na linha de comando. Ele traz conceitos do Seqera como pipelines, ações e ambientes de computação para o terminal.
A plataforma Seqera é um aplicativo full-stack para gerenciamento de pipelines de dados e recursos de computação. Ele permite a análise colaborativa de dados em escala, no local ou em qualquer nuvem.
A CLI interage com o Seqera para fornecer uma interface para lançar pipelines, gerenciar recursos de nuvem e administrar sua análise.
Os principais recursos são:
Uma experiência semelhante ao Nextflow : tw CLI fornece um ambiente amigável ao desenvolvedor. Pipelines podem ser lançados com a CLI de forma semelhante ao Nextflow, mas com os benefícios do Seqera de monitoramento, registro, provisionamento de recursos, gerenciamento de conjunto de dados e compartilhamento colaborativo.
Infraestrutura como código : todos os recursos do Seqera, incluindo pipelines e ambientes de computação, podem ser descritos de forma declarativa. Isso permite uma definição completa de um ambiente de análise que pode ser versionado e tratado como código. Simplifica muito o compartilhamento de configuração e a administração de rotina.
Construído em OpenAPI : tw CLI interage com Seqera por meio da API da plataforma Seqera que usa a especificação OpenAPI 3.0. A CLI fornece controle total do aplicativo Seqera, permitindo que os usuários obtenham o máximo de insights sobre envios de pipeline e ambientes de execução.
Consulte a documentação da Plataforma Seqera para saber mais sobre o aplicativo.
tw CLI pode ser instalado em macOS, Windows e Linux.
É compatível com Seqera Cloud e Enterprise versões 21.08 e posteriores.
Este guia aborda a instalação e configuração da CLI, o provisionamento de infraestrutura em nuvem e o lançamento de pipelines em um ambiente de computação do AWS Batch.
Baixe a versão mais recente para o seu sistema operacional nos ativos da página de lançamentos.
Renomeie e torne o arquivo executável:
mv tw- * tw
chmod +x ./tw
Mova o arquivo para um diretório acessível à sua variável $PATH
:
sudo mv tw /usr/local/bin/
Você precisa de um token de acesso para que a CLI interaja com sua instância do Seqera. Selecione Tokens de usuário no menu do usuário na IU do Seqera e selecione Adicionar token para criar um novo token.
Copie o valor do token de acesso e use-o com a CLI de uma destas duas maneiras:
Variável de ambiente :
Exporte o token como uma variável shell diretamente para o seu terminal:
export TOWER_ACCESS_TOKEN= < your access token >
Adicione o comando export
ao seu arquivo .bashrc
, .zshrc
ou .bash_profile
para que ele seja adicionado permanentemente ao seu ambiente.
sinalizador de comando tw :
Forneça o token de acesso diretamente em seu comando tw
com --access-token
:
tw --access-token= < your access token > < other options >
Se necessário, configure as seguintes variáveis de ambiente não obrigatórias usando os mesmos métodos acima:
TOWER_WORKSPACE_ID
: ID do espaço de trabalho. Padrão: o espaço de trabalho do usuário.TOWER_API_ENDPOINT
: URL da API Seqera. Padrão: api.cloud.seqera.io
.Você pode encontrar seu
TOWER_WORKSPACE_ID
na guia Espaços de trabalho na página da sua organização. Alternativamente, você pode listar todos os espaços de trabalho que seu token pode acessar comtw workspaces list
e copiar o ID do espaço de trabalho da saída do comando.
Confirme a instalação, configuração e conexão:
$ tw info
System health status
---------------------------------------+------------------
Remote API server connection check | OK
Tower API version check | OK
Authentication API credential's token | OK
tw
comandos CLIConsulte Uso para obter instruções detalhadas sobre como usar a CLI.
Ative o preenchimento automático na sua sessão atual com este comando:
source <( tw generate-completion )
Se você estiver usando um certificado SSL de CA privada não reconhecido pelas autoridades de certificação Java padrão, use um armazenamento cacerts
customizado:
tw -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts info
Você pode renomear o binário para tw-binary
e criar um script tw
para incluir automaticamente o armazenamento cacerts
personalizado em cada sessão:
#! /usr/bin/env bash
tw-binary -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts $@
tw CLI é um executável binário de plataforma criado por uma compilação nativa do Java GraalVM. Para compilar e construir uma versão de desenvolvimento do binário:
Se necessário, instale o SDKMan!
Na raiz do projeto tower-cli, instale o GraalVM:
sdk env install
Isso garante que o SDKMan use a configuração .sdkmanrc
específica do projeto tower-cli.
Instale native-image
:
gu install native-image
Exporte suas credenciais do Github. O Github requer autenticação para pacotes públicos (o token requer apenas o escopo read:packages
):
export GITHUB_USERNAME=...
export GITHUB_TOKEN=...
Crie o cliente nativo:
./gradlew nativeCompile
Isso instalará uma versão compilada localmente do tw
no diretório nativeCompile:
Produced artifacts:
<tower-cli-repository-root>/build/native/nativeCompile/tw (executable)
========================================================================================================================
Finished generating 'tw' in 1m 6s.
[native-image-plugin] Native Image written to: <tower-cli-repository-root>/build/native/nativeCompile
BUILD SUCCESSFUL in 1m 8s
6 actionable tasks: 2 executed, 4 up-to-date
Execute tw
:
./build/native/nativeCompile/tw
Execute uma versão de desenvolvimento não binária executando o script ./tw
na raiz deste repositório.
Apache 2.0