Les outils CLI
Apprendre à utiliser les outils de ligne de commande pour OpenShift Dedicated
Résumé
Chapitre 1. Aperçu des outils CLI dédiés à OpenShift Copier lienLien copié sur presse-papiers!
L’utilisateur effectue une série d’opérations tout en travaillant sur OpenShift Dedicated tel que:
- Gestion des clusters
- Construire, déployer et gérer des applications
- Gestion des processus de déploiement
- Développer des opérateurs
- Création et maintenance de catalogues d’opérateurs
L’OpenShift Dedicated propose un ensemble d’outils d’interface de commande-ligne (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 Dedicated:
- CLI OpenShift (oc) : C’est l’outil CLI le plus couramment utilisé par les utilisateurs d’OpenShift Dedicated. Il aide les administrateurs de clusters et les développeurs à effectuer des opérations de bout en bout sur OpenShift Dedicated à 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.
- Knative CLI (kn): L’outil Knative (kn) CLI fournit des commandes terminales simples et intuitives qui peuvent être utilisées pour interagir avec des composants OpenShift Serverless, tels que Knative Serving et Eventing.
- Les pipelines CLI (tkn): OpenShift Pipelines est une solution d’intégration continue et de livraison continue (CI/CD) dans OpenShift Dedicated, qui utilise en interne Tekton. L’outil tkn CLI fournit des commandes simples et intuitives pour interagir avec OpenShift Pipelines à l’aide du terminal.
- CLI OPM : L’outil Opm CLI aide les développeurs d’opérateurs et les administrateurs de clusters à créer et à maintenir les catalogues d’opérateurs à partir du terminal.
- Le SDK de l’opérateur, un composant du Cadre d’opérateur, 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 création d’applications natives Kubernetes, ce qui peut nécessiter des connaissances opérationnelles approfondies et spécifiques à l’application.
Chapitre 2. CLI OpenShift (oc) Copier lienLien copié sur presse-papiers!
2.1. Débuter avec l’OpenShift CLI Copier lienLien copié sur presse-papiers!
2.1.1. À propos de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Avec OpenShift CLI (oc), vous pouvez créer des applications et gérer des projets OpenShift Dedicated à partir d’un terminal. L’OpenShift CLI est idéal dans les situations suivantes:
- En travaillant directement avec le code source du projet
- Scripting OpenShift Opérations dédiées
- Gérer des projets tout en étant limité par les ressources de bande passante et la console Web est indisponible
2.1.2. Installation de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Il est possible d’installer l’OpenShift CLI (oc) en téléchargeant le binaire ou en utilisant un RPM.
2.1.2.1. Installation de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Il est possible d’installer le CLI OpenShift (oc) pour interagir avec les clusters dédiés OpenShift à partir d’une interface de ligne de commande. Il est possible d’installer oc sous Linux, Windows ou macOS.
Lorsque vous avez installé une version antérieure d’oc, vous ne pouvez pas l’utiliser pour compléter toutes les commandes dans OpenShift Dedicated 4. Installez et téléchargez la nouvelle version d’oc.
Installation du CLI OpenShift sur Linux
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Linux.
Procédure
- Accédez à la page de téléchargements OpenShift Dedicated sur le portail client Red Hat.
- Choisissez l’architecture dans la liste déroulante Variante de produit.
- Choisissez la version appropriée dans la liste déroulante Version.
- Cliquez sur Télécharger maintenant à côté de l’entrée OpenShift v4 Linux Clients et enregistrez le fichier.
Décompressez l’archive:
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déposez le binaire oc dans un répertoire qui est sur votre PATH.
Afin de vérifier votre PATH, exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc:
oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Installation du CLI OpenShift sur Windows
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Windows.
Procédure
- Accédez à la page de téléchargements OpenShift Dedicated sur le portail client Red Hat.
- Choisissez la version appropriée dans la liste déroulante Version.
- Cliquez sur Télécharger maintenant à côté de l’entrée client Windows OpenShift v4 et enregistrez le fichier.
- Décompressez l’archive avec un programme ZIP.
Déplacez le binaire oc vers un répertoire qui est sur votre PATH.
Afin de vérifier votre PATH, ouvrez l’invite de commande et exécutez la commande suivante:
path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc:
oc <command>
C:\> oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Installation de l’OpenShift CLI sur macOS
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur macOS.
Procédure
- Accédez à la page de téléchargements OpenShift Dedicated sur le portail client Red Hat.
- Choisissez la version appropriée dans la liste déroulante Version.
Cliquez sur Télécharger maintenant à côté de l’entrée OpenShift v4 macOS Clients et enregistrez le fichier.
NoteDans le cas de macOS arm64, choisissez l’entrée client OpenShift v4 macOS arm64.
- Décompressez et décompressez l’archive.
Déplacez le binaire oc vers un répertoire sur votre PATH.
Afin de vérifier votre PATH, ouvrez un terminal et exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Contrôlez votre installation à l’aide d’une commande oc:
oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.2.2. Installation du CLI OpenShift à l’aide de la console Web Copier lienLien copié sur presse-papiers!
Il est possible d’installer l’OpenShift CLI (oc) pour interagir avec les clusters dédiés OpenShift à partir d’une console Web. Il est possible d’installer oc sous Linux, Windows ou macOS.
Lorsque vous avez installé une version antérieure d’oc, vous ne pouvez pas l’utiliser pour compléter toutes les commandes dans OpenShift Dedicated 4. Installez et téléchargez la nouvelle version d’oc.
2.1.2.2.1. Installation du CLI OpenShift sur Linux à l’aide de la console Web Copier lienLien copié sur presse-papiers!
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Linux.
Procédure
- Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
Extrayez le fichier binaire oc de l’archive téléchargée.
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le binaire oc vers un répertoire qui est sur votre PATH.
Afin de vérifier votre PATH, exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc:
oc <command>
$ oc <command>
2.1.2.2.2. Installation du CLI OpenShift sur Windows à l’aide de la console Web Copier lienLien copié sur presse-papiers!
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur Windows.
Procédure
- Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
- Extrayez le fichier binaire oc de l’archive téléchargée.
Déplacez le binaire oc vers un répertoire qui est sur votre PATH.
Afin de vérifier votre PATH, ouvrez l’invite de commande et exécutez la commande suivante:
path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc:
oc <command>
C:\> oc <command>
2.1.2.2.3. Installation du CLI OpenShift sur macOS à l’aide de la console web Copier lienLien copié sur presse-papiers!
En utilisant la procédure suivante, vous pouvez installer le binaire OpenShift CLI (oc) sur macOS.
Procédure
- Cliquez ici pour télécharger la dernière version de oc CLI pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
- Extrayez le fichier binaire oc de l’archive téléchargée.
Déplacez le binaire oc vers un répertoire sur votre PATH.
Afin de vérifier votre PATH, ouvrez un terminal et exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé le CLI OpenShift, il est disponible à l’aide de la commande oc:
oc <command>
$ oc <command>
2.1.2.3. Installation du CLI OpenShift à l’aide d’un RPM Copier lienLien copié sur presse-papiers!
Dans Red Hat Enterprise Linux (RHEL), vous pouvez installer l’OpenShift CLI (oc) en tant que RPM si vous disposez d’un abonnement dédié OpenShift actif sur votre compte Red Hat.
Il faut installer oc pour RHEL 9 en téléchargeant le binaire. L’installation d’oc à l’aide d’un paquet RPM n’est pas prise en charge sur Red Hat Enterprise Linux (RHEL) 9.
Conditions préalables
- Doit avoir des privilèges racine ou sudo.
Procédure
Inscrivez-vous avec Red Hat Subscription Manager:
subscription-manager register
# subscription-manager register
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Retirez les dernières données d’abonnement:
subscription-manager refresh
# subscription-manager refresh
Copy 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’identifiant de pool pour un abonnement dédié OpenShift 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 référentiels requis par OpenShift Dedicated 4.
subscription-manager repos --enable="rhocp-4-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="rhocp-4-for-rhel-8-x86_64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Installez le package openshift-clients:
yum install openshift-clients
# yum install openshift-clients
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
- Contrôlez votre installation à l’aide d’une commande oc:
oc <command>
$ oc <command>
2.1.2.4. Installation de l’OpenShift CLI à l’aide de Homebrew Copier lienLien copié sur presse-papiers!
Dans macOS, vous pouvez installer l’OpenShift CLI (oc) en utilisant le gestionnaire de paquets Homebrew.
Conditions préalables
- Homebrew (brew) doit être installé.
Procédure
Installez le package openshift-cli en exécutant la commande suivante:
brew install openshift-cli
$ brew install openshift-cli
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
- Contrôlez votre installation à l’aide d’une commande oc:
oc <command>
$ oc <command>
2.1.3. Connexion à l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Connectez-vous à OpenShift CLI (oc) pour accéder et gérer votre cluster.
Conditions préalables
- Il faut avoir accès à un cluster dédié OpenShift.
- L’OpenShift CLI (oc) est installé.
Afin d’accéder à un cluster accessible uniquement sur un serveur proxy HTTP, vous pouvez définir les variables HTTP_PROXY, HTTPS_PROXY et NO_PROXY. Ces variables d’environnement sont respectées par le CLI oc afin que toute communication avec le cluster passe par le proxy HTTP.
Les en-têtes d’authentification ne sont envoyés que lorsque vous utilisez le transport HTTPS.
Procédure
Entrez la commande oc login et passez dans un nom d’utilisateur:
oc login -u user1
$ oc login -u user1
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Lorsque vous l’invitez, entrez les informations requises:
Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Lorsque vous êtes connecté à la console Web, vous pouvez générer une commande de connexion oc qui inclut vos informations de jeton et de serveur. La commande vous permet de vous connecter à OpenShift Dedicated CLI sans les instructions interactives. Afin de générer la commande, sélectionnez Copier la commande de connexion dans le menu déroulant du nom d’utilisateur en haut à droite de la console Web.
Il est maintenant possible de créer un projet ou d’émettre d’autres commandes pour la gestion de votre cluster.
2.1.4. Connexion au CLI OpenShift à l’aide d’un navigateur Web Copier lienLien copié sur presse-papiers!
Connectez-vous à OpenShift CLI (oc) à l’aide d’un navigateur Web pour accéder et gérer votre cluster. Cela permet aux utilisateurs d’éviter d’insérer leur jeton d’accès dans la ligne de commande.
La connexion au CLI via le navigateur Web exécute un serveur sur localhost avec HTTP, et non HTTPS; utilisez avec prudence sur les stations de travail multi-utilisateurs.
Conditions préalables
- Il faut avoir accès à un cluster dédié OpenShift.
- Il faut avoir installé l’OpenShift CLI (oc).
- Il faut installer un navigateur.
Procédure
Entrez la commande de connexion oc avec le drapeau --web:
oc login <cluster_url> --web
$ oc login <cluster_url> --web
1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- En option, vous pouvez spécifier l’URL du serveur et le port de rappel. A titre d’exemple, oc login <cluster_url> --web --callback-port 8280 localhost:8443.
Le navigateur web s’ouvre automatiquement. Dans le cas contraire, cliquez sur le lien dans la sortie de commande. Dans le cas où vous ne spécifiez pas le serveur dédié OpenShift, vous essayez d’ouvrir la console Web du cluster spécifié dans le fichier de configuration oc actuel. En l’absence de configuration d’oc, oc invite de manière interactive l’URL du serveur.
Exemple de sortie
Opening login URL in the default browser: https://openshift.example.com Opening in existing browser session.
Opening login URL in the default browser: https://openshift.example.com Opening in existing browser session.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Lorsque plus d’un fournisseur d’identité est disponible, sélectionnez votre choix parmi les options fournies.
- Entrez votre nom d’utilisateur et votre mot de passe dans les champs de navigateur correspondants. Après avoir été connecté, le navigateur affiche le jeton d’accès texte reçu avec succès; s’il vous plaît revenir à votre terminal.
Consultez le CLI pour une confirmation de connexion.
Exemple de sortie
Login successful. You don't have any projects. You can try to create a new project, by running oc new-project <projectname>
Login successful. You don't have any projects. You can try to create a new project, by running oc new-project <projectname>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La console Web par défaut au profil utilisé lors de la session précédente. Afin de basculer entre les profils Administrateur et Développeur, déconnectez-vous de la console Web OpenShift et effacez le cache.
Il est maintenant possible de créer un projet ou d’émettre d’autres commandes pour la gestion de votre cluster.
2.1.5. À l’aide de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Examinez les sections suivantes pour apprendre à accomplir des tâches communes à l’aide de l’ICC.
2.1.5.1. Créer un projet Copier lienLien copié sur presse-papiers!
La commande oc new-project permet de 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.5.2. Créer une nouvelle application Copier lienLien copié sur presse-papiers!
La commande oc new-app permet de 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.5.3. Affichage des gousses Copier lienLien copié sur presse-papiers!
La commande oc get pods permet d’afficher les pods du projet en cours.
Lorsque vous exécutez oc à l’intérieur d’un pod et ne spécifiez pas un espace de noms, l’espace de noms du pod est utilisé par défaut.
oc get pods -o wide
$ 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.5.4. Affichage des journaux des pod Copier lienLien copié sur presse-papiers!
La commande oc logs permet d’afficher les journaux d’un pod 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.5.5. Affichage du projet en cours Copier lienLien copié sur presse-papiers!
La commande oc project permet d’afficher 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.5.6. Affichage de l’état du projet en cours Copier lienLien copié sur presse-papiers!
La commande d’état oc permet d’afficher des informations sur le projet en cours, tels que les services, les déploiements et les configurations de build.
oc status
$ oc status
Exemple de sortie
2.1.5.7. Liste des ressources d’API prises en charge Copier lienLien copié sur presse-papiers!
La commande oc api-ressources permet d’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.6. Avoir de l’aide Copier lienLien copié sur presse-papiers!
Avec les commandes CLI et OpenShift, vous pouvez obtenir de l’aide de la manière suivante:
Faites appel à l’aide d’oc pour obtenir une liste et une description de toutes les commandes CLI disponibles:
Exemple : Obtenez de l’aide générale pour le CLI
oc help
$ oc help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Employez le drapeau --help pour obtenir de l’aide sur une commande CLI spécifique:
Exemple : Obtenez de l’aide pour la commande oc create
oc create --help
$ oc create --help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow La commande oc explicative permet d’afficher la description et les champs d’une ressource particulière:
Exemple : Voir la documentation pour la ressource Pod
oc explain pods
$ oc explain pods
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.7. Déverrouillage de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
Déconnectez le CLI OpenShift pour terminer votre session en cours.
La commande oc logout est utilisée.
oc logout
$ oc logout
Copy 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
Cela supprime le jeton d’authentification enregistré du serveur et le supprime de votre fichier de configuration.
2.2. Configuration de l’OpenShift CLI Copier lienLien copié sur presse-papiers!
2.2.1. Activer la fin de l’onglet Copier lienLien copié sur presse-papiers!
Il est possible d’activer la fin de l’onglet pour les shells Bash ou Zsh.
2.2.1.1. Activer la réalisation de l’onglet pour Bash Copier lienLien copié sur presse-papiers!
Après avoir installé le CLI OpenShift (oc), vous pouvez activer l’achèvement de l’onglet pour compléter automatiquement les commandes oc ou suggérer des options lorsque vous appuyez sur Tab. La procédure suivante permet de compléter l’onglet pour le shell Bash.
Conditions préalables
-
Il faut que la CLI OpenShift (
oc
) soit installée. - Il faut installer le paquet bash-completion.
Procédure
Enregistrez le code d’achèvement Bash dans un fichier:
oc completion bash > oc_bash_completion
$ oc completion bash > oc_bash_completion
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copiez le fichier dans /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 Il est également possible d’enregistrer le fichier dans un répertoire local et de le sourcer à partir de votre fichier .bashrc à la place.
L’achèvement de l’onglet est activé lorsque vous ouvrez un nouveau terminal.
2.2.1.2. Activer la réalisation de l’onglet pour Zsh Copier lienLien copié sur presse-papiers!
Après avoir installé le CLI OpenShift (oc), vous pouvez activer l’achèvement de l’onglet pour compléter automatiquement les commandes oc ou suggérer des options lorsque vous appuyez sur Tab. La procédure suivante permet de compléter l’onglet pour le shell Zsh.
Conditions préalables
-
Il faut que la CLI OpenShift (
oc
) soit installée.
Procédure
Afin d’ajouter l’onglet oc à votre fichier .zshrc, exécutez la commande suivante:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
L’achèvement de l’onglet est activé lorsque vous ouvrez un nouveau terminal.
2.3. L’utilisation des commandes oc et kubectl Copier lienLien copié sur presse-papiers!
L’interface de ligne de commande Kubernetes (CLI), kubectl, peut être utilisée pour exécuter des commandes contre un cluster Kubernetes. Comme OpenShift Dedicated est une distribution certifiée Kubernetes, vous pouvez utiliser les binaires kubectl pris en charge qui sont livrés avec OpenShift Dedicated, 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 prend en charge nativement des fonctionnalités supplémentaires OpenShift Dedicated, y compris:
Assistance complète pour OpenShift Ressources dédiées
Les ressources telles que DeploymentConfig, BuildConfig, Route, ImageStream et ImageStreamTag sont spécifiques aux distributions dédiées OpenShift et s’appuient sur les primitives Kubernetes standard.
- Authentification
Commandes supplémentaires
La nouvelle application de commande supplémentaire, par exemple, facilite le démarrage de nouvelles applications à l’aide du code source existant ou d’images pré-construites. De même, la commande supplémentaire oc new-project facilite le démarrage d’un projet que vous pouvez passer par défaut.
Lorsque vous avez installé une version antérieure du binaire oc, vous ne pouvez pas l’utiliser pour compléter toutes les commandes dans OpenShift Dedicated 4 . Lorsque vous voulez les dernières fonctionnalités, vous devez télécharger et installer la dernière version du binaire oc correspondant à votre version de serveur dédié OpenShift.
Les changements d’API non sécurisés entraîneront, au minimum, deux versions mineures (4.1 à 4.2 à 4.3, par exemple) pour permettre à d’anciens binaires d’oc de mettre à jour. L’utilisation de nouvelles capacités peut nécessiter de nouveaux binaires oc. Le serveur 4.3 peut avoir des capacités supplémentaires qu’un binaire 4.2 oc ne peut pas utiliser et un binaire 4,3 oc peut avoir des capacités supplémentaires qui ne sont pas prises en charge par un serveur 4.2.
Client x.Y (oc client) | * x.Y+N note de bas de page:versionpolicyn[Là où N est un nombre supérieur ou égal à 1.] (oc Client) | |
Catégorie:X.Y (Serveur) |
|
|
Ajouter au panier x.Y+N note de bas de page:versionpolicyn[] (Server) |
|
|
Entièrement compatible.
le client OC peut ne pas être en mesure d’accéder aux fonctionnalités du serveur.
le client OC peut fournir des options et des fonctionnalités qui pourraient ne pas être compatibles avec le serveur accédé.
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édiés OpenShift provenant d’un environnement Kubernetes standard, ou pour ceux qui préfèrent utiliser le kubectl CLI. Les utilisateurs existants de kubectl peuvent continuer à utiliser le binaire pour interagir avec les primitifs de Kubernetes, sans modification nécessaire au cluster OpenShift Dedicated.
Il est possible d’installer le binaire kubectl pris en charge en suivant les étapes pour installer le CLI OpenShift. Le binaire kubectl est inclus dans l’archive si vous téléchargez le binaire, ou est installé lorsque vous installez le CLI en utilisant un RPM.
Consultez la documentation kubectl pour plus d’informations.
2.4. Gestion des profils CLI Copier lienLien copié sur presse-papiers!
Le fichier de configuration CLI vous permet de configurer différents profils, ou contextes, pour une utilisation avec la vue d’ensemble des outils CLI. Le contexte consiste en un serveur dédié OpenShift associé à un surnom.
2.4.1. À propos des changements entre les profils CLI Copier lienLien copié sur presse-papiers!
Les contextes vous permettent de basculer facilement entre plusieurs utilisateurs sur plusieurs serveurs ou clusters dédiés OpenShift lors de l’utilisation des opérations CLI. Les surnoms facilitent la gestion des configurations CLI en fournissant des références courtes aux contextes, aux identifiants d’utilisateur et aux détails des clusters. Après qu’un utilisateur se connecte avec le CLI oc pour la première fois, OpenShift Dedicated crée un fichier ~/.kube/config si l’on n’existe pas déjà. Comme plus de détails d’authentification et de connexion sont fournis au CLI, soit automatiquement lors d’une opération de connexion oc, soit en configurant manuellement les profils CLI, les informations mises à jour sont stockées dans le fichier de configuration:
CLI config fichier
- 1
- La section clusters définit les détails de connexion pour les clusters dédiés OpenShift, y compris l’adresse de leur serveur maître. Dans cet exemple, un cluster est surnommé openshift1.example.com:8443 et un autre est surnommé openshift2.example.com:8443.
- 2
- Cette section de contextes définit deux contextes: l’un surnommé alice-project/openshift1.example.com:8443/alice, en utilisant le projet alice-projet, openshift1.example.com:8443, cluster et alice user, et un autre surnommé joe-project/openshift1.example.com:8443/alice, en utilisant le projet joe-project, openshift1.example.com:8443 et a
- 3
- Le paramètre current-context montre que le contexte joe-project/openshift1.example.com:8443/alice est actuellement utilisé, permettant à l’utilisateur alice de travailler dans le projet joe-project sur le cluster openshift1.example.com:8443.
- 4
- La section utilisateurs définit les identifiants d’utilisateur. Dans cet exemple, le surnom d’utilisateur alice/openshift1.example.com:8443 utilise un jeton d’accès.
Le CLI 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 à partir de la ligne de commande. Après avoir été connecté, vous pouvez utiliser l’état d’oc ou la commande projet oc 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".
Il est possible d’exécuter à nouveau la commande oc login et de fournir les informations requises au cours du processus interactif, pour vous connecter à l’aide de toute autre combinaison d’informations d’identification utilisateur et de détails de cluster. Le contexte est construit sur la base des informations fournies si l’on n’existe pas déjà. Lorsque 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. Des commandes de configuration CLI supplémentaires sont également disponibles pour une utilisation plus avancée.
Lorsque vous avez accès à des identifiants d’administrateur mais que vous n’êtes plus connecté en tant que système utilisateur par défaut:admin, vous pouvez vous connecter en tant qu’utilisateur à tout moment tant que les informations d’identification sont toujours présentes dans votre fichier de configuration CLI. La commande suivante se connecte et passe 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 couvre l’utilisation plus avancée des configurations CLI. Dans la plupart des situations, vous pouvez utiliser les commandes oc login et oc project pour vous connecter et basculer entre les contextes et les projets.
Lorsque 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 à cet effet:
Le sous-commande | L’utilisation |
---|---|
| Définit une entrée de cluster dans le fichier de configuration CLI. Lorsque le surnom 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>]
|
| Définit une entrée contextuelle dans le fichier de configuration CLI. Lorsque le surnom 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>]
|
| Définit le contexte actuel en utilisant le surnom 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>
Le <property_name> est un nom délimité par point où chaque jeton représente un nom d’attribut ou une clé de carte. La valeur <property_value> est la nouvelle valeur définie. |
| Désactivez les valeurs individuelles dans le fichier de configuration CLI. oc config unset <property_name>
Le <property_name> est un nom délimité par point où chaque jeton représente un nom d’attribut ou une clé de carte. |
| Affiche la configuration CLI fusionnée actuellement utilisée. oc config view
Affiche le résultat du fichier de configuration CLI spécifié. oc config view --config=<specific_filename>
|
Exemple d’utilisation
- Connectez-vous en tant qu’utilisateur qui utilise 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
- Afficher l’entrée de cluster automatiquement créée:
oc config view
$ oc config view
Exemple de sortie
- Actualisez 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, afin de confirmer que les changements sont mis en œuvre:
oc whoami -c
$ oc whoami -c
L’ensemble des opérations de CLI ultérieures utilise le nouveau contexte, sauf indication contraire par la suppression des options CLI ou jusqu’à ce que le contexte soit changé.
2.4.3. Charger et fusionner les règles Copier lienLien copié sur presse-papiers!
Lors de l’émission des opérations CLI pour le chargement et la fusion de l’ordre pour la configuration CLI, vous pouvez suivre ces règles:
Les fichiers de configuration CLI sont récupérés à partir de votre poste de travail, en utilisant la hiérarchie suivante et les règles de fusion:
- Lorsque l’option --config est définie, seul ce fichier est chargé. Le drapeau est fixé une fois et aucune fusion n’a lieu.
- Lorsque la variable d’environnement $KUBECONFIG est 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 ensemble. Lorsqu’une valeur est modifiée, elle est modifiée dans le fichier qui définit la strophe. Lorsqu’une valeur est créée, elle est créée dans le premier fichier existant. En l’absence de fichiers dans la chaîne, il crée le dernier fichier dans la liste.
- Dans le cas contraire, le fichier ~/.kube/config est utilisé et aucune fusion n’a lieu.
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 contextuelle actuelle du fichier de configuration CLI.
- À ce stade, une valeur vide est autorisée.
L’utilisateur et le cluster à utiliser sont déterminés. À ce stade, vous pouvez ou non avoir un contexte; ils sont construits en fonction de la première correspondance dans le flux suivant, qui est exécuté une fois pour l’utilisateur et une fois pour le cluster:
- La valeur de --user pour le nom d’utilisateur et l’option --cluster pour le nom de cluster.
- Lorsque l’option --context est présente, utilisez la valeur du contexte.
- À ce stade, une valeur vide est autorisée.
L’information réelle du cluster à utiliser est déterminée. À ce stade, vous pouvez avoir ou non des informations de cluster. Chaque élément de l’information de cluster est construit en fonction de la première correspondance dans le flux suivant:
Les valeurs de l’une des options de ligne de commande suivantes:
- --serveur,
-
--API-version
-
--certificat-autorité
-
--insécurité-skip-tls-vérifier
- Lorsque des informations de cluster et une valeur pour l’attribut sont présentes, utilisez-les.
- Dans le cas où vous n’avez pas d’emplacement de serveur, il y a une erreur.
Les informations réelles de l’utilisateur à utiliser sont déterminées. Les utilisateurs sont construits en utilisant les mêmes règles que les clusters, sauf que vous ne pouvez avoir qu’une seule technique d’authentification par utilisateur; les techniques contradictoires causent l’échec de l’opération. Les options de ligne de commande ont préséance sur les valeurs de fichier de configuration. Les options de ligne de commande valides sont:
-
--auth-chemin
-
--certificat client
-
--client-clé
-
--jeton
-
- Dans le cas de toute information manquante, des valeurs par défaut sont utilisées et des invitations sont fournies pour des informations supplémentaires.
2.5. Extension du CLI OpenShift avec des plugins Copier lienLien copié sur presse-papiers!
Il est possible d’écrire et d’installer des plugins pour construire sur les commandes oc par défaut, ce qui vous permet d’effectuer de nouvelles tâches plus complexes avec OpenShift CLI.
2.5.1. Ecrire des plugins CLI Copier lienLien copié sur presse-papiers!
Il est possible d’écrire un plugin pour OpenShift CLI dans n’importe quel langage de programmation ou script qui vous permet d’écrire des commandes en ligne de commande. Il est à noter que vous ne pouvez pas utiliser un plugin pour écraser une commande oc existante.
Procédure
Cette procédure crée un plugin Bash simple qui imprime un message vers le terminal lorsque la commande oc foo est émise.
Créez un fichier appelé oc-foo.
Lorsque vous nommez votre fichier plugin, gardez à l’esprit ce qui suit:
- Le fichier doit commencer par oc- ou kubectl- pour être reconnu comme un plugin.
- Le nom du fichier détermine la commande qui invoque le plugin. À titre d’exemple, un plugin avec le nom de fichier oc-foo-bar peut être invoqué par une commande de oc foo bar. Il est également possible d’utiliser des accents si vous souhaitez que la commande contienne des tirets. À titre d’exemple, un plugin avec le nom de fichier oc-foo_bar peut être invoqué par une commande d’oc foo-bar.
Ajoutez le contenu suivant au fichier.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé ce plugin pour le CLI, il peut être invoqué en utilisant la commande oc foo.
2.5.2. Installation et utilisation de plugins CLI Copier lienLien copié sur presse-papiers!
Après avoir écrit un plugin personnalisé pour OpenShift CLI, vous devez installer le plugin avant utilisation.
Conditions préalables
- L’outil oc CLI doit être installé.
- Il faut avoir un fichier de plugin CLI qui commence par oc- ou kubectl-.
Procédure
Au besoin, mettre à jour le fichier plugin pour être exécutable.
chmod +x <plugin_file>
$ chmod +x <plugin_file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déposez le fichier n’importe où dans votre PATH, comme /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 la liste des plugins oc pour vous assurer que le plugin est listé.
oc plugin list
$ oc plugin list
Copy 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 Dans le cas où votre plugin n’est pas listé ici, vérifiez que le fichier commence par oc- ou kubectl-, qu’il est exécutable et qu’il est sur votre PATH.
Invoquez la nouvelle commande ou option introduite par le plugin.
Ainsi, si vous avez construit et installé le plugin kubectl-ns à partir du référentiel du plugin Sample, vous pouvez utiliser la commande suivante pour afficher l’espace de noms actuel.
oc ns
$ oc ns
Copy to Clipboard Copied! Toggle word wrap Toggle overflow A noter que la commande d’invoquer le plugin dépend du nom du fichier du plugin. À titre d’exemple, un plugin avec le nom de fichier d’oc-foo-bar est invoqué par la commande oc foo bar.
2.6. Commande OpenShift CLI Référence de commande Copier lienLien copié sur presse-papiers!
Cette référence fournit des descriptions et des exemples de commandes pour les commandes de développeurs OpenShift CLI (oc).
Exécutez l’aide d’oc pour énumérer toutes les commandes ou exécuter oc <command> --aider à obtenir des détails supplémentaires pour une commande spécifique.
2.6.1. Commandes de développeurs OpenShift CLI (oc) Copier lienLien copié sur presse-papiers!
2.6.1.1. annotation d’OC Copier lienLien copié sur presse-papiers!
Actualiser les annotations sur une ressource
Exemple d’utilisation
2.6.1.2. api-ressources d’OC Copier lienLien copié sur presse-papiers!
Imprimez les ressources API prises en charge sur le serveur
Exemple d’utilisation
2.6.1.3. api-versions OC Copier lienLien copié sur presse-papiers!
Imprimez les versions API prises en charge sur le serveur, sous la forme de "groupe/version"
Exemple d’utilisation
Print the supported API versions
# Print the supported API versions
oc api-versions
2.6.1.4. les OC s’appliquent Copier lienLien copié sur presse-papiers!
Appliquer une configuration à une ressource par nom de fichier ou stdin
Exemple d’utilisation
2.6.1.5. les OC appliquent Edit-last-appliqué Copier lienLien copié sur presse-papiers!
Éditer les dernières annotations de configuration de dernière application d’une ressource/objet
Exemple d’utilisation
Edit the last-applied-configuration annotations by type/name in YAML
# 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.6.1.6. appliquer OC-last-appliqué Copier lienLien copié sur presse-papiers!
Définir l’annotation de dernière configuration appliquée sur un objet en direct pour correspondre au contenu d’un fichier
Exemple d’utilisation
2.6.1.7. l’OC applique view-last-appliqué Copier lienLien copié sur presse-papiers!
Afficher les dernières annotations de configuration appliquée d’une ressource/objet
Exemple d’utilisation
View the last-applied-configuration annotations by type/name in YAML
# 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.6.1.8. joint d’OC Copier lienLien copié sur presse-papiers!
Attacher à un conteneur en cours d’exécution
Exemple d’utilisation
2.6.1.9. auth can-i d’OC Copier lienLien copié sur presse-papiers!
Vérifiez si une action est autorisée
Exemple d’utilisation
2.6.1.10. auth OC se réconcilier Copier lienLien copié sur presse-papiers!
Concilie les règles relatives au rôle RBAC, à la liaison des rôles, au rôle de cluster et aux objets liés au rôle de cluster
Exemple d’utilisation
Reconcile RBAC resources from a file
# Reconcile RBAC resources from a file
oc auth reconcile -f my-rbac-rules.yaml
2.6.1.11. auth whoami d’OC Copier lienLien copié sur presse-papiers!
Expérimental: Vérifier les attributs de soi-même
Exemple d’utilisation
Get your subject attributes.
# Get your subject attributes.
oc auth whoami
# Get your subject attributes in JSON format.
oc auth whoami -o json
2.6.1.12. autoscale d’OC Copier lienLien copié sur presse-papiers!
Automatiser une configuration de déploiement, un déploiement, un ensemble de répliques, un ensemble d’états ou 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
# 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.6.1.13. annulation d’OC Copier lienLien copié sur presse-papiers!
Annuler l’exécution, l’attente ou les nouvelles versions
Exemple d’utilisation
2.6.1.14. cluster-info OC Copier lienLien copié sur presse-papiers!
Afficher les informations du cluster
Exemple d’utilisation
Print the address of the control plane and cluster services
# Print the address of the control plane and cluster services
oc cluster-info
2.6.1.15. dump OC cluster-info Copier lienLien copié sur presse-papiers!
Décharger les informations pertinentes pour le débogage et le diagnostic
Exemple d’utilisation
2.6.1.16. achèvement des OC Copier lienLien copié sur presse-papiers!
Code d’achèvement de la coquille de sortie pour la coquille spécifiée (bash, zsh, poisson ou powershell)
Exemple d’utilisation
2.6.1.17. configuration OC config current-context Copier lienLien copié sur presse-papiers!
Afficher le contexte actuel
Exemple d’utilisation
Display the current-context
# Display the current-context
oc config current-context
2.6.1.18. configuration OC config Remove-cluster Copier lienLien copié sur presse-papiers!
Effacer le cluster spécifié du kubeconfig
Exemple d’utilisation
Delete the minikube cluster
# Delete the minikube cluster
oc config delete-cluster minikube
2.6.1.19. configuration OC config Remove-context Copier lienLien copié sur presse-papiers!
Effacer le contexte spécifié du kubeconfig
Exemple d’utilisation
Delete the context for the minikube cluster
# Delete the context for the minikube cluster
oc config delete-context minikube
2.6.1.20. configuration de l’utilisateur de suppression Copier lienLien copié sur presse-papiers!
Effacer l’utilisateur spécifié du kubeconfig
Exemple d’utilisation
Delete the minikube user
# Delete the minikube user
oc config delete-user minikube
2.6.1.21. config OC get-clusters Copier lienLien copié sur presse-papiers!
Affichage des clusters définis dans le kubeconfig
Exemple d’utilisation
List the clusters that oc knows about
# List the clusters that oc knows about
oc config get-clusters
2.6.1.22. configuration OC 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
# 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.6.1.23. configuration 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
# List the users that oc knows about
oc config get-users
2.6.1.24. configuration d’OC new-admin-kubeconfig Copier lienLien copié sur presse-papiers!
Générer, rendre le serveur fiable et afficher un nouvel admin.kubeconfig
Exemple d’utilisation
Generate a new admin kubeconfig
# Generate a new admin kubeconfig
oc config new-admin-kubeconfig
2.6.1.25. configuration d’OC new-kubelet-bootstrap-kubeconfig Copier lienLien copié sur presse-papiers!
Générer, rendre le serveur fiable et afficher un nouveau kubelet /etc/kubernetes/kubeconfig
Exemple d’utilisation
Generate a new kubelet bootstrap kubeconfig
# Generate a new kubelet bootstrap kubeconfig
oc config new-kubelet-bootstrap-kubeconfig
2.6.1.26. config OC rafraîchissement-ca-grouple Copier lienLien copié sur presse-papiers!
Actualisez le paquet OpenShift CA en contactant le serveur API
Exemple d’utilisation
2.6.1.27. configuration OC rename-context Copier lienLien copié sur presse-papiers!
Le renom d’un contexte à partir du fichier kubeconfig
Exemple d’utilisation
Rename the context 'old-name' to 'new-name' in your kubeconfig file
# Rename the context 'old-name' to 'new-name' in your kubeconfig file
oc config rename-context old-name new-name
2.6.1.28. ensemble de configuration OC Copier lienLien copié sur presse-papiers!
Définir une valeur individuelle dans un fichier kubeconfig
Exemple d’utilisation
2.6.1.29. configuration OC Set-cluster Copier lienLien copié sur presse-papiers!
Définir une entrée de cluster dans kubeconfig
Exemple d’utilisation
2.6.1.30. configuration OC set-context Copier lienLien copié sur presse-papiers!
Définir une entrée contextuelle dans kubeconfig
Exemple d’utilisation
Set the user field on the gce context entry without touching other values
# Set the user field on the gce context entry without touching other values
oc config set-context gce --user=cluster-admin
2.6.1.31. configuration OC config set-credentials Copier lienLien copié sur presse-papiers!
Définir une entrée utilisateur dans kubeconfig
Exemple d’utilisation
2.6.1.32. config OC Unset Copier lienLien copié sur presse-papiers!
Désinitialiser une valeur individuelle dans un fichier kubeconfig
Exemple d’utilisation
Unset the current-context
# Unset the current-context
oc config unset current-context
# Unset namespace in foo context
oc config unset contexts.foo.namespace
2.6.1.33. configuration OC use-context Copier lienLien copié sur presse-papiers!
Définir le contexte courant dans un fichier kubeconfig
Exemple d’utilisation
Use the context for the minikube cluster
# Use the context for the minikube cluster
oc config use-context minikube
2.6.1.34. affichage de configuration OC Copier lienLien copié sur presse-papiers!
Afficher les paramètres de kubeconfig fusionnés ou un fichier kubeconfig spécifié
Exemple d’utilisation
2.6.1.35. cp d’OC Copier lienLien copié sur presse-papiers!
Copier des fichiers et des répertoires vers et depuis des conteneurs
Exemple d’utilisation
2.6.1.36. création d’OC Copier lienLien copié sur presse-papiers!
Créer une ressource à partir d’un fichier ou à partir de stdin
Exemple d’utilisation
2.6.1.37. création d’OC Copier lienLien copié sur presse-papiers!
Créer une nouvelle construction
Exemple d’utilisation
Create a new build
# Create a new build
oc create build myapp
2.6.1.38. créer clusterresourcequota Copier lienLien copié sur presse-papiers!
Créer un quota de ressources en cluster
Exemple d’utilisation
Create a cluster resource quota limited to 10 pods
# 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.6.1.39. créer clusterrole OC Copier lienLien copié sur presse-papiers!
Créer un rôle de cluster
Exemple d’utilisation
2.6.1.40. créer le clusterrolebinding Copier lienLien copié sur presse-papiers!
Créer un rôle de cluster contraignant 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
# 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.6.1.41. créer un configmap Copier lienLien copié sur presse-papiers!
Créer une carte de configuration à partir d’un fichier, d’un répertoire ou d’une valeur littérale locale
Exemple d’utilisation
2.6.1.42. créer un 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
# 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.6.1.43. créer un déploiement Copier lienLien copié sur presse-papiers!
Créer un déploiement avec le nom spécifié
Exemple d’utilisation
2.6.1.44. créer la configuration de déploiement Copier lienLien copié sur presse-papiers!
Créer une configuration de déploiement avec des options par défaut qui utilisent une image donnée
Exemple d’utilisation
Create an nginx deployment config named my-nginx
# Create an nginx deployment config named my-nginx
oc create deploymentconfig my-nginx --image=nginx
2.6.1.45. créer une identité Copier lienLien copié sur presse-papiers!
Créer manuellement une identité (uniquement nécessaire 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"
# Create an identity with identity provider "acme_ldap" and the identity provider username "adamjones"
oc create identity acme_ldap:adamjones
2.6.1.46. créer un flux d’images Copier lienLien copié sur presse-papiers!
Créer un nouveau flux d’images vide
Exemple d’utilisation
Create a new image stream
# Create a new image stream
oc create imagestream mysql
2.6.1.47. création d’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
# 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.6.1.48. l’OC crée une entrée Copier lienLien copié sur presse-papiers!
Créer une entrée avec le nom spécifié
Exemple d’utilisation
2.6.1.49. création d’emploi OC Copier lienLien copié sur presse-papiers!
Créer un job avec le nom spécifié
Exemple d’utilisation
2.6.1.50. créer un espace de noms 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
# Create a new namespace named my-namespace
oc create namespace my-namespace
2.6.1.51. créer un budget poddisruption Copier lienLien copié sur presse-papiers!
Créer un budget de perturbation de pod avec le nom spécifié
Exemple d’utilisation
2.6.1.52. créer une classe de priorité Copier lienLien copié sur presse-papiers!
Créer une classe de priorité avec le nom spécifié
Exemple d’utilisation
2.6.1.53. créer un 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
# 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.6.1.54. créer un rôle Copier lienLien copié sur presse-papiers!
Créer un rôle avec une seule règle
Exemple d’utilisation
2.6.1.55. l’OC crée la reliure de rôle Copier lienLien copié sur presse-papiers!
Créer un rôle contraignant 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
# 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 serviceaccount monitoring:sa-dev using the admin role
oc create rolebinding admin-binding --role=admin --serviceaccount=monitoring:sa-dev
2.6.1.56. créer un bord de route Copier lienLien copié sur presse-papiers!
Créer un itinéraire qui utilise la terminaison TLS edge
Exemple d’utilisation
2.6.1.57. l’OC crée un passage d’itinéraire Copier lienLien copié sur presse-papiers!
Créer un itinéraire qui utilise la terminaison TLS passthrough
Exemple d’utilisation
2.6.1.58. créer une route reencrypt Copier lienLien copié sur presse-papiers!
Créer une route qui utilise recrypter la terminaison TLS
Exemple d’utilisation
2.6.1.59. créer un fichier secret docker-registry Copier lienLien copié sur presse-papiers!
Créer un secret à utiliser avec un registre Docker
Exemple d’utilisation
If you do not already have a .dockercfg file, create a dockercfg secret directly
# If you do not already have a .dockercfg file, create a dockercfg secret directly
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.6.1.60. créer un secret générique Copier lienLien copié sur presse-papiers!
Créer un secret à partir d’un fichier, d’un répertoire ou d’une valeur littérale locale
Exemple d’utilisation
2.6.1.61. créer des tls secrets 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
# Create a new TLS secret named tls-secret with the given key pair
oc create secret tls tls-secret --cert=path/to/tls.crt --key=path/to/tls.key
2.6.1.62. créer un cluster de service Copier lienLien copié sur presse-papiers!
Créer un service ClusterIP
Exemple d’utilisation
Create a new ClusterIP service named my-cs
# 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.6.1.63. créer un nom externe de service Copier lienLien copié sur presse-papiers!
Créer un service ExterneName
Exemple d’utilisation
Create a new ExternalName service named my-ns
# Create a new ExternalName service named my-ns
oc create service externalname my-ns --external-name bar.com
2.6.1.64. créer un balanceur de charge de service Copier lienLien copié sur presse-papiers!
Créer un service LoadBalancer
Exemple d’utilisation
Create a new LoadBalancer service named my-lbs
# Create a new LoadBalancer service named my-lbs
oc create service loadbalancer my-lbs --tcp=5678:8080
2.6.1.65. créer un service nodeport Copier lienLien copié sur presse-papiers!
Créer un service NodePort
Exemple d’utilisation
Create a new NodePort service named my-ns
# Create a new NodePort service named my-ns
oc create service nodeport my-ns --tcp=5678:8080
2.6.1.66. créer un compte de service 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
# Create a new service account named my-service-account
oc create serviceaccount my-service-account
2.6.1.67. créer un jeton OC Copier lienLien copié sur presse-papiers!
Demander un jeton de compte de service
Exemple d’utilisation
2.6.1.68. créer un utilisateur Copier lienLien copié sur presse-papiers!
Créer manuellement un utilisateur (uniquement nécessaire 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"
# Create a user with the username "ajones" and the display name "Adam Jones"
oc create user ajones --full-name="Adam Jones"
2.6.1.69. création d’un useridentitymapping Copier lienLien copié sur presse-papiers!
Cartographie manuelle d’une identité à un utilisateur
Exemple d’utilisation
Map the identity "acme_ldap:adamjones" to the user "ajones"
# Map the identity "acme_ldap:adamjones" to the user "ajones"
oc create useridentitymapping acme_ldap:adamjones ajones
2.6.1.70. débogage d’OC Copier lienLien copié sur presse-papiers!
Lancer une nouvelle instance d’un pod pour le débogage
Exemple d’utilisation
2.6.1.71. les OC suppriment Copier lienLien copié sur presse-papiers!
Effacer les ressources par nom de fichier, stdin, ressources et noms, ou par le sélecteur de ressources et d’étiquettes
Exemple d’utilisation
2.6.1.72. les OC décrivent Copier lienLien copié sur presse-papiers!
Afficher les détails d’une ressource ou d’un groupe de ressources spécifiques
Exemple d’utilisation
2.6.1.73. diff d’OC Copier lienLien copié sur presse-papiers!
Differ la version en direct par rapport à une version appliquée
Exemple d’utilisation
Diff resources included in pod.json
# Diff resources included in pod.json
oc diff -f pod.json
# Diff file read from stdin
cat service.yaml | oc diff -f -
2.6.1.74. édition d’OC Copier lienLien copié sur presse-papiers!
Éditer une ressource sur le serveur
Exemple d’utilisation
2.6.1.75. événements OC Copier lienLien copié sur presse-papiers!
Liste des événements
Exemple d’utilisation
2.6.1.76. exec de l’OC Copier lienLien copié sur presse-papiers!
Exécuter une commande dans un conteneur
Exemple d’utilisation
2.6.1.77. l’OC explique Copier lienLien copié sur presse-papiers!
Obtenir de la documentation pour une ressource
Exemple d’utilisation
2.6.1.78. exposition d’OC Copier lienLien copié sur presse-papiers!
Exposer une application répliquée en tant que service ou itinéraire
Exemple d’utilisation
2.6.1.79. extrait d’OC Copier lienLien copié sur presse-papiers!
Extraire des secrets ou configurer des cartes sur le disque
Exemple d’utilisation
2.6.1.80. les OC obtiennent Copier lienLien copié sur presse-papiers!
Afficher une ou plusieurs ressources
Exemple d’utilisation
2.6.1.81. Get-token d’OC Copier lienLien copié sur presse-papiers!
Expérimental: Obtenez un jeton de l’émetteur OIDC externe en tant que plugin d’identification exec
Exemple d’utilisation
Starts an auth code flow to the issuer URL with the client ID and the given extra scopes
# Starts an auth code flow to the issuer URL with the client ID and the given extra scopes
oc get-token --client-id=client-id --issuer-url=test.issuer.url --extra-scopes=email,profile
# Starts an auth code flow to the issuer URL with a different callback address
oc get-token --client-id=client-id --issuer-url=test.issuer.url --callback-address=127.0.0.1:8343
2.6.1.82. oisive d’OC Copier lienLien copié sur presse-papiers!
Des ressources évolutibles inutilisées
Exemple d’utilisation
Idle the scalable controllers associated with the services listed in 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.6.1.83. annexe de l’image OC Copier lienLien copié sur presse-papiers!
Ajouter des couches aux images et les pousser à un registre
Exemple d’utilisation
2.6.1.84. extrait d’image OC Copier lienLien copié sur presse-papiers!
Copiez des fichiers à partir d’une image dans le système de fichiers
Exemple d’utilisation
2.6.1.85. info sur l’image OC Copier lienLien copié sur presse-papiers!
Afficher des informations sur une image
Exemple d’utilisation
2.6.1.86. le miroir d’image OC Copier lienLien copié sur presse-papiers!
Images miroirs d’un dépôt à l’autre
Exemple d’utilisation
2.6.1.87. image d’importation d’OC Copier lienLien copié sur presse-papiers!
Importer des images à partir d’un registre d’images conteneur
Exemple d’utilisation
2.6.1.88. kustomize OC Copier lienLien copié sur presse-papiers!
Construire une cible de kustomisation à partir d’un répertoire ou d’une URL
Exemple d’utilisation
2.6.1.89. étiquette OC Copier lienLien copié sur presse-papiers!
Actualisez les étiquettes sur une ressource
Exemple d’utilisation
2.6.1.90. connexion OC Copier lienLien copié sur presse-papiers!
Connectez-vous à un serveur
Exemple d’utilisation
2.6.1.91. logo d’OC Copier lienLien copié sur presse-papiers!
Fin de la session serveur actuelle
Exemple d’utilisation
Log out
# Log out
oc logout
2.6.1.92. journaux d’OC Copier lienLien copié sur presse-papiers!
Imprimer les journaux pour un conteneur dans un pod
Exemple d’utilisation
2.6.1.93. la nouvelle application OC Copier lienLien copié sur presse-papiers!
Créer une nouvelle application
Exemple d’utilisation
2.6.1.94. la nouvelle construction d’OC Copier lienLien copié sur presse-papiers!
Créer une nouvelle configuration de build
Exemple d’utilisation
2.6.1.95. le nouveau projet OC Copier lienLien copié sur presse-papiers!
Demander un nouveau projet
Exemple d’utilisation
Create a new project with minimal information
# 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.6.1.96. l’OC observe Copier lienLien copié sur presse-papiers!
Observer les changements de ressources et y réagir (expérimental)
Exemple d’utilisation
2.6.1.97. patch d’OC Copier lienLien copié sur presse-papiers!
Actualiser les champs d’une ressource
Exemple d’utilisation
2.6.1.98. liste des plugins OC Copier lienLien copié sur presse-papiers!
Liste de tous les exécutables de plugin visibles sur le PATH d’un utilisateur
Exemple d’utilisation
List all available plugins
# List all available plugins
oc plugin list
2.6.1.99. add-role-to-user de la politique d’OC 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
# 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.6.1.100. examen de la politique de l’OC Copier lienLien copié sur presse-papiers!
Vérifiez quel compte de service peut créer un pod
Exemple d’utilisation
2.6.1.101. la politique d’OCC-sujet-review Copier lienLien copié sur presse-papiers!
Vérifiez si un utilisateur ou un compte de service peut créer un pod
Exemple d’utilisation
2.6.1.102. le port d’Oc-forward Copier lienLien copié sur presse-papiers!
Acheminer un ou plusieurs ports locaux vers un pod
Exemple d’utilisation
2.6.1.103. le processus d’OC Copier lienLien copié sur presse-papiers!
Le traitement d’un modèle dans la liste des ressources
Exemple d’utilisation
2.6.1.104. le projet OC Copier lienLien copié sur presse-papiers!
Basculer vers un autre projet
Exemple d’utilisation
Switch to the 'myapp' project
# Switch to the 'myapp' project
oc project myapp
# Display the project currently in use
oc project
2.6.1.105. les projets d’OC Copier lienLien copié sur presse-papiers!
Afficher les projets existants
Exemple d’utilisation
List all projects
# List all projects
oc projects
2.6.1.106. le proxy d’OC Copier lienLien copié sur presse-papiers!
Exécutez un proxy vers le serveur API Kubernetes
Exemple d’utilisation
2.6.1.107. connexion au registre OC Copier lienLien copié sur presse-papiers!
Connectez-vous au registre intégré
Exemple d’utilisation
Log in to the integrated registry
# 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.6.1.108. les OC remplacent Copier lienLien copié sur presse-papiers!
Le remplacement d’une ressource par nom de fichier ou stdin
Exemple d’utilisation
2.6.1.109. le retour d’OC Copier lienLien copié sur presse-papiers!
Faire revenir une partie d’une application à un déploiement précédent
Exemple d’utilisation
2.6.1.110. annulation du déploiement d’OC Copier lienLien copié sur presse-papiers!
Annuler le déploiement en cours
Exemple d’utilisation
Cancel the in-progress deployment based on 'nginx'
# Cancel the in-progress deployment based on 'nginx'
oc rollout cancel dc/nginx
2.6.1.111. historique de déploiement d’OC Copier lienLien copié sur presse-papiers!
Afficher l’historique du déploiement
Exemple d’utilisation
View the rollout history of a deployment
# 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.6.1.112. dernier déploiement d’OC Copier lienLien copié sur presse-papiers!
Démarrez un nouveau déploiement pour une configuration de déploiement avec le dernier état à partir de ses déclencheurs
Exemple d’utilisation
Start a new rollout based on the latest images defined in the image change triggers
# 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.6.1.113. pause de déploiement d’OC Copier lienLien copié sur presse-papiers!
Indiquez la ressource fournie comme une pause
Exemple d’utilisation
Mark the nginx deployment as paused. Any current state of
# 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.6.1.114. déploiement d’OC redémarrage Copier lienLien copié sur presse-papiers!
Redémarrez une ressource
Exemple d’utilisation
2.6.1.115. CV de déploiement d’OC Copier lienLien copié sur presse-papiers!
Reprendre une ressource en pause
Exemple d’utilisation
Resume an already paused deployment
# Resume an already paused deployment
oc rollout resume dc/nginx
2.6.1.116. essai de déploiement d’OC Copier lienLien copié sur presse-papiers!
Essayez le dernier déploiement raté
Exemple d’utilisation
Retry the latest failed deployment based on '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.6.1.117. État du déploiement d’OC Copier lienLien copié sur presse-papiers!
Afficher l’état du déploiement
Exemple d’utilisation
Watch the status of the latest rollout
# Watch the status of the latest rollout
oc rollout status dc/nginx
2.6.1.118. lancement d’OC Copier lienLien copié sur presse-papiers!
Annuler un déploiement précédent
Exemple d’utilisation
Roll back to the previous deployment
# 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.6.1.119. à propos de OC rsh Copier lienLien copié sur presse-papiers!
Démarrer une session shell dans un conteneur
Exemple d’utilisation
2.6.1.120. l’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
# 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.6.1.121. course d’OC Copier lienLien copié sur presse-papiers!
Exécutez une image particulière sur le cluster
Exemple d’utilisation
2.6.1.122. échelle d’OC Copier lienLien copié sur presse-papiers!
Définir une nouvelle taille pour un contrôleur de déploiement, de réplique ou de réplication
Exemple d’utilisation
2.6.1.123. lien secret OC Copier lienLien copié sur presse-papiers!
Lier des 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
# 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.6.1.124. les secrets d’OC 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
# Unlink a secret currently associated with a service account
oc secrets unlink serviceaccount-name secret-name another-secret-name ...
2.6.1.125. ensemble OC build-hook Copier lienLien copié sur presse-papiers!
Actualisez un crochet de construction sur une configuration de build
Exemple d’utilisation
2.6.1.126. ensemble OC build-secret Copier lienLien copié sur presse-papiers!
Actualisez un secret de construction sur une configuration de build
Exemple d’utilisation
2.6.1.127. ensemble de données OC Copier lienLien copié sur presse-papiers!
Actualisez les données dans une carte de configuration ou un secret
Exemple d’utilisation
2.6.1.128. jeu OC set déploiement-hook Copier lienLien copié sur presse-papiers!
Actualisez un crochet de déploiement sur une configuration de déploiement
Exemple d’utilisation
2.6.1.129. ensemble d’OC env Copier lienLien copié sur presse-papiers!
Actualiser les variables d’environnement sur un modèle de pod
Exemple d’utilisation
2.6.1.130. image de jeu d’OC Copier lienLien copié sur presse-papiers!
Actualisez l’image d’un modèle de pod
Exemple d’utilisation
2.6.1.131. configuration d’image-lookup d’OC Copier lienLien copié sur presse-papiers!
Changer la façon dont les images sont résolues lors du déploiement d’applications
Exemple d’utilisation
2.6.1.132. capteur de jeu d’OC Copier lienLien copié sur presse-papiers!
Actualiser une sonde sur un modèle de pod
Exemple d’utilisation
2.6.1.133. l’OC a défini des ressources Copier lienLien copié sur presse-papiers!
Actualisez les demandes de ressources/limites sur les objets avec des modèles de pod
Exemple d’utilisation
2.6.1.134. boucles de route d’OC Copier lienLien copié sur presse-papiers!
Actualisez les backends pour un itinéraire
Exemple d’utilisation
2.6.1.135. ensemble d’OC sélecteur Copier lienLien copié sur presse-papiers!
Définir le sélecteur sur une ressource
Exemple d’utilisation
Set the labels and selector before creating a deployment/service pair.
# 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.6.1.136. compte de service fixe d’OC Copier lienLien copié sur presse-papiers!
Actualiser le compte de service d’une ressource
Exemple d’utilisation
Set deployment nginx-deployment's service account to serviceaccount1
# 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.6.1.137. ensemble d’OC sujet Copier lienLien copié sur presse-papiers!
Actualisez le compte utilisateur, groupe ou service dans une liaison de rôle ou de cluster
Exemple d’utilisation
2.6.1.138. déclencheurs OC réglés Copier lienLien copié sur presse-papiers!
Actualisez les déclencheurs sur un ou plusieurs objets
Exemple d’utilisation
2.6.1.139. ensemble de volumes d’OC Copier lienLien copié sur presse-papiers!
Actualiser les volumes sur un modèle de pod
Exemple d’utilisation
2.6.1.140. démarrage d’OC Copier lienLien copié sur presse-papiers!
Démarrer une nouvelle construction
Exemple d’utilisation
2.6.1.141. État des OC Copier lienLien copié sur presse-papiers!
Afficher un aperçu du projet en cours
Exemple d’utilisation
2.6.1.142. étiquette OC Copier lienLien copié sur presse-papiers!
Baliser les images existantes dans les flux d’images
Exemple d’utilisation
2.6.1.143. la version OC Copier lienLien copié sur presse-papiers!
Imprimer les informations sur la version client et serveur
Exemple d’utilisation
2.6.1.144. les OC attendent Copier lienLien copié sur presse-papiers!
Expérimental : Attendez une condition spécifique sur une ou plusieurs ressources
Exemple d’utilisation
2.6.1.145. l’OC whoami Copier lienLien copié sur presse-papiers!
Informations de retour sur la session en cours
Exemple d’utilisation
Display the currently authenticated user
# Display the currently authenticated user
oc whoami
2.7. Commande OpenShift CLI Référence de commande Copier lienLien copié sur presse-papiers!
Cette référence fournit des descriptions et des exemples de commandes pour les commandes d’administrateur OpenShift CLI (oc). Il faut avoir des autorisations de cluster-admin ou des autorisations équivalentes pour utiliser ces commandes.
Dans le cas des commandes de développeurs, consultez la référence des commandes de développeurs OpenShift CLI.
Exécutez oc adm -h pour énumérer toutes les commandes d’administrateur ou exécuter oc <command> --aider à obtenir des détails supplémentaires pour une commande spécifique.
2.7.1. Commandes d’administrateur OpenShift CLI (oc) Copier lienLien copié sur presse-papiers!
2.7.1.1. ajouter au panier OC adm build-chain Copier lienLien copié sur presse-papiers!
Extrayez les entrées et les dépendances de vos builds
Exemple d’utilisation
2.7.1.2. catalogue OC adm miroir Copier lienLien copié sur presse-papiers!
Afficher un catalogue d’opérateur-registre
Exemple d’utilisation
2.7.1.3. le certificat OC adm approuve Copier lienLien copié sur presse-papiers!
Approuver une demande de signature de certificat
Exemple d’utilisation
Approve CSR 'csr-sqgzp'
# Approve CSR 'csr-sqgzp'
oc adm certificate approve csr-sqgzp
2.7.1.4. certificat OC adm refusant Copier lienLien copié sur presse-papiers!
Refuser une demande de signature de certificat
Exemple d’utilisation
Deny CSR 'csr-sqgzp'
# Deny CSR 'csr-sqgzp'
oc adm certificate deny csr-sqgzp
2.7.1.5. copier-to-node d’OC adm Copier lienLien copié sur presse-papiers!
Copiez les fichiers spécifiés dans le nœud
Exemple d’utilisation
Copy a new bootstrap kubeconfig file to node-0
# Copy a new bootstrap kubeconfig file to node-0
oc adm copy-to-node --copy=new-bootstrap-kubeconfig=/etc/kubernetes/kubeconfig node/node-0
2.7.1.6. ajouter au panier OC adm cordon Copier lienLien copié sur presse-papiers!
Nœud de marque comme imprévu
Exemple d’utilisation
Mark node "foo" as unschedulable
# Mark node "foo" as unschedulable
oc adm cordon foo
2.7.1.7. création-bootstrap-project-template d’OC adm 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
# Output a bootstrap project template in YAML format to stdout
oc adm create-bootstrap-project-template -o yaml
2.7.1.8. création-erreur-template d’OC adm 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
# Output a template for the error page to stdout
oc adm create-error-template
2.7.1.9. ajouter au panier 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
# Output a template for the login page to stdout
oc adm create-login-template
2.7.1.10. création-fournisseur-sélection-template OC adm Copier lienLien copié sur presse-papiers!
Créer un modèle de sélection du fournisseur
Exemple d’utilisation
Output a template for the provider selection page to stdout
# Output a template for the provider selection page to stdout
oc adm create-provider-selection-template
2.7.1.11. drain d’adm OC Copier lienLien copié sur presse-papiers!
Nœud de vidange en préparation à 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
# 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.7.1.12. groupes d’adm OC add-users Copier lienLien copié sur presse-papiers!
Ajouter des utilisateurs à un groupe
Exemple d’utilisation
Add user1 and user2 to my-group
# Add user1 and user2 to my-group
oc adm groups add-users my-group user1 user2
2.7.1.13. les groupes d’adm OC nouveaux Copier lienLien copié sur presse-papiers!
Créer un nouveau groupe
Exemple d’utilisation
2.7.1.14. groupes d’adm OC prunes Copier lienLien copié sur presse-papiers!
Enlever les anciens groupes OpenShift faisant référence aux enregistrements manquants d’un fournisseur externe
Exemple d’utilisation
2.7.1.15. les groupes d’adm OC suppriment les utilisateurs Copier lienLien copié sur presse-papiers!
Enlever les utilisateurs d’un groupe
Exemple d’utilisation
Remove user1 and user2 from my-group
# Remove user1 and user2 from my-group
oc adm groups remove-users my-group user1 user2
2.7.1.16. les groupes d’adm OC se synchronisent Copier lienLien copié sur presse-papiers!
Synchroniser les groupes OpenShift avec les enregistrements d’un fournisseur externe
Exemple d’utilisation
2.7.1.17. inspection d’OC adm Copier lienLien copié sur presse-papiers!
Collecter des données de débogage pour une ressource donnée
Exemple d’utilisation
2.7.1.18. ajouter au panier OC adm migration icsp Copier lienLien copié sur presse-papiers!
Actualiser le(s) fichier(s) imagecontentsourcepolicy(s) vers imagedigestmirrorset fichier(s)
Exemple d’utilisation
Update the imagecontentsourcepolicy.yaml file to a new imagedigestmirrorset file under the mydir directory
# Update the imagecontentsourcepolicy.yaml file to a new imagedigestmirrorset file under the mydir directory
oc adm migrate icsp imagecontentsourcepolicy.yaml --dest-dir mydir
2.7.1.19. annonces OC migration template-instances Copier lienLien copié sur presse-papiers!
Actualisez les instances de modèle pour pointer vers les dernières versions de groupe-types
Exemple d’utilisation
Perform a dry-run of updating all objects
# 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.7.1.20. ajouter au panier OC adm must-collectther Copier lienLien copié sur presse-papiers!
Lancer une nouvelle instance d’un pod pour recueillir des informations de débogage
Exemple d’utilisation
2.7.1.21. le nouveau projet OC adm Copier lienLien copié sur presse-papiers!
Créer un nouveau projet
Exemple d’utilisation
Create a new project using a node selector
# Create a new project using a node selector
oc adm new-project myproject --node-selector='type=user-node,region=east'
2.7.1.22. création d’une image de nœud d’adm OC Copier lienLien copié sur presse-papiers!
Créer une image ISO pour démarrer les nœuds à ajouter au cluster cible
Exemple d’utilisation
2.7.1.23. contrôleur d’image de nœud d’adm OC Copier lienLien copié sur presse-papiers!
Contrôlez de nouveaux nœuds ajoutés à un cluster OpenShift
Exemple d’utilisation
2.7.1.24. carnets de nœuds d’adm OC Copier lienLien copié sur presse-papiers!
Afficher et filtrer les journaux des nœuds
Exemple d’utilisation
2.7.1.25. certificats OC adm ocp-certificats moniteurs Copier lienLien copié sur presse-papiers!
Certificats de plate-forme de surveillance
Exemple d’utilisation
Watch platform certificates
# Watch platform certificates
oc adm ocp-certificates monitor-certificates
2.7.1.26. certificats OC adm ocp-regenerate-feuille Copier lienLien copié sur presse-papiers!
Régénérer le client et servir les certificats d’un cluster OpenShift
Exemple d’utilisation
Regenerate a leaf certificate contained in a particular secret
# Regenerate a leaf certificate contained in a particular secret
oc adm ocp-certificates regenerate-leaf -n openshift-config-managed secret/kube-controller-manager-client-cert-key
2.7.1.27. ocp-certificates OC adm regenerate-machine-config-server-serving-cert Copier lienLien copié sur presse-papiers!
Générez les certificats d’opérateur de configuration de la machine dans un cluster OpenShift
Exemple d’utilisation
Regenerate the MCO certs without modifying user-data secrets
# Regenerate the MCO certs without modifying user-data secrets
oc adm ocp-certificates regenerate-machine-config-server-serving-cert --update-ignition=false
# Update the user-data secrets to use new MCS certs
oc adm ocp-certificates update-ignition-ca-bundle-for-machine-config-server
2.7.1.28. les certificats OC adm ocp se régénérent en haut niveau Copier lienLien copié sur presse-papiers!
Générez les certificats de niveau supérieur dans un cluster OpenShift
Exemple d’utilisation
Regenerate the signing certificate contained in a particular secret
# Regenerate the signing certificate contained in a particular secret
oc adm ocp-certificates regenerate-top-level -n openshift-kube-apiserver-operator secret/loadbalancer-serving-signer-key
2.7.1.29. les certificats OC adm ocp éliminent la confiance Copier lienLien copié sur presse-papiers!
Enlever les anciennes CA de ConfigMaps représentant les paquets de confiance de la plate-forme dans un cluster OpenShift
Exemple d’utilisation
Remove a trust bundled contained in a particular config map
# Remove a trust bundled contained in a particular config map
oc adm ocp-certificates remove-old-trust -n openshift-config-managed configmaps/kube-apiserver-aggregator-client-ca --created-before 2023-06-05T14:44:06Z
# Remove only CA certificates created before a certain date from all trust bundles
oc adm ocp-certificates remove-old-trust configmaps -A --all --created-before 2023-06-05T14:44:06Z
2.7.1.30. l’OC adm ocp-certificates met à jour-ignition-ca-bundle-for-machine-config-server Copier lienLien copié sur presse-papiers!
Actualisez les secrets des données utilisateur dans un cluster OpenShift pour utiliser les certificats MCO mis à jour
Exemple d’utilisation
Regenerate the MCO certs without modifying user-data secrets
# Regenerate the MCO certs without modifying user-data secrets
oc adm ocp-certificates regenerate-machine-config-server-serving-cert --update-ignition=false
# Update the user-data secrets to use new MCS certs
oc adm ocp-certificates update-ignition-ca-bundle-for-machine-config-server
2.7.1.31. adm pod-réseau-isolats-projets OC adm pod-network Copier lienLien copié sur presse-papiers!
Isoler le réseau de projet
Exemple d’utilisation
Provide isolation for project p1
# 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.7.1.32. co-projets OC adm pod-network Copier lienLien copié sur presse-papiers!
Joignez-vous au réseau de projets
Exemple d’utilisation
Allow project p2 to use project p1 network
# 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.7.1.33. adm pod-network make-projects-global Copier lienLien copié sur presse-papiers!
Faire du réseau de projets global
Exemple d’utilisation
Allow project p1 to access all pods in the cluster and vice versa
# 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.7.1.34. adm politique d’OC add-cluster-role-to-groupe Copier lienLien copié sur presse-papiers!
Ajouter un rôle aux groupes pour tous les projets du cluster
Exemple d’utilisation
Add the 'cluster-admin' cluster role to the 'cluster-admins' group
# Add the 'cluster-admin' cluster role to the 'cluster-admins' group
oc adm policy add-cluster-role-to-group cluster-admin cluster-admins
2.7.1.35. adm politique d’OC add-cluster-role-to-user Copier lienLien copié sur presse-papiers!
Ajouter un rôle aux utilisateurs pour tous les projets du cluster
Exemple d’utilisation
Add the 'system:build-strategy-docker' cluster role to the 'devuser' user
# Add the 'system:build-strategy-docker' cluster role to the 'devuser' user
oc adm policy add-cluster-role-to-user system:build-strategy-docker devuser
2.7.1.36. add-role-to-user de la politique d’adm OC 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
# 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.7.1.37. adm policy add-scc-to-group d’OC 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
# Add the 'restricted' security context constraint to group1 and group2
oc adm policy add-scc-to-group restricted group1 group2
2.7.1.38. 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
# 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.7.1.39. la politique d’OC adm supprime-cluster-role-du-groupe Copier lienLien copié sur presse-papiers!
Enlever un rôle des groupes pour tous les projets du cluster
Exemple d’utilisation
Remove the 'cluster-admin' cluster role from the 'cluster-admins' group
# Remove the 'cluster-admin' cluster role from the 'cluster-admins' group
oc adm policy remove-cluster-role-from-group cluster-admin cluster-admins
2.7.1.40. la politique d’OC adm Remove-cluster-role-de-l’utilisateur Copier lienLien copié sur presse-papiers!
Enlever un rôle des utilisateurs pour tous les projets du cluster
Exemple d’utilisation
Remove the 'system:build-strategy-docker' cluster role from the 'devuser' user
# Remove the 'system:build-strategy-docker' cluster role from the 'devuser' user
oc adm policy remove-cluster-role-from-user system:build-strategy-docker devuser
2.7.1.41. avis sur la politique d’OC adm Copier lienLien copié sur presse-papiers!
Vérifiez quel compte de service peut créer un pod
Exemple d’utilisation
2.7.1.42. la politique d’OC adm scc-subject-review Copier lienLien copié sur presse-papiers!
Vérifiez si un utilisateur ou un compte de service peut créer un pod
Exemple d’utilisation
2.7.1.43. constructions OC adm prune Copier lienLien copié sur presse-papiers!
Enlever les anciennes constructions terminées et échouées
Exemple d’utilisation
2.7.1.44. déploiements OC adm prunes Copier lienLien copié sur presse-papiers!
Supprimer les anciennes configurations de déploiement terminées et échouées
Exemple d’utilisation
Dry run deleting all but the last complete deployment for every deployment config
# 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.7.1.45. groupes de prunes OC adm Copier lienLien copié sur presse-papiers!
Enlever les anciens groupes OpenShift faisant référence aux enregistrements manquants d’un fournisseur externe
Exemple d’utilisation
2.7.1.46. images de prunes OC adm Copier lienLien copié sur presse-papiers!
Enlever les images non référencées
Exemple d’utilisation
2.7.1.47. ajouter au panier OC adm prune rendermachineconfigs Copier lienLien copié sur presse-papiers!
Les pruneaux ont rendu MachineConfigs dans un cluster OpenShift
Exemple d’utilisation
2.7.1.48. liste des configurations automatiques OC adm prune Copier lienLien copié sur presse-papiers!
Liste rendu MachineConfigs dans un cluster OpenShift
Exemple d’utilisation
List all rendered MachineConfigs for the worker MachineConfigPool in the cluster
# List all rendered MachineConfigs for the worker MachineConfigPool in the cluster
oc adm prune renderedmachineconfigs list --pool-name=worker
# List all rendered MachineConfigs in use by the cluster's MachineConfigPools
oc adm prune renderedmachineconfigs list --in-use
2.7.1.49. ajouter au panier OC adm reboot-machine-config-pool Copier lienLien copié sur presse-papiers!
Initier le redémarrage de la machineConfigPool spécifiée
Exemple d’utilisation
2.7.1.50. extrait de libération d’OC adm Copier lienLien copié sur presse-papiers!
Extraire le contenu d’une charge utile de mise à jour sur le disque
Exemple d’utilisation
2.7.1.51. infos sur la libération d’OC adm Copier lienLien copié sur presse-papiers!
Afficher des informations sur une version
Exemple d’utilisation
2.7.1.52. le miroir de libération d’OC adm Copier lienLien copié sur presse-papiers!
Afficher une version à un autre emplacement de registre d’images
Exemple d’utilisation
2.7.1.53. lancement d’OC adm Copier lienLien copié sur presse-papiers!
Créer une nouvelle version d’OpenShift
Exemple d’utilisation
2.7.1.54. ajouter au panier OC adm redémarrer-kubelet Copier lienLien copié sur presse-papiers!
Kubelet redémarrer sur les nœuds spécifiés
Exemple d’utilisation
2.7.1.55. ajouter au panier OC adm taint Copier lienLien copié sur presse-papiers!
Actualisez les taches sur un ou plusieurs nœuds
Exemple d’utilisation
2.7.1.56. images haut OC adm Copier lienLien copié sur presse-papiers!
Afficher les statistiques d’utilisation des images
Exemple d’utilisation
Show usage statistics for images
# Show usage statistics for images
oc adm top images
2.7.1.57. flux d’images haut OC adm Copier lienLien copié sur presse-papiers!
Afficher les statistiques d’utilisation pour les flux d’images
Exemple d’utilisation
Show usage statistics for image streams
# Show usage statistics for image streams
oc adm top imagestreams
2.7.1.58. nœud supérieur OC adm Copier lienLien copié sur presse-papiers!
Afficher la ressource (CPU/mémoire) utilisation des nœuds
Exemple d’utilisation
Show metrics for all nodes
# Show metrics for all nodes
oc adm top node
# Show metrics for a given node
oc adm top node NODE_NAME
2.7.1.59. ajouter au panier OC adm top pod Copier lienLien copié sur presse-papiers!
Afficher la ressource (CPU/mémoire) utilisation des pods
Exemple d’utilisation
2.7.1.60. ajouter au panier OC adm uncordon Copier lienLien copié sur presse-papiers!
Nœud de marque comme calendrier
Exemple d’utilisation
Mark node "foo" as schedulable
# Mark node "foo" as schedulable
oc adm uncordon foo
2.7.1.61. amélioration d’OC adm Copier lienLien copié sur presse-papiers!
Améliorez un cluster ou ajustez le canal de mise à niveau
Exemple d’utilisation
View the update status and available cluster updates
# View the update status and available cluster updates
oc adm upgrade
# Update to the latest version
oc adm upgrade --to-latest=true
2.7.1.62. adm d’OC check-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
2.7.1.63. adm OC wait-for-node-reboot Copier lienLien copié sur presse-papiers!
Attendez que les nœuds redémarrent après avoir exécuté oc adm reboot-machine-config-pool
Exemple d’utilisation
2.7.1.64. ajouter au panier OC adm wait-for-stable-cluster Copier lienLien copié sur presse-papiers!
Attendez que les opérateurs de plate-forme deviennent stables
Exemple d’utilisation
Wait for all cluster operators to become stable
# Wait for all cluster operators to become stable
oc adm wait-for-stable-cluster
# Consider operators to be stable if they report as such for 5 minutes straight
oc adm wait-for-stable-cluster --minimum-stable-period 5m
Chapitre 3. Importante mise à jour sur l’odo Copier lienLien copié sur presse-papiers!
Le Red Hat ne fournit pas d’informations sur l’odo sur le site de documentation OpenShift Dedicated. Consultez la documentation conservée par Red Hat et la communauté en amont pour obtenir des informations sur l’odo.
En ce qui concerne les matériaux entretenus par la communauté en amont, Red Hat fournit un soutien dans le cadre du soutien communautaire coopératif.
Chapitre 4. Knative CLI pour une utilisation avec OpenShift Serverless Copier lienLien copié sur presse-papiers!
Le Knative (kn) CLI permet une interaction simple avec les composants Knative sur OpenShift Dedicated.
4.1. Caractéristiques clés Copier lienLien copié sur presse-papiers!
Le Knative (kn) CLI est conçu pour rendre les tâches informatiques sans serveur simples et concises. Les principales caractéristiques du Knative CLI comprennent:
- Déployez des applications sans serveur à partir de la ligne de commande.
- Gérez les fonctionnalités de Knative Serving, telles que les services, les révisions et le partage du trafic.
- Créez et gérez les composants Knative Eventing, tels que les sources d’événements et les déclencheurs.
- Créez des liaisons d’évier pour connecter les applications Kubernetes existantes et les services Knative.
- Étendez le CLI Knative avec une architecture de plugin flexible, similaire au kubectl CLI.
- Configurez les paramètres de mise à l’échelle automatique pour les services Knative.
- L’utilisation scriptée, comme l’attente des résultats d’une opération, ou le déploiement de stratégies de déploiement et de déploiement personnalisés.
4.2. Installation du CLI Knative Copier lienLien copié sur presse-papiers!
Installer le CLI Knative.
Chapitre 5. Oléoducs CLI (tkn) Copier lienLien copié sur presse-papiers!
5.1. Installation de tkn Copier lienLien copié sur presse-papiers!
L’outil CLI permet de gérer les pipelines Red Hat OpenShift à partir d’un terminal. La section suivante décrit comment installer l’outil CLI sur différentes plateformes.
Exécuter Red Hat OpenShift Pipelines sur le matériel ARM est une fonctionnalité d’aperçu technologique seulement. Les fonctionnalités d’aperçu technologique ne sont pas prises en charge avec les accords de niveau de service de production de Red Hat (SLA) et pourraient ne pas être fonctionnellement complètes. Le Red Hat ne recommande pas de les utiliser en production. Ces fonctionnalités offrent un accès précoce aux fonctionnalités du produit à venir, permettant aux clients de tester les fonctionnalités et de fournir des commentaires pendant le processus de développement.
En savoir plus sur la portée du support des fonctionnalités de Red Hat Technology Preview, voir la portée du support des fonctionnalités d’aperçu de la technologie.
Les archives et les RPM contiennent les exécutables suivants:
- le TKN
- le TKN-pac
5.1.1. Installation du Red Hat OpenShift Pipelines CLI sur Linux Copier lienLien copié sur presse-papiers!
Dans le cas des distributions Linux, vous pouvez télécharger le CLI sous forme d’archive tar.gz.
Procédure
Cliquez sur l’outil CLI pertinent.
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 et tkn-pac à votre variable d’environnement PATH.
Afin de vérifier votre PATH, exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.1.2. Installation du Red Hat OpenShift Pipelines CLI sur Linux à l’aide d’un RPM Copier lienLien copié sur presse-papiers!
Avec Red Hat Enterprise Linux (RHEL) version 8, vous pouvez installer le Red Hat OpenShift Pipelines CLI en tant que RPM.
Conditions préalables
- Il y a un abonnement dédié à OpenShift sur votre compte Red Hat.
- Il y a des privilèges racine ou sudo sur votre système local.
Procédure
Inscrivez-vous avec Red Hat Subscription Manager:
subscription-manager register
# subscription-manager register
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Retirez les dernières données d’abonnement:
subscription-manager refresh
# subscription-manager refresh
Copy 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’identifiant de pool pour votre abonnement OpenShift Dédicated 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 référentiels requis par Red Hat OpenShift Pipelines:
Linux (x86_64, amd64)
subscription-manager repos --enable="pipelines-1.17-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="pipelines-1.17-for-rhel-8-x86_64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux sur IBM Z® et IBM® LinuxONE (s390x)
subscription-manager repos --enable="pipelines-1.17-for-rhel-8-s390x-rpms"
# subscription-manager repos --enable="pipelines-1.17-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.17-for-rhel-8-ppc64le-rpms"
# subscription-manager repos --enable="pipelines-1.17-for-rhel-8-ppc64le-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Linux sur ARM (aarch64, bras64)
subscription-manager repos --enable="pipelines-1.17-for-rhel-8-aarch64-rpms"
# subscription-manager repos --enable="pipelines-1.17-for-rhel-8-aarch64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Installez le package openshift-pipelines-client:
yum install openshift-pipelines-client
# yum install openshift-pipelines-client
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Après avoir installé le CLI, il est disponible à l’aide de la commande tkn:
tkn version
$ tkn version
5.1.3. Installation du Red Hat OpenShift Pipelines CLI sur Windows Copier lienLien copié sur presse-papiers!
Dans Windows, vous pouvez télécharger le CLI sous forme d’archive zip.
Procédure
- Cliquez sur l’outil CLI.
- Extrayez l’archive avec un programme ZIP.
- Ajoutez l’emplacement de vos fichiers tkn et tkn-pac à votre variable d’environnement PATH.
Afin de vérifier votre PATH, exécutez la commande suivante:
path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.1.4. Installation du Red Hat OpenShift Pipelines CLI sur macOS Copier lienLien copié sur presse-papiers!
Dans macOS, vous pouvez télécharger le CLI sous forme d’archive tar.gz.
Procédure
Cliquez sur l’outil CLI pertinent.
- Déballez et extrayez l’archive.
- Ajoutez l’emplacement de vos fichiers tkn et tkn-pac à votre variable d’environnement PATH.
Afin de vérifier votre PATH, exécutez la commande suivante:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.2. Configuration des pipelines OpenShift tkn CLI Copier lienLien copié sur presse-papiers!
Configurez le Red Hat OpenShift Pipelines tkn CLI pour activer l’achèvement de l’onglet.
5.2.1. Activer la fin de l’onglet Copier lienLien copié sur presse-papiers!
Après avoir installé le CLI tkn, vous pouvez activer l’achèvement de l’onglet pour compléter automatiquement les commandes tkn ou suggérer des options lorsque vous appuyez sur Tab.
Conditions préalables
- L’outil tkn CLI doit être installé.
- Il faut installer bash-completion sur votre système local.
Procédure
La procédure suivante permet de compléter l’onglet pour Bash.
Enregistrez le code d’achèvement Bash dans un fichier:
tkn completion bash > tkn_bash_completion
$ tkn completion bash > tkn_bash_completion
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copiez le fichier dans /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 Alternativement, vous pouvez enregistrer le fichier dans un répertoire local et le sourcer à partir de votre fichier .bashrc à la place.
L’achèvement de l’onglet est activé lorsque vous ouvrez un nouveau terminal.
5.3. Ligne de référence OpenShift Pipelines tkn Copier lienLien copié sur presse-papiers!
Cette section répertorie les commandes de base tkn CLI.
5.3.1. La syntaxe de base Copier lienLien copié sur presse-papiers!
[commande ou options] [arguments…]
5.3.2. Les options globales Copier lienLien copié sur presse-papiers!
--aide, -h
5.3.3. Commandes d’utilitaire Copier lienLien copié sur presse-papiers!
5.3.3.1. le TKN Copier lienLien copié sur presse-papiers!
Commande parent pour tkn CLI.
Exemple : Afficher toutes les options
tkn
$ tkn
5.3.3.2. achèvement [coquille] Copier lienLien copié sur presse-papiers!
Imprimer le code d’achèvement du shell qui doit être évalué pour fournir un achèvement interactif. Les coques prises en charge sont bash et zsh.
Exemple: Code d’achèvement pour bash shell
tkn completion bash
$ tkn completion bash
5.3.3.3. la version Copier lienLien copié sur presse-papiers!
Imprimer les informations de la version tkn CLI.
Exemple : Vérifiez la version tkn
tkn version
$ tkn version
5.3.4. Commandes de gestion des pipelines Copier lienLien copié sur presse-papiers!
5.3.4.1. gazoduc Copier lienLien copié sur presse-papiers!
Gérer les pipelines.
Exemple : Aide d’affichage
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. éliminer le pipeline Copier lienLien copié sur presse-papiers!
Effacez un pipeline.
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écrivez un pipeline.
Exemple : Décrivez le pipeline mypipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. liste des pipelines Copier lienLien copié sur presse-papiers!
Afficher une liste de pipelines.
Exemple : Afficher une liste de pipelines
tkn pipeline list
$ tkn pipeline list
5.3.4.5. journaux des pipelines Copier lienLien copié sur presse-papiers!
Afficher les journaux d’un pipeline spécifique.
Exemple: diffuser les journaux en direct pour le pipeline 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!
Lancez un pipeline.
Exemple : Démarrer le pipeline mypipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. Commandes d’exécution de pipeline Copier lienLien copié sur presse-papiers!
5.3.5.1. cours d’oléoduc Copier lienLien copié sur presse-papiers!
Gérer les conduites de pipelines.
Exemple : Aide d’affichage
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. annulation de pipelinerun Copier lienLien copié sur presse-papiers!
Annulez une conduite d’oléoduc.
Exemple: Annuler le pipeline mypipelinerun exécuté à partir d’un espace de noms
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. les pipelinerun suppriment Copier lienLien copié sur presse-papiers!
Effacez une conduite de pipeline.
Exemple : Supprimer le pipeline à partir d’un espace de noms
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
Exemple: Supprimer tous les pipelines d’un espace de noms, à l’exception des cinq plus récentes exécutions de pipeline
tkn pipelinerun delete -n myspace --keep 5
$ tkn pipelinerun delete -n myspace --keep 5
- 1
- 5 par le nombre d’exécutions de pipelines les plus récentes 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 supprimer --all ne supprime aucune ressource dans l’état en cours d’exécution.
5.3.5.4. description de pipelinerun Copier lienLien copié sur presse-papiers!
Décrivez une conduite d’oléoduc.
Exemple : Décrivez 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 de pipelinerun Copier lienLien copié sur presse-papiers!
Liste des cours d’eau.
Exemple : Afficher une liste d’exécutions de pipelines dans un espace de noms
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
5.3.5.6. journaux de pipelinerun Copier lienLien copié sur presse-papiers!
Afficher les journaux d’une course de pipeline.
Exemple : Afficher les journaux du pipeline mypipelinerun exécuté avec toutes les tâches et étapes dans 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. la tâche Copier lienLien copié sur presse-papiers!
Gérer les tâches.
Exemple : Aide d’affichage
tkn task -h
$ tkn task -h
5.3.6.2. effacer la tâche Copier lienLien copié sur presse-papiers!
Effacer une tâche.
Exemple: Supprimer les tâches mytask1 et mytask2 à partir d’un espace de noms
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. décrire la tâche Copier lienLien copié sur presse-papiers!
Décrivez une tâche.
Exemple : Décrivez 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 des tâches Copier lienLien copié sur presse-papiers!
Liste des tâches.
Exemple : Répertez toutes les tâches dans 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 pour l’exécution de tâches 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émarrage de la tâche Copier lienLien copié sur presse-papiers!
Commencez une tâche.
Exemple : Démarrez 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. exécution des tâches Copier lienLien copié sur presse-papiers!
Gérer l’exécution des tâches.
Exemple : Aide d’affichage
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. annulation de Taskrun Copier lienLien copié sur presse-papiers!
Annuler 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. Effacer les tâches Copier lienLien copié sur presse-papiers!
Effacer un TaskRun.
Exemple: Supprimer la tâche mytaskrun1 et mytaskrun2 s’exécute à partir d’un espace de noms
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
Exemple: Supprimer tout sauf les cinq tâches les plus récemment exécutées s’exécute à partir d’un espace de noms
tkn taskrun delete -n myspace --keep 5
$ tkn taskrun delete -n myspace --keep 5
- 1
- 5 par le nombre d’exécutions de tâches les plus récentes que vous souhaitez conserver.
5.3.7.4. description de Taskrun Copier lienLien copié sur presse-papiers!
Décrivez une tâche exécutée.
Exemple : Décrivez 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 tâches Copier lienLien copié sur presse-papiers!
Liste des tâches exécutées.
Exemple : Répertez 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. journaux d’exécution des tâches Copier lienLien copié sur presse-papiers!
Afficher les journaux d’exécution des tâches.
Exemple : Afficher les journaux en direct pour 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 de condition Copier lienLien copié sur presse-papiers!
5.3.8.1. État de l’état Copier lienLien copié sur presse-papiers!
Gérer les conditions.
Exemple : Aide d’affichage
tkn condition --help
$ tkn condition --help
5.3.8.2. condition supprimer Copier lienLien copié sur presse-papiers!
Effacer 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. condition décrire Copier lienLien copié sur presse-papiers!
Décrivez une condition.
Exemple : Décrivez 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 de condition Copier lienLien copié sur presse-papiers!
Liste des conditions.
Exemple : Liste des conditions dans un espace de noms
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Commandes de gestion des ressources de pipeline Copier lienLien copié sur presse-papiers!
5.3.9.1. a) Ressources Copier lienLien copié sur presse-papiers!
Gérer les ressources des pipelines.
Exemple : Aide d’affichage
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 une entrée sur le nom de la ressource, le type de la ressource et les valeurs basées sur le type de la ressource.
5.3.9.3. effacer la ressource Copier lienLien copié sur presse-papiers!
Supprimez une ressource de pipeline.
Exemple: Supprimer la ressource de pipeline myresource à partir d’un espace de noms
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. décrire la ressource Copier lienLien copié sur presse-papiers!
Décrivez une ressource de pipeline.
Exemple : Décrivez la ressource du pipeline myresource
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. liste des ressources Copier lienLien copié sur presse-papiers!
Liste des ressources du pipeline.
Exemple : Répertez toutes les ressources de pipeline dans un espace de noms
tkn resource list -n myspace
$ tkn resource list -n myspace
5.3.10. Commandes de gestion de 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 obsolète et devrait être supprimée dans une version ultérieure.
5.3.10.1. clustertask Copier lienLien copié sur presse-papiers!
Gérer ClusterTasks.
Exemple : Aide d’affichage
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask supprimer Copier lienLien copié sur presse-papiers!
Supprimez 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. clustertask décrire Copier lienLien copié sur presse-papiers!
Décrivez un ClusterTask.
Exemple : Décrivez le ClusterTask de mytask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. liste de clustertask Copier lienLien copié sur presse-papiers!
Liste ClusterTasks.
Exemple: Liste ClusterTasks
tkn clustertask list
$ tkn clustertask list
5.3.10.5. démarrage de clustertask Copier lienLien copié sur presse-papiers!
Démarrez ClusterTasks.
Exemple: Démarrer le ClusterTask de mytask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. Commandes de gestion de déclenchement Copier lienLien copié sur presse-papiers!
5.3.11.1. EventListener Copier lienLien copié sur presse-papiers!
Gérer EventListeners.
Exemple : Aide d’affichage
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. EventListener supprimer Copier lienLien copié sur presse-papiers!
Effacer un EventListener.
Exemple : Supprimer mylistener1 et mylistener2 EventListeners 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écrivez un EventListener.
Exemple : Décrivez le mylistener EventListener dans un espace de noms
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. liste EventListener Copier lienLien copié sur presse-papiers!
Liste EventListeners.
Exemple : Répertez tous les EventListeners dans un espace de noms
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. journaux EventListener Copier lienLien copié sur presse-papiers!
Afficher les journaux d’un EventListener.
Exemple : Afficher les journaux du mylistener EventListener dans un espace de noms
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace
5.3.11.6. binage de déclenchement Copier lienLien copié sur presse-papiers!
Gérez TriggerBindings.
Exemple: Affichage TriggerBindings aide
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.7. triggerbinding supprimer Copier lienLien copié sur presse-papiers!
Effacer un TriggerBinding.
Exemple: Supprimer mybinding1 et mybinding2 TriggerBindings dans un espace de noms
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.8. triggerbinding décrire Copier lienLien copié sur presse-papiers!
Décrivez un TriggerBinding.
Exemple: Décrivez le Mybinding TriggerBinding dans un espace de noms
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.9. liste debinaison de déclenchement Copier lienLien copié sur presse-papiers!
Liste TriggerBindings.
Exemple: Liste tous les TriggerBindings dans un espace de noms
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.10. triggertemplate Copier lienLien copié sur presse-papiers!
Gérez TriggerTemplates.
Exemple: Affichage TriggerTemplate aide
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.11. triggertemplate supprimer Copier lienLien copié sur presse-papiers!
Effacer un TriggerTemplate.
Exemple: Supprimer mytemplate1 et mytemplate2 TriggerTemplates dans un espace de noms
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.12. triggertemplate décrit Copier lienLien copié sur presse-papiers!
Décrivez un TriggerTemplate.
Exemple: Décrivez 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 triggertemplate Copier lienLien copié sur presse-papiers!
Liste TriggerTemplates.
Exemple: Liste tous les TriggerTemplates dans un espace de noms
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.14. clustertriggerbinding Copier lienLien copié sur presse-papiers!
Gérer ClusterTriggerBindings.
Exemple: Affichage ClusterTriggerBindings aide
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.15. clustertriggerbinding supprimer Copier lienLien copié sur presse-papiers!
Effacer un ClusterTriggerBinding.
Exemple: Supprimer myclusterbinding1 et myclusterbinding2 ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.16. clustertriggerbinding décrit Copier lienLien copié sur presse-papiers!
Décrivez un ClusterTriggerBinding.
Exemple: Décrivez le myclusterbinding ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.17. liste de clustertriggerbinding Copier lienLien copié sur presse-papiers!
Liste ClusterTriggerBindings.
Exemple: Liste tous les ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
5.3.12. Commandes d’interaction Hub Copier lienLien copié sur presse-papiers!
Interagissez avec Tekton Hub pour des ressources telles que des tâches et des pipelines.
5.3.12.1. le hub Copier lienLien copié sur presse-papiers!
Interagissez avec le hub.
Exemple : Aide d’affichage
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
Dans chaque exemple, pour obtenir les sous-commandes et drapeaux correspondants, exécutez tkn hub <command> --help.
5.3.12.2. déclassement du moyeu Copier lienLien copié sur presse-papiers!
Déclasser une ressource installée.
Exemple: Déclasser la tâche mytask dans l’espace de noms mynamespace à sa version antérieure
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace
5.3.12.3. le hub se fait Copier lienLien copié sur presse-papiers!
Bénéficiez d’un manifeste de ressources par son nom, son genre, son catalogue et sa version.
Exemple: Obtenez le manifeste pour une version spécifique du pipeline ou de la tâche myresource à partir du 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. infos sur le hub Copier lienLien copié sur presse-papiers!
Afficher des informations sur une ressource par son nom, son genre, son catalogue et sa version.
Exemple : Afficher des informations sur une version spécifique de la tâche mytask 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 hub Copier lienLien copié sur presse-papiers!
Installez une ressource à partir d’un catalogue par son genre, son nom et 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. Hub réinstallé Copier lienLien copié sur presse-papiers!
Installez une ressource par son genre et 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. la recherche de hub Copier lienLien copié sur presse-papiers!
Cherchez une ressource par une combinaison de nom, de genre et de balises.
Exemple: Rechercher une ressource avec une balise cli
tkn hub search --tags cli
$ tkn hub search --tags cli
5.3.12.8. amélioration du hub Copier lienLien copié sur presse-papiers!
Améliorez une ressource installée.
Exemple : Mettre à niveau 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’opm CLI Copier lienLien copié sur presse-papiers!
6.1.1. À propos de l’opm CLI Copier lienLien copié sur presse-papiers!
L’outil Opm CLI est fourni par le Cadre d’opérateur pour une utilisation avec le format de paquet Opm. Cet outil vous permet de créer et de maintenir des catalogues d’opérateurs à partir d’une liste de paquets d’opérateurs similaires aux référentiels de logiciels. Le résultat est une image de conteneur qui peut être stockée dans un registre de conteneurs puis installée sur un cluster.
Le catalogue contient une base de données de pointeurs vers l’opérateur manifeste du contenu qui peut être interrogé via une API incluse qui est servie lorsque l’image du conteneur est exécutée. Dans OpenShift Dedicated, Operator Lifecycle Manager (OLM) peut référencer l’image dans une source de catalogue, définie par un objet CatalogSource, qui sonne l’image à intervalles réguliers pour permettre des mises à jour fréquentes aux opérateurs installés sur le cluster.
6.1.2. Installation de l’opm CLI Copier lienLien copié sur presse-papiers!
L’outil Opm CLI peut être installé sur votre poste de travail Linux, macOS ou Windows.
Conditions préalables
Dans le cas de Linux, vous devez fournir les paquets suivants. Le RHEL 8 répond à ces exigences:
- la version 1.9.3+ de Podman (version 2.0+ recommandée)
- glibc version 2.28+
Procédure
- Accédez au site miroir OpenShift et téléchargez la dernière version du tarball qui correspond à votre système d’exploitation.
Déballez l’archive.
Linux ou macOS:
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Dans Windows, décompressez l’archive avec un programme ZIP.
Déposez le fichier n’importe où dans votre PATH.
Linux ou macOS:
Consultez votre PATH:
echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le fichier. À titre d’exemple:
sudo mv ./opm /usr/local/bin/
$ sudo mv ./opm /usr/local/bin/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Avec Windows:
Consultez votre PATH:
path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le fichier:
move opm.exe <directory>
C:\> move opm.exe <directory>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Après avoir installé l’opm CLI, vérifiez qu’il est disponible:
opm version
$ opm version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2. CLI de référence OPM Copier lienLien copié sur presse-papiers!
L’interface de ligne de commande opm (CLI) est un outil pour créer et maintenir des catalogues d’opérateurs.
la syntaxe OPM CLI
opm <command> [<subcommand>] [<argument>] [<flags>]
$ opm <command> [<subcommand>] [<argument>] [<flags>]
L’opm CLI n’est pas compatible vers l’avant. La version de l’opm CLI utilisée pour générer du contenu du catalogue doit être antérieure ou égale à la version utilisée pour servir le contenu sur un cluster.
Drapeau | Description |
---|---|
| Évitez la vérification du certificat TLS pour les enregistrements d’images de conteneur tout en tirant des paquets ou des index. |
| Lorsque vous tirez des paquets, utilisez HTTP plaine pour les registres d’images de conteneur. |
Le format de catalogue SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité obsolète est toujours incluse dans OpenShift Dedicated et continue d’être prise en charge; cependant, elle sera supprimée dans une version ultérieure de ce produit et n’est pas recommandée pour de nouveaux déploiements.
6.2.1. générer Copier lienLien copié sur presse-papiers!
Générez divers artefacts pour les index de configuration déclaratifs.
La syntaxe de commande
opm generate <subcommand> [<flags>]
$ opm generate <subcommand> [<flags>]
Le sous-commande | Description |
---|---|
| Générer un Dockerfile pour un index de configuration déclaratif. |
Drapeaux | Description |
---|---|
-h, --aide | Aide pour générer. |
6.2.1.1. Dockerfile Copier lienLien copié sur presse-papiers!
Générer un Dockerfile pour un index de configuration déclaratif.
Cette commande crée un Dockerfile dans le même répertoire que le <dcRootDir> (nommé <dcDirName>.Dockerfile) qui est utilisé pour construire l’index. Lorsqu’un Dockerfile avec le même nom existe déjà, cette commande échoue.
Lorsque vous spécifiez des étiquettes supplémentaires, si des clés dupliquées existent, seule la dernière valeur de chaque clé dupliquée est ajoutée au Dockerfile généré.
La syntaxe de commande
opm generate dockerfile <dcRootDir> [<flags>]
$ opm generate dockerfile <dcRootDir> [<flags>]
Drapeau | Description |
---|---|
-I, --binary-image (string) | Image dans laquelle construire un catalogue. La valeur par défaut est quay.io/operator-framework/opm:latest. |
-l, --extra-étiquettes (chaînes) | Étiquettes supplémentaires à inclure dans le Dockerfile généré. Les étiquettes ont la forme key=valeur. |
-h, --aide | Aide pour Dockerfile. |
Afin de construire avec l’image officielle Red Hat, utilisez la valeur register.redhat.io/openshift4/ose-operator-registry-rhel9:v4 avec le drapeau -i.
6.2.2. index Copier lienLien copié sur presse-papiers!
Générez l’index de l’opérateur pour les images de conteneur de format de base de données SQLite à partir de paquets d’opérateurs préexistants.
À partir d’OpenShift Dedicated 4.11, le catalogue de l’opérateur par défaut Red Hat est publié dans le format de catalogue basé sur des fichiers. Les catalogues d’opérateurs Red Hat fournis par défaut pour OpenShift Dedicated 4.6 à 4.10 publiés dans le format de base de données SQLite obsolète.
Les sous-commandes opm, les drapeaux et les fonctionnalités liés au format de base de données SQLite sont également obsolètes et seront supprimés dans une version ultérieure. Les fonctionnalités sont toujours prises en charge et doivent être utilisées pour les catalogues utilisant le format de base de données SQLite obsolète.
La plupart des sous-commandes et des drapeaux opm pour travailler avec le format de base de données SQLite, tels que le prune de l’index opm, ne fonctionnent pas avec le format de catalogue basé sur des fichiers.
La syntaxe de commande
opm index <subcommand> [<flags>]
$ opm index <subcommand> [<flags>]
Le sous-commande | Description |
---|---|
| Ajoutez des paquets d’opérateurs à un index. |
| Eliminer un index de tous les paquets sauf spécifiés. |
| Eliminez un index de paquets échoués, qui sont des paquets qui ne sont pas associés à une image particulière. |
| Effacer un opérateur entier d’un index. |
6.2.2.1. ajouter Copier lienLien copié sur presse-papiers!
Ajoutez des paquets d’opérateurs à un index.
La syntaxe de commande
opm index add [<flags>]
$ opm index add [<flags>]
Drapeau | Description |
---|---|
-I, --binary-image | Image de conteneur pour la commande on-image opm |
-U, --Build-tool (chaîne) | Outil pour créer des images de conteneur: podman (valeur par défaut) ou docker. Remplace une partie du drapeau --container-outil. |
-B, --bundles (chaînes) | Liste des paquets à ajouter par des virgules. |
-C, --conteneur-outil (corde) | Outil pour interagir avec les images de conteneurs, comme pour enregistrer et construire: docker ou podman. |
-F, --from-index (chaîne) | Index précédent à ajouter. |
| En cas d’activation, il ne crée que le Dockerfile et l’enregistre sur le disque local. |
--mode (chaîne) | Le mode de mise à jour graphique qui définit comment les graphiques de canal sont mis à jour: remplace (valeur par défaut), semver ou semver-skippatch. |
-d, --out-dockerfile (string) | Facultatif: Si vous générez le Dockerfile, spécifiez un nom de fichier. |
| Autoriser les erreurs de chargement du registre. |
-p, --pull-outil (string) | Outil pour tirer des images de conteneur: aucune (valeur par défaut), docker, ou podman. Remplace une partie du drapeau --container-outil. |
-t, --tag (string) | Balise personnalisée pour l’image de conteneur en cours de construction. |
6.2.2.2. le prune Copier lienLien copié sur presse-papiers!
Eliminer un index de tous les paquets sauf spécifiés.
La syntaxe de commande
opm index prune [<flags>]
$ opm index prune [<flags>]
Drapeau | Description |
---|---|
-I, --binary-image | Image de conteneur pour la commande on-image opm |
-C, --conteneur-outil (corde) | Outil pour interagir avec les images de conteneurs, comme pour enregistrer et construire: docker ou podman. |
-F, --from-index (chaîne) | Index sur prune. |
| En cas d’activation, il ne crée que le Dockerfile et l’enregistre sur le disque local. |
-d, --out-dockerfile (string) | Facultatif: Si vous générez le Dockerfile, spécifiez un nom de fichier. |
-p, --emballages (chaînes) | Liste des paquets séparés par les virgules à conserver. |
| Autoriser les erreurs de chargement du registre. |
-t, --tag (string) | Balise personnalisée pour l’image de conteneur en cours de construction. |
6.2.2.3. arboré de prunes Copier lienLien copié sur presse-papiers!
Eliminez un index de paquets échoués, qui sont des paquets qui ne sont pas associés à une image particulière.
La syntaxe de commande
opm index prune-stranded [<flags>]
$ opm index prune-stranded [<flags>]
Drapeau | Description |
---|---|
-I, --binary-image | Image de conteneur pour la commande on-image opm |
-C, --conteneur-outil (corde) | Outil pour interagir avec les images de conteneurs, comme pour enregistrer et construire: docker ou podman. |
-F, --from-index (chaîne) | Index sur prune. |
| En cas d’activation, il ne crée que le Dockerfile et l’enregistre sur le disque local. |
-d, --out-dockerfile (string) | Facultatif: Si vous générez le Dockerfile, spécifiez un nom de fichier. |
-p, --emballages (chaînes) | Liste des paquets séparés par les virgules à conserver. |
| Autoriser les erreurs de chargement du registre. |
-t, --tag (string) | Balise personnalisée pour l’image de conteneur en cours de construction. |
6.2.2.4. a) RM Copier lienLien copié sur presse-papiers!
Effacer un opérateur entier d’un index.
La syntaxe de commande
opm index rm [<flags>]
$ opm index rm [<flags>]
Drapeau | Description |
---|---|
-I, --binary-image | Image de conteneur pour la commande on-image opm |
-U, --Build-tool (chaîne) | Outil pour créer des images de conteneur: podman (valeur par défaut) ou docker. Remplace une partie du drapeau --container-outil. |
-C, --conteneur-outil (corde) | Outil pour interagir avec les images de conteneurs, comme pour enregistrer et construire: docker ou podman. |
-F, --from-index (chaîne) | Index précédent à supprimer. |
| En cas d’activation, il ne crée que le Dockerfile et l’enregistre sur le disque local. |
-O, --operators (chaînes) | Liste séparée par les virgules des opérateurs à supprimer. |
-d, --out-dockerfile (string) | Facultatif: Si vous générez le Dockerfile, spécifiez un nom de fichier. |
-p, --emballages (chaînes) | Liste des paquets séparés par les virgules à conserver. |
| Autoriser les erreurs de chargement du registre. |
-p, --pull-outil (string) | Outil pour tirer des images de conteneur: aucune (valeur par défaut), docker, ou podman. Remplace une partie du drapeau --container-outil. |
-t, --tag (string) | Balise personnalisée pour l’image de conteneur en cours de construction. |
6.2.3. init Copier lienLien copié sur presse-papiers!
Générez un blob de configuration déclaratif olm.package.
La syntaxe de commande
opm init <package_name> [<flags>]
$ opm init <package_name> [<flags>]
Drapeau | Description |
---|---|
-C, --par défaut-canal (chaîne) | Le canal auquel les abonnements seront par défaut s’il n’est pas spécifié. |
-d, --description (chaîne) | Chemin vers la documentation README.md de l’opérateur ou autre documentation. |
-I, --icon (string) | Chemin vers l’icône du paquet. |
-O, --sortie (chaîne) | Format de sortie: json (la valeur par défaut) ou yaml. |
6.2.4. à migrer Copier lienLien copié sur presse-papiers!
Faites migrer une image ou un fichier d’index de base de données SQLite vers un catalogue basé sur des fichiers.
Le format de catalogue SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité obsolète est toujours incluse dans OpenShift Dedicated et continue d’être prise en charge; cependant, elle sera supprimée dans une version ultérieure de ce produit et n’est pas recommandée pour de nouveaux déploiements.
La syntaxe de commande
opm migrate <index_ref> <output_dir> [<flags>]
$ opm migrate <index_ref> <output_dir> [<flags>]
Drapeau | Description |
---|---|
-O, --sortie (chaîne) | Format de sortie: json (la valeur par défaut) ou yaml. |
6.2.5. le rendu Copier lienLien copié sur presse-papiers!
Générez un blob de configuration déclaratif à partir des images d’index fournies, des images groupées et des fichiers de base de données SQLite.
La syntaxe de commande
opm render <index_image | bundle_image | sqlite_file> [<flags>]
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
Drapeau | Description |
---|---|
-O, --sortie (chaîne) | Format de sortie: json (la valeur par défaut) ou yaml. |
6.2.6. à servir Copier lienLien copié sur presse-papiers!
Il sert des configurations déclaratives via un serveur GRPC.
Le répertoire de configuration déclarative est chargé par la commande Serv au démarrage. Les modifications apportées à la configuration déclarative après le démarrage de cette commande ne sont pas reflétées dans le contenu servi.
La syntaxe de commande
opm serve <source_path> [<flags>]
$ opm serve <source_path> [<flags>]
Drapeau | Description |
---|---|
--cache-dir (chaîne) | Lorsque ce drapeau est défini, il synchronise et persiste le répertoire cache du serveur. |
| Quitte avec une erreur si le cache n’est pas présent ou est invalidé. La valeur par défaut est vraie lorsque le drapeau --cache-dir est défini et que le drapeau --cache-only est faux. Dans le cas contraire, la valeur par défaut est fausse. |
| Synchronise le cache de service et les sorties sans service. |
| Active l’enregistrement du débogage. |
h, --aide | Aide pour servir. |
-p, --port (chaîne) | Le numéro de port pour le service. La valeur par défaut est 50051. |
--pprof-addr (chaîne) | L’adresse du point de terminaison du profilage de démarrage. Le format est Addr:Port. |
-t, --termination-log (string) | Le chemin d’accès à un fichier journal de terminaison du conteneur. La valeur par défaut est /dev/termination-log. |
6.2.7. de valider Copier lienLien copié sur presse-papiers!
La validation du fichier (s) de configuration déclaratif JSON dans un répertoire donné.
La syntaxe de commande
opm validate <directory> [<flags>]
$ opm validate <directory> [<flags>]
Chapitre 7. Le SDK de l’opérateur Copier lienLien copié sur presse-papiers!
7.1. Installation de l’opérateur SDK CLI Copier lienLien copié sur presse-papiers!
Le SDK de l’opérateur fournit un outil d’interface de ligne de commande (CLI) que les développeurs d’opérateurs peuvent utiliser pour construire, tester et déployer un opérateur. Il est possible d’installer le SDK CLI de l’opérateur sur votre poste de travail afin que vous soyez prêt à commencer à créer vos propres opérateurs.
La version prise en charge par Red Hat de l’outil Operator SDK CLI, y compris les outils d’échafaudage et de test connexes pour les projets d’opérateur, est dépréciée et devrait être supprimée dans une version ultérieure d’OpenShift Dedicated. Le Red Hat fournira des corrections de bogues et une prise en charge de cette fonctionnalité pendant le cycle de vie de la version actuelle, mais cette fonctionnalité ne recevra plus d’améliorations et sera supprimée des futures versions d’OpenShift Dedicated.
La version prise en charge par Red Hat du SDK de l’opérateur n’est pas recommandée pour la création de nouveaux projets d’opérateur. Les auteurs d’opérateurs avec des projets d’opérateur existants peuvent utiliser la version de l’outil Operator SDK CLI publié avec OpenShift Dedicated 4 pour maintenir leurs projets et créer des versions d’opérateur ciblant des versions plus récentes d’OpenShift Dedicated.
Les images de base suivantes pour les projets d’opérateur ne sont pas dépréciées. Les fonctionnalités d’exécution et les API de configuration de ces images de base sont toujours prises en charge pour les corrections de bogues et pour l’adressage des CVE.
- L’image de base pour les projets d’opérateurs basés sur Ansible
- L’image de base pour les projets d’opérateur basé sur Helm
Afin d’obtenir de l’information sur la version non prise en charge et gérée par la communauté du SDK de l’opérateur, voir Operator SDK (Operator Framework).
Les auteurs d’opérateurs disposant d’un accès administrateur de cluster à un cluster basé sur Kubernetes, tels que OpenShift Dedicated, peuvent utiliser le SDK CLI de l’opérateur pour développer leurs propres opérateurs basés sur Go, Ansible, Java ou Helm. Kubebuilder est intégré dans le SDK de l’opérateur en tant que solution d’échafaudage pour les opérateurs Go, ce qui signifie que les projets Kubebuilder existants peuvent être utilisés comme avec le SDK de l’opérateur et continuer à fonctionner.
7.1.1. Installation de l’opérateur SDK CLI sur Linux Copier lienLien copié sur presse-papiers!
L’outil OpenShift SDK CLI peut être installé sur Linux.
Conditions préalables
- Aller v1.19+
- Docker v17.03+, podman v1.9.3+, ou buildah v1.7+
Procédure
- Accédez au site miroir OpenShift.
- À partir du dernier répertoire 4, téléchargez la dernière version du tarball pour Linux.
Décompressez l’archive:
tar xvf operator-sdk-v1.38.0-ocp-linux-x86_64.tar.gz
$ tar xvf operator-sdk-v1.38.0-ocp-linux-x86_64.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Faire le fichier exécutable:
chmod +x operator-sdk
$ chmod +x operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le binaire opérateur-sdk extrait vers un répertoire qui se trouve sur votre PATH.
AstuceAfin de vérifier votre PATH:
echo $PATH
$ echo $PATH
Copy 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-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Après avoir installé l’opérateur SDK CLI, vérifiez qu’il est disponible:
operator-sdk version
$ operator-sdk version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
operator-sdk version: "v1.38.0-ocp", ...
operator-sdk version: "v1.38.0-ocp", ...
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.1.2. Installation de l’opérateur SDK CLI sur macOS Copier lienLien copié sur presse-papiers!
L’outil OpenShift SDK CLI peut être installé sur macOS.
Conditions préalables
- Aller v1.19+
- Docker v17.03+, podman v1.9.3+, ou buildah v1.7+
Procédure
- En ce qui concerne l’architecture amd64, accédez au site miroir OpenShift pour l’architecture amd64.
- À partir du dernier répertoire 4, téléchargez la dernière version du tarball pour macOS.
Décompressez l’archive de l’opérateur SDK pour l’architecture amd64 en exécutant la commande suivante:
tar xvf operator-sdk-v1.38.0-ocp-darwin-x86_64.tar.gz
$ tar xvf operator-sdk-v1.38.0-ocp-darwin-x86_64.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Faites le fichier exécutable en exécutant la commande suivante:
chmod +x operator-sdk
$ chmod +x operator-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Déplacez le binaire opérateur-sdk extrait vers un répertoire qui est sur votre PATH en exécutant la commande suivante:
AstuceCochez votre PATH en exécutant la commande suivante:
echo $PATH
$ echo $PATH
Copy 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-sdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Après avoir installé l’opérateur SDK CLI, vérifiez qu’il est disponible en exécutant la commande suivante:
operator-sdk version
$ operator-sdk version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
operator-sdk version: "v1.38.0-ocp", ...
operator-sdk version: "v1.38.0-ocp", ...
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.2. Opérateur SDK CLI référence Copier lienLien copié sur presse-papiers!
L’interface de ligne de commande de l’opérateur SDK (CLI) est un kit de développement conçu pour faciliter l’écriture des opérateurs.
La version prise en charge par Red Hat de l’outil Operator SDK CLI, y compris les outils d’échafaudage et de test connexes pour les projets d’opérateur, est dépréciée et devrait être supprimée dans une version ultérieure d’OpenShift Dedicated. Le Red Hat fournira des corrections de bogues et une prise en charge de cette fonctionnalité pendant le cycle de vie de la version actuelle, mais cette fonctionnalité ne recevra plus d’améliorations et sera supprimée des futures versions d’OpenShift Dedicated.
La version prise en charge par Red Hat du SDK de l’opérateur n’est pas recommandée pour la création de nouveaux projets d’opérateur. Les auteurs d’opérateurs avec des projets d’opérateur existants peuvent utiliser la version de l’outil Operator SDK CLI publié avec OpenShift Dedicated 4 pour maintenir leurs projets et créer des versions d’opérateur ciblant des versions plus récentes d’OpenShift Dedicated.
Les images de base suivantes pour les projets d’opérateur ne sont pas dépréciées. Les fonctionnalités d’exécution et les API de configuration de ces images de base sont toujours prises en charge pour les corrections de bogues et pour l’adressage des CVE.
- L’image de base pour les projets d’opérateurs basés sur Ansible
- L’image de base pour les projets d’opérateur basé sur Helm
Afin d’obtenir de l’information sur la version non prise en charge et gérée par la communauté du SDK de l’opérateur, voir Operator SDK (Operator Framework).
L’opérateur SDK CLI syntaxe
operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
$ operator-sdk <command> [<subcommand>] [<argument>] [<flags>]
7.2.1. le paquet Copier lienLien copié sur presse-papiers!
La commande Operator-sdk bundle gère les métadonnées du bundle Operator.
7.2.1.1. de valider Copier lienLien copié sur presse-papiers!
Le bundle valide la sous-commande valide un bundle d’opérateur.
Drapeau | Description |
---|---|
-h, --aide | La sortie d’aide pour le paquet valider la sous-commande. |
--index-builder (chaîne) | Outil pour tirer et déballer des images groupées. Il n’est utilisé que lors de la validation d’une image de paquet. Les options disponibles sont docker, qui est par défaut, podman, ou aucune. |
| Liste de tous les validateurs optionnels disponibles. Lorsqu’il est défini, aucun validateur n’est exécuté. |
--sélectionner-optionnel (chaîne) | Le sélecteur d’étiquette pour sélectionner les validateurs optionnels à exécuter. Lorsque vous exécutez avec le drapeau --list-optional, liste les validateurs optionnels disponibles. |
7.2.2. le nettoyage Copier lienLien copié sur presse-papiers!
La commande de nettoyage de l’opérateur-sdk détruit et supprime les ressources qui ont été créées pour un opérateur qui a été déployé avec la commande run.
Drapeau | Description |
---|---|
-h, --aide | Aide à la sortie pour la sous-commande du paquet d’exécution. |
--kubeconfig (chaîne) | Chemin vers le fichier kubeconfig à utiliser pour les requêtes CLI. |
-n, --namespace (chaîne) | Le cas échéant, l’espace de noms dans lequel exécuter la demande CLI. |
| Il est temps d’attendre que la commande soit terminée avant d’échouer. La valeur par défaut est 2m0s. |
7.2.3. achèvement des travaux Copier lienLien copié sur presse-papiers!
La commande d’achèvement de l’opérateur-sdk génère des achèvements de shell pour rendre les commandes CLI émettrices plus rapides et plus faciles.
Le sous-commande | Description |
---|---|
| Générez des finitions bash. |
| Générez des finitions zsh. |
Drapeau | Description |
---|---|
| Aide à l’utilisation de sortie. |
À titre d’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 échafauder, une API Kubernetes.
7.2.4.1. API Copier lienLien copié sur presse-papiers!
La création de sous-commandes api échafaude une API Kubernetes. La sous-commande doit être exécutée dans un projet initialisé avec la commande init.
Drapeau | Description |
---|---|
-h, --aide | Aide à la sortie pour la sous-commande du paquet d’exécution. |
7.2.5. générer Copier lienLien copié sur presse-papiers!
La commande operator-sdk génère un générateur spécifique pour générer du code ou des manifestes.
7.2.5.1. le paquet Copier lienLien copié sur presse-papiers!
La sous-commande de groupe génératrice génère un ensemble de manifestes de paquets, de métadonnées et d’un fichier bundle.Dockerfile pour votre projet Opérateur.
En règle générale, vous exécutez la commande génératrice kustomize manifeste d’abord la sous-commande pour générer les bases Kustomize d’entrée qui sont utilisées par la sous-commande de paquets génératrices. Cependant, vous pouvez utiliser la commande make bundle dans un projet initialisé pour automatiser l’exécution de ces commandes en séquence.
Drapeau | Description |
---|---|
--canaux (chaîne) | Liste séparée par virgule des canaux auxquels appartient le paquet. La valeur par défaut est alpha. |
--CRDS-dir (chaîne) | Le répertoire root pour CustomResoureDefinition se manifeste. |
--par défaut-canal (chaîne) | Le canal par défaut pour le paquet. |
--déploiement-dir (string) | Le 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 passé au drapeau --input-dir. |
-h, --aide | Aide pour générer des paquets |
--input-dir (chaîne) | Annuaire à partir duquel lire un paquet existant. Ce répertoire est le parent de votre répertoire de manifestes de paquets et est différent du répertoire --deploy-dir. |
--kustomize-dir (string) | Répertoire contenant des bases Kustomize et un fichier kustomization.yaml pour les manifestes de paquets. Le chemin par défaut est config/manifestes. |
| Générez des manifestes de paquets. |
| Générez des métadonnées groupées et Dockerfile. |
--sortie-dir (chaîne) | Annuaire pour écrire le paquet vers. |
| Écrasez les métadonnées du bundle et Dockerfile s’ils existent. La valeur par défaut est true. |
--emballage (chaîne) | Le nom du paquet pour le paquet. |
-Q, --quiet | Exécutez en mode silencieux. |
| Ecrire le paquet manifeste pour standardiser. |
--version (chaîne) | La version sémantique de l’opérateur dans le paquet généré. Défini uniquement lors de la création d’un nouveau paquet ou de la mise à niveau de l’opérateur. |
7.2.5.2. kustomize Copier lienLien copié sur presse-papiers!
La sous-commande génératrice kustomize contient des sous-commandes qui génèrent des données Kustomize pour l’opérateur.
7.2.5.2.1. les manifestes Copier lienLien copié sur presse-papiers!
La sous-commande génératrice kustomize manifeste génère ou régénère les bases Kustomize et un fichier kustomization.yaml dans le répertoire config/manifests, qui sont utilisés pour construire des manifestes de paquets par d’autres commandes SDK de l’opérateur. Cette commande demande interactivement des métadonnées UI, un composant important des bases manifestes, par défaut, sauf si une base existe déjà ou si vous définissez l’indicateur --interactive=false.
Drapeau | Description |
---|---|
--APIs-dir (chaîne) | Répertoire racine pour les définitions de type API. |
-h, --aide | Aide pour générer des manifestes de kustomize. |
--input-dir (chaîne) | Répertoire contenant les fichiers Kustomize existants. |
| Lorsqu’il est défini sur false, si aucune base Kustomize n’existe, une invite de commande interactive est présentée pour accepter les métadonnées personnalisées. |
--sortie-dir (chaîne) | Annuaire où écrire des fichiers Kustomize. |
--emballage (chaîne) | Le nom du paquet. |
-Q, --quiet | Exécutez en mode silencieux. |
7.2.6. init Copier lienLien copié sur presse-papiers!
La commande operator-sdk init initialise un projet Opérateur et génère, ou des échafaudages, une mise en page de répertoire de projet par défaut pour le plugin donné.
Cette commande écrit les fichiers suivants:
- Fichier de licence de hotplate
- Fichier PROJET avec le domaine et le référentiel
- Makefile pour construire le projet
- fichier Go.mod avec dépendances de projet
- fichier kustomization.yaml pour la personnalisation des manifestes
- Fichier correcteur pour personnaliser les images pour les manifestes du gestionnaire
- Fichier de correction pour activer les métriques Prometheus
- fichier Main.go à exécuter
Drapeau | Description |
---|---|
| Aide à la sortie pour la commande init. |
--plugins (chaîne) | Le nom et la version optionnelle du plugin pour initialiser le projet avec. Les plugins disponibles sont ansible.sdk.operatorframework.io/v1, go.kubebuilder.io/v2, go.kubebuilder.io/v3, et helm.sdk.operatorframework.io/v1. |
| La version du projet. Les valeurs disponibles sont 2 et 3-alpha, qui est la valeur par défaut. |
7.2.7. courir Copier lienLien copié sur presse-papiers!
La commande operator-sdk run fournit des options qui peuvent lancer l’opérateur dans divers environnements.
7.2.7.1. le paquet Copier lienLien copié sur presse-papiers!
La sous-commande de paquet d’exécution déploie un opérateur dans le format de paquet avec Operator Lifecycle Manager (OLM).
Drapeau | Description |
---|---|
--index-image (chaîne) | Indexer l’image dans laquelle injecter un paquet. L’image par défaut est quay.io/operator-framework/upstream-opm-builder:latest. |
| Installez le mode supporté par la version de service cluster (CSV) de l’opérateur, par exemple AllNamespaces ou SingleNamespace. |
| Installez le délai d’attente. La valeur par défaut est 2m0s. |
--kubeconfig (chaîne) | Chemin vers le fichier kubeconfig à utiliser pour les requêtes CLI. |
-n, --namespace (chaîne) | Le cas échéant, l’espace de noms dans lequel exécuter la demande CLI. |
| Indique le contexte de sécurité à utiliser pour le pod de catalogue. Les valeurs autorisées incluent des restrictions et des héritages. La valeur par défaut est l’héritage. [1] |
-h, --aide | Aide à la sortie pour la sous-commande du paquet d’exécution. |
- Le contexte de sécurité restreint n’est pas compatible avec l’espace de noms par défaut. Afin de configurer l’admission de sécurité de pod de votre opérateur dans votre environnement de production, voir "Complying with Pod security admission". En savoir plus sur l’admission à la sécurité des pods, voir « Comprendre et gérer l’admission à la sécurité des pod ».
7.2.7.2. la mise à niveau de paquet Copier lienLien copié sur presse-papiers!
La sous-commande de mise à niveau de paquets d’exécution met à niveau un opérateur qui a déjà été installé dans le format de paquet avec Operator Lifecycle Manager (OLM).
Drapeau | Description |
---|---|
| Délai de mise à niveau. La valeur par défaut est 2m0s. |
--kubeconfig (chaîne) | Chemin vers le fichier kubeconfig à utiliser pour les requêtes CLI. |
-n, --namespace (chaîne) | Le cas échéant, l’espace de noms dans lequel exécuter la demande CLI. |
| Indique le contexte de sécurité à utiliser pour le pod de catalogue. Les valeurs autorisées incluent des restrictions et des héritages. La valeur par défaut est l’héritage. [1] |
-h, --aide | Aide à la sortie pour la sous-commande du paquet d’exécution. |
- Le contexte de sécurité restreint n’est pas compatible avec l’espace de noms par défaut. Afin de configurer l’admission de sécurité de pod de votre opérateur dans votre environnement de production, voir "Complying with Pod security admission". En savoir plus sur l’admission à la sécurité des pods, voir « Comprendre et gérer l’admission à la sécurité des pod ».
7.2.8. carte de pointage Copier lienLien copié sur presse-papiers!
La commande operator-sdk scorecard exécute l’outil de carte de pointage pour valider un ensemble d’opérateurs et fournir des suggestions d’améliorations. La commande prend un argument, qu’il s’agisse d’une image groupée ou d’un répertoire contenant des manifestes et des métadonnées. Lorsque l’argument contient une balise d’image, l’image doit être présente à distance.
Drapeau | Description |
---|---|
-C, --config (chaîne) | Chemin d’accès au fichier de configuration de la carte de pointage. Le chemin par défaut est bundle/tests/scorecard/config.yaml. |
-h, --aide | Aide à la sortie pour la commande de la carte de pointage. |
--kubeconfig (chaîne) | Chemin d’accès au fichier kubeconfig. |
-L, --liste | Liste des tests disponibles pour exécuter. |
-n, --namespace (chaîne) | Espace de noms dans lequel exécuter les images de test. |
-O, --sortie (chaîne) | Format de sortie pour les résultats. Les valeurs disponibles sont du texte, qui est la valeur par défaut, et json. |
| L’option d’exécuter une carte de score avec le contexte de sécurité spécifié. Les valeurs autorisées incluent des restrictions et des héritages. La valeur par défaut est l’héritage. [1] |
-l, --séléctor (chaîne) | Le sélecteur d’étiquette pour déterminer quels tests sont exécutés. |
-s, --service-compte (string) | Compte de service à utiliser pour les tests. La valeur par défaut est par défaut. |
-x, --skip-nettoyage | Désactiver le nettoyage des ressources après l’exécution des tests. |
-W, --temps d’attente <durée> | Des secondes pour attendre que les tests soient terminés, par exemple 35s. La valeur par défaut est 30s. |
- Le contexte de sécurité restreint n’est pas compatible avec l’espace de noms par défaut. Afin de configurer l’admission de sécurité de pod de votre opérateur dans votre environnement de production, voir "Complying with Pod security admission". En savoir plus sur l’admission à la sécurité des pods, voir « Comprendre et gérer l’admission à la sécurité des pod ».
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.