Red Hat Summit7.2. Opérateur SDK CLI référence
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 Opérateur, est dépréciée et devrait être supprimée dans une future version de Red Hat OpenShift Service sur AWS. 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 du futur service Red Hat OpenShift sur les versions AWS.
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 Red Hat OpenShift Service sur AWS 4 pour maintenir leurs projets et créer des versions d’opérateur ciblant de nouvelles versions de Red Hat OpenShift Service sur AWS.
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
La commande Operator-sdk bundle gère les métadonnées du bundle Operator.
7.2.1.1. de valider
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
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
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 bashExemple 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=sh7.2.4. créer
La commande operator-sdk create est utilisée pour créer, ou échafauder, une API Kubernetes.
7.2.4.1. API
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
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
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
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
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
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
La commande operator-sdk run fournit des options qui peuvent lancer l’opérateur dans divers environnements.
7.2.7.1. le paquet
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
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
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 ».
'%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}