abctl
v0.22.0
Das Befehlszeilentool von Airbyte für lokale Airbyte-Bereitstellungen.
Notiz
Diese README-Datei konzentriert sich hauptsächlich auf das abctl -Tool selbst, nicht auf die Airbyte-Plattform.
Wenn Sie nach der offiziellen Schnellstartdokumentation von Airbyte suchen, finden Sie diese hier.
Schnellstart
Überblick
Befehle
Mitwirken
Wichtig
Authentifizierungsdaten werden im Rahmen des Installationsprozesses zufällig generiert.
Nachdem die Installation abgeschlossen ist, führen Sie abctl local credentials aus, um Ihre Authentifizierungsdaten zu finden.
Installieren Sie Docker
Linux
Mac
Windows
abctl installieren
Über brew
brew tap airbytehq/tap brew install abctl
Über go install
go install github.com/airbytehq/abctl@latest
Über Github
Installieren Sie Airbyte
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
Notiz
Abhängig von der Internetgeschwindigkeit kann abctl local install mehr als 15 Minuten dauern.
Standardmäßig konfiguriert abctl local install Airbyte so, dass es für alle eingehenden Anfragen auf Port 8000 zugänglich ist. Dies umfasst normalerweise den Zugriff über die IP-Adresse und localhost des Hosts.
Wenn Port 8000 nicht verfügbar ist. oder ein anderer Port bevorzugt wird, kann --port [PORT] angegeben werden.
Melden Sie sich bei Airbyte an
Wenn abctl local install erfolgreich abgeschlossen wurde, sollte ein Browser für http://localhost:8000 (oder für die Überschreibungen --host und --port , falls angegeben) geöffnet werden. Wenn Airbyte zum ersten Mal installiert wird, werden Sie aufgefordert, eine E-Mail-Adresse und einen Organisationsnamen anzugeben. Um Ihr Passwort für die Anmeldung abzurufen, führen Sie abctl local credentials aus.
Wie im Schnellstart erwähnt, besteht die einzige Voraussetzung für abctl darin, dass Docker installiert, ausgeführt und zugänglich sein muss. Allerdings erfordert die Airbyte-Plattform einen Kubernetes-Cluster, den abctl mithilfe von kind erstellt (kind führt einen Kubernetes-Cluster innerhalb eines Docker-Containers aus). Mit dem Kubernetes-Cluster von kind verwendet abctl Helm, um das neueste (standardmäßig) Airbyte-Helmdiagramm und das neueste NGINX Ingress Controller-Helmdiagramm zu installieren (oder darauf zu aktualisieren).
Alle Befehle und Unterbefehle unterstützen die folgenden optionalen globalen Flags:
| Kurz | Lang | Beschreibung |
|---|---|---|
| -H | --helfen | Zeigt die Hilfeinformationen und eine Beschreibung der verfügbaren Optionen an. |
| -v | --verbose | Aktiviert eine ausführliche (Debug-)Ausgabe. Nützlich beim Debuggen unerwarteten Verhaltens. |
Alle Befehle unterstützen die folgenden Umgebungsvariablen:
| Name | Beschreibung |
|---|---|
| DO_NOT_TRACK | Legen Sie einen beliebigen Wert fest, um die Telemetrieverfolgung zu deaktivieren. |
Die folgenden Befehle werden unterstützt:
lokal
Version
abctl local --help
Die lokalen Unterbefehle konzentrieren sich auf die Verwaltung der lokalen Airbyte-Installation. Folgende Unterbefehle stehen zur Verfügung:
Anmeldeinformationen
Bereitstellungen
installieren
Status
deinstallieren
abctl local credentials
Zeigt die Anmeldeinformationen an, die für die Anmeldung bei der lokalen Airbyte-Installation erforderlich sind.
Notiz
Wenn abctl local install zum ersten Mal ausgeführt wird, werden zufälliges password , client-id und client-secret generiert.
Gibt die email , password , client-id und client-secret Anmeldeinformationen zurück. Für die Anmeldung bei Airbyte sind die email und password erforderlich. Die client-id und client-secret sind erforderlich, um ein Access Token für die Interaktion mit der Airbyte-API zu erstellen.
Zum Beispiel:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials unterstützen die folgenden optionalen Flags
| Name | Standard | Beschreibung |
|---|---|---|
| „“ | Ändert die Authentifizierungs-E-Mail-Adresse. | |
| --Passwort | „“ | Ändert das Authentifizierungskennwort. |
abctl local deployments
Zeigt Informationen zur Kubernetes-Bereitstellung an und ermöglicht den Neustart einer Kubernetes-Bereitstellung.
deployments unterstützen die folgenden optionalen Flags
| Name | Standard | Beschreibung |
|---|---|---|
| --neustart | „“ | Startet die bereitgestellte Bereitstellung neu. |
abctl local install
Installiert eine lokale Airbyte-Instanz oder aktualisiert eine vorhandene Installation, die ursprünglich von abctl installiert wurde.
Notiz
Abhängig von Ihrer Internetgeschwindigkeit kann abctl local install mehr als 20 Minuten dauern.
install unterstützt die folgenden optionalen Flags:
Notiz
Ein - in der Standardspalte bedeutet, dass kein Wert angegeben werden kann.
Diese Flags verhalten sich wie ein Schalter. Sie sind aktiviert, sofern vorhanden, und deaktiviert, wenn nicht.
| Name | Standard | Beschreibung |
|---|---|---|
| --Diagramm | „“ | Pfad zum Diagramm. |
| --chart-version | letzte | Welche Airbyte-Ruderkartenversion installiert werden soll. |
| --docker-email | „“ | Docker-E-Mail-Adresse zur Authentifizierung bei --docker-server .Kann auch durch die Umgebungsvariable ABCTL_LOCAL_INSTALL_DOCKER_EMAIL angegeben werden. |
| --docker-password | „“ | Docker-Passwort zur Authentifizierung gegenüber --docker-server .Kann auch durch die Umgebungsvariable ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD angegeben werden. |
| --docker-server | „“ | Docker-Server zur Authentifizierung. Kann auch durch die Umgebungsvariable ABCTL_LOCAL_INSTALL_DOCKER_SERVER angegeben werden. |
| --docker-Benutzername | „“ | Docker-Benutzername zur Authentifizierung bei --docker-server .Kann auch durch die Umgebungsvariable ABCTL_LOCAL_INSTALL_DOCKER_USERNAME angegeben werden. |
| --insecure-cookies | - | Deaktiviert sichere Cookie-Anforderungen. Wird nur festgelegt, wenn --host mit einer unsicheren Verbindung (nicht https ) verwendet wird. |
| --low-resource-mode | FALSCH | Führen Sie Airbyte im ressourcenarmen Modus aus. |
| --Gastgeber | „“ | FQDN, unter dem auf die Airbyte-Installation zugegriffen wird. Standardmäßig ist der gesamte eingehende Datenverkehr auf Port --port zugelassen.Legen Sie dies fest, wenn die Airbyte-Installation eine eingeschränktere Hostkonfiguration erfordert. |
| --wandern | - | Ermöglicht die Datenmigration von einer vorhandenen, von Docker-Compose unterstützten Airbyte-Installation. Kopiert die Daten aus einem Docker-Compose, wobei die Originaldaten unverändert bleiben unterstützte Airbyte-Installation in diese abctl verwaltete Airbyte-Installation. |
| --no-browser | - | Deaktiviert das Starten des Browsers nach Abschluss der Installation. Nützlich in Situationen, in denen kein Browser verfügbar ist. |
| --Hafen | 8000 | Port, über den auf die Airbyte-Installation zugegriffen wird. Legen Sie dies fest, wenn Port 8000 bereits verwendet wird oder ein anderer Port bevorzugt wird. |
| --Geheimnis | „“ | Mehrfach einstellbar . Erstellt ein Kubernetes-Geheimnis basierend auf dem Inhalt der bereitgestellten Datei. Nützlich bei Verwendung in Verbindung mit --values zum Anpassen der Installation. |
| --Werte | „“ | Helm-Wertedatei zur weiteren Anpassung der Airbyte-Installation. |
| --Volumen | „“ | Mehrfach einstellbar . Stellt zusätzliche Volumes im Kubernetes-Cluster bereit. Muss im Format <HOST_PATH>:<GUEST_PATH> vorliegen. |
abctl local status
Wenn eine Airbyte-Installation vorhanden ist, werden Informationen zu dieser Installation zurückgegeben.
Zum Beispiel:
$ 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
Deinstalliert eine lokale Airbyte-Instanz.
Notiz
Die mit der installierten Airbyte-Instanz verknüpften Daten werden nicht entfernt.
Dies geschieht, damit Airbyte zu einem späteren Zeitpunkt erneut installiert werden kann und alle Daten erhalten bleiben.
uninstall unterstützt die folgenden optionalen Flags:
Notiz
Ein - in der Standardspalte bedeutet, dass kein Wert angegeben werden kann.
Diese Flags verhalten sich wie ein Schalter. Sie sind aktiviert, sofern vorhanden, und deaktiviert, wenn nicht.
| Name | Standard | Beschreibung |
|---|---|---|
| --beharrte | - | Entfernt alle Daten für die Airbyte-Installation. Dies kann nicht rückgängig gemacht werden. |
abctl images
Verwalten Sie die von Airbyte und abctl verwendeten Bilder.
Folgende Unterbefehle stehen zur Verfügung:
Manifest
abctl images manifest
Zeigt ein Manifest der von Airbyte und abctl verwendeten Bilder an.
| Name | Standard | Beschreibung |
|---|---|---|
| --Diagramm | „“ | Pfad zum Diagramm. |
| --chart-version | letzte | Welche Airbyte-Ruderkartenversion installiert werden soll. |
| --Werte | „“ | Helm-Wertedatei zur weiteren Anpassung der Airbyte-Installation. |
abctl version
Zeigt Versionsinformationen zum abctl -Tool an.
Zum Beispiel:
$ abctl version version: v0.19.0
Wenn Sie ein Problem mit abctl gefunden haben, öffnen Sie bitte ein Github-Problem und verwenden Sie das ? [abctl] Report an issue with the abctl tool -Vorlage.
Installieren Sie go
Über brew
brew install go
Über go.dev
Dieses Repository verwendet ein Makefile, das die herkömmlichen go -Befehle umschließt, die zum Formatieren, Überprüfen, Erstellen und Testen go Code verwendet werden.
Die folgenden make -Befehle werden unterstützt:
| Name | Beschreibung |
|---|---|
make build | Erstellt die abctl Binärdatei und platziert sie im build -Verzeichnis. |
make clean | Entfernt das build Verzeichnis. |
make fmt | Formatiert den Code. |
make test | Führt alle Tests durch. |
make vet | Führt den Befehl vet aus. |
