Skip to content

Latest commit

 

History

History
148 lines (100 loc) · 3.25 KB

File metadata and controls

148 lines (100 loc) · 3.25 KB

Utilisation du client en ligne de commande

factory CLI est une application compilée, sans dépendance, disponible pour différents OS.

Ce client permet d’intérragir avec les projets déployés sur votre usine logiciel factory.

Pré requis

L’utilisation du client requiert:

  • un agent ssh (reportez vous à la documentation de ssh-agent) gérant une clé ssh dont la clé publique a été uploader sur votre compte utilisateur gitlab. Voir la documentation gitlab pour plus d’information sur ce point.

  • un token gitlab avec, à minima, les scopes api et read_registry.

  • de lancer la commande depuis un projet git hébergé sur gitlab. Ainsi certain paramètre sont déduis de votre .git (url du gitlab et non du projet)

Options communes

Obtenir de l’aide, utilisez l’option -h

$ factory -h

Vous pouvez obtenir l’aide d’une commande de la même manière:

$ factory container -h
$ factory container exec -h

L’option -t vous permet de passer votre token gitlab:

$ factory -t votre_token ...

Vous pouvez aussi le définir dans l’environnement de votre shell pour ne pas avoir à le repasser à chaque commande:

$ export PRIVATE_TOKEN=votre_token
$ factory ...

Enfin, vous pouvez le stocker dans un fichier de configuration:

$ echo "token: votre_token" > $HOME/.factory-cli.yaml

La plupart des commandes sont liées à un environnement (staging/production/etc.) L’option -e staging indique que la commande agira sur l’environnement de staging.

$ factory container exec myapp -e staging

Afficher les informations du projet

Afficher les informations du projet courant:

$ factory infos

Afficher aussi la liste des environnements du projet courant:

$ factory infos --with-environments
$ factory infos -e

Copier des fichiers

Un serveur sftp est à votre disposition.

Vous pouvez l’utiliser en mode interractif:

$ factory volume -e staging sftp

Ou en mode non interractif, en passant vos commandes via l’entrée standard (STDIN).

Pousser un fichier:

$ echo "put test ./data/volume/test" | factory volume -e staging sftp

Récupérer un fichier:

$ echo "get ./data/volume/test test" | factory volume -e staging sftp

Executer une commande au sein d’un conteneur

factory exec vous permets de lancer une commande au sein des conteneurs de vôtre projet.

Bash est la commande par défaut:

$ factory container exec -e staging web

Mais vous pouvez en spécifier une:

$ factory container exec -e staging web -- ls -l

-- est utilisé pour passer les arguments au shell et non à factory exec.

Récupérer un dump de base de donnée

La commande factory dump vous permets de récupérer un dump de base de données:

$ factory container dump -e staging mysql

Le fichier est récupéré en local sous forme d’archive.