abctl
v0.22.0
Alat baris perintah Airbyte untuk penerapan Airbyte lokal.
Catatan
README ini terutama berfokus pada alat abctl itu sendiri, bukan pada platform Airbyte.
Jika Anda mencari dokumentasi panduan memulai resmi Airbyte, Anda dapat menemukannya di sini.
Mulai cepat
Ringkasan
Perintah
Berkontribusi
Penting
Kredensial otentikasi dihasilkan secara acak sebagai bagian dari proses instalasi.
Setelah instalasi selesai, untuk menemukan kredensial otentikasi Anda, jalankan abctl local credentials .
Instal Docker
Linux
Mac
jendela
Instal abctl
Melalui minuman
brew tap airbytehq/tap brew install abctl
Melalui go instal
go install github.com/airbytehq/abctl@latest
Melalui Github
Instal Airbyte
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
Catatan
Tergantung pada kecepatan internet, abctl local install dapat memakan waktu lebih dari 15 menit.
Secara default, abctl local install mengonfigurasi Airbyte agar dapat diakses oleh semua permintaan masuk pada port 8000 . Ini biasanya mencakup akses melalui alamat ip host dan localhost .
Jika port 8000 tidak tersedia. atau port lain yang lebih disukai, --port [PORT] dapat ditentukan.
Masuk ke Airbyte
Jika abctl local install berhasil diselesaikan, browser akan terbuka ke http://localhost:8000 (atau ke penggantian --host dan --port jika ditentukan). Jika ini adalah pertama kalinya Airbyte diinstal, Anda akan diminta memberikan email dan nama organisasi. Untuk mengambil kata sandi Anda untuk masuk, jalankan abctl local credentials .
Seperti disebutkan dalam mulai cepat, satu-satunya prasyarat yang dimiliki abctl adalah Docker harus diinstal, dijalankan, dan dapat diakses. Namun, platform Airbyte memerlukan cluster Kubernetes, yang dibuat oleh abctl dengan menggunakan kind (kind menjalankan cluster Kubernetes dalam container Docker). Dengan cluster Kubernetes kind, abctl menggunakan helm untuk menginstal (atau memperbarui) diagram helm Airbyte terbaru (secara default) dan diagram helm NGINX Ingress Controller terbaru.
Semua perintah dan sub-perintah mendukung tanda global opsional berikut:
| Pendek | Panjang | Keterangan |
|---|---|---|
| -H | --membantu | Menampilkan informasi bantuan, menjelaskan opsi yang tersedia. |
| -v | --bertele-tele | Mengaktifkan keluaran verbose (debug). Berguna saat men-debug perilaku tak terduga. |
Semua perintah mendukung variabel lingkungan berikut:
| Nama | Keterangan |
|---|---|
| JANGAN_NOT_TRACK | Setel ke nilai apa pun untuk menonaktifkan pelacakan telemetri. |
Perintah berikut ini didukung:
lokal
versi
abctl local --help
Sub-perintah lokal difokuskan pada pengelolaan instalasi Airbyte lokal. Sub-perintah berikut tersedia:
kredensial
penerapan
memasang
status
hapus instalan
abctl local credentials
Menampilkan kredensial yang diperlukan untuk masuk ke instalasi Airbyte lokal.
Catatan
Ketika abctl local install pertama kali dijalankan, password acak, client-id , dan client-secret dihasilkan.
Mengembalikan kredensial email , password , client-id , dan client-secret . email dan password diperlukan untuk masuk ke Airbyte. client-id dan client-secret diperlukan untuk membuat Access Token untuk berinteraksi dengan API Airbyte.
Misalnya:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials mendukung tanda opsional berikut
| Nama | Bawaan | Keterangan |
|---|---|---|
| "" | Mengubah alamat email otentikasi. | |
| --kata sandi | "" | Mengubah kata sandi otentikasi. |
abctl local deployments
Menampilkan informasi penerapan kubernetes dan memungkinkan untuk memulai ulang penerapan kubernetes.
deployments mendukung tanda opsional berikut
| Nama | Bawaan | Keterangan |
|---|---|---|
| --mulai ulang | "" | Mulai ulang penerapan yang disediakan. |
abctl local install
Menginstal instans Airbyte lokal atau memperbarui instalasi yang sudah ada yang awalnya diinstal oleh abctl .
Catatan
Tergantung pada kecepatan internet Anda, abctl local install mungkin memerlukan waktu lebih dari 20 menit.
install mendukung tanda opsional berikut:
Catatan
Tanda - di kolom default menunjukkan tidak ada nilai yang dapat diberikan.
Bendera ini berperilaku seperti saklar, diaktifkan jika disediakan, dinonaktifkan jika tidak.
| Nama | Bawaan | Keterangan |
|---|---|---|
| --bagan | "" | Jalur menuju grafik. |
| --versi bagan | terbaru | Versi diagram helm Airbyte mana yang akan dipasang. |
| --buruh pelabuhan-email | "" | Alamat email Docker untuk diautentikasi terhadap --docker-server .Dapat juga ditentukan oleh variabel lingkungan ABCTL_LOCAL_INSTALL_DOCKER_EMAIL . |
| --kata sandi buruh pelabuhan | "" | Kata sandi Docker untuk mengautentikasi --docker-server .Dapat juga ditentukan oleh variabel lingkungan ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD . |
| --server buruh pelabuhan | "" | Server Docker untuk diautentikasi. Dapat juga ditentukan oleh variabel lingkungan ABCTL_LOCAL_INSTALL_DOCKER_SERVER . |
| --nama pengguna buruh pelabuhan | "" | Nama pengguna Docker untuk diautentikasi terhadap --docker-server .Dapat juga ditentukan oleh variabel lingkungan ABCTL_LOCAL_INSTALL_DOCKER_USERNAME . |
| --cookie yang tidak aman | - | Menonaktifkan persyaratan cookie aman. Hanya disetel jika menggunakan --host dengan koneksi yang tidak aman (bukan https ). |
| --mode sumber daya rendah | PALSU | Jalankan Airbyte dalam mode sumber daya rendah. |
| --tuan rumah | "" | FQDN tempat instalasi Airbyte akan diakses. Defaultnya adalah mengizinkan semua lalu lintas masuk pada port --port .Atur ini jika instalasi Airbyte memerlukan konfigurasi host yang lebih terbatas. |
| --bermigrasi | - | Mengaktifkan migrasi data dari instalasi Airbyte yang didukung komposisi buruh pelabuhan. Menyalin, membiarkan data asli tidak diubah, data dari penulisan buruh pelabuhan mendukung instalasi Airbyte ke dalam instalasi Airbyte yang dikelola abctl ini. |
| --tanpa browser | - | Menonaktifkan peluncuran browser saat instalasi selesai. Berguna untuk mengatur dalam situasi di mana tidak ada browser yang tersedia. |
| --pelabuhan | 8000 | Port tempat instalasi Airbyte akan diakses. Atur ini jika port 8000 sudah digunakan atau jika port lain lebih disukai. |
| --rahasia | "" | Dapat diatur berkali-kali . Membuat rahasia kubernetes berdasarkan konten file yang disediakan. Berguna bila digunakan bersama dengan --values untuk menyesuaikan instalasi. |
| --nilai | "" | File nilai helm untuk menyesuaikan lebih lanjut instalasi Airbyte. |
| --volume | "" | Dapat diatur berkali-kali . Memasang volume tambahan di cluster kubernetes. Harus dalam format <HOST_PATH>:<GUEST_PATH> . |
abctl local status
Jika instalasi Airbyte ada, kembalikan informasi mengenai instalasi itu.
Misalnya:
$ 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
Menghapus instalasi instans Airbyte lokal.
Catatan
Data yang terkait dengan instans Airbyte yang diinstal tidak akan dihapus.
Hal ini dilakukan agar Airbyte dapat diinstal ulang di kemudian hari dengan semua data tetap tersimpan.
uninstall mendukung tanda opsional berikut:
Catatan
Tanda - di kolom default menunjukkan tidak ada nilai yang dapat diberikan.
Bendera ini berperilaku seperti saklar, diaktifkan jika disediakan, dinonaktifkan jika tidak.
| Nama | Bawaan | Keterangan |
|---|---|---|
| --bertahan | - | Akan menghapus semua data untuk instalasi Airbyte. Hal ini tidak dapat dibatalkan. |
abctl images
Kelola gambar yang digunakan oleh Airbyte dan abctl.
Sub-perintah berikut tersedia:
tampak
abctl images manifest
Menampilkan manifes gambar yang digunakan oleh Airbyte dan abctl.
| Nama | Bawaan | Keterangan |
|---|---|---|
| --bagan | "" | Jalur menuju grafik. |
| --versi bagan | terbaru | Versi diagram helm Airbyte mana yang akan dipasang. |
| --nilai | "" | File nilai helm untuk menyesuaikan lebih lanjut instalasi Airbyte. |
abctl version
Menampilkan informasi versi tentang alat abctl .
Misalnya:
$ abctl version version: v0.19.0
Jika Anda menemukan masalah dengan abctl , silakan buka Masalah Github dan gunakan ? [abctl] Report an issue with the abctl tool .
Instal go
Melalui minuman
brew install go
Melalui go.dev
Repositori ini menggunakan Makefile, yang menggabungkan perintah go tradisional yang digunakan untuk memformat, memeriksa, membuat, dan menguji kode go .
Perintah make berikut ini didukung:
| nama | keterangan |
|---|---|
make build | Membangun biner abctl , menempatkannya di direktori build . |
make clean | Menghapus direktori build . |
make fmt | Memformat kode. |
make test | Menjalankan semua tes. |
make vet | Jalankan perintah dokter hewan. |
