abctl

ABCTL

Airbyte 用于本地 Airbyte 部署的命令行工具。

笔记

本自述文件主要关注abctl工具本身，而不是 Airbyte 平台。

如果您正在寻找 Airbyte 的官方快速入门文档，可以在这里找到。

---

• 快速入门

• 概述

• 命令

• 贡献

快速入门

重要的

身份验证凭据是在安装过程中随机生成的。

安装完成后，要查找您的身份验证凭据，请运行abctl local credentials 。

1. 安装Docker

• Linux

• 苹果

• 视窗

2. 安装abctl

• 通过酿造

  brew tap airbytehq/tap
  brew install abctl

• 通过去安装

  go install github.com/airbytehq/abctl@latest

• 通过Github

3. 安装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] 。

4. 登录Airbyte

   如果abctl local install成功完成，它应该打开浏览器访问 http://localhost:8000（或者打开--host和--port覆盖，如果指定的话）。 如果这是第一次安装 Airbyte，您将被要求提供电子邮件和组织名称。 要检索登录密码，请运行abctl local credentials 。

概述

正如快速入门中提到的， abctl唯一的先决条件是 Docker 必须已安装、运行且可访问。然而，Airbyte 平台需要一个 Kubernetes 集群， abctl通过利用 kind（kind 在 Docker 容器内运行 Kubernetes 集群）创建该集群。通过 kind 的 Kubernetes 集群， abctl使用 helm 安装（或更新到）最新（默认）的 Airbyte helm Chart 和最新的 NGINX Ingress Controller helm Chart。

命令

所有命令和子命令都支持以下可选全局标志：

短的	长的	描述
-h	- 帮助	显示帮助信息，描述可用选项。
-v	--详细	启用详细（调试）输出。 在调试意外行为时很有用。

所有命令都支持以下环境变量：

姓名	描述
请勿跟踪	设置为任意值以禁用遥测跟踪。

支持以下命令：

• 当地的

• 版本

当地的

abctl local --help

本地子命令主要用于管理本地 Airbyte 安装。可以使用以下子命令：

• 证书

• 部署

• 安装

• 地位

• 卸载

证书

abctl local credentials

显示登录本地 Airbyte 安装所需的凭据。

笔记

首次执行abctl local install时，会生成随机的password 、 client-id和client-secret 。

返回email 、 password 、 client-id和client-secret凭证。登录 Airbyte 需要email和password 。要创建与 Airbyte API 交互的Access Token ，必须使用client-id和client-secret 。

例如：

$ 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支持以下可选标志：

笔记

默认列中的-表示无法提供任何值。

这些标志的行为就像一个开关，如果提供则启用，否则禁用。

姓名	默认	描述
- 图表	””	图表的路径。
--图表版本	最新的	要安装哪个 Airbyte helm-chart 版本。
--docker-电子邮件	””	用于针对--docker-server进行身份验证的 Docker 电子邮件地址。 也可以通过环境变量ABCTL_LOCAL_INSTALL_DOCKER_EMAIL指定。
--docker 密码	””	用于针对--docker-server进行身份验证的 Docker 密码。 也可以通过环境变量ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD指定。
--docker-服务器	””	用于进行身份验证的 Docker 服务器。 也可以通过环境变量ABCTL_LOCAL_INSTALL_DOCKER_SERVER指定。
--docker-用户名	””	用于针对--docker-server进行身份验证的 Docker 用户名。 也可以通过环境变量ABCTL_LOCAL_INSTALL_DOCKER_USERNAME指定。
--不安全-cookie	-	禁用安全 cookie 要求。 仅当使用--host进行不安全（非https ）连接时才设置。
--低资源模式	错误的	在低资源模式下运行 Airbyte。
- 主持人	””	将访问 Airbyte 安装的 FQDN。默认值是允许端口--port上的所有传入流量。 如果 Airbyte 安装需要更严格的主机配置，请设置此项。
- 迁移	-	允许从现有的 docker-compose 支持的 Airbyte 安装进行数据迁移。 复制来自 docker-compose 的数据，保持原始数据不变 支持 Airbyte 安装到此abctl管理的 Airbyte 安装中。
--无浏览器	-	安装完成后禁用启动浏览器。 在没有浏览器可用的情况下设置很有用。
- 港口	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 使用的图像清单。

姓名	默认	描述
- 图表	””	图表的路径。
--图表版本	最新的	要安装哪个 Airbyte helm-chart 版本。
--价值观	””	Helm 值文件可进一步自定义 Airbyte 安装。

版本

abctl version

显示abctl工具的版本信息。

例如：

$ abctl version
version: v0.19.0

贡献

报告问题

如果您发现abctl存在问题，请打开 Github Issue 并使用? [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	运行 vet 命令。