tower cli

два интерфейса командной строки

tw — это платформа Seqera в командной строке. Он переносит на терминал такие концепции Seqera, как конвейеры, действия и вычислительные среды.

Seqera Platform — это полнофункциональное приложение для управления конвейерами данных и вычислительными ресурсами. Оно обеспечивает совместный анализ данных в любом масштабе, локально или в любом облаке.

Интерфейс командной строки взаимодействует с Seqera, предоставляя интерфейс для запуска конвейеров, управления облачными ресурсами и администрирования анализа.

Ключевые особенности:

• Опыт, подобный Nextflow : tw CLI обеспечивает удобную для разработчиков среду. Конвейеры можно запускать с помощью CLI аналогично Nextflow, но с преимуществами Seqera по мониторингу, ведению журналов, предоставлению ресурсов, управлению наборами данных и совместному использованию.

• Инфраструктура как код : все ресурсы Seqera, включая конвейеры и вычислительные среды, можно описать декларативно. Это позволяет полностью определить среду анализа, которая может управляться версиями и рассматриваться как код. Это значительно упрощает обмен конфигурациями и рутинное администрирование.

• Построен на основе OpenAPI : tw CLI взаимодействует с Seqera через API платформы Seqera, который использует спецификацию OpenAPI 3.0. Интерфейс командной строки обеспечивает полный контроль над приложением Seqera, позволяя пользователям получить максимальную информацию о конвейерных отправках и средах выполнения.

Дополнительную информацию о приложении см. в документации платформы Seqera.

Доступность

tw CLI можно установить на macOS, Windows и Linux.

Он совместим с Seqera Cloud и Enterprise версий 21.08 и новее.

Начиная

В этом руководстве описывается установка и настройка интерфейса командной строки, предоставление облачной инфраструктуры и запуск конвейеров в среде пакетных вычислений AWS.

1. Установка

1. Загрузите последнюю версию для вашей ОС из ресурсов на странице выпусков.

2. Переименуйте и сделайте файл исполняемым:

   mv tw- * tw
   chmod +x ./tw

3. Переместите файл в каталог, доступный для вашей переменной $PATH :

   sudo mv tw /usr/local/bin/

2. Конфигурация

Вам понадобится токен доступа, чтобы CLI мог взаимодействовать с вашим экземпляром Seqera. Выберите «Токены пользователя» в меню пользователя пользовательского интерфейса Seqera, затем выберите «Добавить токен», чтобы создать новый токен.

Скопируйте значение токена доступа и используйте его в CLI одним из двух способов:

• Переменная среды :

  1. Экспортируйте токен как переменную оболочки прямо в свой терминал:

      export TOWER_ACCESS_TOKEN= < your access token >

  2. Добавьте команду export в файл .bashrc , .zshrc или .bash_profile , чтобы она была навсегда добавлена ​​в вашу среду.

• флаг команды tw :

  Укажите токен доступа непосредственно в команде tw с помощью --access-token :

  tw --access-token= < your access token > < other options >

При необходимости настройте следующие необязательные переменные среды, используя те же методы, что и выше:

• TOWER_WORKSPACE_ID : идентификатор рабочей области. По умолчанию: рабочая область пользователя.
• TOWER_API_ENDPOINT : URL-адрес API Seqera. По умолчанию: api.cloud.seqera.io .

Вы можете найти свой TOWER_WORKSPACE_ID на вкладке «Рабочие пространства» на странице вашей организации. Альтернативно вы можете перечислить все рабочие области, к которым может получить доступ ваш токен, с помощью tw workspaces list и скопировать идентификатор рабочей области из выходных данных команды.

3. Проверка здоровья

Подтвердите установку, настройку и подключение:

$ tw info

    System health status
    ---------------------------------------+------------------
     Remote API server connection check    | OK
     Tower API version check               | OK
     Authentication API credential's token | OK 

tw команды CLI

Подробные инструкции по использованию CLI см. в разделе «Использование».

Автодополнение

Активируйте автозаполнение в текущем сеансе с помощью этой команды:

 source <( tw generate-completion ) 

Пользовательское хранилище центров сертификации SSL

Если вы используете SSL-сертификат частного CA, не распознаваемый центрами сертификации Java по умолчанию, используйте собственное хранилище cacerts :

tw -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts info

Вы можете переименовать двоичный файл в tw-binary и создать сценарий tw для автоматического включения пользовательского хранилища cacerts в каждый сеанс:

 #! /usr/bin/env bash
tw-binary -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts $@ 

Создание двоичных версий для разработки

tw CLI — это двоичный исполняемый файл платформы, созданный путем компиляции Java GraalVM. Чтобы скомпилировать и построить версию двоичного файла для разработки:

1. При необходимости установите SDKMan!

2. Из корня проекта Tower-cli установите GraalVM:

   sdk env install

   Это гарантирует, что SDKMan использует конфигурацию .sdkmanrc , специфичную для проекта Tower-cli.

3. Установите native-image :

   gu install native-image

4. Экспортируйте свои учетные данные Github. Github требует аутентификации для общедоступных пакетов (токену требуется только область действия read:packages ):

    export GITHUB_USERNAME=...
   export GITHUB_TOKEN=...

5. Создайте собственный клиент:

   ./gradlew nativeCompile

   Это установит локально скомпилированную версию tw в каталог ownCompile:

    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

6. Запустите tw :

   ./build/native/nativeCompile/tw

Небинарные версии разработки

Запустите недвоичную версию разработки, выполнив сценарий ./tw в корне этого репозитория.

Лицензия

Апач 2.0