Installer et configurer OKS CLI

Vous pouvez gérer vos ressources sur OUTSCALE Kubernetes as a Service (OKS) avec OKS CLI, une interface en ligne de commande (CLI) développée par 3DS OUTSCALE.

Assurez-vous d’utiliser la dernière version d’OKS CLI disponible. Consultez le dépôt pour voir toutes les versions disponibles.

Pour en savoir plus sur les versions de Kubernetes supportées, voir À propos d’OKS > Support de versions Kubernetes.

Installer OKS CLI

Installer OKS CLI sur Linux

Avant de commencer : Assurez-vous que Python 3.11, ou ultérieur, et pip sont installés sur votre machine.

  1. (optionnel) Il est recommandé d’installer OKS CLI et ses dépendances dans un environnement virtuel Python (virtualenv) plutôt que directement sur votre système. Pour créer un virtualenv, lancez les commandes suivantes :

    $ python3 -m venv .venv
$ source .venv/bin/activate

  2. Pour installer OKS CLI depuis le paquet pip, lancez la commande suivante :

    $ pip install https://docs.eu-west-2.oks.outscale.com/oks-cli/oks_cli-latest.zip

    Pour quitter le virtualenv, tapez deactivate dans votre terminal.

Installer OKS CLI sur macOS

Avant de commencer : Assurez-vous que Python 3.11, ou ultérieur, et pip sont installés sur votre machine.

  1. (optionnel) Il est recommandé d’installer OKS CLI et ses dépendances dans un environnement virtuel Python (virtualenv) plutôt que directement sur votre système. Pour créer un virtualenv, lancez les commandes suivantes :

    $ python3 -m venv .venv
$ source .venv/bin/activate

  2. Pour installer OKS CLI depuis le paquet pip, lancez la commande suivante :

    $ pip install https://docs.eu-west-2.oks.outscale.com/oks-cli/oks_cli-latest.zip

    Pour quitter le virtualenv, tapez deactivate dans votre terminal.

Installer OKS CLI sur Windows

  1. Installez Python 3.11 sur votre machine :

    1. Téléchargez et lancez l’https://www.python.org/downloads/[installateur Python le plus récent].

    2. Cochez la case Add Python 3.11 to PATH.

    3. Cliquez sur Install Now.

    4. Cliquez sur Disable path length limit.

  2. Dans une invite de commande, tapez la commande suivante :

    $ pip install --upgrade pip
$ pip install https://docs.eu-west-2.oks.outscale.com/oks-cli/oks_cli-latest.zip

    OKS CLI est installé.

Installer kubectl

Bien qu’OKS CLI fournisse les commandes nécessaires pour la création et la gestion du Control Plane et des worker nodes du cluster, nous vous recommandons d’installer un outil kubectl (ou tout autre outil compatible) pour votre OS afin de gérer les charges de travail de votre cluster.

Configurer OKS CLI

Activer l’autocomplétion

OKS CLI supporte l’autocomplétion pour les commandes non dynamiques, les sous-commandes, et les paramètres.

Activer l’autocomplétion dans Bash

  1. Générez le fichier d’autocomplétion avec la commande suivante :

    $ _OKS_CLI_COMPLETE=bash_source oks-cli > $HOME/.oks_cli/completions/oks-cli.bash

  2. Sourcez le fichier et assignez-le au sourçage automatique pour les sessions futures :

    $ . $HOME/.oks_cli/completions/oks-cli.bash
$ echo '. $HOME/.oks_cli/completions/oks-cli.bash' >> $HOME/.bashrc

Activer l’autocomplétion dans Zsh

  1. Générez le fichier d’autocomplétion avec la commande suivante :

    $ _OKS_CLI_COMPLETE=zsh_source oks-cli > $HOME/.oks_cli/completions/oks-cli.zsh

  2. Sourcez le fichier et assignez-le au sourçage automatique pour les sessions futures :

    $ . $HOME/.oks_cli/completions/oks-cli.zsh
$ echo '. $HOME/.oks_cli/completions/oks-cli.zsh' >> $HOME/.zsh_source

    Vous pouvez aussi générer le fichier et le placer dans tout catalogue listé dans le résultat de echo $fpath.

Activer l’autocomplétion dans Fish

Générez le fichier d’autocomplétion avec la commande suivante, plaçant le fichier sortant dans le dossier /completions/ de fish :

$ _OKS_CLI_COMPLETE=fish_source oks-cli > $HOME/.config/fish/completions/oks-cli.fish

Paramétrer votre premier profil

Vous devez ajouter au moins un profil OUTSCALE pour utiliser OKS CLI. Pour en savoir plus, voir Gérer vos profils avec OKS CLI.

Utiliser OKS CLI

Pour envoyer une requête avec OKS CLI, vous devez spécifier :

  • La commande que vous souhaitez utiliser,

  • La sous-commande à exécuter,

  • Toute autre option requise par la commande.

Vous pouvez exécuter des commandes dans deux périmètres : project et cluster. De plus, le périmètre profile vous permet de lister et gérer des comptes OUTSCALE dans le fichier $HOME/.oks_cli/config.json.

Pour voir toutes les options disponibles, lancez la commande fullhelp.

$ oks-cli fullhelp

Pour créer votre premier cluster, lancez la commande suivante (où xx.xx.xx.xx est l’IP dont vous souhaitez autoriser l’accès à la gestion du cluster) :

$ oks-cli cluster create \
    --cluster-name NAME_OF_CLUSTER \
    --admin "xx.xx.xx.xx/32"

OKS CLI vérifiera tous les prérequis and vous guidera tout au long du processus de configuration jusqu’à ce que votre cluster soit prêt à être utilisé.

Vous pouvez aussi ajouter à OKS CLI les profils appropriés à la main. Pour en savoir plus, voir Gérer vos profils avec OKS CLI.

Exporter en PDF