4.7. Gestion des catalogues personnalisés

Procédure

1. Initialiser le catalogue:

   1. Créer un répertoire pour le catalogue en exécutant la commande suivante:

      $ mkdir <catalog_dir>

      Copy to Clipboard Toggle word wrap

   2. Générer un Dockerfile qui peut construire une image de catalogue en exécutant la commande opm générer dockerfile:

      $ opm generate dockerfile <catalog_dir> \
          -i registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4 

      1

      Copy to Clipboard Toggle word wrap

      1

      Indiquez l’image de base officielle Red Hat en utilisant le drapeau -i, sinon le Dockerfile utilise l’image par défaut en amont.

      Le Dockerfile doit être dans le même répertoire parent que le répertoire de catalogue que vous avez créé à l’étape précédente:

      Exemple de structure de répertoire

      . 

      1

      
      ├── <catalog_dir> 

      2

      
      └── <catalog_dir>.Dockerfile 

      3

      Copy to Clipboard Toggle word wrap

      1

      Annuaire parent

      2

      Annuaire du catalogue

      3

      Dockerfile généré par l’opm générer la commande dockerfile

   3. Remplissez le catalogue avec la définition du paquet pour votre opérateur en exécutant la commande opm init:

      $ opm init <operator_name> \ 

      1

      
          --default-channel=preview \ 

      2

      
          --description=./README.md \ 

      3

      
          --icon=./operator-icon.svg \ 

      4

      
          --output yaml \ 

      5

      
          > <catalog_dir>/index.yaml 

      6

      Copy to Clipboard Toggle word wrap

      1

      Exploitant, ou paquet, nom

      2

      Canal auquel les abonnements par défaut s’ils ne sont pas spécifiés

      3

      Chemin vers la documentation README.md de l’opérateur ou autre documentation

      4

      Chemin vers l’icône de l’opérateur

      5

      Format de sortie: JSON ou YAML

      6

      Chemin de création du fichier de configuration du catalogue

      Cette commande génère un blob de configuration déclaratif olm.package dans le fichier de configuration du catalogue spécifié.

2. Ajouter un paquet au catalogue en exécutant la commande de rendu opm:

   $ opm render <registry>/<namespace>/<bundle_image_name>:<tag> \ 

   1

   
       --output=yaml \
       >> <catalog_dir>/index.yaml 

   2

   Copy to Clipboard Toggle word wrap

   1

   Dessinez les spécifications pour l’image de paquet

   2

   Chemin d’accès au fichier de configuration du catalogue

   Note

   Les canaux doivent contenir au moins un paquet.

3. Ajoutez une entrée de canal pour le paquet. À titre d’exemple, modifiez l’exemple suivant à vos spécifications et ajoutez-le à votre fichier <catalog_dir>/index.yaml:

   Exemple d’entrée de canal

   ---
   schema: olm.channel
   package: <operator_name>
   name: preview
   entries:
     - name: <operator_name>.v0.1.0 

   1

   Copy to Clipboard Toggle word wrap

   1

   Assurez-vous d’inclure la période (.) après <operator_name> mais avant le v dans la version. Dans le cas contraire, l’entrée ne parvient pas à passer la commande de validation opm.

4. De valider le catalogue basé sur les fichiers:

   1. Exécutez la commande opm valider par rapport au répertoire du catalogue:

      $ opm validate <catalog_dir>

      Copy to Clipboard Toggle word wrap

   2. Assurez-vous que le code d’erreur est 0:

      $ echo $?

      Copy to Clipboard Toggle word wrap

      Exemple de sortie

      0

      Copy to Clipboard Toggle word wrap

5. Créez l’image du catalogue en exécutant la commande podman build:

   $ podman build . \
       -f <catalog_dir>.Dockerfile \
       -t <registry>/<namespace>/<catalog_image_name>:<tag>

   Copy to Clipboard Toggle word wrap

6. Appuyez sur l’image du catalogue vers un registre:

   1. Au besoin, authentifier avec votre registre cible en exécutant la commande de connexion podman:

      $ podman login <registry>

      Copy to Clipboard Toggle word wrap

   2. Appuyez sur l’image du catalogue en exécutant la commande podman push:

      $ podman push <registry>/<namespace>/<catalog_image_name>:<tag>

      Copy to Clipboard Toggle word wrap

Procédure

1. Extraire le contenu de l’image du catalogue au format YAML dans un fichier index.yaml dans votre répertoire de catalogue:

   $ opm render <registry>/<namespace>/<catalog_image_name>:<tag> \
       -o yaml > <catalog_dir>/index.yaml

   Copy to Clipboard Toggle word wrap
   Note

   Alternativement, vous pouvez utiliser le drapeau -o json pour afficher au format JSON.

2. Modifiez le contenu du fichier index.yaml résultant à vos spécifications:

   Important

   Après la publication d’un paquet dans un catalogue, supposez que l’un de vos utilisateurs l’a installé. Assurez-vous que tous les paquets publiés précédemment dans un catalogue disposent d’un chemin de mise à jour vers la tête de canal actuelle ou plus récente pour éviter d’échouer les utilisateurs qui ont cette version installée.

   • Afin d’ajouter un opérateur, suivez les étapes de création de paquets, de paquets et de canaux dans la procédure "Créer une image de catalogue basée sur un fichier".

   • Afin de supprimer un opérateur, supprimez les blobs olm.package, olm.channel et olm.bundle qui se rapportent au paquet. L’exemple suivant montre un ensemble qui doit être supprimé pour supprimer le package example-operator du catalogue:

     Exemple 4.9. Exemple d’entrées supprimées

     ---
     defaultChannel: release-2.7
     icon:
       base64data: <base64_string>
       mediatype: image/svg+xml
     name: example-operator
     schema: olm.package
     ---
     entries:
     - name: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.0'
     - name: example-operator.v2.7.1
       replaces: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.1'
     - name: example-operator.v2.7.2
       replaces: example-operator.v2.7.1
       skipRange: '>=2.6.0 <2.7.2'
     - name: example-operator.v2.7.3
       replaces: example-operator.v2.7.2
       skipRange: '>=2.6.0 <2.7.3'
     - name: example-operator.v2.7.4
       replaces: example-operator.v2.7.3
       skipRange: '>=2.6.0 <2.7.4'
     name: release-2.7
     package: example-operator
     schema: olm.channel
     ---
     image: example.com/example-inc/example-operator-bundle@sha256:<digest>
     name: example-operator.v2.7.0
     package: example-operator
     properties:
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyObject
         version: v1alpha1
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyOtherObject
         version: v1beta1
     - type: olm.package
       value:
         packageName: example-operator
         version: 2.7.0
     - type: olm.bundle.object
       value:
         data: <base64_string>
     - type: olm.bundle.object
       value:
         data: <base64_string>
     relatedImages:
     - image: example.com/example-inc/example-related-image@sha256:<digest>
       name: example-related-image
     schema: olm.bundle
     ---

     Copy to Clipboard Toggle word wrap
   • Afin d’ajouter ou de mettre à jour des messages de déprécation pour un opérateur, assurez-vous qu’il y a un fichier déprecations.yaml dans le même répertoire que le fichier index.yaml du paquet. Informations sur le format de fichier deprecations.yaml, voir "olm.deprecations schema".
3. Enregistrez vos modifications.

4. De valider le catalogue:

   $ opm validate <catalog_dir>

   Copy to Clipboard Toggle word wrap

5. Reconstruire le catalogue:

   $ podman build . \
       -f <catalog_dir>.Dockerfile \
       -t <registry>/<namespace>/<catalog_image_name>:<tag>

   Copy to Clipboard Toggle word wrap

6. Appuyez sur l’image du catalogue mise à jour vers un registre:

   $ podman push <registry>/<namespace>/<catalog_image_name>:<tag>

   Copy to Clipboard Toggle word wrap

La vérification

1. Dans la console Web, accédez à la ressource de configuration OperatorHub dans la page Administration Paramètres de cluster Configuration.

2. Ajoutez la source du catalogue ou mettez à jour la source du catalogue existant pour utiliser la spécification de traction pour votre image de catalogue mise à jour.

   De plus amples informations, voir "Ajouter une source de catalogue à un cluster" dans les "Ressources supplémentaires" de cette section.

3. Après que la source du catalogue est dans un état READY, accédez à la page Opérateurs OperatorHub et vérifiez que les modifications que vous avez apportées sont reflétées dans la liste des Opérateurs.

Procédure

1. Commencez un nouvel index:

   $ opm index add \
       --bundles <registry>/<namespace>/<bundle_image_name>:<tag> \

   1

   
       --tag <registry>/<namespace>/<index_image_name>:<tag> \

   2

   
       [--binary-image <registry_base_image>] 

   3

   Copy to Clipboard Toggle word wrap

   1

   Liste séparée par virgule d’images groupées à ajouter à l’index.

   2

   La balise d’image que vous voulez que l’image de l’index ait.

   3

   Facultatif: Une image de base de registre alternative à utiliser pour servir le catalogue.

2. Appuyez sur l’image de l’index vers un registre.

   1. Au besoin, authentifier avec votre registre cible:

      $ podman login <registry>

      Copy to Clipboard Toggle word wrap

   2. Appuyez sur l’image de l’index:

      $ podman push <registry>/<namespace>/<index_image_name>:<tag>

      Copy to Clipboard Toggle word wrap

Procédure

1. Actualisez l’index existant en ajoutant des images groupées:

   $ opm index add \
       --bundles <registry>/<namespace>/<new_bundle_image>@sha256:<digest> \

   1

   
       --from-index <registry>/<namespace>/<existing_index_image>:<existing_tag> \

   2

   
       --tag <registry>/<namespace>/<existing_index_image>:<updated_tag> \

   3

   
       --pull-tool podman 

   4

   Copy to Clipboard Toggle word wrap

   1

   L’indicateur --bundles spécifie une liste séparée par des virgules d’images de paquet supplémentaires à ajouter à l’index.

   2

   L’indicateur --from-index spécifie l’index précédemment poussé.

   3

   L’indicateur --tag spécifie la balise image à appliquer à l’image d’index mise à jour.

   4

   Le drapeau --pull-outil spécifie l’outil utilisé pour tirer des images de conteneur.

   là où:

   <registre>

   Indique le nom d’hôte du registre, tel que quay.io ou mirror.example.com.

   <namespace>

   Indique l’espace de noms du registre, tel que ocs-dev ou abc.

   <new_bundle_image>

   Indique la nouvelle image de paquet à ajouter au registre, comme ocs-operator.

   <digest>

   Indique l’ID d’image SHA, ou digérer, de l’image de faisceau, telle que c7f11097a628f092d8bad148406a0e0951094a03445fd4bc0775431ef683a41.

   <bx id="1" />

   Indique l’image précédemment poussée, telle que abc-redhat-operator-index.

   <bx id="1" />

   Indique une balise d’image précédemment poussée, telle que 4.

   <mise à jour_tag>

   Indique la balise image à appliquer à l’image d’index mise à jour, telle que 4.1.

   Commande d’exemple

   $ opm index add \
       --bundles quay.io/ocs-dev/ocs-operator@sha256:c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41 \
       --from-index mirror.example.com/abc/abc-redhat-operator-index:4 \
       --tag mirror.example.com/abc/abc-redhat-operator-index:4.1 \
       --pull-tool podman

   Copy to Clipboard Toggle word wrap

2. Appuyez sur l’image de l’index mise à jour:

   $ podman push <registry>/<namespace>/<existing_index_image>:<updated_tag>

   Copy to Clipboard Toggle word wrap

3. Après que Operator Lifecycle Manager (OLM) sonde automatiquement l’image de l’index référencée dans la source du catalogue à son intervalle régulier, vérifiez que les nouveaux paquets sont ajoutés avec succès:

   $ oc get packagemanifests -n openshift-marketplace

   Copy to Clipboard Toggle word wrap

Procédure

1. Authentifier avec votre registre cible:

   $ podman login <target_registry>

   Copy to Clipboard Toggle word wrap

2. Déterminez la liste des paquets que vous souhaitez inclure dans votre index élevé.

   1. Exécutez l’image de l’index source que vous souhaitez tailler dans un conteneur. À titre d’exemple:

      $ podman run -p50051:50051 \
          -it registry.redhat.io/redhat/redhat-operator-index:v4

      Copy to Clipboard Toggle word wrap

      Exemple de sortie

      Trying to pull registry.redhat.io/redhat/redhat-operator-index:v4...
      Getting image source signatures
      Copying blob ae8a0c23f5b1 done
      ...
      INFO[0000] serving registry                              database=/database/index.db port=50051

      Copy to Clipboard Toggle word wrap

   2. Dans une session terminale séparée, utilisez la commande grpcurl pour obtenir une liste des paquets fournis par l’index:

      $ grpcurl -plaintext localhost:50051 api.Registry/ListPackages > packages.out

      Copy to Clipboard Toggle word wrap

   3. Inspectez le fichier packages.out et identifiez les noms de paquets de cette liste que vous souhaitez conserver dans votre index élevé. À titre d’exemple:

      Exemples d’extraits de liste de paquets

      ...
      {
        "name": "advanced-cluster-management"
      }
      ...
      {
        "name": "jaeger-product"
      }
      ...
      {
      {
        "name": "quay-operator"
      }
      ...

      Copy to Clipboard Toggle word wrap

   4. Dans la session terminale où vous avez exécuté la commande podman exécuter, appuyez sur Ctrl et C pour arrêter le processus de conteneur.

3. Exécutez la commande suivante pour tailler l’index source de tous les paquets sauf les paquets spécifiés:

   $ opm index prune \
       -f registry.redhat.io/redhat/redhat-operator-index:v4 \

   1

   
       -p advanced-cluster-management,jaeger-product,quay-operator \

   2

   
       [-i registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4] \

   3

   
       -t <target_registry>:<port>/<namespace>/redhat-operator-index:v4 

   4

   Copy to Clipboard Toggle word wrap

   1

   Index sur prune.

   2

   Liste des paquets séparés par les virgules à conserver.

   3

   Requis uniquement pour les images IBM Power® et IBM Z® : image de base du registre de l’opérateur avec l’étiquette correspondant à la version majeure et mineure du cluster dédié à OpenShift.

   4

   Balise personnalisée pour la nouvelle image d’index en cours de construction.

4. Exécutez la commande suivante pour pousser la nouvelle image d’index vers votre registre cible:

   $ podman push <target_registry>:<port>/<namespace>/redhat-operator-index:v4

   Copy to Clipboard Toggle word wrap

   lorsque <namespace> est un espace de noms existant sur le registre.

Procédure

1. Faites migrer votre catalogue de base de données SQLite vers un catalogue basé sur des fichiers en exécutant la commande suivante:

   $ opm migrate <registry_image> <fbc_directory>

   Copy to Clipboard Toggle word wrap

2. Générez un Dockerfile pour votre catalogue basé sur des fichiers en exécutant la commande suivante:

   $ opm generate dockerfile <fbc_directory> \
     --binary-image \
     registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4

   Copy to Clipboard Toggle word wrap

Procédure

1. Editez la définition de CatalogSource en définissant l’étiquette spec.grpcPodConfig.securityContextConfig sur l’héritage, comme indiqué dans l’exemple suivant:

   Exemple de CatalogSource Définition

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: my-catsrc
     namespace: my-ns
   spec:
     sourceType: grpc
     grpcPodConfig:
       securityContextConfig: legacy
     image: my-image:latest

   Copy to Clipboard Toggle word wrap

   Astuce

   Dans OpenShift Dedicated 4, le champ spec.grpcPodConfig.securityContextConfig est défini à l’héritage par défaut. Dans une version ultérieure d’OpenShift Dedicated, il est prévu que le paramètre par défaut change pour être limité. Dans le cas où votre catalogue ne peut pas fonctionner sous une application restreinte, il est recommandé de définir manuellement ce champ sur l’héritage.

2. Modifiez votre fichier <namespace>.yaml pour ajouter des normes d’admission de sécurité de pod élevées à votre espace de noms source de catalogue, comme indiqué dans l’exemple suivant:

   Exemple <namespace>.yaml fichier

   apiVersion: v1
   kind: Namespace
   metadata:
   ...
     labels:
       security.openshift.io/scc.podSecurityLabelSync: "false" 

   1

   
       openshift.io/cluster-monitoring: "true"
       pod-security.kubernetes.io/enforce: baseline 

   2

   
     name: "<namespace_name>"

   Copy to Clipboard Toggle word wrap

   1

   Désactivez la synchronisation des étiquettes de sécurité de pod en ajoutant l’étiquette security.openshift.io/scc.podSecurityLabelSync=false à l’espace de noms.

   2

   Appliquez l’étiquette pod-security.kubernetes.io/enforce. Définissez l’étiquette en ligne de base ou privilégiée. Utilisez le profil de sécurité de la pod de base, sauf si d’autres charges de travail dans l’espace de noms nécessitent un profil privilégié.