4.10. Utilisation d'Operator Lifecycle Manager sur des réseaux restreints

Procédure

1. S'authentifier avec registry.redhat.io:

   $ podman login registry.redhat.io

2. S'authentifier avec le registre cible :

   $ podman login <target_registry>

3. Déterminez la liste des paquets que vous souhaitez inclure dans votre index élagué.

   1. Exécutez l'image de l'index source que vous souhaitez élaguer dans un conteneur. Par exemple :

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

      Exemple de sortie

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

   2. Dans une autre session de terminal, utilisez la commande grpcurl pour obtenir une liste des paquets fournis par l'index :

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

   3. Inspectez le fichier packages.out et identifiez les noms de paquets de cette liste que vous souhaitez conserver dans votre index élagué. Par exemple :

      Exemples de listes de paquets

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

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

4. Exécutez la commande suivante pour élaguer l'index source de tous les paquets, à l'exception des paquets spécifiés :

   $ opm index prune \
       -f registry.redhat.io/redhat/redhat-operator-index:v4.12 \1
       -p advanced-cluster-management,jaeger-product,quay-operator \2
       [-i registry.redhat.io/openshift4/ose-operator-registry:v4.9] \3
       -t <target_registry>:<port>/<namespace>/redhat-operator-index:v4.12 4

   1

   Index pour la taille.

   2

   Liste de paquets à conserver, séparés par des virgules.

   3

   Requis uniquement pour les images IBM Power et IBM zSystems : L'image de base Operator Registry avec le tag qui correspond à la version majeure et mineure du cluster OpenShift Container Platform cible.

   4

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

5. Exécutez la commande suivante pour transférer la nouvelle image d'index dans votre registre cible :

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

   où <namespace> est un espace de noms existant dans le registre. Par exemple, vous pouvez créer un espace de noms olm-mirror pour y transférer tout le contenu mis en miroir.

Procédure

1. Créez un objet CatalogSource qui fait référence à votre image d'index. Si vous avez utilisé la commande oc adm catalog mirror pour mettre en miroir votre catalogue vers un registre cible, vous pouvez utiliser le fichier catalogSource.yaml généré dans votre répertoire manifests comme point de départ.

   1. Modifiez le texte suivant selon vos spécifications et sauvegardez-le sous forme de fichier catalogSource.yaml:

      apiVersion: operators.coreos.com/v1alpha1
      kind: CatalogSource
      metadata:
        name: my-operator-catalog 1
        namespace: openshift-marketplace 2
      spec:
        sourceType: grpc
        grpcPodConfig:
          securityContextConfig: <security_mode> 3
        image: <registry>/<namespace>/redhat-operator-index:v4.12 4
        displayName: My Operator Catalog
        publisher: <publisher_name> 5
        updateStrategy:
          registryPoll: 6
            interval: 30m

      1

      Si vous avez mis en miroir le contenu dans des fichiers locaux avant de le télécharger dans un registre, supprimez tous les caractères backslash (/) du champ metadata.name afin d'éviter une erreur "invalid resource name" (nom de ressource non valide) lors de la création de l'objet.

      2

      Si vous souhaitez que la source du catalogue soit disponible globalement pour les utilisateurs de tous les espaces de noms, spécifiez l'espace de noms openshift-marketplace. Sinon, vous pouvez spécifier un espace de noms différent pour que le catalogue soit délimité et disponible uniquement pour cet espace de noms.

      3

      Spécifiez la valeur de legacy ou restricted. Si le champ n'est pas défini, la valeur par défaut est legacy. Dans une prochaine version d'OpenShift Container Platform, il est prévu que la valeur par défaut soit restricted. Si votre catalogue ne peut pas s'exécuter avec les autorisations restricted, il est recommandé de définir manuellement ce champ sur legacy.

      4

      Spécifiez votre image d'index. Si vous spécifiez une balise après le nom de l'image, par exemple :v4.12, le pod source du catalogue utilise une politique d'extraction d'image de Always, ce qui signifie que le pod extrait toujours l'image avant de démarrer le conteneur. Si vous spécifiez un condensé, par exemple @sha256:<id>, la politique d'extraction d'image est IfNotPresent, ce qui signifie que le module n'extrait l'image que si elle n'existe pas déjà sur le nœud.

      5

      Indiquez votre nom ou le nom d'une organisation qui publie le catalogue.

      6

      Les sources du catalogue peuvent automatiquement vérifier la présence de nouvelles versions pour rester à jour.

   2. Utilisez le fichier pour créer l'objet CatalogSource:

      $ oc apply -f catalogSource.yaml

2. Vérifiez que les ressources suivantes ont bien été créées.

   1. Vérifier les gousses :

      $ oc get pods -n openshift-marketplace

      Exemple de sortie

      NAME                                    READY   STATUS    RESTARTS  AGE
      my-operator-catalog-6njx6               1/1     Running   0         28s
      marketplace-operator-d9f549946-96sgr    1/1     Running   0         26h

   2. Vérifier la source du catalogue :

      $ oc get catalogsource -n openshift-marketplace

      Exemple de sortie

      NAME                  DISPLAY               TYPE PUBLISHER  AGE
      my-operator-catalog   My Operator Catalog   grpc            5s

   3. Vérifier le manifeste du paquet :

      $ oc get packagemanifest -n openshift-marketplace

      Exemple de sortie

      NAME                          CATALOG               AGE
      jaeger-product                My Operator Catalog   93s

Procédure

1. Mettre à jour l'index existant en ajoutant des images de liasses :

   $ 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

   1

   L'option --bundles spécifie une liste séparée par des virgules d'images supplémentaires à ajouter à l'index.

   2

   Le drapeau --from-index spécifie l'index précédemment poussé.

   3

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

   4

   L'option --pull-tool spécifie l'outil utilisé pour extraire les images des conteneurs.

   où :

   <registry>

   Spécifie le nom d'hôte du registre, par exemple quay.io ou mirror.example.com.

   <namespace>

   Spécifie l'espace de noms du registre, par exemple ocs-dev ou abc.

   <new_bundle_image>

   Spécifie la nouvelle image de paquet à ajouter au registre, par exemple ocs-operator.

   <digest>

   Spécifie l'ID de l'image SHA, ou condensé, de l'image de la liasse, par exemple c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41.

   <existing_index_image>

   Spécifie l'image précédemment poussée, telle que abc-redhat-operator-index.

   <existing_tag>

   Spécifie une balise d'image précédemment poussée, telle que 4.12.

   <updated_tag>

   Spécifie la balise d'image à appliquer à l'image d'index mise à jour, par exemple 4.12.1.

   Example command

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

2. Pousser l'image d'index mise à jour :

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

3. Suivez à nouveau les étapes de la procédure Mirroring an Operator catalog pour refléter le contenu mis à jour. Cependant, lorsque vous arrivez à l'étape de création de l'objet ImageContentSourcePolicy (ICSP), utilisez la commande oc replace au lieu de la commande oc create. Par exemple :

   oc replace -f ./manifests-redhat-operator-index-<random_number>/imageContentSourcePolicy.yaml

   Cette modification est nécessaire car l'objet existe déjà et doit être mis à jour.

   Note

   Normalement, la commande oc apply peut être utilisée pour mettre à jour des objets existants qui ont été créés précédemment à l'aide de oc apply. Toutefois, en raison d'un problème connu concernant la taille du champ metadata.annotations dans les objets ICSP, la commande oc replace doit être utilisée pour cette étape.

4. Une fois que Operator Lifecycle Manager (OLM) a interrogé automatiquement l'image d'index référencée dans la source du catalogue à intervalles réguliers, vérifiez que les nouveaux paquets ont été ajoutés avec succès :

   $ oc get packagemanifests -n openshift-marketplace