6.2. référence CLI opm
L'interface de ligne de commande (CLI) opm est un outil permettant de créer et de maintenir des catalogues d'opérateurs.
opm Syntaxe du CLI
$ opm <command> [<subcommand>] [<argument>] [<flags>]
| Drapeau | Description |
|---|---|
|
| Sauter la vérification des certificats TLS pour les registres d'images de conteneurs lors de l'extraction de paquets ou d'index. |
|
| Lorsque vous tirez des paquets, utilisez le protocole HTTP pour les registres d'images de conteneurs. |
Le format de catalogue basé sur SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité dépréciée est toujours incluse dans OpenShift Container Platform et continue d'être prise en charge ; cependant, elle sera supprimée dans une prochaine version de ce produit et n'est pas recommandée pour les nouveaux déploiements.
Pour obtenir la liste la plus récente des fonctionnalités majeures qui ont été dépréciées ou supprimées dans OpenShift Container Platform, consultez la section Deprecated and removed features des notes de version d'OpenShift Container Platform.
6.2.1. init
Génère un blob de configuration déclaratif olm.package.
Syntaxe de la commande
$ opm init <package_name> [<flags>]
| Drapeau | Description |
|---|---|
|
| Le canal que les abonnements utiliseront par défaut s'il n'est pas spécifié. |
|
|
Chemin d'accès au site de l'opérateur |
|
| Chemin d'accès à l'icône du paquet. |
|
|
Format de sortie : |
6.2.2. rendre
Génère un blob de configuration déclaratif à partir des images d'index, des images de bundle et des fichiers de base de données SQLite fournis.
Syntaxe de la commande
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| Drapeau | Description |
|---|---|
|
|
Format de sortie : |
6.2.3. valider
Valide le(s) fichier(s) JSON de la configuration déclarative dans un répertoire donné.
Syntaxe de la commande
$ opm validate <directory> [<flags>]
6.2.4. servir
Servir des configurations déclaratives via un serveur GRPC.
Le répertoire declarative config est chargé par la commande serve au démarrage. Les modifications apportées à la configuration déclarative après le lancement de cette commande ne sont pas répercutées dans le contenu servi.
Syntaxe de la commande
$ opm serve <source_path> [<flags>]
| Drapeau | Description |
|---|---|
|
| Si ce drapeau est activé, il synchronise et conserve le répertoire du cache du serveur. |
|
|
Il se termine par une erreur si le cache n'est pas présent ou s'il est invalidé. La valeur par défaut est |
|
| Synchronise le cache de service et quitte sans servir. |
|
| Active la journalisation de débogage. |
|
| Aide au service. |
|
|
Le numéro de port du service. La valeur par défaut est |
|
|
L'adresse du point final de profilage de démarrage. Le format est le suivant : |
|
|
Chemin d'accès à un fichier journal de fin de conteneur. La valeur par défaut est |
Le format de catalogue basé sur SQLite, y compris les commandes CLI associées, est une fonctionnalité obsolète. La fonctionnalité dépréciée est toujours incluse dans OpenShift Container Platform et continue d'être prise en charge ; cependant, elle sera supprimée dans une prochaine version de ce produit et n'est pas recommandée pour les nouveaux déploiements.
Pour obtenir la liste la plus récente des fonctionnalités majeures qui ont été dépréciées ou supprimées dans OpenShift Container Platform, consultez la section Deprecated and removed features des notes de version d'OpenShift Container Platform.
6.2.5. migrer
Migrer une image d'index ou un fichier de base de données au format SQLite vers un catalogue basé sur des fichiers.
Syntaxe de la commande
$ opm migrate <index_ref> <output_dir> [<flags>]
| Drapeau | Description |
|---|---|
|
|
Format de sortie : |
6.2.6. index
Générer l'index de l'opérateur pour les images de conteneurs au format de base de données SQLite à partir de bundles d'opérateurs préexistants.
À partir d'OpenShift Container Platform 4.11, le catalogue Operator fourni par Red Hat par défaut est publié dans le format de catalogue basé sur des fichiers. Les catalogues Operator fournis par Red Hat par défaut pour OpenShift Container Platform 4.6 à 4.10 sont publiés dans le format de base de données SQLite déprécié.
Les sous-commandes, drapeaux et fonctionnalités de opm liés au format de base de données SQLite sont également obsolètes et seront supprimés dans une prochaine version. Ces fonctionnalités sont toujours prises en charge et doivent être utilisées pour les catalogues qui utilisent le format de base de données SQLite obsolète.
La plupart des sous-commandes et des drapeaux de opm pour travailler avec le format de base de données SQLite, comme opm index prune, ne fonctionnent pas avec le format de catalogue basé sur des fichiers. Pour plus d'informations sur l'utilisation des catalogues basés sur des fichiers, voir "Ressources supplémentaires".
Syntaxe de la commande
$ opm index <subcommand> [<flags>]
| Sous-commande | Description |
|---|---|
|
| Ajouter des liasses d'opérateurs à un index. |
|
| Élaguer un index de tous les paquets sauf ceux spécifiés. |
|
| Élaguer un index de liasses non identifiées, c'est-à-dire de liasses qui ne sont pas associées à une image particulière. |
|
| Supprimer un opérateur entier d'un index. |
6.2.6.1. ajouter
Ajouter des liasses d'opérateurs à un index.
Syntaxe de la commande
$ opm index add [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil de construction des images de conteneurs : |
|
| Liste de bundles séparés par des virgules à ajouter. |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index précédent à ajouter. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
|
Mode de mise à jour des graphiques qui définit la manière dont les graphiques des canaux sont mis à jour : |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Autoriser les erreurs de chargement du registre. |
|
|
Outil pour extraire les images des conteneurs : |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.2. pruneau
Élaguer un index de tous les paquets sauf ceux spécifiés.
Syntaxe de la commande
$ opm index prune [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index pour la taille. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.3. brin élagué
Élaguer un index de liasses non identifiées, c'est-à-dire de liasses qui ne sont pas associées à une image particulière.
Syntaxe de la commande
$ opm index prune-stranded [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index pour la taille. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.6.4. rm
Supprimer un opérateur entier d'un index.
Syntaxe de la commande
$ opm index rm [<flags>]
| Drapeau | Description |
|---|---|
|
|
Image conteneur pour la commande on-image |
|
|
Outil de construction des images de conteneurs : |
|
|
Outil permettant d'interagir avec les images des conteneurs, notamment pour les sauvegarder et les construire : |
|
| Index précédent à supprimer. |
|
| Si cette option est activée, elle crée uniquement le fichier Docker et l'enregistre sur le disque local. |
|
| Liste d'opérateurs à supprimer, séparés par des virgules. |
|
| Facultatif : si vous générez un fichier Docker, indiquez un nom de fichier. |
|
| Liste de paquets à conserver, séparés par des virgules. |
|
| Autoriser les erreurs de chargement du registre. |
|
|
Outil pour extraire les images des conteneurs : |
|
| Étiquette personnalisée pour l'image du conteneur en cours de construction. |
6.2.7. générer
Générer divers artefacts pour les index de configuration déclaratifs.
Syntaxe de la commande
$ opm generate [command]
| Drapeaux | Description |
|---|---|
|
| Aide à la génération. |
Syntaxe de la commande
$ opm generate <subcommand> [<flags>]
| Sous-commande | Description |
|---|---|
|
| Générer un fichier Docker pour un index de configuration déclaratif. |
6.2.7.1. dockerfile
Générer un fichier Docker pour un index de configuration déclaratif.
Cette commande crée un fichier Docker dans le même répertoire que <dcRootDir> (nommé <dcDirName>.Dockerfile) qui est utilisé pour construire l'index. Si un fichier Docker portant le même nom existe déjà, cette commande échoue.
Lors de la spécification d'étiquettes supplémentaires, s'il existe des clés dupliquées, seule la dernière valeur de chaque clé dupliquée est ajoutée au fichier Dockerfile généré.
Syntaxe de la commande
$ opm generate dockerfile <dcRootDir> [flags] (drapeaux)
| Drapeau | Description |
|---|---|
|
|
Image dans laquelle le catalogue doit être construit. La valeur par défaut est |
|
|
Étiquettes supplémentaires à inclure dans le fichier Docker généré. Les étiquettes ont la forme |
|
| Aide pour Dockerfile. |
