Installer et configurer octl

Vous pouvez gérer vos ressources du Cloud OUTSCALE avec octl, la principale interface en ligne de commande (CLI) développée par 3DS OUTSCALE.

octl la première CLI compatible à la fois avec :

L’API OUTSCALE, pour gérer les ressources IaaS
L’API OOS, pour gérer les ressources de stockage objet
L’API OKS, pour gérer les ressources Kubernetes

Pour une description complète de toutes les fonctionnalités avancées, voir le dépôt GitHub d’octl.

Installer octl

Installer octl sur Linux

Téléchargez le dernier fichier binaire :

$ curl -L -o octl https://github.com/outscale/octl/releases/latest/download/octl_Linux_x86_64

Rendez le fichier exécutable :
```
$ chmod +x octl
```
Déplacez le fichier dans votre répertoire usr/local/bin :
```
$ sudo mv octl /usr/local/bin
```

Installer octl sur macOS

Avant de commencer : Installez Homebrew sur votre machine.

Ajoutez le tap de 3DS OUTSCALE sur votre machine :
```
$ brew tap outscale/tap
```
Installez octl comme suit :
```
$ brew install outscale/tap/octl
```

Installer octl sur Windows

Téléchargez le dernier fichier octl_Windows_x86_64.exe, que vous pouvez lancer directement comme exécutable.
(optionnel) Pour pouvoir lancer octl depuis n’importe quel emplacement, vous pouvez ajouter le répertoire contenant octl à la variable d’environnement Path de votre système. Par exemple, tapez les commandes suivantes dans l’invite de commandes de Windows :
1. Déplacez l’exécutable dans un répertoire distinct :
  mkdir octl move octl_Windows_x86_64.exe octl\octl.exe
2. Ajoutez le répertoire à votre Path pour la session courante (commande set) et les futures sessions (commande setx) :
  set Path=%Path%;C:\Users\Administrator\Desktop\octl setx Path %Path%;C:\Users\Administrator\Desktop\octl
3. Vérifiez l’installation :
  octl --version

Configurer octl

Mettre en place l’autocomplétion

Voir docs/installation.md dans le dépôt GitHub.

S’authentifier

Vous pouvez configurer votre profil d’authentification soit via des variables d’environnement :

OSC_ACCESS_KEY : L’ID d’access key de votre compte OUTSCALE. Pour en savoir plus, voir Créer une access key.
OSC_SECRET_KEY : La secret key correspondante de votre compte OUTSCALE.
OSC_REGION : La Région de votre compte OUTSCALE (par exemple, eu-west-2).

Ou soit en créant le fichier ~/.osc/config.json :

{
  "default": {
    "access_key": "XXXX",
    "secret_key": "YYYY",
    "region": "eu-west-2"
  }
}

Vous pouvez éditer ce fichier via un éditeur de texte ou directement avec la commande octl profile. Par exemple, la commande suivante créera un profil nommé default (elle créera le fichier s’il n’existe pas déjà) :

$ octl profile add default --ak XXXX --sk YYYY --region eu-west-2

Pour en savoir plus sur l’authentification et pour gérer plusieurs profils, voir docs/configuration.md dans le dépôt GitHub.

Utiliser octl

octl fournit deux syntaxes différentes pour interagir avec vos ressources :

Une syntaxe spécifique à octl pour des commandes de haut niveau, sous la forme octl <service> <entity> list/describe/create/update/delete …, avec des valeurs par défaut prédéfinies et des raccourcis :
Exemples de requêtes
```
$ octl iaas volume list

$ octl iaas vol ls
```
Ces commandes de haut niveau sont actuellement documentées dans le dossier docs/reference du dépôt GitHub.
Un syntaxe brute qui se calque directement sur les opérations API et les paramètres de requêtes API, sous la forme octl <service> api <OperationName> … :
Exemple de requête
```
$ octl iaas api ReadVms --Filters.VmStateNames running
```
Des exemples de code dans cette syntaxe brute figurent dans la documentation de l’API OUTSCALE et la documentation de l’API OKS, pour toutes les opérations API possibles.

Vous pouvez aussi utiliser l’option --help pour consulter l’aide de chaque commande et sous-commande. Pour une description complète de toutes les fonctionnalités avancées, voir le dépôt GitHub d’octl.

Page connexe

Dépôt GitHub d’octl