abctl
v0.22.0
Ferramenta de linha de comando do Airbyte para implantações locais do Airbyte.
Observação
Este README concentra-se principalmente na própria ferramenta abctl , não na plataforma Airbyte.
Se você está procurando a documentação oficial de início rápido da Airbyte, ela pode ser encontrada aqui.
Início rápido
Visão geral
Comandos
Contribuindo
Importante
As credenciais de autenticação são geradas aleatoriamente como parte do processo de instalação.
Após a conclusão da instalação, para encontrar suas credenciais de autenticação, execute abctl local credentials .
Instale Docker
Linux
Mac
Windows
Instalar abctl
Via cerveja
brew tap airbytehq/tap brew install abctl
Através de ir instalar
go install github.com/airbytehq/abctl@latest
Através do Github
Instale Airbyte
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
Observação
Dependendo da velocidade da Internet, abctl local install pode levar mais de 15 minutos.
Por padrão, abctl local install configura o Airbyte para ser acessível por todas as solicitações de entrada na porta 8000 . Isso normalmente inclui acesso por meio do endereço IP e localhost do host.
Se a porta 8000 não estiver disponível. ou outra porta é preferida, --port [PORT] pode ser especificado.
Faça login no Airbyte
Se abctl local install for concluída com êxito, ele deverá abrir um navegador para http://localhost:8000 (ou para as substituições --host e --port , se especificado). Se esta for a primeira vez que o Airbyte é instalado, você será solicitado a fornecer um e-mail e o nome da organização. Para recuperar sua senha de login, execute abctl local credentials .
Conforme mencionado no início rápido, o único pré-requisito que abctl tem é que o Docker esteja instalado, em execução e acessível. No entanto, a plataforma Airbyte requer um cluster Kubernetes, que abctl cria utilizando kind (o kind executa um cluster Kubernetes dentro de um contêiner Docker). Com o cluster Kubernetes do kind, abctl usa o helm para instalar (ou atualizar para) o gráfico de leme Airbyte mais recente (por padrão) e o gráfico de leme mais recente do NGINX Ingress Controller.
Todos os comandos e subcomandos suportam os seguintes sinalizadores globais opcionais:
| Curto | Longo | Descrição |
|---|---|---|
| -h | --ajuda | Exibe as informações de ajuda, descrição das opções disponíveis. |
| -v | --verbose | Ativa a saída detalhada (depuração). Útil ao depurar comportamento inesperado. |
Todos os comandos suportam as seguintes variáveis de ambiente:
| Nome | Descrição |
|---|---|
| DO_NOT_TRACK | Defina qualquer valor para desativar o rastreamento de telemetria. |
Os seguintes comandos são suportados:
local
versão
abctl local --help
Os subcomandos locais concentram-se no gerenciamento da instalação local do Airbyte. Os seguintes subcomandos estão disponíveis:
credenciais
implantações
instalar
status
desinstalar
abctl local credentials
Exibe as credenciais necessárias para fazer login na instalação local do Airbyte.
Observação
Quando abctl local install é executado pela primeira vez, são gerados random password , client-id e client-secret .
Retorna essas credenciais email , password , client-id e client-secret . O email e password são necessários para fazer login no Airbyte. O client-id e client-secret são necessários para criar um Access Token para interagir com a API Airbyte.
Por exemplo:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials suporta os seguintes sinalizadores opcionais
| Nome | Padrão | Descrição |
|---|---|---|
| "" | Altera o endereço de e-mail de autenticação. | |
| --senha | "" | Altera a senha de autenticação. |
abctl local deployments
Exibe informações de implantação do Kubernetes e permite reiniciar uma implantação do Kubernetes.
deployments suportam os seguintes sinalizadores opcionais
| Nome | Padrão | Descrição |
|---|---|---|
| --reiniciar | "" | Reinicia a implantação fornecida. |
abctl local install
Instala uma instância local do Airbyte ou atualiza uma instalação existente que foi inicialmente instalada por abctl .
Observação
Dependendo da velocidade da sua internet, abctl local install pode levar mais de 20 minutos.
install oferece suporte aos seguintes sinalizadores opcionais:
Observação
Um - na coluna padrão indica que nenhum valor pode ser fornecido.
Esses sinalizadores se comportam como uma opção, habilitada se fornecida, desabilitada se não for fornecida.
| Nome | Padrão | Descrição |
|---|---|---|
| --gráfico | "" | Caminho para o gráfico. |
| --chart-version | mais recente | Qual versão do helm-chart do Airbyte instalar. |
| --docker-e-mail | "" | Endereço de e-mail do Docker para autenticação em --docker-server .Também pode ser especificado pela variável de ambiente ABCTL_LOCAL_INSTALL_DOCKER_EMAIL . |
| --docker-senha | "" | Senha do Docker para autenticação em --docker-server .Também pode ser especificado pela variável de ambiente ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD . |
| --docker-servidor | "" | Servidor Docker para autenticação. Também pode ser especificado pela variável de ambiente ABCTL_LOCAL_INSTALL_DOCKER_SERVER . |
| --docker-nome de usuário | "" | Nome de usuário do Docker para autenticação em --docker-server .Também pode ser especificado pela variável de ambiente ABCTL_LOCAL_INSTALL_DOCKER_USERNAME . |
| --cookies inseguros | - | Desativa os requisitos de cookies seguros. Defina apenas se estiver usando --host com uma conexão insegura (não https ). |
| --modo de baixo recurso | falso | Execute o Airbyte no modo de poucos recursos. |
| --hospedar | "" | FQDN onde a instalação do Airbyte será acessada. O padrão é permitir todo o tráfego de entrada na porta --port .Defina isto se a instalação do Airbyte precisar de uma configuração de host mais restrita. |
| --migrar | - | Permite a migração de dados de uma instalação existente do Airbyte suportada pelo docker-compose. Copia, deixando os dados originais inalterados, os dados de um docker-compose apoiou a instalação do Airbyte nesta instalação do Airbyte gerenciada abctl . |
| --no-navegador | - | Desativa a inicialização do navegador quando a instalação for concluída. Útil para configurar em situações onde nenhum navegador está disponível. |
| --porta | 8.000 | Porta onde será acessada a instalação do Airbyte. Defina isto se a porta 8000 já estiver em uso ou se uma porta diferente for preferida. |
| --segredo | "" | Pode ser definido várias vezes . Cria um segredo do Kubernetes com base no conteúdo do arquivo fornecido. Útil quando usado em conjunto com --values para personalizar a instalação. |
| --valores | "" | Arquivo de valores do Helm para personalizar ainda mais a instalação do Airbyte. |
| --volume | "" | Pode ser definido várias vezes . Monta volumes adicionais no cluster kubernetes. Deve estar no formato <HOST_PATH>:<GUEST_PATH> . |
abctl local status
Se existir uma instalação Airbyte, retorna informações sobre essa instalação.
Por exemplo:
$ 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 uma instância local do Airbyte.
Observação
Os dados associados à instância Airbyte instalada não serão removidos.
Isso é feito para permitir que o Airbyte seja reinstalado posteriormente com todos os dados preservados.
uninstall oferece suporte aos seguintes sinalizadores opcionais:
Observação
Um - na coluna padrão indica que nenhum valor pode ser fornecido.
Esses sinalizadores se comportam como uma opção, habilitada se fornecida, desabilitada se não for fornecida.
| Nome | Padrão | Descrição |
|---|---|---|
| --persistiu | - | Remove todos os dados da instalação do Airbyte. Isto não pode ser desfeito. |
abctl images
Gerencie imagens usadas pelo Airbyte e abctl.
Os seguintes subcomandos estão disponíveis:
manifesto
abctl images manifest
Exiba um manifesto de imagens usadas por Airbyte e abctl.
| Nome | Padrão | Descrição |
|---|---|---|
| --gráfico | "" | Caminho para o gráfico. |
| --chart-version | mais recente | Qual versão do helm-chart do Airbyte instalar. |
| --valores | "" | Arquivo de valores do Helm para personalizar ainda mais a instalação do Airbyte. |
abctl version
Exibe informações de versão sobre a ferramenta abctl .
Por exemplo:
$ abctl version version: v0.19.0
Se você encontrou um problema com abctl , abra um problema no Github e use o ? [abctl] Report an issue with the abctl tool .
Instalar go
Via cerveja
brew install go
Via go.dev
Este repositório utiliza um Makefile, agrupando os comandos go tradicionais usados para formatar, verificar, construir e testar o código go .
Os seguintes comandos make são suportados:
| nome | descrição |
|---|---|
make build | Constrói o binário abctl , colocando-o no diretório build . |
make clean | Remove o diretório build . |
make fmt | Formata o código. |
make test | Executa todos os testes. |
make vet | Executa o comando veterinário. |
