Red Hat Summit6.2. CLI de référence OPM
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 Red Hat OpenShift Service sur AWS et continue d’être prise en charge; cependant, il sera supprimé dans une future version de ce produit et n’est pas recommandé pour de nouveaux déploiements.
6.2.1. générer
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
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
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 de Red Hat OpenShift Service sur AWS 4.11, le catalogue par défaut Red Hat fourni par l’opérateur publie dans le format de catalogue basé sur des fichiers. Les catalogues de Red Hat fournis par défaut pour Red Hat OpenShift Service sur AWS 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
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
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
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
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
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
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 Red Hat OpenShift Service sur AWS et continue d’être prise en charge; cependant, il sera supprimé dans une future version de ce produit et n’est pas recommandé 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
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
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
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>]
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}