abctl
v0.22.0
Herramienta de línea de comandos de Airbyte para implementaciones locales de Airbyte.
Nota
Este README se centra principalmente en la herramienta abctl en sí, no en la plataforma Airbyte.
Si está buscando la documentación oficial de inicio rápido de Airbyte, puede encontrarla aquí.
Inicio rápido
Descripción general
Comandos
Contribuyendo
Importante
Las credenciales de autenticación se generan aleatoriamente como parte del proceso de instalación.
Una vez completada la instalación, para encontrar sus credenciales de autenticación, ejecute abctl local credentials .
Instalar Docker
linux
Impermeable
ventanas
Instalar abctl
A través de cerveza
brew tap airbytehq/tap brew install abctl
A través de ir a instalar
go install github.com/airbytehq/abctl@latest
A través de Github
Instalar Airbyte
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
Nota
Dependiendo de la velocidad de Internet, abctl local install podría tardar más de 15 minutos.
De forma predeterminada, abctl local install configura Airbyte para que sea accesible para todas las solicitudes entrantes en el puerto 8000 . Por lo general, esto incluye el acceso a través de la dirección IP del host y localhost .
Si el puerto 8000 no está disponible. o se prefiere otro puerto, se puede especificar --port [PORT] .
Iniciar sesión en Airbyte
Si abctl local install se completó exitosamente, debería abrir un navegador en http://localhost:8000 (o en las anulaciones --host y --port si se especifica). Si es la primera vez que instala Airbyte, se le pedirá que proporcione un correo electrónico y el nombre de la organización. Para recuperar su contraseña para iniciar sesión, ejecute abctl local credentials .
Como se mencionó en el inicio rápido, el único requisito previo que tiene abctl es que Docker debe estar instalado, en ejecución y accesible. Sin embargo, la plataforma Airbyte requiere un clúster de Kubernetes, que abctl crea utilizando type (kind ejecuta un clúster de Kubernetes dentro de un contenedor Docker). Con el clúster Kubernetes de kind, abctl usa helm para instalar (o actualizar) el gráfico de timón de Airbyte más reciente (de forma predeterminada) y el gráfico de timón de NGINX Ingress Controller más reciente.
Todos los comandos y subcomandos admiten los siguientes indicadores globales opcionales:
| Corto | Largo | Descripción |
|---|---|---|
| -h | --ayuda | Muestra la información de ayuda, descripción de las opciones disponibles. |
| -v | --verboso | Habilita la salida detallada (depuración). Útil para depurar comportamientos inesperados. |
Todos los comandos admiten las siguientes variables de entorno:
| Nombre | Descripción |
|---|---|
| DO_NO_TRACK | Establezca cualquier valor para deshabilitar el seguimiento de telemetría. |
Se admiten los siguientes comandos:
local
versión
abctl local --help
Los subcomandos locales se centran en gestionar la instalación local de Airbyte. Están disponibles los siguientes subcomandos:
cartas credenciales
implementaciones
instalar
estado
desinstalar
abctl local credentials
Muestra las credenciales necesarias para iniciar sesión en la instalación local de Airbyte.
Nota
Cuando se ejecuta por primera vez abctl local install , se generan password aleatoria, client-id y client-secret .
Devuelve este email , password , client-id y credenciales client-secret . Se requieren el email y password para iniciar sesión en Airbyte. El client-id y client-secret son necesarios para crear un Access Token para interactuar con la API de Airbyte.
Por ejemplo:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials admite los siguientes indicadores opcionales
| Nombre | Por defecto | Descripción |
|---|---|---|
| --correo electrónico | "" | Cambia la dirección de correo electrónico de autenticación. |
| --contraseña | "" | Cambia la contraseña de autenticación. |
abctl local deployments
Muestra información de implementación de Kubernetes y permite reiniciar una implementación de Kubernetes.
deployments admiten las siguientes banderas opcionales.
| Nombre | Por defecto | Descripción |
|---|---|---|
| --Reanudar | "" | Reinicia la implementación proporcionada. |
abctl local install
Instala una instancia local de Airbyte o actualiza una instalación existente que fue instalada inicialmente por abctl .
Nota
Dependiendo de su velocidad de Internet, abctl local install puede tardar más de 20 minutos.
install admite los siguientes indicadores opcionales:
Nota
Un - en la columna predeterminada indica que no se puede proporcionar ningún valor.
Estas banderas se comportan como un interruptor, habilitadas si se proporcionan, deshabilitadas si no.
| Nombre | Por defecto | Descripción |
|---|---|---|
| --cuadro | "" | Ruta al gráfico. |
| --versión-gráfico | el último | Qué versión de Airbyte helm-chart instalar. |
| --docker-correo electrónico | "" | Dirección de correo electrónico de Docker para autenticarse en --docker-server .También se puede especificar mediante la variable de entorno ABCTL_LOCAL_INSTALL_DOCKER_EMAIL . |
| --contraseña-docker | "" | Contraseña de Docker para autenticarse en --docker-server .También se puede especificar mediante la variable de entorno ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD . |
| --servidor-docker | "" | Servidor Docker para autenticarse. También se puede especificar mediante la variable de entorno ABCTL_LOCAL_INSTALL_DOCKER_SERVER . |
| --docker-nombre de usuario | "" | Nombre de usuario de Docker para autenticarse en --docker-server .También se puede especificar mediante la variable de entorno ABCTL_LOCAL_INSTALL_DOCKER_USERNAME . |
| --cookies-inseguras | - | Desactiva los requisitos de cookies seguras. Establezca solo si usa --host con una conexión insegura (no https ). |
| --modo-de-bajos-recursos | FALSO | Ejecute Airbyte en modo de bajos recursos. |
| --anfitrión | "" | FQDN donde se accederá a la instalación de Airbyte. El valor predeterminado es permitir todo el tráfico entrante en port --port .Configure esto si la instalación de Airbyte necesita una configuración de host más restringida. |
| --emigrar | - | Permite la migración de datos desde una instalación de Airbyte existente respaldada por Docker Compose. Copia, dejando los datos originales sin modificar, los datos de un docker-compose instalación de Airbyte respaldada en esta instalación de Airbyte administrada abctl . |
| --sin navegador | - | Desactiva el inicio del navegador cuando se completa la instalación. Útil para configurar en situaciones donde no hay ningún navegador disponible. |
| --puerto | 8000 | Puerto donde se accederá a la instalación de Airbyte. Configúrelo si el puerto 8000 ya está en uso o si se prefiere un puerto diferente. |
| --secreto | "" | Se puede configurar varias veces . Crea un secreto de Kubernetes basado en el contenido del archivo proporcionado. Útil cuando se usa junto con --values para personalizar la instalación. |
| --valores | "" | Archivo de valores de Helm para personalizar aún más la instalación de Airbyte. |
| --volumen | "" | Se puede configurar varias veces . Monta volúmenes adicionales en el clúster de Kubernetes. Debe tener el formato <HOST_PATH>:<GUEST_PATH> . |
abctl local status
Si existe una instalación de Airbyte, devuelve información sobre esa instalación.
Por ejemplo:
$ 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
Desinstala una instancia local de Airbyte.
Nota
Los datos asociados con la instancia de Airbyte instalada no se eliminarán.
Esto se hace para permitir que Airbyte se reinstale en una fecha posterior conservando todos los datos.
uninstall admite los siguientes indicadores opcionales:
Nota
Un - en la columna predeterminada indica que no se puede proporcionar ningún valor.
Estas banderas se comportan como un interruptor, habilitadas si se proporcionan, deshabilitadas si no.
| Nombre | Por defecto | Descripción |
|---|---|---|
| --persistió | - | Eliminará todos los datos para la instalación de Airbyte. Esto no se puede deshacer. |
abctl images
Administrar imágenes utilizadas por Airbyte y abctl.
Están disponibles los siguientes subcomandos:
manifiesto
abctl images manifest
Muestra un manifiesto de imágenes utilizadas por Airbyte y abctl.
| Nombre | Por defecto | Descripción |
|---|---|---|
| --cuadro | "" | Ruta al gráfico. |
| --versión-gráfico | el último | Qué versión de Airbyte helm-chart instalar. |
| --valores | "" | Archivo de valores de Helm para personalizar aún más la instalación de Airbyte. |
abctl version
Muestra información de la versión de la herramienta abctl .
Por ejemplo:
$ abctl version version: v0.19.0
Si ha encontrado un problema con abctl , abra un problema de Github y utilice el comando ? [abctl] Report an issue with the abctl tool .
instalar go
A través de cerveza
brew install go
Vía go.dev
Este repositorio utiliza un Makefile, que envuelve los comandos go tradicionales utilizados para formatear, examinar, crear y probar el código go .
Se admiten los siguientes comandos make :
| nombre | descripción |
|---|---|
make build | Construye el binario abctl y lo coloca en el directorio build . |
make clean | Elimina el directorio build . |
make fmt | Formatea el código. |
make test | Ejecuta todas las pruebas. |
make vet | Ejecuta el comando veterinario. |
