Загрузка abctl - Загрузка исходного кода abctl

abctl

Другой исходный код

v0.22.0

Скачать

логотип abctl

abctl

Инструмент командной строки Airbyte для локального развертывания Airbyte.

Примечание

Этот README в первую очередь посвящен самому инструменту abctl , а не платформе Airbyte.

Если вы ищете официальную краткую документацию Airbyte, ее можно найти здесь.

Быстрый старт
Обзор
Команды
Содействие

Быстрый старт

Важный

Учетные данные аутентификации генерируются случайным образом в процессе установки.

После завершения установки, чтобы найти свои учетные данные для аутентификации, запустите abctl local credentials .

Установить Docker

Линукс
Мак
Окна

Установить abctl

Через пивоварение

brew tap airbytehq/tap
brew install abctl

Через установку

go install github.com/airbytehq/abctl@latest

Через Гитхаб

Установить Airbyte

# install Airbyte 
abctl local install
# fetch the login credentials
abctl local credentials

Примечание

В зависимости от скорости интернета abctl local install может занять более 15 минут.

По умолчанию abctl local install настраивает Airbyte на доступность для всех входящих запросов через порт 8000 . Обычно это включает доступ через IP-адрес хоста и localhost .

Если порт 8000 недоступен. или другой порт является предпочтительным, можно указать --port [PORT] .

Войти в Airbyte
Если abctl local install завершилась успешно, в браузере должен открыться адрес http://localhost:8000 (или переопределения --host и --port , если они указаны). Если Airbyte устанавливается впервые, вам будет предложено указать адрес электронной почты и название организации. Чтобы получить пароль для входа в систему, запустите abctl local credentials .

Обзор

арка.png

Как упоминалось в кратком руководстве, единственное необходимое условие для abctl — это то, что Docker должен быть установлен, запущен и доступен. Однако для платформы Airbyte требуется кластер Kubernetes, который abctl создает с помощью kind (kind запускает кластер Kubernetes внутри контейнера Docker). В кластере kind Kubernetes abctl использует helm для установки (или обновления) последней (по умолчанию) helm-чарта Airbyte и последней helm-чарта контроллера NGINX Ingress.

Команды

Все команды и подкоманды поддерживают следующие дополнительные глобальные флаги:

Короткий	Длинный	Описание
-час	--помощь	Отображает справочную информацию, описание доступных опций.
-v	--многословный	Включает подробный (отладочный) вывод. Полезно при отладке неожиданного поведения.

Все команды поддерживают следующие переменные среды:

Имя	Описание
DO_NOT_TRACK	Установите любое значение, чтобы отключить отслеживание телеметрии.

Поддерживаются следующие команды:

местный
версия

местный

abctl local --help

Локальные подкоманды предназначены для управления локальной установкой Airbyte. Доступны следующие подкоманды:

реквизиты для входа
развертывания
установить
статус
удалить

реквизиты для входа

abctl local credentials

Отображает учетные данные, необходимые для входа в локальную установку Airbyte.

Примечание

При первом запуске abctl local install генерируются случайный password , client-id и client-secret .

Возвращает адрес email , password , client-id и client-secret . email и password необходимы для входа в Airbyte. client-id и client-secret необходимы для создания Access Token для взаимодействия с API Airbyte.

Например:

$ abctl local credentials
{
  "password": "[RANDOM PASSWORD]",
  "client-id": "[RANDOM CLIENT-ID]",
  "client-secret": "[RANDOM CLIENT-SECRET]"
}

credentials поддерживают следующие дополнительные флаги

Имя	По умолчанию	Описание
--электронная почта	""	Изменяет адрес электронной почты для аутентификации.
--пароль	""	Изменяет пароль аутентификации.

развертывания

abctl local deployments

Отображение информации о развертывании Kubernetes и возможность перезапуска развертывания Kubernetes.

deployments поддерживают следующие дополнительные флаги

Имя	По умолчанию	Описание
--перезапуск	""	Перезапускает предоставленное развертывание.

установить

abctl local install

Устанавливает локальный экземпляр Airbyte или обновляет существующую установку, которая изначально была установлена с помощью abctl .

Примечание

В зависимости от скорости вашего интернета abctl local install может занять более 20 минут.

install поддерживает следующие дополнительные флаги:

Примечание

Знак - в столбце по умолчанию означает, что значение указать невозможно.

Эти флаги действуют как переключатель: включены, если они предусмотрены, и отключены, если нет.

Имя	По умолчанию	Описание
--диаграмма	""	Путь к графику.
--chart-версия	последний	Какую версию диаграммы управления Airbyte установить.
--docker-email	""	Адрес электронной почты Docker для аутентификации на `--docker-server` . Также может быть указано переменной среды `ABCTL_LOCAL_INSTALL_DOCKER_EMAIL` .
--docker-пароль	""	Пароль Docker для аутентификации на `--docker-server` . Также может быть указано переменной среды `ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD` .
--docker-сервер	""	Сервер Docker для аутентификации. Также может быть указано переменной среды `ABCTL_LOCAL_INSTALL_DOCKER_SERVER` .
--docker-имя пользователя	""	Имя пользователя Docker для аутентификации на `--docker-server` . Также может быть указано переменной среды `ABCTL_LOCAL_INSTALL_DOCKER_USERNAME` .
--insecure-cookies	-	Отключает требования к безопасным файлам cookie. Устанавливается только при использовании `--host` с небезопасным (не `https` ) соединением.
--режим с низким уровнем ресурсов	ЛОЖЬ	Запустите Airbyte в режиме низкого потребления ресурсов.
--хозяин	""	Полное доменное имя, по которому будет осуществляться доступ к установке Airbyte. По умолчанию разрешен весь входящий трафик через порт `--port` . Установите это значение, если для установки Airbyte требуется более ограниченная конфигурация хоста.
--мигрировать	-	Обеспечивает миграцию данных из существующей установки Airbyte, поддерживаемой Docker Compose. Копирует, оставляя исходные данные неизмененными, данные из файла docker-compose. поддерживаемую установку Airbyte в эту установку Airbyte, управляемую `abctl` .
--без браузера	-	Отключает запуск браузера после завершения установки. Полезно установить в ситуациях, когда браузер недоступен.
--порт	8000	Порт, к которому будет осуществляться доступ к установке Airbyte. Установите этот параметр, если порт 8000 уже используется или если предпочтителен другой порт.
--секрет	""	Можно устанавливать несколько раз . Создает секрет Kubernetes на основе содержимого предоставленного файла. Полезно при использовании вместе с `--values` для настройки установки.
--ценности	""	Файл значений Helm для дальнейшей настройки установки Airbyte.
--объем	""	Можно устанавливать несколько раз . Монтирует дополнительные тома в кластере Kubernetes. Должен быть в формате `<HOST_PATH>:<GUEST_PATH>` .

статус

abctl local status

Если установка Airbyte существует, возвращает информацию об этой установке.

Например:

$ abctl local status
Existing cluster 'airbyte-abctl' found
Found helm chart 'airbyte-abctl'
  Status: deployed
  Chart Version: 0.422.2
  App Version: 0.63.15
Found helm chart 'ingress-nginx'
  Status: deployed
  Chart Version: 4.11.1
  App Version: 1.11.1
Airbyte should be accessible via http://localhost:8000

удалить

abctl local uninstall

Удаляет локальный экземпляр Airbyte.

Примечание

Данные, связанные с установленным экземпляром Airbyte, не будут удалены.

Это сделано для того, чтобы позже можно было переустановить Airbyte с сохранением всех данных.

uninstall поддерживает следующие дополнительные флаги:

Примечание

Знак - в столбце по умолчанию означает, что значение указать невозможно.

Эти флаги действуют как переключатель: включены, если они предусмотрены, и отключены, если нет.

Имя	По умолчанию	Описание
-- упорствовал	-	Будут удалены все данные для установки Airbyte. Это невозможно отменить.

изображения

abctl images

Управляйте изображениями, используемыми Airbyte и abctl.

Доступны следующие подкоманды:

манифестировать

манифестировать

abctl images manifest

Отображение манифеста изображений, используемых Airbyte и abctl.

Имя	По умолчанию	Описание
--диаграмма	""	Путь к графику.
--chart-версия	последний	Какую версию диаграммы управления Airbyte установить.
--ценности	""	Файл значений Helm для дальнейшей настройки установки Airbyte.

версия

abctl version

Отображает информацию о версии инструмента abctl .

Например:

$ abctl version
version: v0.19.0

Содействие

Сообщить о проблеме

Если вы обнаружили проблему с abctl , откройте выпуск Github и используйте команду ? [abctl] Report an issue with the abctl tool .

Строить

Установить go

Через пивоварение
```
brew install go
```
Через go.dev

В этом репозитории используется Makefile, содержащий традиционные команды go используемые для форматирования, проверки, сборки и тестирования кода go .

Поддерживаются следующие команды make :

имя	описание
`make build`	Создает двоичный файл `abctl` , помещая его в каталог `build` .
`make clean`	Удаляет каталог `build` .
`make fmt`	Форматирует код.
`make test`	Проводит все тесты.
`make vet`	Запускает команду ветеринара.