Rechercher
SupportConsoleDéveloppeursCommencer un essaiContact

Chapitre 2. OpenShift CLI (oc)

download PDF

2.1. Démarrer avec le CLI d'OpenShift

2.1.1. À propos de la CLI d'OpenShift

Avec l'interface de ligne de commande (CLI) OpenShift, la commande oc, vous pouvez créer des applications et gérer des projets OpenShift Container Platform à partir d'un terminal. L'interface de ligne de commande OpenShift est idéale dans les situations suivantes :

  • Travailler directement avec le code source du projet
  • Scripting des opérations de OpenShift Container Platform
  • Gérer des projets lorsque les ressources en bande passante sont limitées et que la console web n'est pas disponible

2.1.2. Installation du CLI OpenShift

Vous pouvez installer l'OpenShift CLI (oc) soit en téléchargeant le binaire, soit en utilisant un RPM.

2.1.2.1. Installer le CLI OpenShift en téléchargeant le binaire

Vous pouvez installer l'OpenShift CLI (oc) pour interagir avec OpenShift Container Platform à partir d'une interface de ligne de commande. Vous pouvez installer oc sur Linux, Windows ou macOS.

Important

Si vous avez installé une version antérieure de oc, vous ne pouvez pas l'utiliser pour exécuter toutes les commandes dans OpenShift Container Platform 4.12. Téléchargez et installez la nouvelle version de oc.

Installation de la CLI OpenShift sur Linux

Vous pouvez installer le binaire OpenShift CLI (oc) sur Linux en utilisant la procédure suivante.

Procédure

  1. Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
  2. Sélectionnez l'architecture dans la liste déroulante Product Variant.
  3. Sélectionnez la version appropriée dans la liste déroulante Version.
  4. Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 Linux Client et enregistrez le fichier.

  5. Décompressez l'archive : 

    tar xvf <file>

  6. Placez le fichier binaire oc dans un répertoire situé sur votre site PATH.

    Pour vérifier votre PATH, exécutez la commande suivante : 

    $ echo $PATH

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

oc <command>
Installation de la CLI OpenShift sur Windows

Vous pouvez installer le binaire OpenShift CLI (oc) sur Windows en utilisant la procédure suivante.

Procédure

  1. Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
  2. Sélectionnez la version appropriée dans la liste déroulante Version.
  3. Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 Windows Client et enregistrez le fichier.
  4. Décompressez l'archive à l'aide d'un programme ZIP.

  5. Déplacez le fichier binaire oc dans un répertoire situé sur votre site PATH.

    Pour vérifier votre PATH, ouvrez l'invite de commande et exécutez la commande suivante : 

    C:\N> path

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

C:\N> oc <command>
Installation de la CLI OpenShift sur macOS

Vous pouvez installer le binaire OpenShift CLI (oc) sur macOS en utilisant la procédure suivante.

Procédure

  1. Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
  2. Sélectionnez la version appropriée dans la liste déroulante Version.

  3. Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 macOS Client et enregistrez le fichier.

    Note

    Pour macOS arm64, choisissez l'entrée OpenShift v4.12 macOS arm64 Client.

  4. Décompressez l'archive.

  5. Déplacez le binaire oc dans un répertoire de votre PATH.

    Pour vérifier votre PATH, ouvrez un terminal et exécutez la commande suivante : 

    $ echo $PATH

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

oc <command>

2.1.2.2. Installer le CLI OpenShift en utilisant la console web

Vous pouvez installer l'OpenShift CLI (oc) pour interagir avec OpenShift Container Platform à partir d'une console web. Vous pouvez installer oc sur Linux, Windows ou macOS.

Important

Si vous avez installé une version antérieure de oc, vous ne pouvez pas l'utiliser pour exécuter toutes les commandes dans OpenShift Container Platform 4.12. Téléchargez et installez la nouvelle version de oc.

2.1.2.2.1. Installer le CLI OpenShift sur Linux à l'aide de la console web

Vous pouvez installer le binaire OpenShift CLI (oc) sur Linux en utilisant la procédure suivante.

Procédure

  1. Dans la console web, cliquez sur ?.

    click question mark

  2. Cliquez sur Command Line Tools.

    CLI list
  3. Sélectionnez le binaire oc approprié pour votre plate-forme Linux, puis cliquez sur Download oc for Linux.
  4. Enregistrer le fichier.

  5. Décompressez l'archive. 

    tar xvf <file>

  6. Déplacez le fichier binaire oc dans un répertoire situé sur votre site PATH.

    Pour vérifier votre PATH, exécutez la commande suivante : 

    $ echo $PATH

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

oc <command>
2.1.2.2.2. Installer le CLI OpenShift sur Windows à l'aide de la console web

Vous pouvez installer le binaire OpenShift CLI (oc) sur Windows en utilisant la procédure suivante.

Procédure

  1. Dans la console web, cliquez sur ?.

    click question mark

  2. Cliquez sur Command Line Tools.

    CLI list
  3. Sélectionnez le binaire oc pour la plate-forme Windows, puis cliquez sur Download oc for Windows for x86_64.
  4. Enregistrer le fichier.
  5. Décompressez l'archive à l'aide d'un programme ZIP.

  6. Déplacez le fichier binaire oc dans un répertoire situé sur votre site PATH.

    Pour vérifier votre PATH, ouvrez l'invite de commande et exécutez la commande suivante : 

    C:\N> path

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

C:\N> oc <command>
2.1.2.2.3. Installer la CLI OpenShift sur macOS à l'aide de la console web

Vous pouvez installer le binaire OpenShift CLI (oc) sur macOS en utilisant la procédure suivante.

Procédure

  1. Dans la console web, cliquez sur ?.

    click question mark

  2. Cliquez sur Command Line Tools.

    CLI list

  3. Sélectionnez le binaire oc pour la plate-forme macOS, puis cliquez sur Download oc for Mac for x86_64.

    Note

    Pour macOS arm64, cliquez sur Download oc for Mac for ARM 64.

  4. Enregistrer le fichier.
  5. Décompressez l'archive.

  6. Déplacez le binaire oc dans un répertoire de votre PATH.

    Pour vérifier votre PATH, ouvrez un terminal et exécutez la commande suivante : 

    $ echo $PATH

Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc: 

oc <command>

2.1.2.3. Installer le CLI OpenShift à l'aide d'un RPM

Pour Red Hat Enterprise Linux (RHEL), vous pouvez installer l'OpenShift CLI (oc) sous forme de RPM si vous avez un abonnement actif à OpenShift Container Platform sur votre compte Red Hat.

Conditions préalables

  • Doit avoir les privilèges root ou sudo.

Procédure

  1. S'inscrire auprès du gestionnaire d'abonnements Red Hat : 

    # subscription-manager register

  2. Extraire les données d'abonnement les plus récentes : 

    # subscription-manager refresh

  3. Liste des abonnements disponibles : 

    # subscription-manager list --available --matches '*OpenShift*'

  4. Dans la sortie de la commande précédente, trouvez l'ID du pool pour un abonnement OpenShift Container Platform et attachez l'abonnement au système enregistré : 

    # subscription-manager attach --pool=<pool_id>

  5. Activer les dépôts requis par OpenShift Container Platform 4.12. 

    # subscription-manager repos --enable="rhocp-4.12-for-rhel-8-x86_64-rpms"
    Note

    Il n'est pas possible d'installer l'OpenShift CLI (oc) en tant que RPM pour Red Hat Enterprise Linux (RHEL) 9. Vous devez installer OpenShift CLI pour RHEL 9 en téléchargeant le binaire.

  6. Installez le paquetage openshift-clients: 

    # yum install openshift-clients

Une fois installé, le CLI est disponible à l'aide de la commande oc: 

oc <command>

2.1.2.4. Installer le CLI OpenShift en utilisant Homebrew

Pour macOS, vous pouvez installer l'OpenShift CLI (oc) en utilisant le gestionnaire de paquets Homebrew.

Conditions préalables

  • Vous devez avoir installé Homebrew (brew).

Procédure

  • Exécutez la commande suivante pour installer le paquet openshift-cli: 

    $ brew install openshift-cli

2.1.3. Se connecter à l'interface de commande OpenShift

Vous pouvez vous connecter à l'OpenShift CLI (oc) pour accéder et gérer votre cluster.

Conditions préalables

  • Vous devez avoir accès à un cluster OpenShift Container Platform.
  • Vous devez avoir installé l'OpenShift CLI (oc).
Note

Pour accéder à un cluster qui n'est accessible que via un serveur proxy HTTP, vous pouvez définir les variables HTTP_PROXY, HTTPS_PROXY et NO_PROXY. Ces variables d'environnement sont respectées par le CLI oc de sorte que toutes les communications avec le cluster passent par le proxy HTTP.

Les en-têtes d'authentification ne sont envoyés que lors de l'utilisation du transport HTTPS.

Procédure

  1. Entrez la commande oc login et indiquez un nom d'utilisateur : 

    $ oc login -u user1

  2. Lorsque vous y êtes invité, saisissez les informations requises :

    Exemple de sortie

    Server [https://localhost:8443]: https://openshift.example.com:6443 1
The server uses a certificate signed by an unknown authority.
You can bypass the certificate check, but any data you send to the server could be intercepted by others.
Use insecure connections? (y/n): y 2

Authentication required for https://openshift.example.com:6443 (openshift)
Username: user1
Password: 3
Login successful.

You don't have any projects. You can try to create a new project, by running

    oc new-project <projectname>

Welcome! See 'oc help' to get started.

    1
    Saisissez l'URL du serveur OpenShift Container Platform.
    2
    Indiquez si vous souhaitez utiliser des connexions non sécurisées.
    3
    Entrez le mot de passe de l'utilisateur.
Note

Si vous êtes connecté à la console Web, vous pouvez générer une commande oc login qui inclut votre jeton et les informations relatives au serveur. Vous pouvez utiliser cette commande pour vous connecter à la CLI d'OpenShift Container Platform sans les invites interactives. Pour générer la commande, sélectionnez Copy login command dans le menu déroulant du nom d'utilisateur en haut à droite de la console Web.

Vous pouvez maintenant créer un projet ou lancer d'autres commandes pour gérer votre cluster.

2.1.4. Utiliser le CLI d'OpenShift

Les sections suivantes expliquent comment effectuer des tâches courantes à l'aide de l'interface CLI.

2.1.4.1. Création d'un projet

Utilisez la commande oc new-project pour créer un nouveau projet. 

$ oc new-project my-project

Exemple de sortie

Now using project "my-project" on server "https://openshift.example.com:6443".

2.1.4.2. Créer une nouvelle application

Utilisez la commande oc new-app pour créer une nouvelle application. 

$ oc new-app https://github.com/sclorg/cakephp-ex

Exemple de sortie

--> Found image 40de956 (9 days old) in imagestream "openshift/php" under tag "7.2" for "php"

...

    Run 'oc status' to view your app.

2.1.4.3. Visualisation des nacelles

La commande oc get pods permet de visualiser les pods du projet en cours.

Note

Lorsque vous exécutez oc à l'intérieur d'un pod et que vous ne spécifiez pas d'espace de noms, l'espace de noms du pod est utilisé par défaut. 

$ oc get pods -o wide

Exemple de sortie

NAME                  READY   STATUS      RESTARTS   AGE     IP            NODE                           NOMINATED NODE
cakephp-ex-1-build    0/1     Completed   0          5m45s   10.131.0.10   ip-10-0-141-74.ec2.internal    <none>
cakephp-ex-1-deploy   0/1     Completed   0          3m44s   10.129.2.9    ip-10-0-147-65.ec2.internal    <none>
cakephp-ex-1-ktz97    1/1     Running     0          3m33s   10.128.2.11   ip-10-0-168-105.ec2.internal   <none>

2.1.4.4. Visualisation des journaux de pods

Utilisez la commande oc logs pour afficher les journaux d'un module particulier. 

$ oc logs cakephp-ex-1-deploy

Exemple de sortie

--> Scaling cakephp-ex-1 to 1
--> Success

2.1.4.5. Visualisation du projet en cours

La commande oc project permet de visualiser le projet en cours. 

$ oc project

Exemple de sortie

Using project "my-project" on server "https://openshift.example.com:6443".

2.1.4.6. Visualisation de l'état du projet en cours

La commande oc status permet d'afficher des informations sur le projet en cours, telles que les services, les déploiements et les configurations de construction. 

$ oc status

Exemple de sortie

In project my-project on server https://openshift.example.com:6443

svc/cakephp-ex - 172.30.236.80 ports 8080, 8443
  dc/cakephp-ex deploys istag/cakephp-ex:latest <-
    bc/cakephp-ex source builds https://github.com/sclorg/cakephp-ex on openshift/php:7.2
    deployment #1 deployed 2 minutes ago - 1 pod

3 infos identified, use 'oc status --suggest' to see details.

2.1.4.7. Liste des ressources API prises en charge

Utilisez la commande oc api-resources pour afficher la liste des ressources API prises en charge sur le serveur. 

$ oc api-resources

Exemple de sortie

NAME                                  SHORTNAMES       APIGROUP                              NAMESPACED   KIND
bindings                                                                                     true         Binding
componentstatuses                     cs                                                     false        ComponentStatus
configmaps                            cm                                                     true         ConfigMap
...

2.1.5. Obtenir de l'aide

Vous pouvez obtenir de l'aide sur les commandes CLI et les ressources OpenShift Container Platform de la manière suivante.

  • Utilisez oc help pour obtenir une liste et une description de toutes les commandes CLI disponibles :

    Exemple : Obtenir de l'aide générale pour le CLI

    $ oc help

    Exemple de sortie

    OpenShift Client

This client helps you develop, build, deploy, and run your applications on any OpenShift or Kubernetes compatible
platform. It also includes the administrative commands for managing a cluster under the 'adm' subcommand.

Usage:
  oc [flags]

Basic Commands:
  login           Log in to a server
  new-project     Request a new project
  new-app         Create a new application

...

  • Utilisez l'option --help pour obtenir de l'aide sur une commande CLI spécifique :

    Exemple : Obtenir de l'aide pour la commande oc create 

    $ oc create --help

    Exemple de sortie

    Create a resource by filename or stdin

JSON and YAML formats are accepted.

Usage:
  oc create -f FILENAME [flags]

...

  • Utilisez la commande oc explain pour afficher la description et les champs d'une ressource particulière :

    Exemple : Consulter la documentation de la ressource Pod 

    $ oc explain pods

    Exemple de sortie

    KIND:     Pod
VERSION:  v1

DESCRIPTION:
     Pod is a collection of containers that can run on a host. This resource is
     created by clients and scheduled onto hosts.

FIELDS:
   apiVersion	<string>
     APIVersion defines the versioned schema of this representation of an
     object. Servers should convert recognized schemas to the latest internal
     value, and may reject unrecognized values. More info:
     https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

...

2.1.6. Se déconnecter de l'interface de commande OpenShift

Vous pouvez vous déconnecter de l'OpenShift CLI pour mettre fin à votre session en cours.

  • Utilisez la commande oc logout. 

    $ oc logout

    Exemple de sortie

    Logged "user1" out on "https://openshift.example.com"

Cette opération supprime le jeton d'authentification enregistré sur le serveur et le supprime de votre fichier de configuration.

Red Hat logoGithubRedditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez leBlog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

© 2024 Red Hat, Inc.