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 指令。