abctl
v0.22.0
ローカルの Airbyte 導入用の Airbyte のコマンドライン ツール。
注記
この README は、Airbyte プラットフォームではなく、 abctlツール自体に主に焦点を当てています。
Airbyte の公式クイックスタート ドキュメントをお探しの場合は、ここで見つけることができます。
クイックスタート
概要
コマンド
貢献する
重要
認証資格情報は、インストール プロセスの一部としてランダムに生成されます。
インストールが完了したら、 abctl local credentials実行して認証資格情報を確認します。
Dockerをインストールする
Linux
マック
窓
abctlをインストールする
醸造経由
brew tap airbytehq/tap brew install abctl
go install経由
go install github.com/airbytehq/abctl@latest
Github経由
Airbyteをインストールする
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
注記
インターネットの速度によっては、 abctl local install 15 分以上かかる場合があります。
デフォルトでは、 abctl local installポート8000上のすべての受信リクエストがアクセスできるように Airbyte を設定します。これには通常、ホストの IP アドレスとlocalhost介したアクセスが含まれます。
ポート8000が使用できない場合。または、別のポートが優先される場合は、 --port [PORT]を指定できます。
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 チャートと最新の NGINX Ingress Controller Helm チャートをインストール (または更新) します。
すべてのコマンドとサブコマンドは、次のオプションのグローバル フラグをサポートしています。
| 短い | 長さ | 説明 |
|---|---|---|
| -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必要です。 client-idとclient-secret 、Airbyte API と対話するためのAccess Tokenを作成するために必要です。
例えば：
$ 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 ヘルムチャートのバージョン。 |
| --docker-メール | 「」 | --docker-serverに対して認証するための Docker メール アドレス。環境変数 ABCTL_LOCAL_INSTALL_DOCKER_EMAILによって指定することもできます。 |
| --docker-パスワード | 「」 | --docker-serverに対して認証するための Docker パスワード。環境変数 ABCTL_LOCAL_INSTALL_DOCKER_PASSWORDによって指定することもできます。 |
| --docker-server | 「」 | 認証対象の Docker サーバー。 環境変数 ABCTL_LOCAL_INSTALL_DOCKER_SERVERによって指定することもできます。 |
| --docker-ユーザー名 | 「」 | --docker-serverに対して認証するための Docker ユーザー名。環境変数 ABCTL_LOCAL_INSTALL_DOCKER_USERNAMEによって指定することもできます。 |
| --insecure-cookies | - | 安全な Cookie 要件を無効にします。 安全でない (非 https ) 接続で--host使用する場合にのみ設定します。 |
| --低リソースモード | 間違い | Airbyteを低リソースモードで実行します。 |
| - ホスト | 「」 | Airbyte インストールにアクセスする FQDN。デフォルトでは、ポート--port上のすべての受信トラフィックが許可されます。Airbyte のインストールでより制限されたホスト構成が必要な場合は、これを設定します。 |
| --移行 | - | 既存の docker-compose ベースの Airbyte インストールからのデータ移行を有効にします。 元のデータを変更せずに、docker-compose からのデータをコピーします。 バックアップされた Airbyte インストールをこの abctl管理の Airbyte インストールに追加します。 |
| --ブラウザなし | - | インストール完了時のブラウザの起動を無効にします。 使用可能なブラウザがない状況で設定すると便利です。 |
| - ポート | 8000 | Airbyte インストールにアクセスするポート。 ポート 8000 がすでに使用されている場合、または別のポートが優先される場合は、これを設定します。 |
| - 秘密 | 「」 | 複数回設定可能です。 提供されたファイルの内容に基づいて kubernetes シークレットを作成します。 インストールをカスタマイズするために --valuesと組み合わせて使用すると便利です。 |
| -- 値 | 「」 | Airbyte インストールをさらにカスタマイズするための Helm 値ファイル。 |
| - 音量 | 「」 | 複数回設定可能です。 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 ヘルムチャートのバージョン。 |
| -- 値 | 「」 | Airbyte インストールをさらにカスタマイズするための Helm 値ファイル。 |
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 コマンドを実行します。 |
