Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Chapitre 2. CLI OpenShift (oc)

2.1. Débuter avec l’OpenShift CLI
Copier lien

2.1.1. À propos de l’OpenShift CLI
Copier lien

Avec OpenShift CLI (oc), vous pouvez créer des applications et gérer les projets Red Hat OpenShift sur AWS (ROSA) à partir d’un terminal. L’OpenShift CLI est idéal dans les situations suivantes:

  • En travaillant directement avec le code source du projet
  • Script des opérations ROSA
  • Gérer des projets tout en étant limité par les ressources de bande passante et la console Web est indisponible

2.1.2. Installation de l’OpenShift CLI
Copier lien

Il est possible d’installer l’OpenShift CLI (oc) en téléchargeant le binaire ou en utilisant un RPM.

2.1.2.1. Installation de l’OpenShift CLI
Copier lien

Il est possible d’installer OpenShift CLI (oc) pour interagir avec ROSA à partir d’une interface de ligne de commande. Il est possible d’installer oc sous Linux, Windows ou macOS.

Important

Lorsque vous avez installé une version antérieure d’oc, vous ne pouvez pas l’utiliser pour compléter toutes les commandes dans ROSA. Installez et téléchargez la nouvelle version d’oc.

Installation du CLI OpenShift sur Linux

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Linux.

Procédure

  1. Accédez au service OpenShift Red Hat sur la page de téléchargement d’AWS sur le portail client Red Hat.
  2. Choisissez l’architecture dans la liste déroulante Variante de produit.
  3. Choisissez la version appropriée dans la liste déroulante Version.
  4. Cliquez sur Télécharger maintenant à côté de l’entrée OpenShift v4 Linux Clients et enregistrez le fichier.

  5. Décompressez l’archive: 

    $ tar xvf <file>
    Copy to Clipboard Toggle word wrap

  6. Déposez le binaire oc dans un répertoire qui est sur votre PATH.

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

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

La vérification

  • Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc: 

    $ oc <command>
    Copy to Clipboard Toggle word wrap
Installation du CLI OpenShift sur Windows

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Windows.

Procédure

  1. Accédez au service OpenShift Red Hat sur la page de téléchargement d’AWS sur le portail client Red Hat.
  2. Choisissez la version appropriée dans la liste déroulante Version.
  3. Cliquez sur Télécharger maintenant à côté de l’entrée client Windows OpenShift v4 et enregistrez le fichier.
  4. Décompressez l’archive avec un programme ZIP.

  5. Déplacez le binaire oc vers un répertoire qui est sur votre PATH.

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

    C:\> path
    Copy to Clipboard Toggle word wrap

La vérification

  • Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc: 

    C:\> oc <command>
    Copy to Clipboard Toggle word wrap
Installation de l’OpenShift CLI sur macOS

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur macOS.

Procédure

  1. Accédez au service OpenShift Red Hat sur la page de téléchargement d’AWS sur le portail client Red Hat.
  2. Choisissez la version appropriée dans la liste déroulante Version.

  3. Cliquez sur Télécharger maintenant à côté de l’entrée OpenShift v4 macOS Clients et enregistrez le fichier.

    Note

    Dans le cas de macOS arm64, choisissez l’entrée client OpenShift v4 macOS arm64.

  4. Décompressez et décompressez l’archive.

  5. Déplacez le binaire oc vers un répertoire sur votre PATH.

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

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

La vérification

  • Contrôlez votre installation à l’aide d’une commande oc: 

    $ oc <command>
    Copy to Clipboard Toggle word wrap

Il est possible d’installer OpenShift CLI (oc) pour interagir avec Red Hat OpenShift Service sur AWS (ROSA) à partir d’une console Web. Il est possible d’installer oc sous Linux, Windows ou macOS.

Important

Lorsque vous avez installé une version antérieure d’oc, vous ne pouvez pas l’utiliser pour compléter toutes les commandes dans ROSA. Installez et téléchargez la nouvelle version d’oc.

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Linux.

Procédure

  1. Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.

  2. Extrayez le fichier binaire oc de l’archive téléchargée. 

    $ tar xvf <file>
    Copy to Clipboard Toggle word wrap

  3. Déplacez le binaire oc vers un répertoire qui est sur votre PATH.

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

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc: 

$ oc <command>
Copy to Clipboard Toggle word wrap

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Windows.

Procédure

  1. Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
  2. Extrayez le fichier binaire oc de l’archive téléchargée.

  3. Déplacez le binaire oc vers un répertoire qui est sur votre PATH.

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

    C:\> path
    Copy to Clipboard Toggle word wrap

Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc: 

C:\> oc <command>
Copy to Clipboard Toggle word wrap

En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur macOS.

Procédure

  1. Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
  2. Extrayez le fichier binaire oc de l’archive téléchargée.

  3. Déplacez le binaire oc vers un répertoire sur votre PATH.

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

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc: 

$ oc <command>
Copy to Clipboard Toggle word wrap

2.1.2.3. Installation du CLI OpenShift à l’aide d’un RPM
Copier lien

Dans Red Hat Enterprise Linux (RHEL), vous pouvez installer l’OpenShift CLI (oc) en tant que RPM si vous avez un abonnement Red Hat OpenShift sur AWS (ROSA) actif sur votre compte Red Hat.

Important

Il faut installer oc pour RHEL 9 en téléchargeant le binaire. L’installation d’oc à l’aide d’un paquet RPM n’est pas prise en charge sur Red Hat Enterprise Linux (RHEL) 9.

Conditions préalables

  • Doit avoir des privilèges racine ou sudo.

Procédure

  1. Inscrivez-vous avec Red Hat Subscription Manager: 

    # subscription-manager register
    Copy to Clipboard Toggle word wrap

  2. Retirez les dernières données d’abonnement: 

    # subscription-manager refresh
    Copy to Clipboard Toggle word wrap

  3. Liste des abonnements disponibles: 

    # subscription-manager list --available --matches '*OpenShift*'
    Copy to Clipboard Toggle word wrap

  4. Dans la sortie de la commande précédente, trouvez l’identifiant de pool pour un abonnement ROSA et joindre l’abonnement au système enregistré: 

    # subscription-manager attach --pool=<pool_id>
    Copy to Clipboard Toggle word wrap

  5. Activer les référentiels requis par ROSA. 

    # subscription-manager repos --enable="rhocp-4-for-rhel-8-x86_64-rpms"
    Copy to Clipboard Toggle word wrap

  6. Installez le package openshift-clients: 

    # yum install openshift-clients
    Copy to Clipboard Toggle word wrap

La vérification

  • Contrôlez votre installation à l’aide d’une commande oc: 
$ oc <command>
Copy to Clipboard Toggle word wrap

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

Conditions préalables

  • Homebrew (brew) doit être installé.

Procédure

  • Installez le package openshift-cli en exécutant la commande suivante: 

    $ brew install openshift-cli
    Copy to Clipboard Toggle word wrap

La vérification

  • Contrôlez votre installation à l’aide d’une commande oc: 
$ oc <command>
Copy to Clipboard Toggle word wrap

2.1.3. Connexion à l’OpenShift CLI
Copier lien

Connectez-vous à OpenShift CLI (oc) pour accéder et gérer votre cluster.

Conditions préalables

  • Il faut avoir accès à un cluster ROSA.
  • L’OpenShift CLI (oc) est installé.
Note

Afin d’accéder à un cluster accessible uniquement sur 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 afin que toute communication avec le cluster passe par le proxy HTTP.

Les en-têtes d’authentification ne sont envoyés que lorsque vous utilisez le transport HTTPS.

Procédure

  1. Entrez la commande oc login et passez dans un nom d’utilisateur: 

    $ oc login -u user1
    Copy to Clipboard Toggle word wrap

  2. Lorsque vous l’invitez, entrez 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.
    Copy to Clipboard Toggle word wrap

    1
    Entrez l’URL du serveur ROSA.
    2
    Entrez s’il faut utiliser des connexions non sécurisées.
    3
    Entrez le mot de passe de l’utilisateur.
Note

Lorsque vous êtes connecté à la console Web, vous pouvez générer une commande de connexion oc qui inclut vos informations de jeton et de serveur. La commande vous permet de vous connecter à OpenShift CLI sans les instructions interactives. Afin de générer la commande, sélectionnez Copier la commande de connexion dans le menu déroulant du nom d’utilisateur en haut à droite de la console Web.

Il est maintenant possible de créer un projet ou d’émettre d’autres commandes pour la gestion de votre cluster.

Connectez-vous à OpenShift CLI (oc) à l’aide d’un navigateur Web pour accéder et gérer votre cluster. Cela permet aux utilisateurs d’éviter d’insérer leur jeton d’accès dans la ligne de commande.

Avertissement

La connexion au CLI via le navigateur Web exécute un serveur sur localhost avec HTTP, et non HTTPS; utilisez avec prudence sur les stations de travail multi-utilisateurs.

Conditions préalables

  • Il faut avoir accès à un service Red Hat OpenShift sur AWS cluster.
  • Il faut avoir installé l’OpenShift CLI (oc).
  • Il faut installer un navigateur.

Procédure

  1. Entrez la commande de connexion oc avec le drapeau --web: 

    $ oc login <cluster_url> --web
    1
    Copy to Clipboard Toggle word wrap
    1
    En option, vous pouvez spécifier l’URL du serveur et le port de rappel. A titre d’exemple, oc login &lt;cluster_url&gt; --web --callback-port 8280 localhost:8443.

  2. Le navigateur web s’ouvre automatiquement. Dans le cas contraire, cliquez sur le lien dans la sortie de commande. Dans le cas où vous ne spécifiez pas le service Red Hat OpenShift sur AWS Server oc, vous essayez d’ouvrir la console Web du cluster spécifié dans le fichier de configuration oc actuel. En l’absence de configuration d’oc, oc invite de manière interactive l’URL du serveur.

    Exemple de sortie

    Opening login URL in the default browser: https://openshift.example.com
Opening in existing browser session.
    Copy to Clipboard Toggle word wrap

  3. Lorsque plus d’un fournisseur d’identité est disponible, sélectionnez votre choix parmi les options fournies.
  4. Entrez votre nom d’utilisateur et votre mot de passe dans les champs de navigateur correspondants. Après avoir été connecté, le navigateur affiche le jeton d’accès texte reçu avec succès; s’il vous plaît revenir à votre terminal.

  5. Consultez le CLI pour une confirmation de connexion.

    Exemple de sortie

    Login successful.

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

    oc new-project <projectname>
    Copy to Clipboard Toggle word wrap

Note

La console Web par défaut au profil utilisé lors de la session précédente. Afin de basculer entre les profils Administrateur et Développeur, déconnectez-vous du Service OpenShift Red Hat sur la console web AWS et effacez le cache.

Il est maintenant possible de créer un projet ou d’émettre d’autres commandes pour la gestion de votre cluster.

2.1.5. À l’aide de l’OpenShift CLI
Copier lien

Examinez les sections suivantes pour apprendre à accomplir des tâches communes à l’aide de l’ICC.

2.1.5.1. Créer un projet
Copier lien

La commande oc new-project permet de créer un nouveau projet. 

$ oc new-project my-project
Copy to Clipboard Toggle word wrap

Exemple de sortie

Now using project "my-project" on server "https://openshift.example.com:6443".
Copy to Clipboard Toggle word wrap

2.1.5.2. Créer une nouvelle application
Copier lien

La commande oc new-app permet de créer une nouvelle application. 

$ oc new-app https://github.com/sclorg/cakephp-ex
Copy to Clipboard Toggle word wrap

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.
Copy to Clipboard Toggle word wrap

2.1.5.3. Affichage des gousses
Copier lien

La commande oc get pods permet d’afficher les pods du projet en cours.

Note

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

$ oc get pods -o wide
Copy to Clipboard Toggle word wrap

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>
Copy to Clipboard Toggle word wrap

2.1.5.4. Affichage des journaux des pod
Copier lien

La commande oc logs permet d’afficher les journaux d’un pod particulier. 

$ oc logs cakephp-ex-1-deploy
Copy to Clipboard Toggle word wrap

Exemple de sortie

--> Scaling cakephp-ex-1 to 1
--> Success
Copy to Clipboard Toggle word wrap

2.1.5.5. Affichage du projet en cours
Copier lien

La commande oc project permet d’afficher le projet en cours. 

$ oc project
Copy to Clipboard Toggle word wrap

Exemple de sortie

Using project "my-project" on server "https://openshift.example.com:6443".
Copy to Clipboard Toggle word wrap

2.1.5.6. Affichage de l’état du projet en cours
Copier lien

La commande d’état oc permet d’afficher des informations sur le projet en cours, tels que les services, les déploiements et les configurations de build. 

$ oc status
Copy to Clipboard Toggle word wrap

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.
Copy to Clipboard Toggle word wrap

2.1.5.7. Liste des ressources d’API prises en charge
Copier lien

La commande oc api-ressources permet d’afficher la liste des ressources API prises en charge sur le serveur. 

$ oc api-resources
Copy to Clipboard Toggle word wrap

Exemple de sortie

NAME                                  SHORTNAMES       APIGROUP                              NAMESPACED   KIND
bindings                                                                                     true         Binding
componentstatuses                     cs                                                     false        ComponentStatus
configmaps                            cm                                                     true         ConfigMap
...
Copy to Clipboard Toggle word wrap

2.1.6. Avoir de l’aide
Copier lien

Il est possible d’obtenir de l’aide avec les commandes CLI et les ressources ROSA de la manière suivante:

  • Faites appel à l’aide d’oc pour obtenir une liste et une description de toutes les commandes CLI disponibles:

    Exemple : Obtenez de l’aide générale pour le CLI

    $ oc help
    Copy to Clipboard Toggle word wrap

    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

...
    Copy to Clipboard Toggle word wrap

  • Employez le drapeau --help pour obtenir de l’aide sur une commande CLI spécifique:

    Exemple : Obtenez de l’aide pour la commande oc create

    $ oc create --help
    Copy to Clipboard Toggle word wrap

    Exemple de sortie

    Create a resource by filename or stdin

JSON and YAML formats are accepted.

Usage:
  oc create -f FILENAME [flags]

...
    Copy to Clipboard Toggle word wrap

  • La commande oc explicative permet d’afficher la description et les champs d’une ressource particulière:

    Exemple : Voir la documentation pour la ressource Pod

    $ oc explain pods
    Copy to Clipboard Toggle word wrap

    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

...
    Copy to Clipboard Toggle word wrap

2.1.7. Déverrouillage de l’OpenShift CLI
Copier lien

Déconnectez le CLI OpenShift pour terminer votre session en cours.

  • La commande oc logout est utilisée. 

    $ oc logout
    Copy to Clipboard Toggle word wrap

    Exemple de sortie

    Logged "user1" out on "https://openshift.example.com"
    Copy to Clipboard Toggle word wrap

Cela supprime le jeton d’authentification enregistré du serveur et le supprime de votre fichier de configuration.

Retour au début
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. Découvrez nos récentes mises à jour.

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 le Blog 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.

Theme

© 2025 Red Hat