Outils CLI
Apprendre à utiliser les outils de ligne de commande pour OpenShift Container Platform
Résumé
Chapitre 1. Vue d'ensemble des outils CLI de OpenShift Container Platform Copier lienLien copié sur presse-papiers!
Un utilisateur effectue une série d'opérations lorsqu'il travaille sur OpenShift Container Platform, telles que les suivantes :
- Gestion des clusters
- Construire, déployer et gérer des applications
- Gestion des processus de déploiement
- Développer les opérateurs
- Création et mise à jour des catalogues d'opérateurs
OpenShift Container Platform offre un ensemble d'outils d'interface de ligne de commande (CLI) qui simplifient ces tâches en permettant aux utilisateurs d'effectuer diverses opérations d'administration et de développement à partir du terminal. Ces outils exposent des commandes simples pour gérer les applications, ainsi que pour interagir avec chaque composant du système.
1.1. Liste des outils CLI Copier lienLien copié sur presse-papiers!
Les outils CLI suivants sont disponibles dans OpenShift Container Platform :
- OpenShift CLI (oc) : Il s'agit de l'outil CLI le plus couramment utilisé par les utilisateurs d'OpenShift Container Platform. Il aide les administrateurs de clusters et les développeurs à effectuer des opérations de bout en bout sur OpenShift Container Platform à l'aide du terminal. Contrairement à la console web, il permet à l'utilisateur de travailler directement avec le code source du projet à l'aide de scripts de commande.
-
CLI Knative (kn) : L'outil CLI de Knative (
kn) fournit des commandes de terminal simples et intuitives qui peuvent être utilisées pour interagir avec les composants OpenShift Serverless, tels que Knative Serving et Eventing. -
Pipelines CLI (tkn): OpenShift Pipelines est une solution d'intégration et de livraison continues (CI/CD) dans OpenShift Container Platform, qui utilise Tekton en interne. L'outil
tknCLI fournit des commandes simples et intuitives pour interagir avec OpenShift Pipelines en utilisant le terminal. -
opm CLI: L'outil
opmCLI aide les développeurs d'opérateurs et les administrateurs de clusters à créer et à maintenir les catalogues d'opérateurs à partir du terminal. - SDK de l'opérateur: L'Operator SDK, un composant de l'Operator Framework, fournit un outil CLI que les développeurs d'opérateurs peuvent utiliser pour construire, tester et déployer un opérateur à partir du terminal. Il simplifie le processus de construction d'applications natives de Kubernetes, qui peut nécessiter des connaissances opérationnelles approfondies et spécifiques à l'application.
Chapitre 2. OpenShift CLI (oc) Copier lienLien copié sur presse-papiers!
2.1. Démarrer avec le CLI d'OpenShift Copier lienLien copié sur presse-papiers!
2.1.1. À propos de la CLI d'OpenShift Copier lienLien copié sur presse-papiers!
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 Copier lienLien copié sur presse-papiers!
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 Copier lienLien copié sur presse-papiers!
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.
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
- Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
- Sélectionnez l'architecture dans la liste déroulante Product Variant.
- Sélectionnez la version appropriée dans la liste déroulante Version.
- Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 Linux Client et enregistrez le fichier.
Décompressez l'archive :
tar xvf <file>
tar xvf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Placez le fichier binaire
ocdans un répertoire situé sur votre sitePATH.Pour vérifier votre
PATH, exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
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
- Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
- Sélectionnez la version appropriée dans la liste déroulante Version.
- Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 Windows Client et enregistrez le fichier.
- Décompressez l'archive à l'aide d'un programme ZIP.
Déplacez le fichier binaire
ocdans un répertoire situé sur votre sitePATH.Pour vérifier votre
PATH, ouvrez l'invite de commande et exécutez la commande suivante :path
C:\N> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
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
- Naviguez jusqu'à la page de téléchargements OpenShift Container Platform sur le portail client Red Hat.
- Sélectionnez la version appropriée dans la liste déroulante Version.
Cliquez sur Download Now à côté de l'entrée OpenShift v4.12 macOS Client et enregistrez le fichier.
NotePour macOS arm64, choisissez l'entrée OpenShift v4.12 macOS arm64 Client.
- Décompressez l'archive.
Déplacez le binaire
ocdans un répertoire de votre PATH.Pour vérifier votre
PATH, ouvrez un terminal et exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
oc <command>
2.1.2.2. Installer le CLI OpenShift en utilisant la console web Copier lienLien copié sur presse-papiers!
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.
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 Copier lienLien copié sur presse-papiers!
Vous pouvez installer le binaire OpenShift CLI (oc) sur Linux en utilisant la procédure suivante.
Procédure
Dans la console web, cliquez sur ?.
Cliquez sur Command Line Tools.
-
Sélectionnez le binaire
ocapproprié pour votre plate-forme Linux, puis cliquez sur Download oc for Linux. - Enregistrer le fichier.
Décompressez l'archive.
tar xvf <file>
tar xvf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le fichier binaire
ocdans un répertoire situé sur votre sitePATH.Pour vérifier votre
PATH, exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
oc <command>
2.1.2.2.2. Installer le CLI OpenShift sur Windows à l'aide de la console web Copier lienLien copié sur presse-papiers!
Vous pouvez installer le binaire OpenShift CLI (oc) sur Windows en utilisant la procédure suivante.
Procédure
Dans la console web, cliquez sur ?.
Cliquez sur Command Line Tools.
-
Sélectionnez le binaire
ocpour la plate-forme Windows, puis cliquez sur Download oc for Windows for x86_64. - Enregistrer le fichier.
- Décompressez l'archive à l'aide d'un programme ZIP.
Déplacez le fichier binaire
ocdans un répertoire situé sur votre sitePATH.Pour vérifier votre
PATH, ouvrez l'invite de commande et exécutez la commande suivante :path
C:\N> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
C:\N> oc <command>
2.1.2.2.3. Installer la CLI OpenShift sur macOS à l'aide de la console web Copier lienLien copié sur presse-papiers!
Vous pouvez installer le binaire OpenShift CLI (oc) sur macOS en utilisant la procédure suivante.
Procédure
Dans la console web, cliquez sur ?.
Cliquez sur Command Line Tools.
Sélectionnez le binaire
ocpour la plate-forme macOS, puis cliquez sur Download oc for Mac for x86_64.NotePour macOS arm64, cliquez sur Download oc for Mac for ARM 64.
- Enregistrer le fichier.
- Décompressez l'archive.
Déplacez le binaire
ocdans un répertoire de votre PATH.Pour vérifier votre
PATH, ouvrez un terminal et exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Après l'installation de la CLI OpenShift, elle est disponible à l'aide de la commande oc:
oc <command>
oc <command>
2.1.2.3. Installer le CLI OpenShift à l'aide d'un RPM Copier lienLien copié sur presse-papiers!
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
S'inscrire auprès du gestionnaire d'abonnements Red Hat :
subscription-manager register
# subscription-manager registerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Extraire les données d'abonnement les plus récentes :
subscription-manager refresh
# subscription-manager refreshCopy to Clipboard Copied! Toggle word wrap Toggle overflow Liste des abonnements disponibles :
subscription-manager list --available --matches '*OpenShift*'
# subscription-manager list --available --matches '*OpenShift*'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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>
# subscription-manager attach --pool=<pool_id>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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"
# subscription-manager repos --enable="rhocp-4.12-for-rhel-8-x86_64-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIl 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.Installez le paquetage
openshift-clients:yum install openshift-clients
# yum install openshift-clientsCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Une fois installé, le CLI est disponible à l'aide de la commande oc:
oc <command>
oc <command>
2.1.2.4. Installer le CLI OpenShift en utilisant Homebrew Copier lienLien copié sur presse-papiers!
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
$ brew install openshift-cliCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.3. Se connecter à l'interface de commande OpenShift Copier lienLien copié sur presse-papiers!
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).
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
Entrez la commande
oc loginet indiquez un nom d'utilisateur :oc login -u user1
$ oc login -u user1Copy to Clipboard Copied! Toggle word wrap Toggle overflow Lorsque vous y êtes invité, saisissez les informations requises :
Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
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 Copier lienLien copié sur presse-papiers!
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 Copier lienLien copié sur presse-papiers!
Utilisez la commande oc new-project pour créer un nouveau projet.
oc new-project my-project
$ oc new-project my-project
Exemple de sortie
Now using project "my-project" on server "https://openshift.example.com:6443".
Now using project "my-project" on server "https://openshift.example.com:6443".
2.1.4.2. Créer une nouvelle application Copier lienLien copié sur presse-papiers!
Utilisez la commande oc new-app pour créer une nouvelle application.
oc new-app https://github.com/sclorg/cakephp-ex
$ 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.
--> 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 Copier lienLien copié sur presse-papiers!
La commande oc get pods permet de visualiser les pods du projet en cours.
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
$ 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>
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 Copier lienLien copié sur presse-papiers!
Utilisez la commande oc logs pour afficher les journaux d'un module particulier.
oc logs cakephp-ex-1-deploy
$ oc logs cakephp-ex-1-deploy
Exemple de sortie
--> Scaling cakephp-ex-1 to 1 --> Success
--> Scaling cakephp-ex-1 to 1
--> Success
2.1.4.5. Visualisation du projet en cours Copier lienLien copié sur presse-papiers!
La commande oc project permet de visualiser le projet en cours.
oc project
$ oc project
Exemple de sortie
Using project "my-project" on server "https://openshift.example.com:6443".
Using project "my-project" on server "https://openshift.example.com:6443".
2.1.4.6. Visualisation de l'état du projet en cours Copier lienLien copié sur presse-papiers!
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
$ oc status
Exemple de sortie
2.1.4.7. Liste des ressources API prises en charge Copier lienLien copié sur presse-papiers!
Utilisez la commande oc api-resources pour afficher la liste des ressources API prises en charge sur le serveur.
oc api-resources
$ oc api-resources
Exemple de sortie
NAME SHORTNAMES APIGROUP NAMESPACED KIND bindings true Binding componentstatuses cs false ComponentStatus configmaps cm true ConfigMap ...
NAME SHORTNAMES APIGROUP NAMESPACED KIND
bindings true Binding
componentstatuses cs false ComponentStatus
configmaps cm true ConfigMap
...
2.1.5. Obtenir de l'aide Copier lienLien copié sur presse-papiers!
Vous pouvez obtenir de l'aide sur les commandes CLI et les ressources OpenShift Container Platform de la manière suivante.
Utilisez
oc helppour 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
$ oc helpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Utilisez l'option
--helppour obtenir de l'aide sur une commande CLI spécifique :Exemple : Obtenir de l'aide pour la commande
oc createoc create --help
$ oc create --helpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Utilisez la commande
oc explainpour afficher la description et les champs d'une ressource particulière :Exemple : Consulter la documentation de la ressource
Podoc explain pods
$ oc explain podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.6. Se déconnecter de l'interface de commande OpenShift Copier lienLien copié sur presse-papiers!
Vous pouvez vous déconnecter de l'OpenShift CLI pour mettre fin à votre session en cours.
Utilisez la commande
oc logout.oc logout
$ oc logoutCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Logged "user1" out on "https://openshift.example.com"
Logged "user1" out on "https://openshift.example.com"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Cette opération supprime le jeton d'authentification enregistré sur le serveur et le supprime de votre fichier de configuration.
2.2. Configuration de la CLI d'OpenShift Copier lienLien copié sur presse-papiers!
2.2.1. Activation de l'achèvement des onglets Copier lienLien copié sur presse-papiers!
Vous pouvez activer la complétion de tabulation pour les interpréteurs de commandes Bash ou Zsh.
2.2.1.1. Activation de la complétion des tabulations pour Bash Copier lienLien copié sur presse-papiers!
Après avoir installé l'OpenShift CLI (oc), vous pouvez activer la complétion de tabulation pour compléter automatiquement les commandes oc ou suggérer des options lorsque vous appuyez sur Tab. La procédure suivante permet d'activer la complétion de tabulation pour l'interpréteur de commandes Bash.
Conditions préalables
-
Vous devez avoir installé OpenShift CLI (
oc). -
Le paquet
bash-completiondoit être installé.
Procédure
Enregistrer le code d'achèvement de Bash dans un fichier :
oc completion bash > oc_bash_completion
oc completion bash > oc_bash_completionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copiez le fichier sur
/etc/bash_completion.d/:sudo cp oc_bash_completion /etc/bash_completion.d/
$ sudo cp oc_bash_completion /etc/bash_completion.d/Copy to Clipboard Copied! Toggle word wrap Toggle overflow Vous pouvez également enregistrer le fichier dans un répertoire local et l'extraire de votre fichier
.bashrc.
La complétion des tabulations est activée lorsque vous ouvrez un nouveau terminal.
2.2.1.2. Activation de la complétion des tabulations pour Zsh Copier lienLien copié sur presse-papiers!
Après avoir installé l'OpenShift CLI (oc), vous pouvez activer la complétion de tabulation pour compléter automatiquement les commandes oc ou suggérer des options lorsque vous appuyez sur Tab. La procédure suivante permet d'activer la complétion de tabulation pour l'interpréteur de commandes Zsh.
Conditions préalables
-
Vous devez avoir installé OpenShift CLI (
oc).
Procédure
Pour ajouter la complétion de tabulation pour
ocà votre fichier.zshrc, exécutez la commande suivante :Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La complétion des tabulations est activée lorsque vous ouvrez un nouveau terminal.
2.3. Utilisation des commandes oc et kubectl Copier lienLien copié sur presse-papiers!
L'interface de ligne de commande (CLI) de Kubernetes, kubectl, peut être utilisée pour exécuter des commandes sur un cluster Kubernetes. OpenShift Container Platform étant une distribution Kubernetes certifiée, vous pouvez utiliser les binaires kubectl pris en charge qui sont livrés avec OpenShift Container Platform, ou vous pouvez obtenir des fonctionnalités étendues en utilisant le binaire oc.
2.3.1. Le binaire oc Copier lienLien copié sur presse-papiers!
Le binaire oc offre les mêmes capacités que le binaire kubectl, mais il s'étend pour prendre en charge nativement des fonctionnalités supplémentaires d'OpenShift Container Platform, notamment :
Full support for OpenShift Container Platform resources
Les ressources telles que les objets
DeploymentConfig,BuildConfig,Route,ImageStream, etImageStreamTagsont spécifiques aux distributions OpenShift Container Platform, et s'appuient sur les primitives Kubernetes standard.Authentication
Le binaire
ocoffre une commandeloginintégrée pour l'authentification et vous permet de travailler avec des projets OpenShift Container Platform, qui mappent les espaces de noms Kubernetes aux utilisateurs authentifiés. Pour plus d'informations, consultez la section Comprendre l'authentification.Additional commands
La commande supplémentaire
oc new-app, par exemple, facilite le démarrage de nouvelles applications en utilisant le code source existant ou des images préconstruites. De même, la commande supplémentaireoc new-projectfacilite le démarrage d'un projet que vous pouvez utiliser par défaut.
Si vous avez installé une version antérieure du binaire oc, vous ne pouvez pas l'utiliser pour exécuter toutes les commandes d'OpenShift Container Platform 4.12. Si vous souhaitez bénéficier des dernières fonctionnalités, vous devez télécharger et installer la dernière version du binaire oc correspondant à la version de votre serveur OpenShift Container Platform.
Les modifications de l'API non liées à la sécurité impliqueront, au minimum, deux versions mineures (4.1 à 4.2 à 4.3, par exemple) pour permettre la mise à jour des anciens fichiers binaires oc. L'utilisation de nouvelles fonctionnalités peut nécessiter des binaires oc plus récents. Un serveur 4.3 peut avoir des capacités supplémentaires qu'un binaire oc 4.2 ne peut pas utiliser et un binaire oc 4.3 peut avoir des capacités supplémentaires qui ne sont pas prises en charge par un serveur 4.2.
|
X.Y ( |
X.Y N footnote:versionpolicyn[où N est un nombre supérieur ou égal à 1.] ( | |
| X.Y (Serveur) |
|
|
| X.Y N footnote:versionpolicyn[] (Serveur) |
|
|
Entièrement compatible.
oc le client pourrait ne pas être en mesure d'accéder aux fonctions du serveur.
oc le client peut offrir des options et des fonctionnalités qui ne sont pas compatibles avec le serveur auquel on accède.
2.3.2. Le binaire kubectl Copier lienLien copié sur presse-papiers!
Le binaire kubectl est fourni comme un moyen de prendre en charge les flux de travail et les scripts existants pour les nouveaux utilisateurs d'OpenShift Container Platform venant d'un environnement Kubernetes standard, ou pour ceux qui préfèrent utiliser le CLI kubectl. Les utilisateurs existants de kubectl peuvent continuer à utiliser le binaire pour interagir avec les primitives Kubernetes, sans qu'aucun changement ne soit nécessaire dans le cluster OpenShift Container Platform.
Vous pouvez installer le binaire kubectl pris en charge en suivant les étapes de l'installation de l'OpenShift CLI. Le binaire kubectl est inclus dans l'archive si vous téléchargez le binaire, ou est installé lorsque vous installez le CLI à l'aide d'un RPM.
Pour plus d'informations, voir la documentation kubectl.
2.4. Gestion des profils CLI Copier lienLien copié sur presse-papiers!
Un fichier de configuration CLI vous permet de configurer différents profils, ou contextes, pour l'utilisation de la vue d'ensemble des outils CLI. Un contexte se compose de l'authentification de l'utilisateur et des informations du serveur OpenShift Container Platform associées à un nickname.
2.4.1. À propos des commutations entre profils CLI Copier lienLien copié sur presse-papiers!
Les contextes vous permettent de passer facilement d'un utilisateur à l'autre sur plusieurs serveurs OpenShift Container Platform, ou clusters, lorsque vous utilisez des opérations CLI. Les surnoms facilitent la gestion des configurations de la CLI en fournissant des références abrégées aux contextes, aux informations d'identification de l'utilisateur et aux détails du cluster. Après la première connexion à la CLI, OpenShift Container Platform crée un fichier ~/.kube/config s'il n'en existe pas déjà un. Au fur et à mesure que des détails d'authentification et de connexion sont fournis à la CLI, soit automatiquement au cours d'une opération oc login, soit en configurant manuellement les profils de la CLI, les informations mises à jour sont stockées dans le fichier de configuration :
Fichier de configuration CLI
- 1
- La section
clustersdéfinit les détails de connexion pour les clusters OpenShift Container Platform, y compris l'adresse de leur serveur principal. Dans cet exemple, un cluster est surnomméopenshift1.example.com:8443et un autreopenshift2.example.com:8443. - 2
- Cette section
contextsdéfinit deux contextes : l'un surnomméalice-project/openshift1.example.com:8443/alice, qui utilise le projetalice-project, le groupeopenshift1.example.com:8443et l'utilisateuralice, et l'autre surnomméjoe-project/openshift1.example.com:8443/alice, qui utilise le projetjoe-project, le groupeopenshift1.example.com:8443et l'utilisateuralice. - 3
- Le paramètre
current-contextindique que le contextejoe-project/openshift1.example.com:8443/aliceest actuellement utilisé, ce qui permet à l'utilisateuralicede travailler dans le projetjoe-projectsur le clusteropenshift1.example.com:8443. - 4
- La section
usersdéfinit les informations d'identification de l'utilisateur. Dans cet exemple, le pseudo de l'utilisateuralice/openshift1.example.com:8443utilise un jeton d'accès.
L'interface de programmation peut prendre en charge plusieurs fichiers de configuration qui sont chargés au moment de l'exécution et fusionnés avec toutes les options de remplacement spécifiées dans la ligne de commande. Une fois connecté, vous pouvez utiliser la commande oc status ou oc project pour vérifier votre environnement de travail actuel :
Vérifier l'environnement de travail actuel
oc status
$ oc status
Exemple de sortie
Liste du projet en cours
oc project
$ oc project
Exemple de sortie
Using project "joe-project" from context named "joe-project/openshift1.example.com:8443/alice" on server "https://openshift1.example.com:8443".
Using project "joe-project" from context named "joe-project/openshift1.example.com:8443/alice" on server "https://openshift1.example.com:8443".
Vous pouvez exécuter à nouveau la commande oc login et fournir les informations requises au cours du processus interactif, afin de vous connecter en utilisant toute autre combinaison d'informations d'identification de l'utilisateur et de détails sur le cluster. Un contexte est créé sur la base des informations fournies s'il n'en existe pas déjà un. Si vous êtes déjà connecté et que vous souhaitez passer à un autre projet auquel l'utilisateur actuel a déjà accès, utilisez la commande oc project et entrez le nom du projet :
oc project alice-project
$ oc project alice-project
Exemple de sortie
Now using project "alice-project" on server "https://openshift1.example.com:8443".
Now using project "alice-project" on server "https://openshift1.example.com:8443".
À tout moment, vous pouvez utiliser la commande oc config view pour afficher votre configuration CLI actuelle, comme le montre la sortie. D'autres commandes de configuration de l'ITC sont également disponibles pour une utilisation plus avancée.
Si vous avez accès aux informations d'identification de l'administrateur mais que vous n'êtes plus connecté en tant qu'utilisateur du système par défaut system:admin, vous pouvez vous reconnecter à tout moment en tant qu'utilisateur, à condition que les informations d'identification soient toujours présentes dans le fichier de configuration de l'interface de programmation. La commande suivante permet de se connecter et de passer au projet par défaut :
oc login -u system:admin -n default
$ oc login -u system:admin -n default
2.4.2. Configuration manuelle des profils CLI Copier lienLien copié sur presse-papiers!
Cette section traite de l'utilisation plus avancée des configurations de l'interface de programmation. Dans la plupart des cas, vous pouvez utiliser les commandes oc login et oc project pour vous connecter et passer d'un contexte à l'autre et d'un projet à l'autre.
Si vous souhaitez configurer manuellement vos fichiers de configuration CLI, vous pouvez utiliser la commande oc config au lieu de modifier directement les fichiers. La commande oc config comprend un certain nombre de sous-commandes utiles à cette fin :
| Sous-commande | Utilisation |
|---|---|
|
| Définit une entrée de cluster dans le fichier de configuration CLI. Si le pseudonyme de cluster référencé existe déjà, les informations spécifiées sont fusionnées. oc config set-cluster <cluster_nickname> [--server=<master_ip_or_fqdn>] [--certificate-authority=<path/to/certificate/authority>] [--api-version=<apiversion>] [--insecure-skip-tls-verify=true]
|
|
| Définit une entrée de contexte dans le fichier de configuration de la CLI. Si le pseudonyme de contexte référencé existe déjà, les informations spécifiées sont fusionnées. oc config set-context <context_nickname> [--cluster=<cluster_nickname>] [--user=<user_nickname>] [--namespace=<namespace>]
|
|
| Définit le contexte actuel en utilisant le pseudonyme de contexte spécifié. oc config use-context <context_nickname>
|
|
| Définit une valeur individuelle dans le fichier de configuration CLI. oc config set <property_name> <property_value> $ oc config set <property_name>
|
|
| Annule les valeurs individuelles dans le fichier de configuration CLI. oc config unset <nom_de_la_propriété>
Le site |
|
| Affiche la configuration CLI fusionnée en cours d'utilisation. oc config view
Affiche le résultat du fichier de configuration CLI spécifié. oc config view --config=<specific_filename> $ oc config view --config=<specific_filename>
|
Exemple d'utilisation
-
Connectez-vous en tant qu'utilisateur utilisant un jeton d'accès. Ce jeton est utilisé par l'utilisateur
alice:
oc login https://openshift1.example.com --token=ns7yVhuRNpDM9cgzfhhxQ7bM5s7N2ZVrkZepSRf4LC0
$ oc login https://openshift1.example.com --token=ns7yVhuRNpDM9cgzfhhxQ7bM5s7N2ZVrkZepSRf4LC0
- Affichez l'entrée de la grappe créée automatiquement :
oc config view
$ oc config view
Exemple de sortie
- Mettre à jour le contexte actuel pour que les utilisateurs se connectent à l'espace de noms souhaité :
oc config set-context `oc config current-context` --namespace=<project_name>
$ oc config set-context `oc config current-context` --namespace=<project_name>
- Examiner le contexte actuel pour confirmer que les changements sont mis en œuvre :
oc whoami -c
$ oc whoami -c
Toutes les opérations CLI suivantes utilisent le nouveau contexte, sauf indication contraire dans les options CLI ou jusqu'à ce que le contexte soit modifié.
2.4.3. Charger et fusionner des règles Copier lienLien copié sur presse-papiers!
Vous pouvez suivre ces règles lorsque vous effectuez des opérations CLI pour l'ordre de chargement et de fusion de la configuration CLI :
Les fichiers de configuration CLI sont récupérés à partir de votre poste de travail, en utilisant la hiérarchie et les règles de fusion suivantes :
-
Si l'option
--configest activée, seul ce fichier est chargé. L'indicateur n'est activé qu'une seule fois et aucune fusion n'a lieu. -
Si la variable d'environnement
$KUBECONFIGest définie, elle est utilisée. La variable peut être une liste de chemins, et si c'est le cas, les chemins sont fusionnés. Lorsqu'une valeur est modifiée, elle l'est dans le fichier qui définit la strophe. Lorsqu'une valeur est créée, elle l'est dans le premier fichier existant. Si aucun fichier de la chaîne n'existe, le dernier fichier de la liste est créé. -
Dans le cas contraire, le fichier
~/.kube/configest utilisé et aucune fusion n'a lieu.
-
Si l'option
Le contexte à utiliser est déterminé en fonction de la première correspondance dans le flux suivant :
-
La valeur de l'option
--context. -
La valeur
current-contextdu fichier de configuration CLI. - Une valeur vide est autorisée à ce stade.
-
La valeur de l'option
L'utilisateur et la grappe à utiliser sont déterminés. À ce stade, vous pouvez avoir ou non un contexte ; ils sont construits sur la base de la première correspondance dans le flux suivant, qui est exécuté une fois pour l'utilisateur et une fois pour la grappe :
-
La valeur de l'option
--userpour le nom de l'utilisateur et--clusterpour le nom de la grappe. -
Si l'option
--contextest présente, la valeur du contexte est utilisée. - Une valeur vide est autorisée à ce stade.
-
La valeur de l'option
Les informations sur les clusters à utiliser sont déterminées. À ce stade, vous pouvez disposer ou non d'informations sur les grappes. Chaque élément de l'information sur la grappe est construit sur la base de la première correspondance dans le flux suivant :
Les valeurs de l'une des options de ligne de commande suivantes :
-
--server, -
--api-version -
--certificate-authority -
--insecure-skip-tls-verify
-
- Si des informations sur le cluster et une valeur pour l'attribut sont présentes, utilisez-les.
- Si vous n'avez pas d'emplacement de serveur, il y a une erreur.
Les informations sur l'utilisateur à utiliser sont déterminées. Les utilisateurs sont construits selon les mêmes règles que les clusters, sauf qu'il ne peut y avoir qu'une seule technique d'authentification par utilisateur ; des techniques contradictoires entraînent l'échec de l'opération. Les options de la ligne de commande sont prioritaires sur les valeurs du fichier de configuration. Les options de ligne de commande valides sont les suivantes :
-
--auth-path -
--client-certificate -
--client-key -
--token
-
- Pour toute information manquante, des valeurs par défaut sont utilisées et des invites sont données pour obtenir des informations supplémentaires.
2.5. Extension de la CLI d'OpenShift avec des plugins Copier lienLien copié sur presse-papiers!
Vous pouvez écrire et installer des plugins pour développer les commandes par défaut de oc, ce qui vous permet d'effectuer des tâches nouvelles et plus complexes avec la CLI d'OpenShift Container Platform.
2.5.1. Écrire des plugins CLI Copier lienLien copié sur presse-papiers!
Vous pouvez écrire un plugin pour la CLI d'OpenShift Container Platform dans n'importe quel langage de programmation ou script qui vous permet d'écrire des commandes en ligne de commande. Notez que vous ne pouvez pas utiliser un plugin pour écraser une commande oc existante.
Procédure
Cette procédure permet de créer un plugin Bash simple qui imprime un message dans le terminal lorsque la commande oc foo est lancée.
Créez un fichier appelé
oc-foo.Lorsque vous nommez votre fichier de plugin, gardez à l'esprit les points suivants :
-
Le fichier doit commencer par
oc-oukubectl-pour être reconnu comme un plugin. -
Le nom du fichier détermine la commande qui invoque le plugin. Par exemple, un plugin dont le nom de fichier est
oc-foo-barpeut être appelé par la commandeoc foo bar. Vous pouvez également utiliser des traits de soulignement si vous souhaitez que la commande contienne des tirets. Par exemple, un plugin dont le nom de fichier estoc-foo_barpeut être appelé par la commandeoc foo-bar.
-
Le fichier doit commencer par
Ajoutez le contenu suivant au fichier.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé ce plugin pour le CLI de OpenShift Container Platform, il peut être invoqué à l'aide de la commande oc foo.
2.5.2. Installation et utilisation des plugins CLI Copier lienLien copié sur presse-papiers!
Après avoir écrit un plugin personnalisé pour la CLI d'OpenShift Container Platform, vous devez l'installer pour utiliser les fonctionnalités qu'il fournit.
Conditions préalables
-
L'outil CLI
ocdoit être installé. -
Vous devez avoir un fichier de plugin CLI qui commence par
oc-oukubectl-.
Procédure
Si nécessaire, mettez à jour le fichier du plugin pour qu'il soit exécutable.
chmod x <plugin_file>
chmod x <plugin_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Placez le fichier n'importe où dans votre
PATH, par exemple/usr/local/bin/.sudo mv <plugin_file> /usr/local/bin/.
$ sudo mv <plugin_file> /usr/local/bin/.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exécutez
oc plugin listpour vous assurer que le plugin est répertorié.oc plugin list
$ oc plugin listCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
The following compatible plugins are available: /usr/local/bin/<plugin_file>
The following compatible plugins are available: /usr/local/bin/<plugin_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Si votre plugin ne figure pas dans cette liste, vérifiez que le fichier commence par
oc-oukubectl-, qu'il est exécutable et qu'il se trouve sur votre sitePATH.Invoquer la nouvelle commande ou option introduite par le plugin.
Par exemple, si vous avez créé et installé le plugin
kubectl-nsà partir du dépôt de plugins Sample, vous pouvez utiliser la commande suivante pour afficher l'espace de noms actuel.oc ns
$ oc nsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Notez que la commande permettant d'invoquer le plugin dépend du nom du fichier du plugin. Par exemple, un plugin dont le nom de fichier est
oc-foo-barest appelé par la commandeoc foo bar.
2.6. Gérer les plugins CLI avec Krew Copier lienLien copié sur presse-papiers!
Vous pouvez utiliser Krew pour installer et gérer des plugins pour l'OpenShift CLI (oc).
L'utilisation de Krew pour installer et gérer des plugins pour OpenShift CLI est une fonctionnalité d'aperçu technologique uniquement. Les fonctionnalités de l'aperçu technologique ne sont pas prises en charge par les accords de niveau de service (SLA) de production de Red Hat et peuvent ne pas être complètes sur le plan fonctionnel. Red Hat ne recommande pas de les utiliser en production. Ces fonctionnalités offrent un accès anticipé aux fonctionnalités des produits à venir, ce qui permet aux clients de tester les fonctionnalités et de fournir des commentaires pendant le processus de développement.
Pour plus d'informations sur la portée de l'assistance des fonctionnalités de l'aperçu technologique de Red Hat, voir Portée de l'assistance des fonctionnalités de l'aperçu technologique.
2.6.1. Installer un plugin CLI avec Krew Copier lienLien copié sur presse-papiers!
Vous pouvez installer un plugin pour l'OpenShift CLI (oc) avec Krew.
Conditions préalables
- Vous avez installé Krew en suivant la procédure d'installation décrite dans la documentation de Krew.
Procédure
Pour obtenir la liste de tous les plugins disponibles, exécutez la commande suivante :
oc krew search
$ oc krew searchCopy to Clipboard Copied! Toggle word wrap Toggle overflow Pour obtenir des informations sur un plugin, exécutez la commande suivante :
oc krew info <nom_du_plugin>
oc krew info <nom_du_plugin>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Pour installer un plugin, exécutez la commande suivante :
oc krew install <nom_du_plugin>
oc krew install <nom_du_plugin>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Pour obtenir la liste de tous les plugins installés par Krew, exécutez la commande suivante :
oc krew list
$ oc krew listCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.2. Mise à jour d'un plugin CLI avec Krew Copier lienLien copié sur presse-papiers!
Vous pouvez mettre à jour un plugin qui a été installé pour l'OpenShift CLI (oc) avec Krew.
Conditions préalables
- Vous avez installé Krew en suivant la procédure d'installation décrite dans la documentation de Krew.
- Vous avez installé un plugin pour la CLI d'OpenShift avec Krew.
Procédure
Pour mettre à jour un seul plugin, exécutez la commande suivante :
oc krew upgrade <nom_du_plugin>
oc krew upgrade <nom_du_plugin>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Pour mettre à jour tous les plugins qui ont été installés par Krew, exécutez la commande suivante :
oc krew upgrade
$ oc krew upgradeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.6.3. Désinstallation d'un plugin CLI avec Krew Copier lienLien copié sur presse-papiers!
Vous pouvez désinstaller un plugin qui a été installé pour l'OpenShift CLI (oc) avec Krew.
Conditions préalables
- Vous avez installé Krew en suivant la procédure d'installation décrite dans la documentation de Krew.
- Vous avez installé un plugin pour la CLI d'OpenShift avec Krew.
Procédure
Pour désinstaller un plugin, exécutez la commande suivante :
oc krew uninstall <nom_du_plugin>
oc krew uninstall <nom_du_plugin>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.7. Référence des commandes de développement de la CLI d'OpenShift Copier lienLien copié sur presse-papiers!
Cette référence fournit des descriptions et des exemples de commandes pour les commandes développeur de l'OpenShift CLI (oc). Pour les commandes administrateur, voir la référence des commandes administrateur de l'OpenShift CLI.
Exécutez oc help pour obtenir la liste de toutes les commandes ou exécutez oc <command> --help pour obtenir des détails supplémentaires sur une commande spécifique.
2.7.1. Commandes du développeur OpenShift CLI (oc) Copier lienLien copié sur presse-papiers!
2.7.1.1. oc annotate Copier lienLien copié sur presse-papiers!
Mettre à jour les annotations d'une ressource
Exemple d'utilisation
2.7.1.2. oc api-resources Copier lienLien copié sur presse-papiers!
Imprimer les ressources API prises en charge sur le serveur
Exemple d'utilisation
2.7.1.3. oc api-versions Copier lienLien copié sur presse-papiers!
Imprimer les versions d'API prises en charge sur le serveur, sous la forme de "group/version"
Exemple d'utilisation
# Print the supported API versions oc api-versions
# Print the supported API versions
oc api-versions
2.7.1.4. oc appliquer Copier lienLien copié sur presse-papiers!
Appliquer une configuration à une ressource par nom de fichier ou stdin
Exemple d'utilisation
2.7.1.5. oc apply edit-last-applied Copier lienLien copié sur presse-papiers!
Modifier les dernières annotations de configuration d'une ressource ou d'un objet
Exemple d'utilisation
# Edit the last-applied-configuration annotations by type/name in YAML oc apply edit-last-applied deployment/nginx # Edit the last-applied-configuration annotations by file in JSON oc apply edit-last-applied -f deploy.yaml -o json
# Edit the last-applied-configuration annotations by type/name in YAML
oc apply edit-last-applied deployment/nginx
# Edit the last-applied-configuration annotations by file in JSON
oc apply edit-last-applied -f deploy.yaml -o json
2.7.1.6. oc apply set-last-applied Copier lienLien copié sur presse-papiers!
Définir la dernière annotation de configuration appliquée sur un objet vivant pour qu'elle corresponde au contenu d'un fichier
Exemple d'utilisation
2.7.1.7. oc apply view-last-applied Copier lienLien copié sur presse-papiers!
Afficher les dernières annotations de configuration d'une ressource ou d'un objet
Exemple d'utilisation
# View the last-applied-configuration annotations by type/name in YAML oc apply view-last-applied deployment/nginx # View the last-applied-configuration annotations by file in JSON oc apply view-last-applied -f deploy.yaml -o json
# View the last-applied-configuration annotations by type/name in YAML
oc apply view-last-applied deployment/nginx
# View the last-applied-configuration annotations by file in JSON
oc apply view-last-applied -f deploy.yaml -o json
2.7.1.8. attachement oc Copier lienLien copié sur presse-papiers!
S'attacher à un conteneur en cours d'exécution
Exemple d'utilisation
2.7.1.9. oc auth can-i Copier lienLien copié sur presse-papiers!
Vérifier si une action est autorisée
Exemple d'utilisation
2.7.1.10. oc auth reconcile Copier lienLien copié sur presse-papiers!
Réconcilie les règles pour les objets RBAC de rôle, de liaison de rôle, de rôle de cluster et de liaison de rôle de cluster
Exemple d'utilisation
# Reconcile RBAC resources from a file oc auth reconcile -f my-rbac-rules.yaml
# Reconcile RBAC resources from a file
oc auth reconcile -f my-rbac-rules.yaml
2.7.1.11. oc autoscale Copier lienLien copié sur presse-papiers!
Mise à l'échelle automatique d'une configuration de déploiement, d'un déploiement, d'un ensemble de répliques, d'un ensemble avec état ou d'un contrôleur de réplication
Exemple d'utilisation
# Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used oc autoscale deployment foo --min=2 --max=10 # Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80% oc autoscale rc foo --max=5 --cpu-percent=80
# Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used
oc autoscale deployment foo --min=2 --max=10
# Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%
oc autoscale rc foo --max=5 --cpu-percent=80
2.7.1.12. oc cancel-build Copier lienLien copié sur presse-papiers!
Annuler les constructions en cours, en attente ou nouvelles
Exemple d'utilisation
2.7.1.13. oc cluster-info Copier lienLien copié sur presse-papiers!
Affichage des informations sur le cluster
Exemple d'utilisation
# Print the address of the control plane and cluster services oc cluster-info
# Print the address of the control plane and cluster services
oc cluster-info
2.7.1.14. oc cluster-info dump Copier lienLien copié sur presse-papiers!
Dépose des informations pertinentes pour le débogage et le diagnostic
Exemple d'utilisation
2.7.1.15. achèvement de l'oc Copier lienLien copié sur presse-papiers!
Sortie du code de complétion de l'interpréteur de commandes pour l'interpréteur de commandes spécifié (bash, zsh, fish ou powershell)
Exemple d'utilisation
2.7.1.16. oc config current-context Copier lienLien copié sur presse-papiers!
Afficher le contexte actuel
Exemple d'utilisation
# Display the current-context oc config current-context
# Display the current-context
oc config current-context
2.7.1.17. oc config delete-cluster Copier lienLien copié sur presse-papiers!
Supprimer le cluster spécifié de kubeconfig
Exemple d'utilisation
# Delete the minikube cluster oc config delete-cluster minikube
# Delete the minikube cluster
oc config delete-cluster minikube
2.7.1.18. oc config delete-context Copier lienLien copié sur presse-papiers!
Supprimer le contexte spécifié du kubeconfig
Exemple d'utilisation
# Delete the context for the minikube cluster oc config delete-context minikube
# Delete the context for the minikube cluster
oc config delete-context minikube
2.7.1.19. oc config delete-user Copier lienLien copié sur presse-papiers!
Supprimer l'utilisateur spécifié de kubeconfig
Exemple d'utilisation
# Delete the minikube user oc config delete-user minikube
# Delete the minikube user
oc config delete-user minikube
2.7.1.20. oc config get-clusters Copier lienLien copié sur presse-papiers!
Afficher les clusters définis dans kubeconfig
Exemple d'utilisation
# List the clusters that oc knows about oc config get-clusters
# List the clusters that oc knows about
oc config get-clusters
2.7.1.21. oc config get-contexts Copier lienLien copié sur presse-papiers!
Décrire un ou plusieurs contextes
Exemple d'utilisation
# List all the contexts in your kubeconfig file oc config get-contexts # Describe one context in your kubeconfig file oc config get-contexts my-context
# List all the contexts in your kubeconfig file
oc config get-contexts
# Describe one context in your kubeconfig file
oc config get-contexts my-context
2.7.1.22. oc config get-users Copier lienLien copié sur presse-papiers!
Afficher les utilisateurs définis dans le kubeconfig
Exemple d'utilisation
# List the users that oc knows about oc config get-users
# List the users that oc knows about
oc config get-users
2.7.1.23. oc config rename-context Copier lienLien copié sur presse-papiers!
Renommer un contexte à partir du fichier kubeconfig
Exemple d'utilisation
# Rename the context 'old-name' to 'new-name' in your kubeconfig file oc config rename-context old-name new-name
# Rename the context 'old-name' to 'new-name' in your kubeconfig file
oc config rename-context old-name new-name
2.7.1.24. oc config set Copier lienLien copié sur presse-papiers!
Définir une valeur individuelle dans un fichier kubeconfig
Exemple d'utilisation
2.7.1.25. oc config set-cluster Copier lienLien copié sur presse-papiers!
Définir une entrée de cluster dans kubeconfig
Exemple d'utilisation
2.7.1.26. oc config set-context Copier lienLien copié sur presse-papiers!
Définir une entrée de contexte dans kubeconfig
Exemple d'utilisation
# Set the user field on the gce context entry without touching other values oc config set-context gce --user=cluster-admin
# Set the user field on the gce context entry without touching other values
oc config set-context gce --user=cluster-admin
2.7.1.27. oc config set-credentials Copier lienLien copié sur presse-papiers!
Définir une entrée utilisateur dans kubeconfig
Exemple d'utilisation
2.7.1.28. oc config unset Copier lienLien copié sur presse-papiers!
Annuler une valeur individuelle dans un fichier kubeconfig
Exemple d'utilisation
# Unset the current-context oc config unset current-context # Unset namespace in foo context oc config unset contexts.foo.namespace
# Unset the current-context
oc config unset current-context
# Unset namespace in foo context
oc config unset contexts.foo.namespace
2.7.1.29. oc config use-context Copier lienLien copié sur presse-papiers!
Définir le contexte actuel dans un fichier kubeconfig
Exemple d'utilisation
# Use the context for the minikube cluster oc config use-context minikube
# Use the context for the minikube cluster
oc config use-context minikube
2.7.1.30. vue de la configuration de l'oc Copier lienLien copié sur presse-papiers!
Afficher les paramètres kubeconfig fusionnés ou un fichier kubeconfig spécifié
Exemple d'utilisation
2.7.1.31. oc cp Copier lienLien copié sur presse-papiers!
Copier des fichiers et des répertoires vers et depuis des conteneurs
Exemple d'utilisation
2.7.1.32. oc créer Copier lienLien copié sur presse-papiers!
Créer une ressource à partir d'un fichier ou de stdin
Exemple d'utilisation
2.7.1.33. oc create build Copier lienLien copié sur presse-papiers!
Créer une nouvelle construction
Exemple d'utilisation
# Create a new build oc create build myapp
# Create a new build
oc create build myapp
2.7.1.34. oc create clusterresourcequota Copier lienLien copié sur presse-papiers!
Créer un quota de ressources pour le cluster
Exemple d'utilisation
# Create a cluster resource quota limited to 10 pods oc create clusterresourcequota limit-bob --project-annotation-selector=openshift.io/requester=user-bob --hard=pods=10
# Create a cluster resource quota limited to 10 pods
oc create clusterresourcequota limit-bob --project-annotation-selector=openshift.io/requester=user-bob --hard=pods=10
2.7.1.35. oc create clusterrole Copier lienLien copié sur presse-papiers!
Créer un rôle de cluster
Exemple d'utilisation
2.7.1.36. oc create clusterrolebinding Copier lienLien copié sur presse-papiers!
Créer une liaison de rôle de cluster pour un rôle de cluster particulier
Exemple d'utilisation
# Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role oc create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
# Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
oc create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
2.7.1.37. oc create configmap Copier lienLien copié sur presse-papiers!
Créer une carte de configuration à partir d'un fichier local, d'un répertoire ou d'une valeur littérale
Exemple d'utilisation
2.7.1.38. oc create cronjob Copier lienLien copié sur presse-papiers!
Créer une tâche cron avec le nom spécifié
Exemple d'utilisation
# Create a cron job oc create cronjob my-job --image=busybox --schedule="*/1 * * * *" # Create a cron job with a command oc create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date
# Create a cron job
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *"
# Create a cron job with a command
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date
2.7.1.39. oc create deployment Copier lienLien copié sur presse-papiers!
Créer un déploiement avec le nom spécifié
Exemple d'utilisation
2.7.1.40. oc create deploymentconfig Copier lienLien copié sur presse-papiers!
Créer une configuration de déploiement avec des options par défaut qui utilise une image donnée
Exemple d'utilisation
# Create an nginx deployment config named my-nginx oc create deploymentconfig my-nginx --image=nginx
# Create an nginx deployment config named my-nginx
oc create deploymentconfig my-nginx --image=nginx
2.7.1.41. oc créer une identité Copier lienLien copié sur presse-papiers!
Créer manuellement une identité (nécessaire uniquement si la création automatique est désactivée)
Exemple d'utilisation
# Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones" oc create identity acme_ldap:adamjones
# Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones"
oc create identity acme_ldap:adamjones
2.7.1.42. oc create imagestream Copier lienLien copié sur presse-papiers!
Créer un nouveau flux d'images vide
Exemple d'utilisation
# Create a new image stream oc create imagestream mysql
# Create a new image stream
oc create imagestream mysql
2.7.1.43. oc create imagestreamtag Copier lienLien copié sur presse-papiers!
Créer une nouvelle balise de flux d'images
Exemple d'utilisation
# Create a new image stream tag based on an image in a remote registry oc create imagestreamtag mysql:latest --from-image=myregistry.local/mysql/mysql:5.0
# Create a new image stream tag based on an image in a remote registry
oc create imagestreamtag mysql:latest --from-image=myregistry.local/mysql/mysql:5.0
2.7.1.44. oc create ingress Copier lienLien copié sur presse-papiers!
Créer une entrée avec le nom spécifié
Exemple d'utilisation
2.7.1.45. oc créer un emploi Copier lienLien copié sur presse-papiers!
Créer un travail avec le nom spécifié
Exemple d'utilisation
2.7.1.46. oc create namespace Copier lienLien copié sur presse-papiers!
Créer un espace de noms avec le nom spécifié
Exemple d'utilisation
# Create a new namespace named my-namespace oc create namespace my-namespace
# Create a new namespace named my-namespace
oc create namespace my-namespace
2.7.1.47. oc create poddisruptionbudget Copier lienLien copié sur presse-papiers!
Créer un budget d'interruption de pods avec le nom spécifié
Exemple d'utilisation
2.7.1.48. oc create priorityclass Copier lienLien copié sur presse-papiers!
Créer une classe de priorité avec le nom spécifié
Exemple d'utilisation
2.7.1.49. oc create quota Copier lienLien copié sur presse-papiers!
Créer un quota avec le nom spécifié
Exemple d'utilisation
# Create a new resource quota named my-quota oc create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10 # Create a new resource quota named best-effort oc create quota best-effort --hard=pods=100 --scopes=BestEffort
# Create a new resource quota named my-quota
oc create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
# Create a new resource quota named best-effort
oc create quota best-effort --hard=pods=100 --scopes=BestEffort
2.7.1.50. oc create role Copier lienLien copié sur presse-papiers!
Créer un rôle avec une seule règle
Exemple d'utilisation
2.7.1.51. oc create rolebinding Copier lienLien copié sur presse-papiers!
Créer un lien de rôle pour un rôle particulier ou un rôle de cluster
Exemple d'utilisation
# Create a role binding for user1, user2, and group1 using the admin cluster role oc create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
# Create a role binding for user1, user2, and group1 using the admin cluster role
oc create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
2.7.1.52. oc create route edge Copier lienLien copié sur presse-papiers!
Créer une route qui utilise la terminaison TLS en périphérie
Exemple d'utilisation
2.7.1.53. oc create route passthrough Copier lienLien copié sur presse-papiers!
Créer une route qui utilise la terminaison TLS passthrough
Exemple d'utilisation
2.7.1.54. oc create route reencrypt Copier lienLien copié sur presse-papiers!
Créer une route qui utilise la terminaison TLS reencrypt
Exemple d'utilisation
2.7.1.55. oc create secret docker-registry Copier lienLien copié sur presse-papiers!
Créer un secret à utiliser avec un registre Docker
Exemple d'utilisation
# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: oc create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL # Create a new secret named my-secret from ~/.docker/config.json oc create secret docker-registry my-secret --from-file=.dockerconfigjson=path/to/.docker/config.json
# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
oc create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
# Create a new secret named my-secret from ~/.docker/config.json
oc create secret docker-registry my-secret --from-file=.dockerconfigjson=path/to/.docker/config.json
2.7.1.56. oc create secret generic Copier lienLien copié sur presse-papiers!
Créer un secret à partir d'un fichier local, d'un répertoire ou d'une valeur littérale
Exemple d'utilisation
2.7.1.57. oc create secret tls Copier lienLien copié sur presse-papiers!
Créer un secret TLS
Exemple d'utilisation
# Create a new TLS secret named tls-secret with the given key pair oc create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
# Create a new TLS secret named tls-secret with the given key pair
oc create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
2.7.1.58. oc create service clusterip Copier lienLien copié sur presse-papiers!
Créer un service ClusterIP
Exemple d'utilisation
# Create a new ClusterIP service named my-cs oc create service clusterip my-cs --tcp=5678:8080 # Create a new ClusterIP service named my-cs (in headless mode) oc create service clusterip my-cs --clusterip="None"
# Create a new ClusterIP service named my-cs
oc create service clusterip my-cs --tcp=5678:8080
# Create a new ClusterIP service named my-cs (in headless mode)
oc create service clusterip my-cs --clusterip="None"
2.7.1.59. oc create service externalname Copier lienLien copié sur presse-papiers!
Créer un service ExternalName
Exemple d'utilisation
# Create a new ExternalName service named my-ns oc create service externalname my-ns --external-name bar.com
# Create a new ExternalName service named my-ns
oc create service externalname my-ns --external-name bar.com
2.7.1.60. oc create service loadbalancer Copier lienLien copié sur presse-papiers!
Créer un service LoadBalancer
Exemple d'utilisation
# Create a new LoadBalancer service named my-lbs oc create service loadbalancer my-lbs --tcp=5678:8080
# Create a new LoadBalancer service named my-lbs
oc create service loadbalancer my-lbs --tcp=5678:8080
2.7.1.61. oc create service nodeport Copier lienLien copié sur presse-papiers!
Créer un service NodePort
Exemple d'utilisation
# Create a new NodePort service named my-ns oc create service nodeport my-ns --tcp=5678:8080
# Create a new NodePort service named my-ns
oc create service nodeport my-ns --tcp=5678:8080
2.7.1.62. oc create serviceaccount Copier lienLien copié sur presse-papiers!
Créer un compte de service avec le nom spécifié
Exemple d'utilisation
# Create a new service account named my-service-account oc create serviceaccount my-service-account
# Create a new service account named my-service-account
oc create serviceaccount my-service-account
2.7.1.63. oc create token Copier lienLien copié sur presse-papiers!
Demander un jeton de compte de service
Exemple d'utilisation
2.7.1.64. oc create user Copier lienLien copié sur presse-papiers!
Créer manuellement un utilisateur (nécessaire uniquement si la création automatique est désactivée)
Exemple d'utilisation
# Create a user with the username "ajones" and the display name "Adam Jones" oc create user ajones --full-name="Adam Jones"
# Create a user with the username "ajones" and the display name "Adam Jones"
oc create user ajones --full-name="Adam Jones"
2.7.1.65. oc create useridentitymapping Copier lienLien copié sur presse-papiers!
Associer manuellement une identité à un utilisateur
Exemple d'utilisation
# Map the identity "acme_ldap:adamjones" to the user "ajones" oc create useridentitymapping acme_ldap:adamjones ajones
# Map the identity "acme_ldap:adamjones" to the user "ajones"
oc create useridentitymapping acme_ldap:adamjones ajones
2.7.1.66. oc debug Copier lienLien copié sur presse-papiers!
Lancer une nouvelle instance d'un pod pour le débogage
Exemple d'utilisation
2.7.1.67. oc supprimer Copier lienLien copié sur presse-papiers!
Supprimer les ressources par nom de fichier, stdin, ressources et noms, ou par ressources et sélecteur d'étiquette
Exemple d'utilisation
2.7.1.68. oc décrire Copier lienLien copié sur presse-papiers!
Afficher les détails d'une ressource spécifique ou d'un groupe de ressources
Exemple d'utilisation
2.7.1.69. oc diff Copier lienLien copié sur presse-papiers!
Comparer la version en direct avec une version appliquée potentielle
Exemple d'utilisation
# Diff resources included in pod.json oc diff -f pod.json # Diff file read from stdin cat service.yaml | oc diff -f -
# Diff resources included in pod.json
oc diff -f pod.json
# Diff file read from stdin
cat service.yaml | oc diff -f -
2.7.1.70. oc edit Copier lienLien copié sur presse-papiers!
Modifier une ressource sur le serveur
Exemple d'utilisation
2.7.1.71. oc exec Copier lienLien copié sur presse-papiers!
Exécuter une commande dans un conteneur
Exemple d'utilisation
2.7.1.72. oc expliquer Copier lienLien copié sur presse-papiers!
Obtenir la documentation d'une ressource
Exemple d'utilisation
# Get the documentation of the resource and its fields oc explain pods # Get the documentation of a specific field of a resource oc explain pods.spec.containers
# Get the documentation of the resource and its fields
oc explain pods
# Get the documentation of a specific field of a resource
oc explain pods.spec.containers
2.7.1.73. oc exposer Copier lienLien copié sur presse-papiers!
Exposer une application répliquée en tant que service ou route
Exemple d'utilisation
2.7.1.74. extrait d'oc Copier lienLien copié sur presse-papiers!
Extraction de secrets ou de cartes de configuration sur disque
Exemple d'utilisation
2.7.1.75. oc obtenir Copier lienLien copié sur presse-papiers!
Afficher une ou plusieurs ressources
Exemple d'utilisation
2.7.1.76. oc oisif Copier lienLien copié sur presse-papiers!
Ressources modulables inactives
Exemple d'utilisation
# Idle the scalable controllers associated with the services listed in to-idle.txt $ oc idle --resource-names-file to-idle.txt
# Idle the scalable controllers associated with the services listed in to-idle.txt
$ oc idle --resource-names-file to-idle.txt
2.7.1.77. oc image append Copier lienLien copié sur presse-papiers!
Ajouter des calques aux images et les transférer dans un registre
Exemple d'utilisation
2.7.1.78. extraction d'images d'oc Copier lienLien copié sur presse-papiers!
Copier des fichiers d'une image vers le système de fichiers
Exemple d'utilisation
2.7.1.79. oc image info Copier lienLien copié sur presse-papiers!
Afficher des informations sur une image
Exemple d'utilisation
2.7.1.80. oc image mirror Copier lienLien copié sur presse-papiers!
Images miroir d'un référentiel à l'autre
Exemple d'utilisation
2.7.1.81. oc import-image Copier lienLien copié sur presse-papiers!
Importer des images à partir d'un registre d'images de conteneurs
Exemple d'utilisation
2.7.1.82. oc kustomize Copier lienLien copié sur presse-papiers!
Construire une cible de personnalisation à partir d'un répertoire ou d'une URL.
Exemple d'utilisation
2.7.1.83. étiquette oc Copier lienLien copié sur presse-papiers!
Mettre à jour les étiquettes d'une ressource
Exemple d'utilisation
2.7.1.84. login oc Copier lienLien copié sur presse-papiers!
Se connecter à un serveur
Exemple d'utilisation
2.7.1.85. oc logout Copier lienLien copié sur presse-papiers!
Fin de la session serveur en cours
Exemple d'utilisation
# Log out oc logout
# Log out
oc logout
2.7.1.86. journaux d'oc Copier lienLien copié sur presse-papiers!
Imprimer les logs d'un conteneur dans un pod
Exemple d'utilisation
2.7.1.87. oc new-app Copier lienLien copié sur presse-papiers!
Créer une nouvelle application
Exemple d'utilisation
2.7.1.88. oc nouvelle construction Copier lienLien copié sur presse-papiers!
Créer une nouvelle configuration de construction
Exemple d'utilisation
2.7.1.89. oc new-project Copier lienLien copié sur presse-papiers!
Demander un nouveau projet
Exemple d'utilisation
# Create a new project with minimal information oc new-project web-team-dev # Create a new project with a display name and description oc new-project web-team-dev --display-name="Web Team Development" --description="Development project for the web team."
# Create a new project with minimal information
oc new-project web-team-dev
# Create a new project with a display name and description
oc new-project web-team-dev --display-name="Web Team Development" --description="Development project for the web team."
2.7.1.90. oc observer Copier lienLien copié sur presse-papiers!
Observer les changements dans les ressources et y réagir (expérimental)
Exemple d'utilisation
2.7.1.91. patch oc Copier lienLien copié sur presse-papiers!
Mise à jour des champs d'une ressource
Exemple d'utilisation
2.7.1.92. liste des plugins oc Copier lienLien copié sur presse-papiers!
Liste de tous les exécutables de plugins visibles dans le PATH d'un utilisateur
Exemple d'utilisation
# List all available plugins oc plugin list
# List all available plugins
oc plugin list
2.7.1.93. oc policy add-role-to-user Copier lienLien copié sur presse-papiers!
Ajouter un rôle aux utilisateurs ou aux comptes de service pour le projet en cours
Exemple d'utilisation
# Add the 'view' role to user1 for the current project oc policy add-role-to-user view user1 # Add the 'edit' role to serviceaccount1 for the current project oc policy add-role-to-user edit -z serviceaccount1
# Add the 'view' role to user1 for the current project
oc policy add-role-to-user view user1
# Add the 'edit' role to serviceaccount1 for the current project
oc policy add-role-to-user edit -z serviceaccount1
2.7.1.94. politique de l'oc révision du csc Copier lienLien copié sur presse-papiers!
Vérifier quel compte de service peut créer un pod
Exemple d'utilisation
2.7.1.95. politique de l'oc scc-subject-review Copier lienLien copié sur presse-papiers!
Vérifier si un utilisateur ou un compte de service peut créer un pod
Exemple d'utilisation
2.7.1.96. oc port-forward Copier lienLien copié sur presse-papiers!
Transférer un ou plusieurs ports locaux vers un pod
Exemple d'utilisation
2.7.1.97. processus d'oc Copier lienLien copié sur presse-papiers!
Transformer un modèle en liste de ressources
Exemple d'utilisation
2.7.1.98. projet oc Copier lienLien copié sur presse-papiers!
Passer à un autre projet
Exemple d'utilisation
# Switch to the 'myapp' project oc project myapp # Display the project currently in use oc project
# Switch to the 'myapp' project
oc project myapp
# Display the project currently in use
oc project
2.7.1.99. projets d'oc Copier lienLien copié sur presse-papiers!
Afficher les projets existants
Exemple d'utilisation
# List all projects oc projects
# List all projects
oc projects
2.7.1.100. proxy oc Copier lienLien copié sur presse-papiers!
Exécuter un proxy vers le serveur API Kubernetes
Exemple d'utilisation
2.7.1.101. infos sur le registre des oc Copier lienLien copié sur presse-papiers!
Imprimer des informations sur le registre intégré
Exemple d'utilisation
# Display information about the integrated registry oc registry info
# Display information about the integrated registry
oc registry info
2.7.1.102. oc registry login Copier lienLien copié sur presse-papiers!
Se connecter au registre intégré
Exemple d'utilisation
# Log in to the integrated registry oc registry login # Log in to different registry using BASIC auth credentials oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS
# Log in to the integrated registry
oc registry login
# Log in to different registry using BASIC auth credentials
oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS
2.7.1.103. oc remplacer Copier lienLien copié sur presse-papiers!
Remplacer une ressource par un nom de fichier ou par stdin
Exemple d'utilisation
2.7.1.104. oc rollback Copier lienLien copié sur presse-papiers!
Revenir à un déploiement antérieur d'une partie de l'application
Exemple d'utilisation
2.7.1.105. annulation de la mise en œuvre de l'oc Copier lienLien copié sur presse-papiers!
Annuler le déploiement en cours
Exemple d'utilisation
# Cancel the in-progress deployment based on 'nginx' oc rollout cancel dc/nginx
# Cancel the in-progress deployment based on 'nginx'
oc rollout cancel dc/nginx
2.7.1.106. historique du déploiement des oc Copier lienLien copié sur presse-papiers!
Voir l'historique des déploiements
Exemple d'utilisation
# View the rollout history of a deployment oc rollout history dc/nginx # View the details of deployment revision 3 oc rollout history dc/nginx --revision=3
# View the rollout history of a deployment
oc rollout history dc/nginx
# View the details of deployment revision 3
oc rollout history dc/nginx --revision=3
2.7.1.107. dernier déploiement d'oc Copier lienLien copié sur presse-papiers!
Démarrer un nouveau déploiement pour une configuration de déploiement avec le dernier état de ses déclencheurs
Exemple d'utilisation
# Start a new rollout based on the latest images defined in the image change triggers oc rollout latest dc/nginx # Print the rolled out deployment config oc rollout latest dc/nginx -o json
# Start a new rollout based on the latest images defined in the image change triggers
oc rollout latest dc/nginx
# Print the rolled out deployment config
oc rollout latest dc/nginx -o json
2.7.1.108. pause dans le déploiement de l'oc Copier lienLien copié sur presse-papiers!
Marquer la ressource fournie comme interrompue
Exemple d'utilisation
# Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused oc rollout pause dc/nginx
# Mark the nginx deployment as paused. Any current state of
# the deployment will continue its function, new updates to the deployment will not
# have an effect as long as the deployment is paused
oc rollout pause dc/nginx
2.7.1.109. redémarrage du déploiement d'oc Copier lienLien copié sur presse-papiers!
Redémarrer une ressource
Exemple d'utilisation
2.7.1.110. résumé de la mise en œuvre de l'oc Copier lienLien copié sur presse-papiers!
Reprendre une ressource en pause
Exemple d'utilisation
# Resume an already paused deployment oc rollout resume dc/nginx
# Resume an already paused deployment
oc rollout resume dc/nginx
2.7.1.111. oc rollout retry Copier lienLien copié sur presse-papiers!
Réessayer le dernier déploiement qui a échoué
Exemple d'utilisation
# Retry the latest failed deployment based on 'frontend' # The deployer pod and any hook pods are deleted for the latest failed deployment oc rollout retry dc/frontend
# Retry the latest failed deployment based on 'frontend'
# The deployer pod and any hook pods are deleted for the latest failed deployment
oc rollout retry dc/frontend
2.7.1.112. état d'avancement du déploiement des oc Copier lienLien copié sur presse-papiers!
Afficher l'état d'avancement du déploiement
Exemple d'utilisation
# Watch the status of the latest rollout oc rollout status dc/nginx
# Watch the status of the latest rollout
oc rollout status dc/nginx
2.7.1.113. oc rollout undo Copier lienLien copié sur presse-papiers!
Annuler un déploiement précédent
Exemple d'utilisation
# Roll back to the previous deployment oc rollout undo dc/nginx # Roll back to deployment revision 3. The replication controller for that version must exist oc rollout undo dc/nginx --to-revision=3
# Roll back to the previous deployment
oc rollout undo dc/nginx
# Roll back to deployment revision 3. The replication controller for that version must exist
oc rollout undo dc/nginx --to-revision=3
2.7.1.114. oc rsh Copier lienLien copié sur presse-papiers!
Démarrer une session shell dans un conteneur
Exemple d'utilisation
2.7.1.115. oc rsync Copier lienLien copié sur presse-papiers!
Copier des fichiers entre un système de fichiers local et un pod
Exemple d'utilisation
# Synchronize a local directory with a pod directory oc rsync ./local/dir/ POD:/remote/dir # Synchronize a pod directory with a local directory oc rsync POD:/remote/dir/ ./local/dir
# Synchronize a local directory with a pod directory
oc rsync ./local/dir/ POD:/remote/dir
# Synchronize a pod directory with a local directory
oc rsync POD:/remote/dir/ ./local/dir
2.7.1.116. course d'oc Copier lienLien copié sur presse-papiers!
Exécuter une image particulière sur le cluster
Exemple d'utilisation
2.7.1.117. échelle oc Copier lienLien copié sur presse-papiers!
Définir une nouvelle taille pour un déploiement, un ensemble de réplicas ou un contrôleur de réplication
Exemple d'utilisation
2.7.1.118. oc secrets link Copier lienLien copié sur presse-papiers!
Lier les secrets à un compte de service
Exemple d'utilisation
# Add an image pull secret to a service account to automatically use it for pulling pod images oc secrets link serviceaccount-name pull-secret --for=pull # Add an image pull secret to a service account to automatically use it for both pulling and pushing build images oc secrets link builder builder-image-secret --for=pull,mount
# Add an image pull secret to a service account to automatically use it for pulling pod images
oc secrets link serviceaccount-name pull-secret --for=pull
# Add an image pull secret to a service account to automatically use it for both pulling and pushing build images
oc secrets link builder builder-image-secret --for=pull,mount
2.7.1.119. oc secrets unlink Copier lienLien copié sur presse-papiers!
Détacher les secrets d'un compte de service
Exemple d'utilisation
# Unlink a secret currently associated with a service account oc secrets unlink serviceaccount-name secret-name another-secret-name ...
# Unlink a secret currently associated with a service account
oc secrets unlink serviceaccount-name secret-name another-secret-name ...
2.7.1.120. oc set build-hook Copier lienLien copié sur presse-papiers!
Mise à jour d'un crochet de construction sur une configuration de construction
Exemple d'utilisation
2.7.1.121. oc set build-secret Copier lienLien copié sur presse-papiers!
Mise à jour d'un secret de construction sur une configuration de construction
Exemple d'utilisation
2.7.1.122. oc set data Copier lienLien copié sur presse-papiers!
Mettre à jour les données d'une carte de configuration ou d'un secret
Exemple d'utilisation
2.7.1.123. oc set deployment-hook Copier lienLien copié sur presse-papiers!
Mise à jour d'un crochet de déploiement sur une configuration de déploiement
Exemple d'utilisation
2.7.1.124. oc set env Copier lienLien copié sur presse-papiers!
Mise à jour des variables d'environnement sur un modèle de pod
Exemple d'utilisation
2.7.1.125. oc set image Copier lienLien copié sur presse-papiers!
Mise à jour de l'image d'un modèle de pod
Exemple d'utilisation
2.7.1.126. oc set image-lookup Copier lienLien copié sur presse-papiers!
Modifier la façon dont les images sont résolues lors du déploiement des applications
Exemple d'utilisation
2.7.1.127. oc set probe Copier lienLien copié sur presse-papiers!
Mise à jour d'une sonde sur un modèle de pod
Exemple d'utilisation
2.7.1.128. oc set resources Copier lienLien copié sur presse-papiers!
Mise à jour des demandes/limites de ressources sur les objets avec des modèles de pods
Exemple d'utilisation
2.7.1.129. oc set route-backends Copier lienLien copié sur presse-papiers!
Mettre à jour les backends d'une route
Exemple d'utilisation
2.7.1.130. sélecteur d'ensemble d'oc Copier lienLien copié sur presse-papiers!
Définir le sélecteur d'une ressource
Exemple d'utilisation
# Set the labels and selector before creating a deployment/service pair. oc create service clusterip my-svc --clusterip="None" -o yaml --dry-run | oc set selector --local -f - 'environment=qa' -o yaml | oc create -f - oc create deployment my-dep -o yaml --dry-run | oc label --local -f - environment=qa -o yaml | oc create -f -
# Set the labels and selector before creating a deployment/service pair.
oc create service clusterip my-svc --clusterip="None" -o yaml --dry-run | oc set selector --local -f - 'environment=qa' -o yaml | oc create -f -
oc create deployment my-dep -o yaml --dry-run | oc label --local -f - environment=qa -o yaml | oc create -f -
2.7.1.131. oc set serviceaccount Copier lienLien copié sur presse-papiers!
Mettre à jour le compte de service d'une ressource
Exemple d'utilisation
# Set deployment nginx-deployment's service account to serviceaccount1 oc set serviceaccount deployment nginx-deployment serviceaccount1 # Print the result (in YAML format) of updated nginx deployment with service account from a local file, without hitting the API server oc set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
# Set deployment nginx-deployment's service account to serviceaccount1
oc set serviceaccount deployment nginx-deployment serviceaccount1
# Print the result (in YAML format) of updated nginx deployment with service account from a local file, without hitting the API server
oc set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
2.7.1.132. oc set subject Copier lienLien copié sur presse-papiers!
Mise à jour du compte de l'utilisateur, du groupe ou du service dans une liaison de rôles ou une liaison de rôles de cluster
Exemple d'utilisation
2.7.1.133. oc set triggers Copier lienLien copié sur presse-papiers!
Mise à jour des déclencheurs sur un ou plusieurs objets
Exemple d'utilisation
2.7.1.134. oc set volumes Copier lienLien copié sur presse-papiers!
Mise à jour des volumes sur un modèle de pod
Exemple d'utilisation
2.7.1.135. oc start-build Copier lienLien copié sur presse-papiers!
Commencer une nouvelle construction
Exemple d'utilisation
2.7.1.136. statut de l'oc Copier lienLien copié sur presse-papiers!
Afficher une vue d'ensemble du projet en cours
Exemple d'utilisation
2.7.1.137. étiquette oc Copier lienLien copié sur presse-papiers!
Marquer des images existantes dans des flux d'images
Exemple d'utilisation
2.7.1.138. version oc Copier lienLien copié sur presse-papiers!
Imprimer les informations relatives à la version du client et du serveur
Exemple d'utilisation
2.7.1.139. oc attendre Copier lienLien copié sur presse-papiers!
Expérimental : Attente d'une condition spécifique sur une ou plusieurs ressources
Exemple d'utilisation
2.7.1.140. oc whoami Copier lienLien copié sur presse-papiers!
Renvoi d'informations sur la session en cours
Exemple d'utilisation
# Display the currently authenticated user oc whoami
# Display the currently authenticated user
oc whoami
2.8. Référence des commandes de l'administrateur de la CLI d'OpenShift Copier lienLien copié sur presse-papiers!
Cette référence fournit des descriptions et des exemples de commandes pour les commandes administrateur de l'OpenShift CLI (oc). Vous devez disposer de cluster-admin ou d'autorisations équivalentes pour utiliser ces commandes.
Pour les commandes de développeur, voir la référence des commandes de développeur de l'OpenShift CLI.
Exécutez oc adm -h pour obtenir la liste de toutes les commandes de l'administrateur ou exécutez oc <command> --help pour obtenir des détails supplémentaires sur une commande spécifique.
2.8.1. Commandes de l'administrateur OpenShift CLI (oc) Copier lienLien copié sur presse-papiers!
2.8.1.1. oc adm build-chain Copier lienLien copié sur presse-papiers!
Produire les entrées et les dépendances de vos constructions
Exemple d'utilisation
2.8.1.2. oc adm catalogue mirror Copier lienLien copié sur presse-papiers!
Miroir d'un catalogue de registres d'opérateurs
Exemple d'utilisation
2.8.1.3. certificat oc adm approuver Copier lienLien copié sur presse-papiers!
Approuver une demande de signature de certificat
Exemple d'utilisation
# Approve CSR 'csr-sqgzp' oc adm certificate approve csr-sqgzp
# Approve CSR 'csr-sqgzp'
oc adm certificate approve csr-sqgzp
2.8.1.4. oc adm certificat deny Copier lienLien copié sur presse-papiers!
Refuser une demande de signature de certificat
Exemple d'utilisation
# Deny CSR 'csr-sqgzp' oc adm certificate deny csr-sqgzp
# Deny CSR 'csr-sqgzp'
oc adm certificate deny csr-sqgzp
2.8.1.5. oc adm cordon Copier lienLien copié sur presse-papiers!
Marquer le nœud comme non maîtrisable
Exemple d'utilisation
# Mark node "foo" as unschedulable oc adm cordon foo
# Mark node "foo" as unschedulable
oc adm cordon foo
2.8.1.6. oc adm create-bootstrap-project-template Copier lienLien copié sur presse-papiers!
Créer un modèle de projet bootstrap
Exemple d'utilisation
# Output a bootstrap project template in YAML format to stdout oc adm create-bootstrap-project-template -o yaml
# Output a bootstrap project template in YAML format to stdout
oc adm create-bootstrap-project-template -o yaml
2.8.1.7. oc adm create-error-template Copier lienLien copié sur presse-papiers!
Créer un modèle de page d'erreur
Exemple d'utilisation
# Output a template for the error page to stdout oc adm create-error-template
# Output a template for the error page to stdout
oc adm create-error-template
2.8.1.8. oc adm create-login-template Copier lienLien copié sur presse-papiers!
Créer un modèle de connexion
Exemple d'utilisation
# Output a template for the login page to stdout oc adm create-login-template
# Output a template for the login page to stdout
oc adm create-login-template
2.8.1.9. oc adm create-provider-selection-template (modèle de sélection du fournisseur) Copier lienLien copié sur presse-papiers!
Créer un modèle de sélection des fournisseurs
Exemple d'utilisation
# Output a template for the provider selection page to stdout oc adm create-provider-selection-template
# Output a template for the provider selection page to stdout
oc adm create-provider-selection-template
2.8.1.10. oc adm drain Copier lienLien copié sur presse-papiers!
Drainage du nœud en vue de l'entretien
Exemple d'utilisation
# Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set on it oc adm drain foo --force # As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set, and use a grace period of 15 minutes oc adm drain foo --grace-period=900
# Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set on it
oc adm drain foo --force
# As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set, and use a grace period of 15 minutes
oc adm drain foo --grace-period=900
2.8.1.11. oc adm groups add-users Copier lienLien copié sur presse-papiers!
Ajouter des utilisateurs à un groupe
Exemple d'utilisation
# Add user1 and user2 to my-group oc adm groups add-users my-group user1 user2
# Add user1 and user2 to my-group
oc adm groups add-users my-group user1 user2
2.8.1.12. oc adm groups new Copier lienLien copié sur presse-papiers!
Créer un nouveau groupe
Exemple d'utilisation
2.8.1.13. oc adm groups prune Copier lienLien copié sur presse-papiers!
Supprimer d'anciens groupes OpenShift référençant des enregistrements manquants d'un fournisseur externe
Exemple d'utilisation
2.8.1.14. oc adm groups remove-users Copier lienLien copié sur presse-papiers!
Supprimer des utilisateurs d'un groupe
Exemple d'utilisation
# Remove user1 and user2 from my-group oc adm groups remove-users my-group user1 user2
# Remove user1 and user2 from my-group
oc adm groups remove-users my-group user1 user2
2.8.1.15. oc adm groups sync Copier lienLien copié sur presse-papiers!
Synchroniser les groupes OpenShift avec les enregistrements d'un fournisseur externe
Exemple d'utilisation
2.8.1.16. oc adm inspect Copier lienLien copié sur presse-papiers!
Collecte des données de débogage pour une ressource donnée
Exemple d'utilisation
2.8.1.17. oc adm migrate template-instances Copier lienLien copié sur presse-papiers!
Mettre à jour les instances de modèles pour qu'elles pointent vers les derniers types de versions de groupes
Exemple d'utilisation
# Perform a dry-run of updating all objects oc adm migrate template-instances # To actually perform the update, the confirm flag must be appended oc adm migrate template-instances --confirm
# Perform a dry-run of updating all objects
oc adm migrate template-instances
# To actually perform the update, the confirm flag must be appended
oc adm migrate template-instances --confirm
2.8.1.18. oc adm must-gather Copier lienLien copié sur presse-papiers!
Lancer une nouvelle instance d'un pod pour recueillir des informations de débogage
Exemple d'utilisation
2.8.1.19. oc adm new-project Copier lienLien copié sur presse-papiers!
Créer un nouveau projet
Exemple d'utilisation
# Create a new project using a node selector oc adm new-project myproject --node-selector='type=user-node,region=east'
# Create a new project using a node selector
oc adm new-project myproject --node-selector='type=user-node,region=east'
2.8.1.20. oc adm node-logs Copier lienLien copié sur presse-papiers!
Afficher et filtrer les journaux des nœuds
Exemple d'utilisation
2.8.1.21. oc adm pod-network isolate-projects Copier lienLien copié sur presse-papiers!
Isoler le réseau de projets
Exemple d'utilisation
# Provide isolation for project p1 oc adm pod-network isolate-projects <p1> # Allow all projects with label name=top-secret to have their own isolated project network oc adm pod-network isolate-projects --selector='name=top-secret'
# Provide isolation for project p1
oc adm pod-network isolate-projects <p1>
# Allow all projects with label name=top-secret to have their own isolated project network
oc adm pod-network isolate-projects --selector='name=top-secret'
2.8.1.22. oc adm pod-network join-projects Copier lienLien copié sur presse-papiers!
Rejoindre le réseau de projets
Exemple d'utilisation
# Allow project p2 to use project p1 network oc adm pod-network join-projects --to=<p1> <p2> # Allow all projects with label name=top-secret to use project p1 network oc adm pod-network join-projects --to=<p1> --selector='name=top-secret'
# Allow project p2 to use project p1 network
oc adm pod-network join-projects --to=<p1> <p2>
# Allow all projects with label name=top-secret to use project p1 network
oc adm pod-network join-projects --to=<p1> --selector='name=top-secret'
2.8.1.23. oc adm pod-network make-projects-global Copier lienLien copié sur presse-papiers!
Faire du réseau de projets un réseau mondial
Exemple d'utilisation
# Allow project p1 to access all pods in the cluster and vice versa oc adm pod-network make-projects-global <p1> # Allow all projects with label name=share to access all pods in the cluster and vice versa oc adm pod-network make-projects-global --selector='name=share'
# Allow project p1 to access all pods in the cluster and vice versa
oc adm pod-network make-projects-global <p1>
# Allow all projects with label name=share to access all pods in the cluster and vice versa
oc adm pod-network make-projects-global --selector='name=share'
2.8.1.24. oc adm policy add-role-to-user Copier lienLien copié sur presse-papiers!
Ajouter un rôle aux utilisateurs ou aux comptes de service pour le projet en cours
Exemple d'utilisation
# Add the 'view' role to user1 for the current project oc adm policy add-role-to-user view user1 # Add the 'edit' role to serviceaccount1 for the current project oc adm policy add-role-to-user edit -z serviceaccount1
# Add the 'view' role to user1 for the current project
oc adm policy add-role-to-user view user1
# Add the 'edit' role to serviceaccount1 for the current project
oc adm policy add-role-to-user edit -z serviceaccount1
2.8.1.25. oc adm policy add-scc-to-group Copier lienLien copié sur presse-papiers!
Ajouter une contrainte de contexte de sécurité aux groupes
Exemple d'utilisation
# Add the 'restricted' security context constraint to group1 and group2 oc adm policy add-scc-to-group restricted group1 group2
# Add the 'restricted' security context constraint to group1 and group2
oc adm policy add-scc-to-group restricted group1 group2
2.8.1.26. oc adm policy add-scc-to-user Copier lienLien copié sur presse-papiers!
Ajouter une contrainte de contexte de sécurité aux utilisateurs ou à un compte de service
Exemple d'utilisation
# Add the 'restricted' security context constraint to user1 and user2 oc adm policy add-scc-to-user restricted user1 user2 # Add the 'privileged' security context constraint to serviceaccount1 in the current namespace oc adm policy add-scc-to-user privileged -z serviceaccount1
# Add the 'restricted' security context constraint to user1 and user2
oc adm policy add-scc-to-user restricted user1 user2
# Add the 'privileged' security context constraint to serviceaccount1 in the current namespace
oc adm policy add-scc-to-user privileged -z serviceaccount1
2.8.1.27. oc adm policy scc-review Copier lienLien copié sur presse-papiers!
Vérifier quel compte de service peut créer un pod
Exemple d'utilisation
2.8.1.28. politique de l'oc adm scc-subject-review Copier lienLien copié sur presse-papiers!
Vérifier si un utilisateur ou un compte de service peut créer un pod
Exemple d'utilisation
2.8.1.29. oc adm prune builds Copier lienLien copié sur presse-papiers!
Supprimer les anciennes constructions achevées et celles qui ont échoué
Exemple d'utilisation
2.8.1.30. oc adm prune deployments Copier lienLien copié sur presse-papiers!
Suppression des anciennes configurations de déploiement terminées ou ayant échoué
Exemple d'utilisation
# Dry run deleting all but the last complete deployment for every deployment config oc adm prune deployments --keep-complete=1 # To actually perform the prune operation, the confirm flag must be appended oc adm prune deployments --keep-complete=1 --confirm
# Dry run deleting all but the last complete deployment for every deployment config
oc adm prune deployments --keep-complete=1
# To actually perform the prune operation, the confirm flag must be appended
oc adm prune deployments --keep-complete=1 --confirm
2.8.1.31. oc adm prune groups Copier lienLien copié sur presse-papiers!
Supprimer d'anciens groupes OpenShift référençant des enregistrements manquants d'un fournisseur externe
Exemple d'utilisation
2.8.1.32. oc adm prune images Copier lienLien copié sur presse-papiers!
Supprimer les images non référencées
Exemple d'utilisation
2.8.1.33. oc adm release extract Copier lienLien copié sur presse-papiers!
Extraire le contenu d'une charge utile de mise à jour sur le disque
Exemple d'utilisation
2.8.1.34. oc adm release info Copier lienLien copié sur presse-papiers!
Afficher des informations sur une version
Exemple d'utilisation
2.8.1.35. oc adm release mirror Copier lienLien copié sur presse-papiers!
Miroir d'une version vers un autre emplacement du registre d'images
Exemple d'utilisation
2.8.1.36. oc adm release new Copier lienLien copié sur presse-papiers!
Créer une nouvelle version d'OpenShift
Exemple d'utilisation
2.8.1.37. oc adm taint Copier lienLien copié sur presse-papiers!
Mise à jour des taches sur un ou plusieurs nœuds
Exemple d'utilisation
2.8.1.38. oc adm top images Copier lienLien copié sur presse-papiers!
Afficher les statistiques d'utilisation des images
Exemple d'utilisation
# Show usage statistics for images oc adm top images
# Show usage statistics for images
oc adm top images
2.8.1.39. oc adm top imagestreams Copier lienLien copié sur presse-papiers!
Afficher les statistiques d'utilisation des flux d'images
Exemple d'utilisation
# Show usage statistics for image streams oc adm top imagestreams
# Show usage statistics for image streams
oc adm top imagestreams
2.8.1.40. oc adm top node Copier lienLien copié sur presse-papiers!
Affichage de l'utilisation des ressources (CPU/mémoire) des nœuds
Exemple d'utilisation
# Show metrics for all nodes oc adm top node # Show metrics for a given node oc adm top node NODE_NAME
# Show metrics for all nodes
oc adm top node
# Show metrics for a given node
oc adm top node NODE_NAME
2.8.1.41. oc adm top pod Copier lienLien copié sur presse-papiers!
Afficher l'utilisation des ressources (CPU/mémoire) des pods
Exemple d'utilisation
2.8.1.42. oc adm uncordon Copier lienLien copié sur presse-papiers!
Marquer le nœud comme planifiable
Exemple d'utilisation
# Mark node "foo" as schedulable oc adm uncordon foo
# Mark node "foo" as schedulable
oc adm uncordon foo
2.8.1.43. oc adm upgrade Copier lienLien copié sur presse-papiers!
Mettre à niveau un cluster ou ajuster le canal de mise à niveau
Exemple d'utilisation
# Review the available cluster updates oc adm upgrade # Update to the latest version oc adm upgrade --to-latest=true
# Review the available cluster updates
oc adm upgrade
# Update to the latest version
oc adm upgrade --to-latest=true
2.8.1.44. oc adm verify-image-signature Copier lienLien copié sur presse-papiers!
Vérifier l'identité de l'image contenue dans la signature de l'image
Exemple d'utilisation
Chapitre 3. Mise à jour importante sur odo Copier lienLien copié sur presse-papiers!
Red Hat ne fournit pas d'informations sur odo sur le site de documentation d'OpenShift Container Platform. Consultez la documentation maintenue par Red Hat et la communauté en amont pour obtenir des informations sur la documentation relative à odo.
Pour les matériaux maintenus par la communauté en amont, Red Hat fournit une assistance sous Cooperative Community Support.
Chapitre 4. CLI Knative pour utilisation avec OpenShift Serverless Copier lienLien copié sur presse-papiers!
Le CLI Knative (kn) permet une interaction simple avec les composants Knative sur OpenShift Container Platform.
4.1. Caractéristiques principales Copier lienLien copié sur presse-papiers!
La CLI Knative (kn) est conçue pour rendre les tâches informatiques sans serveur simples et concises. Les principales caractéristiques de la CLI Knative sont les suivantes :
- Déployer des applications sans serveur à partir de la ligne de commande.
- Gérer les fonctionnalités de Knative Serving, telles que les services, les révisions et la répartition du trafic.
- Créer et gérer des composants Knative Eventing, tels que des sources d'événements et des déclencheurs.
- Créer des sink bindings pour connecter les applications Kubernetes existantes et les services Knative.
-
Étendre la CLI Knative avec une architecture flexible de plugins, similaire à la CLI
kubectl. - Configurer les paramètres d'autoscaling pour les services Knative.
- L'utilisation de scripts, comme l'attente des résultats d'une opération, ou le déploiement de stratégies personnalisées de déploiement et de retour en arrière.
4.2. Installation du CLI Knative Copier lienLien copié sur presse-papiers!
Chapitre 5. CLI Pipelines (tkn) Copier lienLien copié sur presse-papiers!
5.1. Installation de tkn Copier lienLien copié sur presse-papiers!
Utilisez l'outil CLI pour gérer Red Hat OpenShift Pipelines à partir d'un terminal. La section suivante décrit comment installer l'outil CLI sur différentes plateformes.
Vous pouvez également trouver l'URL des derniers binaires à partir de la console web d'OpenShift Container Platform en cliquant sur l'icône ? dans le coin supérieur droit et en sélectionnant Command Line Tools.
L'exécution de Red Hat OpenShift Pipelines sur du matériel ARM est une fonctionnalité d'aperçu technologique uniquement. Les fonctionnalités de l'aperçu technologique ne sont pas prises en charge par les accords de niveau de service (SLA) de production de Red Hat et peuvent ne pas être complètes sur le plan fonctionnel. Red Hat ne recommande pas de les utiliser en production. Ces fonctionnalités offrent un accès anticipé aux fonctionnalités des produits à venir, ce qui permet aux clients de tester les fonctionnalités et de fournir un retour d'information pendant le processus de développement.
Pour plus d'informations sur la portée de l'assistance des fonctionnalités de l'aperçu technologique de Red Hat, voir Portée de l'assistance des fonctionnalités de l'aperçu technologique.
Les archives et les RPM contiennent les exécutables suivants :
- tkn
- tkn-pac
- opc
L'exécution de Red Hat OpenShift Pipelines avec l'outil opc CLI est une fonctionnalité d'aperçu technologique uniquement. Les fonctionnalités de l'aperçu technologique ne sont pas prises en charge par les accords de niveau de service (SLA) de production de Red Hat et peuvent ne pas être complètes sur le plan fonctionnel. Red Hat ne recommande pas leur utilisation en production. Ces fonctionnalités offrent un accès anticipé aux fonctionnalités des produits à venir, ce qui permet aux clients de tester les fonctionnalités et de fournir un retour d'information pendant le processus de développement.
Pour plus d'informations sur la portée de l'assistance des fonctionnalités de l'aperçu technologique de Red Hat, voir Portée de l'assistance des fonctionnalités de l'aperçu technologique.
5.1.1. Installation de la CLI Red Hat OpenShift Pipelines sur Linux Copier lienLien copié sur presse-papiers!
Pour les distributions Linux, vous pouvez télécharger le CLI sous la forme d'une archive tar.gz.
Procédure
Téléchargez l'outil CLI approprié.
Décompressez l'archive :
tar xvzf <file>
tar xvzf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Ajoutez l'emplacement de vos fichiers
tkn,tkn-pacetopcà votre variable d'environnementPATH. Pour vérifier votre
PATH, exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.1.2. Installation de Red Hat OpenShift Pipelines CLI sur Linux à l'aide d'un RPM Copier lienLien copié sur presse-papiers!
Pour Red Hat Enterprise Linux (RHEL) version 8, vous pouvez installer Red Hat OpenShift Pipelines CLI en tant que RPM.
Conditions préalables
- Vous disposez d'un abonnement OpenShift Container Platform actif sur votre compte Red Hat.
- Vous disposez des privilèges root ou sudo sur votre système local.
Procédure
S'inscrire auprès du gestionnaire d'abonnements Red Hat :
subscription-manager register
# subscription-manager registerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Extraire les données d'abonnement les plus récentes :
subscription-manager refresh
# subscription-manager refreshCopy to Clipboard Copied! Toggle word wrap Toggle overflow Liste des abonnements disponibles :
subscription-manager list --available --matches '*pipelines*'
# subscription-manager list --available --matches '*pipelines*'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Dans la sortie de la commande précédente, trouvez l'ID du pool pour votre abonnement OpenShift Container Platform et attachez l'abonnement au système enregistré :
subscription-manager attach --pool=<pool_id>
# subscription-manager attach --pool=<pool_id>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Activez les dépôts requis par Red Hat OpenShift Pipelines :
Linux (x86_64, amd64)
subscription-manager repos --enable="pipelines-1.10-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="pipelines-1.10-for-rhel-8-x86_64-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux sur IBM zSystems et IBM® LinuxONE (s390x)
subscription-manager repos --enable="pipelines-1.10-for-rhel-8-s390x-rpms"
# subscription-manager repos --enable="pipelines-1.10-for-rhel-8-s390x-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux sur IBM Power (ppc64le)
subscription-manager repos --enable="pipelines-1.10-for-rhel-8-ppc64le-rpms"
# subscription-manager repos --enable="pipelines-1.10-for-rhel-8-ppc64le-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux sur ARM (arm64)
subscription-manager repos --enable="pipelines-1.10-for-rhel-8-arm64-rpms"
# subscription-manager repos --enable="pipelines-1.10-for-rhel-8-arm64-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Installez le paquetage
openshift-pipelines-client:yum install openshift-pipelines-client
# yum install openshift-pipelines-clientCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Une fois installé, le CLI est disponible à l'aide de la commande tkn:
tkn version
$ tkn version
5.1.3. Installation de Red Hat OpenShift Pipelines CLI sur Windows Copier lienLien copié sur presse-papiers!
Pour Windows, vous pouvez télécharger le CLI sous la forme d'une archive zip.
Procédure
- Télécharger l'outil CLI.
- Extraire l'archive à l'aide d'un programme ZIP.
-
Ajoutez l'emplacement de vos fichiers
tkn,tkn-pacetopcà votre variable d'environnementPATH. Pour vérifier votre
PATH, exécutez la commande suivante :path
C:\N> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.1.4. Installer le CLI de Red Hat OpenShift Pipelines sur macOS Copier lienLien copié sur presse-papiers!
Pour macOS, vous pouvez télécharger le CLI sous forme d'archive tar.gz.
Procédure
Téléchargez l'outil CLI approprié.
- Décompressez et extrayez l'archive.
-
Ajoutez l'emplacement de vos fichiers
tkn,tkn-pacetopcà votre variable d'environnementPATH. Pour vérifier votre
PATH, exécutez la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.2. Configuration de l'interface de commande OpenShift Pipelines tkn Copier lienLien copié sur presse-papiers!
Configurez la CLI de Red Hat OpenShift Pipelines tkn pour activer l'achèvement des tabulations.
5.2.1. Activation de l'achèvement des onglets Copier lienLien copié sur presse-papiers!
Après avoir installé le CLI tkn, vous pouvez activer la complétion de tabulation pour compléter automatiquement les commandes tkn ou suggérer des options lorsque vous appuyez sur Tab.
Conditions préalables
-
L'outil CLI
tkndoit être installé. -
Vous devez avoir installé
bash-completionsur votre système local.
Procédure
La procédure suivante permet de compléter les tabulations pour Bash.
Enregistrer le code d'achèvement de Bash dans un fichier :
tkn completion bash > tkn_bash_completion
$ tkn completion bash > tkn_bash_completionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copiez le fichier sur
/etc/bash_completion.d/:sudo cp tkn_bash_completion /etc/bash_completion.d/
$ sudo cp tkn_bash_completion /etc/bash_completion.d/Copy to Clipboard Copied! Toggle word wrap Toggle overflow Vous pouvez également enregistrer le fichier dans un répertoire local et l'extraire de votre fichier
.bashrc.
La complétion des tabulations est activée lorsque vous ouvrez un nouveau terminal.
5.3. Référence pour OpenShift Pipelines Copier lienLien copié sur presse-papiers!
Cette section énumère les commandes CLI de base de tkn.
5.3.1. Syntaxe de base Copier lienLien copié sur presse-papiers!
tkn [command or options] [arguments…]
5.3.2. Options globales Copier lienLien copié sur presse-papiers!
--help, -h
5.3.3. Commandes d'utilitaires Copier lienLien copié sur presse-papiers!
5.3.3.1. tkn Copier lienLien copié sur presse-papiers!
Commande parente de tkn CLI.
Exemple : Afficher toutes les options
tkn
$ tkn
5.3.3.2. achèvement [shell] Copier lienLien copié sur presse-papiers!
Imprime le code d'achèvement de l'interpréteur de commandes qui doit être évalué pour fournir un achèvement interactif. Les shells supportés sont bash et zsh.
Exemple : Code d'achèvement pour bash shell
tkn completion bash
$ tkn completion bash
5.3.3.3. version Copier lienLien copié sur presse-papiers!
Imprimer les informations relatives à la version de l'interface CLI de tkn.
Exemple : Vérifier la version de tkn
tkn version
$ tkn version
5.3.4. Commandes de gestion des pipelines Copier lienLien copié sur presse-papiers!
5.3.4.1. canalisation Copier lienLien copié sur presse-papiers!
Gérer les pipelines.
Exemple : Afficher l'aide
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. suppression du pipeline Copier lienLien copié sur presse-papiers!
Supprimer une canalisation.
Exemple : Supprimer le pipeline mypipeline d'un espace de noms
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. description du pipeline Copier lienLien copié sur presse-papiers!
Décrire un pipeline.
Exemple : Décrire la filière mypipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. liste des pipelines Copier lienLien copié sur presse-papiers!
Affiche une liste de pipelines.
Exemple : Afficher une liste de pipelines
tkn pipeline list
$ tkn pipeline list
5.3.4.5. journaux de bord des pipelines Copier lienLien copié sur presse-papiers!
Affiche les journaux d'un pipeline spécifique.
Exemple : Diffusion en continu des journaux en direct de la canalisation mypipeline
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline
5.3.4.6. démarrage du pipeline Copier lienLien copié sur presse-papiers!
Lancer un pipeline.
Exemple : Démarrer le pipeline mypipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. Commandes d'exécution du pipeline Copier lienLien copié sur presse-papiers!
5.3.5.1. pipelinerun Copier lienLien copié sur presse-papiers!
Gérer l'exécution du pipeline.
Exemple : Afficher l'aide
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. pipelinerun annuler Copier lienLien copié sur presse-papiers!
Annule le passage d'un pipeline.
Exemple : Annuler l'exécution du pipeline mypipelinerun à partir d'un espace de noms
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun supprimer Copier lienLien copié sur presse-papiers!
Supprimer un pipeline.
Exemple : Suppression de l'exécution d'un pipeline à partir d'un espace de noms
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
Exemple : Supprimer toutes les exécutions de pipeline d'un espace de noms, à l'exception des cinq exécutions les plus récentes
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5
- 1
- Remplacez
5par le nombre d'exécutions les plus récentes du pipeline que vous souhaitez conserver.
Exemple : Supprimer tous les pipelines
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
À partir de Red Hat OpenShift Pipelines 1.6, la commande tkn pipelinerun delete --all ne supprime pas les ressources qui sont en cours d'exécution.
5.3.5.4. pipelinerun décrire Copier lienLien copié sur presse-papiers!
Décrire un parcours de canalisation.
Exemple : Décrire le pipeline mypipelinerun exécuté dans un espace de noms
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. liste des pipelines Copier lienLien copié sur presse-papiers!
Liste de l'exécution des pipelines.
Exemple : Afficher une liste d'exécutions de pipeline dans un espace de noms
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
5.3.5.6. journaux de bord pipelinerun Copier lienLien copié sur presse-papiers!
Affiche les journaux d'un pipeline.
Exemple : Afficher les journaux du pipeline mypipelinerun exécuté avec toutes les tâches et étapes d'un espace de noms
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. Commandes de gestion des tâches Copier lienLien copié sur presse-papiers!
5.3.6.1. tâche Copier lienLien copié sur presse-papiers!
Gérer les tâches.
Exemple : Afficher l'aide
tkn task -h
$ tkn task -h
5.3.6.2. suppression d'une tâche Copier lienLien copié sur presse-papiers!
Supprimer une tâche.
Exemple : Supprimer les tâches mytask1 et mytask2 d'un espace de noms
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. description de la tâche Copier lienLien copié sur presse-papiers!
Décrire une tâche.
Exemple : Décrire la tâche mytask dans un espace de noms
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace
5.3.6.4. liste de tâches Copier lienLien copié sur presse-papiers!
Dresser la liste des tâches.
Exemple : Liste de toutes les tâches d'un espace de noms
tkn task list -n myspace
$ tkn task list -n myspace
5.3.6.5. journaux des tâches Copier lienLien copié sur presse-papiers!
Afficher les journaux des tâches.
Exemple : Afficher les journaux de l'exécution de la tâche mytaskrun de la tâche mytask
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. début de la tâche Copier lienLien copié sur presse-papiers!
Démarrer une tâche.
Exemple : Démarrer la tâche mytask dans un espace de noms
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. Commandes d'exécution des tâches Copier lienLien copié sur presse-papiers!
5.3.7.1. course à pied Copier lienLien copié sur presse-papiers!
Gérer l'exécution des tâches.
Exemple : Afficher l'aide
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. annulation de la course à pied Copier lienLien copié sur presse-papiers!
Annuler l'exécution d'une tâche.
Exemple : Annuler la tâche mytaskrun exécutée à partir d'un espace de noms
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. taskrun supprimer Copier lienLien copié sur presse-papiers!
Supprimer une TaskRun.
Exemple : Supprimer les tâches mytaskrun1 et mytaskrun2 d'un espace de noms
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
Exemple : Supprimer d'un espace de noms toutes les tâches exécutées, à l'exception des cinq dernières
tkn taskrun delete -n myspace --keep 5
$ tkn taskrun delete -n myspace --keep 5
- 1
- Remplacez
5par le nombre d'exécutions de tâches les plus récentes que vous souhaitez conserver.
5.3.7.4. description de la course Copier lienLien copié sur presse-papiers!
Décrire l'exécution d'une tâche.
Exemple : Décrire la tâche mytaskrun exécutée dans un espace de noms
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. liste des courses Copier lienLien copié sur presse-papiers!
Liste des tâches exécutées.
Exemple : Liste de toutes les tâches exécutées dans un espace de noms
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace
5.3.7.6. carnets de route Copier lienLien copié sur presse-papiers!
Afficher les journaux d'exécution des tâches.
Exemple : Afficher les journaux en direct de la tâche mytaskrun exécutée dans un espace de noms
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. Commandes de gestion des conditions Copier lienLien copié sur presse-papiers!
5.3.8.1. condition Copier lienLien copié sur presse-papiers!
Gérer les conditions.
Exemple : Afficher l'aide
tkn condition --help
$ tkn condition --help
5.3.8.2. condition supprimer Copier lienLien copié sur presse-papiers!
Supprimer une condition.
Exemple : Supprimer la condition mycondition1 d'un espace de noms
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. décrire l'état Copier lienLien copié sur presse-papiers!
Décrire une condition.
Exemple : Décrire la condition mycondition1 dans un espace de noms
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. liste des conditions Copier lienLien copié sur presse-papiers!
Conditions de la liste.
Exemple : Liste des conditions dans un espace de noms
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Pipeline Commandes de gestion des ressources Copier lienLien copié sur presse-papiers!
5.3.9.1. ressource Copier lienLien copié sur presse-papiers!
Gérer les ressources du pipeline.
Exemple : Afficher l'aide
tkn resource -h
$ tkn resource -h
5.3.9.2. créer des ressources Copier lienLien copié sur presse-papiers!
Créer une ressource de pipeline.
Exemple : Créer une ressource de pipeline dans un espace de noms
tkn resource create -n myspace
$ tkn resource create -n myspace
Il s'agit d'une commande interactive qui demande des informations sur le nom de la ressource, son type et les valeurs basées sur le type de la ressource.
5.3.9.3. suppression des ressources Copier lienLien copié sur presse-papiers!
Supprimer une ressource du pipeline.
Exemple : Supprimer la ressource myresource Pipeline d'un espace de noms
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. description des ressources Copier lienLien copié sur presse-papiers!
Décrire une ressource du pipeline.
Exemple : Décrire la ressource myresource Pipeline
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. liste de ressources Copier lienLien copié sur presse-papiers!
Ressources pour le pipeline de la liste.
Exemple : Liste de toutes les ressources de pipeline d'un espace de noms
tkn resource list -n myspace
$ tkn resource list -n myspace
5.3.10. Commandes de gestion ClusterTask Copier lienLien copié sur presse-papiers!
Dans Red Hat OpenShift Pipelines 1.10, la fonctionnalité ClusterTask de l'utilitaire de ligne de commande tkn est dépréciée et il est prévu de la supprimer dans une prochaine version.
5.3.10.1. tâche en grappe Copier lienLien copié sur presse-papiers!
Gérer les tâches de cluster.
Exemple : Afficher l'aide
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask delete Copier lienLien copié sur presse-papiers!
Supprimer une ressource ClusterTask dans un cluster.
Exemple : Supprimer mytask1 et mytask2 ClusterTasks
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. description de la tâche en grappe Copier lienLien copié sur presse-papiers!
Décrire une ClusterTask.
Exemple : Décrire la tâche mytask ClusterTask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. liste de tâches en grappe Copier lienLien copié sur presse-papiers!
Liste des tâches de cluster.
Exemple : Liste des tâches de cluster
tkn clustertask list
$ tkn clustertask list
5.3.10.5. clustertask start Copier lienLien copié sur presse-papiers!
Démarrer ClusterTasks.
Exemple : Démarrer la tâche mytask ClusterTask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. Déclencher des commandes de gestion Copier lienLien copié sur presse-papiers!
5.3.11.1. générateur d'événements Copier lienLien copié sur presse-papiers!
Gérer les écouteurs d'événements.
Exemple : Afficher l'aide
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. eventlistener supprimer Copier lienLien copié sur presse-papiers!
Supprimer un EventListener.
Exemple : Supprimer les EventListeners mylistener1 et mylistener2 dans un espace de noms
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. eventlistener décrire Copier lienLien copié sur presse-papiers!
Décrire un écouteur d'événements.
Exemple : Décrire l'écouteur d'événements mylistener dans un espace de noms
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. liste d'événements Copier lienLien copié sur presse-papiers!
Liste des écouteurs d'événements.
Exemple : Liste de tous les EventListeners d'un espace de noms
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. journaux d'événements Copier lienLien copié sur presse-papiers!
Afficher les journaux d'un EventListener.
Exemple : Afficher les journaux de mylistener EventListener dans un espace de noms
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. liaison de déclenchement Copier lienLien copié sur presse-papiers!
Gérer les TriggerBindings.
Exemple : Afficher l'aide sur les TriggerBindings
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.7. triggerbinding delete Copier lienLien copié sur presse-papiers!
Supprimer un TriggerBinding.
Exemple : Supprimer les TriggerBindings mybinding1 et mybinding2 dans un espace de noms
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. description de l'obligation de déclenchement Copier lienLien copié sur presse-papiers!
Décrire un TriggerBinding.
Exemple : Décrire le lien mybinding TriggerBinding dans un espace de noms
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. liste des déclencheurs (triggerbinding) Copier lienLien copié sur presse-papiers!
Liste des TriggerBindings.
Exemple : Lister tous les TriggerBindings d'un espace de noms
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.10. modèle de déclenchement Copier lienLien copié sur presse-papiers!
Gérer les modèles de déclenchement.
Exemple : Afficher l'aide de TriggerTemplate
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.11. modèle de déclenchement supprimer Copier lienLien copié sur presse-papiers!
Supprimer un TriggerTemplate.
Exemple : Supprimer les TriggerTemplates mytemplate1 et mytemplate2 dans un espace de noms
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. modèle de déclenchement décrire Copier lienLien copié sur presse-papiers!
Décrire un TriggerTemplate.
Exemple : Décrire le mytemplate TriggerTemplate dans un espace de noms
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.13. liste de modèles de déclenchement Copier lienLien copié sur presse-papiers!
Liste des modèles de déclenchement.
Exemple : Liste de tous les TriggerTemplates d'un espace de noms
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding (liaison de déclenchement de cluster) Copier lienLien copié sur presse-papiers!
Gérer les ClusterTriggerBindings.
Exemple : Afficher l'aide sur les ClusterTriggerBindings
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding delete Copier lienLien copié sur presse-papiers!
Supprimer un ClusterTriggerBinding.
Exemple : Supprimer myclusterbinding1 et myclusterbinding2 ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding describe Copier lienLien copié sur presse-papiers!
Décrire un ClusterTriggerBinding.
Exemple : Décrire le lien myclusterbinding ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. liste des déclencheurs de clusters Copier lienLien copié sur presse-papiers!
Liste des ClusterTriggerBindings.
Exemple : Liste de tous les ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
5.3.12. Commandes d'interaction avec le Hub Copier lienLien copié sur presse-papiers!
Interagir avec Tekton Hub pour les ressources telles que les tâches et les pipelines.
5.3.12.1. plaque tournante Copier lienLien copié sur presse-papiers!
Interagir avec le hub.
Exemple : Afficher l'aide
tkn hub -h
$ tkn hub -h
Exemple : Interagir avec un serveur API hub
tkn hub --api-server https://api.hub.tekton.dev
$ tkn hub --api-server https://api.hub.tekton.dev
Pour chaque exemple, pour obtenir les sous-commandes et les drapeaux correspondants, exécutez tkn hub <command> --help.
5.3.12.2. rétrogradation de la plaque tournante Copier lienLien copié sur presse-papiers!
Rétrograder une ressource installée.
Exemple : Rétrograder la tâche mytask dans l'espace de noms mynamespace vers son ancienne version
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. hub get Copier lienLien copié sur presse-papiers!
Obtenir le manifeste d'une ressource par son nom, son type, son catalogue et sa version.
Exemple : Obtenir le manifeste d'une version spécifique du pipeline ou de la tâche myresource dans le catalogue tekton
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version
5.3.12.4. info sur le moyeu Copier lienLien copié sur presse-papiers!
Afficher des informations sur une ressource en fonction de son nom, de son type, de son catalogue et de sa version.
Exemple : Afficher des informations sur une version spécifique de la tâche mytask à partir du catalogue tekton
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version
5.3.12.5. installation du moyeu Copier lienLien copié sur presse-papiers!
Installer une ressource à partir d'un catalogue en fonction de son type, de son nom et de sa version.
Exemple : Installer une version spécifique de la tâche mytask à partir du catalogue tekton dans l'espace de noms mynamespace
tkn hub install task mytask --from tekton --version version -n mynamespace
$ tkn hub install task mytask --from tekton --version version -n mynamespace
5.3.12.6. réinstallation du moyeu Copier lienLien copié sur presse-papiers!
Réinstaller une ressource en fonction de son type et de son nom.
Exemple : Réinstaller une version spécifique de la tâche mytask à partir du catalogue tekton dans l'espace de noms mynamespace
tkn hub reinstall task mytask --from tekton --version version -n mynamespace
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
5.3.12.7. recherche de moyeu Copier lienLien copié sur presse-papiers!
Recherche d'une ressource par une combinaison de nom, de type et d'étiquettes.
Exemple : Rechercher une ressource avec une étiquette cli
tkn hub search --tags cli
$ tkn hub search --tags cli
5.3.12.8. mise à niveau du moyeu Copier lienLien copié sur presse-papiers!
Mettre à jour une ressource installée.
Exemple : Mettre à jour la tâche mytask installée dans l'espace de noms mynamespace vers une nouvelle version
tkn hub upgrade task mytask --to version -n mynamespace
$ tkn hub upgrade task mytask --to version -n mynamespace
Chapitre 6. cLI opm Copier lienLien copié sur presse-papiers!
6.1. Installation de l'interface de programmation opm Copier lienLien copié sur presse-papiers!
6.1.1. À propos de l'interface de programmation opm Copier lienLien copié sur presse-papiers!
L'outil CLI opm est fourni par Operator Framework pour être utilisé avec le format Operator bundle. Cet outil vous permet de créer et de maintenir des catalogues d'opérateurs à partir d'une liste de bundles d'opérateurs qui sont similaires à des dépôts de logiciels. Le résultat est une image de conteneur qui peut être stockée dans un registre de conteneurs et ensuite installée sur un cluster.
Un catalogue contient une base de données de pointeurs vers le contenu du manifeste de l'opérateur qui peut être interrogé par le biais d'une API incluse qui est servie lorsque l'image du conteneur est exécutée. Sur OpenShift Container Platform, Operator Lifecycle Manager (OLM) peut référencer l'image dans une source de catalogue, définie par un objet CatalogSource, qui interroge l'image à intervalles réguliers pour permettre des mises à jour fréquentes des opérateurs installés sur le cluster.
6.1.2. Installation de l'interface de programmation opm Copier lienLien copié sur presse-papiers!
Vous pouvez installer l'outil CLI opm sur votre station de travail Linux, macOS ou Windows.
Conditions préalables
Pour Linux, vous devez fournir les paquets suivants. RHEL 8 répond à ces exigences :
-
podmanversion 1.9.3 (version 2.0 recommandée) -
glibcversion 2.28
-
Procédure
- Naviguez vers le site miroir d'OpenShift et téléchargez la dernière version de l'archive correspondant à votre système d'exploitation.
Décompressez l'archive.
Pour Linux ou macOS :
tar xvf <file>
tar xvf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Pour Windows, décompressez l'archive avec un programme ZIP.
Placez le fichier n'importe où dans votre
PATH.Pour Linux ou macOS :
Vérifiez votre
PATH:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacer le fichier. Par exemple :
sudo mv ./opm /usr/local/bin/
$ sudo mv ./opm /usr/local/bin/Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Pour Windows :
Vérifiez votre
PATH:path
C:\N> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacer le fichier :
move opm.exe <directory>
C:\N> move opm.exe <directory>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Vérification
Après avoir installé le CLI
opm, vérifiez qu'il est disponible :opm version
$ opm versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2. référence CLI opm Copier lienLien copié sur presse-papiers!
L'interface de ligne de commande (CLI) opm est un outil permettant de créer et de maintenir des catalogues d'opérateurs.
opm Syntaxe du CLI
opm <command> [<subcommand>] [<argument>] [<flags>]
$ opm <command> [<subcommand>] [<argument>] [<flags>]
| Drapeau | Description |
|---|---|
|
| Sauter la vérification des certificats TLS pour les registres d'images de conteneurs lors de l'extraction de paquets ou d'index. |
|
| Lorsque vous tirez des paquets, utilisez le protocole HTTP pour les registres d'images de conteneurs. |
Le format de catalogue basé sur SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité dépréciée est toujours incluse dans OpenShift Container Platform et continue d'être prise en charge ; cependant, elle sera supprimée dans une prochaine version de ce produit et n'est pas recommandée pour les nouveaux déploiements.
Pour obtenir la liste la plus récente des fonctionnalités majeures qui ont été dépréciées ou supprimées dans OpenShift Container Platform, consultez la section Deprecated and removed features des notes de version d'OpenShift Container Platform.
6.2.1. init Copier lienLien copié sur presse-papiers!
Génère un blob de configuration déclaratif olm.package.
Syntaxe de la commande
opm init <package_name> [<flags>]
$ opm init <package_name> [<flags>]
| Drapeau | Description |
|---|---|
|
| Le canal que les abonnements utiliseront par défaut s'il n'est pas spécifié. |
|
|
Chemin d'accès au site de l'opérateur |
|
| Chemin d'accès à l'icône du paquet. |
|
|
Format de sortie : |
6.2.2. rendre Copier lienLien copié sur presse-papiers!
Génère un blob de configuration déclaratif à partir des images d'index, des images de bundle et des fichiers de base de données SQLite fournis.
Syntaxe de la commande
opm render <index_image | bundle_image | sqlite_file> [<flags>]
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| Drapeau | Description |
|---|---|
|
|
Format de sortie : |
6.2.3. valider Copier lienLien copié sur presse-papiers!
Valide le(s) fichier(s) JSON de la configuration déclarative dans un répertoire donné.
Syntaxe de la commande
opm validate <directory> [<flags>]
$ opm validate <directory> [<flags>]
6.2.4. servir Copier lienLien copié sur presse-papiers!
Servir des configurations déclaratives via un serveur GRPC.
Le répertoire declarative config est chargé par la commande serve au démarrage. Les modifications apportées à la configuration déclarative après le lancement de cette commande ne sont pas répercutées dans le contenu servi.
Syntaxe de la commande
opm serve <source_path> [<flags>]
$ opm serve <source_path> [<flags>]
| Drapeau | Description |
|---|---|
|
| Si ce drapeau est activé, il synchronise et conserve le répertoire du cache du serveur. |
|
|
Il se termine par une erreur si le cache n'est pas présent ou s'il est invalidé. La valeur par défaut est |
|
| Synchronise le cache de service et quitte sans servir. |
|
| Active la journalisation de débogage. |
|
| Aide au service. |
|
|
Le numéro de port du service. La valeur par défaut est |
|
|
L'adresse du point final de profilage de démarrage. Le format est le suivant : |
|
|
Chemin d'accès à un fichier journal de fin de conteneur. La valeur par défaut est |
Le format de catalogue basé sur SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité dépréciée est toujours incluse dans OpenShift Container Platform et continue d'être prise en charge ; cependant, elle sera supprimée dans une prochaine version de ce produit et n'est pas recommandée pour les nouveaux déploiements.
Pour obtenir la liste la plus récente des fonctionnalités majeures qui ont été dépréciées ou supprimées dans OpenShift Container Platform, consultez la section Deprecated and removed features des notes de version d'OpenShift Container Platform.
6.2.5. migrer Copier lienLien copié sur presse-papiers!
Migrer une image d'index ou un fichier de base de données au format SQLite vers un catalogue basé sur des fichiers.
Syntaxe de la commande
opm migrate <index_ref> <output_dir> [<flags>]
$ opm migrate <index_ref> <output_dir> [<flags>]
| Drapeau | Description |
|---|---|
|
|
Format de sortie : |
6.2.6. index Copier lienLien copié sur presse-papiers!
Générer l'index de l'opérateur pour les images de conteneurs au format de base de données SQLite à partir de bundles d'opérateurs préexistants.
À partir d'OpenShift Container Platform 4.11, le catalogue Operator fourni par Red Hat par défaut est publié dans le format de catalogue basé sur des fichiers. Les catalogues Operator fournis par Red Hat par défaut pour OpenShift Container Platform 4.6 à 4.10 sont publiés dans le format de base de données SQLite déprécié.
Les sous-commandes, drapeaux et fonctionnalités de opm liés au format de base de données SQLite sont également obsolètes et seront supprimés dans une prochaine version. Ces fonctionnalités sont toujours prises en charge et doivent être utilisées pour les catalogues qui utilisent le format de base de données SQLite obsolète.
La plupart des sous-commandes et des drapeaux de opm pour travailler avec le format de base de données SQLite, comme opm index prune, ne fonctionnent pas avec le format de catalogue basé sur des fichiers. Pour plus d'informations sur l'utilisation des catalogues basés sur des fichiers, voir "Ressources supplémentaires".
Syntaxe de la commande
opm index <subcommand> [<flags>]
$ opm index <subcommand> [<flags>]
| Sous-commande | Description |
|---|---|
|
| Ajouter des liasses d'opérateurs à un index. |
|
| Élaguer un index de tous les paquets sauf ceux spécifiés. |
|
| Élaguer un index de liasses non identifiées, c'est-à-dire de liasses qui ne sont pas associées à une image particulière. |
|
| Supprimer un opérateur entier d'un index. |
6.2.6.1. ajouter Copier lienLien copié sur presse-papiers!
Ajouter des liasses d'opérateurs à un index.
Syntaxe de la commande
opm index add [<flags>]
$ opm index add [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil de construction des images de conteneurs : |
|
| Liste de bundles séparés par des virgules à ajouter. |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index précédent à ajouter. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
|
Mode de mise à jour des graphiques qui définit la manière dont les graphiques des canaux sont mis à jour : |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Autoriser les erreurs de chargement du registre. |
|
|
Outil pour extraire les images des conteneurs : |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.2. pruneau Copier lienLien copié sur presse-papiers!
Élaguer un index de tous les paquets sauf ceux spécifiés.
Syntaxe de la commande
opm index prune [<flags>]
$ opm index prune [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index pour la taille. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.3. brin élagué Copier lienLien copié sur presse-papiers!
Élaguer un index de liasses non identifiées, c'est-à-dire de liasses qui ne sont pas associées à une image particulière.
Syntaxe de la commande
opm index prune-stranded [<flags>]
$ opm index prune-stranded [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index pour la taille. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.4. rm Copier lienLien copié sur presse-papiers!
Supprimer un opérateur entier d'un index.
Syntaxe de la commande
opm index rm [<flags>]
$ opm index rm [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil de construction des images de conteneurs : |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index précédent à supprimer. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Liste d'opérateurs à supprimer, séparés par des virgules. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
|
Outil pour extraire les images des conteneurs : |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.7. générer Copier lienLien copié sur presse-papiers!
Générer divers artefacts pour les index de configuration déclaratifs.
Syntaxe de la commande
opm generate [command]
$ opm generate [command]
| Drapeaux | Description |
|---|---|
|
| Aide à la génération. |
Syntaxe de la commande
opm generate <subcommand> [<flags>]
$ opm generate <subcommand> [<flags>]
| Sous-commande | Description |
|---|---|
|
| Générer un fichier Docker pour un index de configuration déclaratif. |
6.2.7.1. dockerfile Copier lienLien copié sur presse-papiers!
Générer un fichier Docker pour un index de configuration déclaratif.
Cette commande crée un fichier Docker dans le même répertoire que <dcRootDir> (nommé <dcDirName>.Dockerfile) qui est utilisé pour construire l'index. Si un fichier Docker portant le même nom existe déjà, cette commande échoue.
Lors de la spécification d'étiquettes supplémentaires, s'il existe des clés dupliquées, seule la dernière valeur de chaque clé dupliquée est ajoutée au fichier Dockerfile généré.
Syntaxe de la commande
opm generate dockerfile <dcRootDir> [flags] (drapeaux)
$ opm generate dockerfile <dcRootDir> [flags] (drapeaux)
| Drapeau | Description |
|---|---|
|
|
Image dans laquelle le catalogue doit être construit. La valeur par défaut est |
|
|
Étiquettes supplémentaires à inclure dans le fichier Docker généré. Les étiquettes ont la forme |
|
| Aide pour Dockerfile. |
Chapitre 7. SDK de l'opérateur Copier lienLien copié sur presse-papiers!
7.1. Installation du SDK CLI de l'opérateur Copier lienLien copié sur presse-papiers!
L'Operator SDK fournit une interface de ligne de commande (CLI) que les développeurs d'opérateurs peuvent utiliser pour créer, tester et déployer un opérateur. Vous pouvez installer l'interface CLI du SDK de l'opérateur sur votre poste de travail afin d'être prêt à créer vos propres opérateurs.
Les auteurs d'opérateurs disposant d'un accès d'administrateur de cluster à un cluster basé sur Kubernetes, tel que OpenShift Container Platform, peuvent utiliser l'interface de programmation Operator SDK pour développer leurs propres opérateurs basés sur Go, Ansible, Java ou Helm. Kubebuilder est intégré dans le SDK Operator en tant que solution d'échafaudage pour les opérateurs basés sur Go, ce qui signifie que les projets Kubebuilder existants peuvent être utilisés tels quels avec le SDK Operator et continuer à fonctionner.
Voir Développement d'opérateurs pour une documentation complète sur le SDK des opérateurs.
OpenShift Container Platform 4.12 supporte Operator SDK 1.25.4.
7.1.1. Installation de l'interface de programmation de l'opérateur sous Linux Copier lienLien copié sur presse-papiers!
Vous pouvez installer l'outil OpenShift SDK CLI sur Linux.
Conditions préalables
- Go v1.19
-
dockerv17.03 ,podmanv1.9.3 , oubuildahv1.7
Procédure
- Naviguez vers le site miroir d'OpenShift.
- A partir du dernier répertoire 4.12, téléchargez la dernière version de l'archive pour Linux.
Décompressez l'archive :
tar xvf operator-sdk-v1.25.4-ocp-linux-x86_64.tar.gz
$ tar xvf operator-sdk-v1.25.4-ocp-linux-x86_64.tar.gzCopy to Clipboard Copied! Toggle word wrap Toggle overflow Rendre le fichier exécutable :
chmod +x operator-sdk
$ chmod +x operator-sdkCopy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le fichier binaire
operator-sdkextrait dans un répertoire qui se trouve sur votre sitePATH.AstucePour vérifier votre
PATH:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow sudo mv ./operator-sdk /usr/local/bin/operator-sdk
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdkCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Vérification
Après avoir installé le SDK CLI de l'opérateur, vérifiez qu'il est disponible :
operator-sdk version
$ operator-sdk versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
operator-sdk version: "v1.25.4-ocp", ...
operator-sdk version: "v1.25.4-ocp", ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.1.2. Installation du SDK CLI de l'opérateur sur macOS Copier lienLien copié sur presse-papiers!
Vous pouvez installer l'outil OpenShift SDK CLI sur macOS.
Conditions préalables
- Go v1.19
-
dockerv17.03 ,podmanv1.9.3 , oubuildahv1.7
Procédure
-
Pour les architectures
amd64etarm64, naviguez vers le site miroir OpenShift pour l'architectureamd64et le site miroir OpenShift pour l'architecturearm64respectivement. - A partir du dernier répertoire 4.12, téléchargez la dernière version de l'archive pour macOS.
Décompressez l'archive Operator SDK pour l'architecture
amd64en exécutant la commande suivante :tar xvf operator-sdk-v1.25.4-ocp-darwin-x86_64.tar.gz
$ tar xvf operator-sdk-v1.25.4-ocp-darwin-x86_64.tar.gzCopy to Clipboard Copied! Toggle word wrap Toggle overflow Décompressez l'archive Operator SDK pour l'architecture
arm64en exécutant la commande suivante :tar xvf operator-sdk-v1.25.4-ocp-darwin-aarch64.tar.gz
$ tar xvf operator-sdk-v1.25.4-ocp-darwin-aarch64.tar.gzCopy to Clipboard Copied! Toggle word wrap Toggle overflow Rendez le fichier exécutable en exécutant la commande suivante :
chmod +x operator-sdk
$ chmod +x operator-sdkCopy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le binaire
operator-sdkextrait dans un répertoire qui se trouve sur votrePATHen exécutant la commande suivante :AstuceVérifiez votre
PATHen exécutant la commande suivante :echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow sudo mv ./operator-sdk /usr/local/bin/operator-sdk
$ sudo mv ./operator-sdk /usr/local/bin/operator-sdkCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Vérification
Après avoir installé l'interface de programmation de l'opérateur, vérifiez qu'elle est disponible en exécutant la commande suivante: :
operator-sdk version
$ operator-sdk versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
operator-sdk version: "v1.25.4-ocp", ...
operator-sdk version: "v1.25.4-ocp", ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.2. Référence CLI du SDK de l'opérateur Copier lienLien copié sur presse-papiers!
L'interface de ligne de commande (CLI) de l'Operator SDK est un kit de développement conçu pour faciliter l'écriture d'opérateurs.
Syntaxe du CLI du SDK de l'opérateur
operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
$ operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
Voir Développement d'opérateurs pour une documentation complète sur le SDK des opérateurs.
7.2.1. liasse Copier lienLien copié sur presse-papiers!
La commande operator-sdk bundle gère les métadonnées du faisceau d'opérateurs.
7.2.1.1. valider Copier lienLien copié sur presse-papiers!
La sous-commande bundle validate valide une liasse d'opérateurs.
| Drapeau | Description |
|---|---|
|
|
Aide pour la sous-commande |
|
|
Outil permettant d'extraire et de décompresser les images de la liasse. Il n'est utilisé que lors de la validation d'une image de paquet. Les options disponibles sont |
|
| Liste de tous les validateurs optionnels disponibles. Lorsqu'il est défini, aucun validateur n'est exécuté. |
|
|
Sélecteur d'étiquettes pour sélectionner les validateurs optionnels à exécuter. Lorsqu'il est exécuté avec l'option |
7.2.2. nettoyage Copier lienLien copié sur presse-papiers!
La commande operator-sdk cleanup détruit et supprime les ressources créées pour un opérateur déployé avec la commande run.
| Drapeau | Description |
|---|---|
|
|
Aide pour la sous-commande |
|
|
Chemin d'accès au fichier |
|
| S'il est présent, l'espace de noms dans lequel la requête CLI doit être exécutée. |
|
|
Temps d'attente pour que la commande se termine avant d'échouer. La valeur par défaut est |
7.2.3. achèvement Copier lienLien copié sur presse-papiers!
La commande operator-sdk completion génère des compléments d'information sur l'interpréteur de commandes afin d'accélérer et de faciliter l'exécution des commandes de l'interface de programmation.
| Sous-commande | Description |
|---|---|
|
| Générer des complétions bash. |
|
| Générer des complétions zsh. |
| Drapeau | Description |
|---|---|
|
| Utilisation help output. |
Par exemple :
operator-sdk completion bash
$ operator-sdk completion bash
Exemple de sortie
bash completion for operator-sdk -*- shell-script -*- ... ex: ts=4 sw=4 et filetype=sh
# bash completion for operator-sdk -*- shell-script -*-
...
# ex: ts=4 sw=4 et filetype=sh
7.2.4. créer Copier lienLien copié sur presse-papiers!
La commande operator-sdk create est utilisée pour créer, ou scaffold, une API Kubernetes.
7.2.4.1. api Copier lienLien copié sur presse-papiers!
La sous-commande create api permet d'échafauder une API Kubernetes. La sous-commande doit être exécutée dans un projet qui a été initialisé avec la commande init.
| Drapeau | Description |
|---|---|
|
|
Aide pour la sous-commande |
7.2.5. générer Copier lienLien copié sur presse-papiers!
La commande operator-sdk generate invoque un générateur spécifique pour générer du code ou des manifestes.
7.2.5.1. liasse Copier lienLien copié sur presse-papiers!
La sous-commande generate bundle génère un ensemble de manifestes de bundle, de métadonnées et un fichier bundle.Dockerfile pour votre projet Operator.
En règle générale, vous exécutez d'abord la sous-commande generate kustomize manifests pour générer les bases Kustomize utilisées par la sous-commande generate bundle. Cependant, vous pouvez utiliser la commande make bundle dans un projet initialisé pour automatiser l'exécution de ces commandes dans l'ordre.
| Drapeau | Description |
|---|---|
|
|
Liste séparée par des virgules des canaux auxquels le paquet appartient. La valeur par défaut est |
|
|
Répertoire racine pour les manifestes |
|
| Le canal par défaut de la liasse. |
|
|
Répertoire racine pour les manifestes de l'opérateur, tels que les déploiements et RBAC. Ce répertoire est différent du répertoire transmis à l'indicateur |
|
|
Aide pour |
|
|
Répertoire à partir duquel lire une offre groupée existante. Ce répertoire est le parent du répertoire |
|
|
Répertoire contenant les bases de Kustomize et un fichier |
|
| Générer des manifestes de paquets. |
|
| Générer les métadonnées du bundle et le fichier Docker. |
|
| Répertoire dans lequel écrire le bundle. |
|
|
Remplacer les métadonnées du bundle et le fichier Docker s'ils existent. La valeur par défaut est |
|
| Nom du paquet pour la liasse. |
|
| Fonctionne en mode silencieux. |
|
| Rédiger un manifeste de liasse pour la sortie standard. |
|
| Version sémantique de l'opérateur dans la liasse générée. À définir uniquement lors de la création d'une nouvelle liasse ou de la mise à niveau de l'opérateur. |
7.2.5.2. personnaliser Copier lienLien copié sur presse-papiers!
La sous-commande generate kustomize contient des sous-commandes qui génèrent des données de personnalisation pour l'opérateur.
7.2.5.2.1. manifestes Copier lienLien copié sur presse-papiers!
La sous-commande generate kustomize manifests génère ou régénère des bases Kustomize et un fichier kustomization.yaml dans le répertoire config/manifests, qui sont utilisés pour construire des manifestes de bundle par d'autres commandes Operator SDK. Cette commande demande interactivement les métadonnées de l'interface utilisateur, un composant important des bases de manifeste, par défaut, à moins qu'une base n'existe déjà ou que vous n'ayez activé l'option --interactive=false.
| Drapeau | Description |
|---|---|
|
| Répertoire racine pour les définitions des types d'API. |
|
|
Aide pour |
|
| Répertoire contenant les fichiers Kustomize existants. |
|
|
Lorsque la valeur est |
|
| Répertoire où écrire les fichiers Kustomize. |
|
| Nom du paquet. |
|
| Fonctionne en mode silencieux. |
7.2.6. init Copier lienLien copié sur presse-papiers!
La commande operator-sdk init initialise un projet Operator et génère, ou scaffolds, un répertoire de projet par défaut pour le plugin donné.
Cette commande écrit les fichiers suivants :
- Fichier de licence type
-
PROJECTavec le domaine et le référentiel -
Makefilepour construire le projet -
go.modavec les dépendances du projet -
kustomization.yamlfichier pour personnaliser les manifestes - Fichier correctif pour la personnalisation des images des manifestes des gestionnaires
- Fichier correctif pour l'activation des métriques Prometheus
-
main.gopour exécuter
| Drapeau | Description |
|---|---|
|
|
Aide pour la commande |
|
|
Nom et éventuellement version du plugin avec lequel le projet doit être initialisé. Les plugins disponibles sont |
|
|
Version du projet. Les valeurs disponibles sont |
7.2.7. courir Copier lienLien copié sur presse-papiers!
La commande operator-sdk run propose des options qui permettent de lancer l'opérateur dans différents environnements.
7.2.7.1. liasse Copier lienLien copié sur presse-papiers!
La sous-commande run bundle déploie un opérateur au format bundle avec Operator Lifecycle Manager (OLM).
| Drapeau | Description |
|---|---|
|
|
Image d'index dans laquelle injecter un bundle. L'image par défaut est |
|
|
Mode d'installation pris en charge par la version du service de cluster (CSV) de l'opérateur, par exemple |
|
|
Délai d'installation. La valeur par défaut est |
|
|
Chemin d'accès au fichier |
|
| S'il est présent, l'espace de noms dans lequel la requête CLI doit être exécutée. |
|
|
Aide pour la sous-commande |
7.2.7.2. mise à niveau groupée Copier lienLien copié sur presse-papiers!
La sous-commande run bundle-upgrade met à niveau un opérateur précédemment installé au format bundle avec Operator Lifecycle Manager (OLM).
| Drapeau | Description |
|---|---|
|
|
Délai de mise à niveau. La valeur par défaut est |
|
|
Chemin d'accès au fichier |
|
| S'il est présent, l'espace de noms dans lequel la requête CLI doit être exécutée. |
|
|
Aide pour la sous-commande |
7.2.8. carte de pointage Copier lienLien copié sur presse-papiers!
La commande operator-sdk scorecard exécute l'outil scorecard pour valider un bundle Operator et fournir des suggestions d'amélioration. La commande prend un argument, soit une image de l'offre groupée, soit un répertoire contenant les manifestes et les métadonnées. Si l'argument contient une balise image, l'image doit être présente à distance.
| Drapeau | Description |
|---|---|
|
|
Chemin d'accès au fichier de configuration de la carte de score. Le chemin par défaut est |
|
|
Aide pour la commande |
|
|
Chemin d'accès au fichier |
|
| Liste des tests disponibles pour exécution. |
|
| Espace de noms dans lequel les images de test doivent être exécutées. |
|
|
Format de sortie des résultats. Les valeurs disponibles sont |
|
| Sélecteur d'étiquettes pour déterminer les tests à effectuer. |
|
|
Compte de service à utiliser pour les tests. La valeur par défaut est |
|
| Désactiver le nettoyage des ressources après l'exécution des tests. |
|
|
Nombre de secondes à attendre pour que les tests soient terminés, par exemple |
Legal Notice
Copier lienLien copié sur presse-papiers!
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.