abctl
v0.22.0
L'outil de ligne de commande d'Airbyte pour les déploiements Airbyte locaux.
Note
Ce README se concentre principalement sur l'outil abctl lui-même, et non sur la plateforme Airbyte.
Si vous recherchez la documentation officielle de démarrage rapide d'Airbyte, vous pouvez la trouver ici.
Démarrage rapide
Aperçu
Commandes
Contribuer
Important
Les informations d'authentification sont générées de manière aléatoire dans le cadre du processus d'installation.
Une fois l'installation terminée, pour trouver vos informations d'authentification, exécutez abctl local credentials .
Installer Docker
Linux
Mac
Fenêtres
Installer abctl
Via infusion
brew tap airbytehq/tap brew install abctl
Via aller installer
go install github.com/airbytehq/abctl@latest
Via GitHub
Installer Airbyte
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
Note
En fonction de la vitesse d'Internet, abctl local install peut prendre plus de 15 minutes.
Par défaut, abctl local install configure Airbyte pour qu'il soit accessible par toutes les requêtes entrantes sur le port 8000 . Cela inclut généralement l'accès via l'adresse IP et localhost de l'hôte.
Si le port 8000 n'est pas disponible. ou un autre port est préféré, --port [PORT] peut être spécifié.
Connectez-vous à Airbyte
Si abctl local install s'est terminée avec succès, elle devrait ouvrir un navigateur sur http://localhost:8000 (ou sur les remplacements --host et --port si spécifiés). Si c'est la première fois qu'Airbyte est installé, il vous sera demandé de fournir une adresse e-mail et le nom de votre organisation. Pour récupérer votre mot de passe pour vous connecter, exécutez abctl local credentials .
Comme mentionné dans le démarrage rapide, la seule condition préalable abctl est que Docker doit être installé, exécuté et accessible. Cependant, la plate-forme Airbyte nécessite un cluster Kubernetes, abctl crée en utilisant kind (kind exécute un cluster Kubernetes dans un conteneur Docker). Avec le cluster Kubernetes de kind, abctl utilise helm pour installer (ou mettre à jour) la dernière carte de barre Airbyte (par défaut) et la dernière carte de barre NGINX Ingress Controller.
Toutes les commandes et sous-commandes prennent en charge les indicateurs globaux facultatifs suivants :
| Court | Long | Description |
|---|---|---|
| -h | --aide | Affiche les informations d'aide, la description des options disponibles. |
| -v | --verbeux | Active la sortie détaillée (débogage). Utile lors du débogage d’un comportement inattendu. |
Toutes les commandes prennent en charge les variables d'environnement suivantes :
| Nom | Description |
|---|---|
| DO_NOT_TRACK | Réglez-le sur n’importe quelle valeur pour désactiver le suivi de télémétrie. |
Les commandes suivantes sont prises en charge :
locale
version
abctl local --help
Les sous-commandes locales se concentrent sur la gestion de l'installation locale d'Airbyte. Les sous-commandes suivantes sont disponibles :
informations d'identification
déploiements
installer
statut
désinstaller
abctl local credentials
Affiche les informations d'identification requises pour se connecter à l'installation locale d'Airbyte.
Note
Lors de la première exécution abctl local install , password aléatoire, client-id et client-secret sont générés.
Renvoie les informations d'identification email , password , client-id et client-secret . L' email et password sont requis pour vous connecter à Airbyte. L' client-id et client-secret sont nécessaires pour créer un Access Token permettant d'interagir avec l'API Airbyte.
Par exemple:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials prennent en charge les indicateurs facultatifs suivants
| Nom | Défaut | Description |
|---|---|---|
| "" | Modifie l'adresse e-mail d'authentification. | |
| --mot de passe | "" | Modifie le mot de passe d'authentification. |
abctl local deployments
Affiche les informations de déploiement de Kubernetes et permet de redémarrer un déploiement de Kubernetes.
deployments prennent en charge les indicateurs facultatifs suivants
| Nom | Défaut | Description |
|---|---|---|
| --redémarrage | "" | Redémarre le déploiement fourni. |
abctl local install
Installe une instance Airbyte locale ou met à jour une installation existante initialement installée par abctl .
Note
En fonction de votre vitesse Internet, abctl local install peut prendre plus de 20 minutes.
install prend en charge les indicateurs facultatifs suivants :
Note
Un - dans la colonne par défaut indique qu'aucune valeur ne peut être fournie.
Ces indicateurs se comportent comme un commutateur, activés s'ils sont fournis, désactivés sinon.
| Nom | Défaut | Description |
|---|---|---|
| --graphique | "" | Chemin vers le graphique. |
| --version-graphique | dernier | Quelle version du graphique de barre Airbyte installer. |
| --docker-e-mail | "" | Adresse e-mail Docker pour s'authentifier auprès de --docker-server .Peut également être spécifié par la variable d'environnement ABCTL_LOCAL_INSTALL_DOCKER_EMAIL . |
| --docker-mot de passe | "" | Mot de passe Docker pour s'authentifier auprès de --docker-server .Peut également être spécifié par la variable d'environnement ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD . |
| --docker-serveur | "" | Serveur Docker sur lequel s’authentifier. Peut également être spécifié par la variable d'environnement ABCTL_LOCAL_INSTALL_DOCKER_SERVER . |
| --docker-nom d'utilisateur | "" | Nom d'utilisateur Docker pour s'authentifier auprès de --docker-server .Peut également être spécifié par la variable d'environnement ABCTL_LOCAL_INSTALL_DOCKER_USERNAME . |
| --cookies non sécurisés | - | Désactive les exigences en matière de cookies sécurisés. À définir uniquement si vous utilisez --host avec une connexion non sécurisée (non https ). |
| --mode-faibles ressources | FAUX | Exécutez Airbyte en mode faibles ressources. |
| --hôte | "" | FQDN où l'installation d'Airbyte sera accessible. La valeur par défaut est d'autoriser tout le trafic entrant sur le port --port .Définissez cette valeur si l'installation d'Airbyte nécessite une configuration d'hôte plus restreinte. |
| --émigrer | - | Permet la migration des données à partir d’une installation Airbyte existante basée sur Docker-compose. Copie, en laissant les données d'origine inchangées, les données d'un docker-compose installation Airbyte sauvegardée dans cette installation Airbyte gérée abctl . |
| --pas de navigateur | - | Désactive le lancement du navigateur une fois l'installation terminée. Utile à définir dans les situations où aucun navigateur n'est disponible. |
| --port | 8000 | Port où l'installation d'Airbyte sera accessible. Définissez cette valeur si le port 8000 est déjà utilisé ou si un autre port est préféré. |
| --secrète | "" | Peut être réglé plusieurs fois . Crée un secret Kubernetes basé sur le contenu du fichier fourni. Utile lorsqu'il est utilisé conjointement avec --values pour personnaliser l'installation. |
| --valeurs | "" | Fichier de valeurs Helm pour personnaliser davantage l'installation d'Airbyte. |
| --volume | "" | Peut être réglé plusieurs fois . Monte des volumes supplémentaires dans le cluster Kubernetes. Doit être au format <HOST_PATH>:<GUEST_PATH> . |
abctl local status
Si une installation Airbyte existe, renvoie des informations concernant cette installation.
Par exemple:
$ 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
Désinstalle une instance Airbyte locale.
Note
Les données associées à l'instance Airbyte installée ne seront pas supprimées.
Ceci est fait pour permettre à Airbyte d'être réinstallé ultérieurement avec toutes les données préservées.
uninstall prend en charge les indicateurs facultatifs suivants :
Note
Un - dans la colonne par défaut indique qu'aucune valeur ne peut être fournie.
Ces indicateurs se comportent comme un commutateur, activés s'ils sont fournis, désactivés sinon.
| Nom | Défaut | Description |
|---|---|---|
| --a persisté | - | Supprimera toutes les données pour l'installation d'Airbyte. Cela ne peut pas être annulé. |
abctl images
Gérez les images utilisées par Airbyte et abctl.
Les sous-commandes suivantes sont disponibles :
manifeste
abctl images manifest
Affichez un manifeste des images utilisées par Airbyte et abctl.
| Nom | Défaut | Description |
|---|---|---|
| --graphique | "" | Chemin vers le graphique. |
| --version-graphique | dernier | Quelle version du graphique de barre Airbyte installer. |
| --valeurs | "" | Fichier de valeurs Helm pour personnaliser davantage l'installation d'Airbyte. |
abctl version
Affiche les informations de version sur l'outil abctl .
Par exemple:
$ abctl version version: v0.19.0
Si vous avez trouvé un problème avec abctl , veuillez ouvrir un problème Github et utiliser le ? [abctl] Report an issue with the abctl tool .
Installer, go
Via infusion
brew install go
Via go.dev
Ce référentiel utilise un Makefile, encapsulant les commandes go traditionnelles utilisées pour le formatage, la vérification, la création et le test du code go .
Les commandes make suivantes sont prises en charge :
| nom | description |
|---|---|
make build | Construit le binaire abctl , en le plaçant dans le répertoire build . |
make clean | Supprime le répertoire build . |
make fmt | Formate le code. |
make test | Exécute tous les tests. |
make vet | Exécute la commande vet. |
