Ce document a été traduit à l'aide d'une technologie de traduction automatique. Bien que nous nous efforcions de fournir des traductions exactes, nous ne fournissons aucune garantie quant à l'exhaustivité, l'exactitude ou la fiabilité du contenu traduit. En cas de divergence, la version originale anglaise prévaut et fait foi.

Extensions

Les extensions permettent aux utilisateurs, développeurs, partenaires et clients d’étendre et d’améliorer l’interface utilisateur de Rancher. De plus, les utilisateurs peuvent apporter des modifications et créer des améliorations à la fonctionnalité de leur interface utilisateur indépendamment des versions de Rancher. Les extensions permettront aux utilisateurs de s’appuyer sur Rancher pour mieux l’adapter à leurs environnements respectifs. Notez que les utilisateurs auront également la possibilité de mettre à jour vers de nouvelles versions ainsi que de revenir à une version précédente.

Les extensions sont des graphiques Helm qui ne peuvent être installés qu’une seule fois dans un cluster ; par conséquent, ces graphiques ont été simplifiés et séparés des graphiques Helm généraux listés sous Apps.

Des exemples d’extensions intégrées à Rancher sont Fleet, Explorer et Harvester. Des exemples d’autres extensions qui utilisent l’API des extensions et qui peuvent être ajoutées manuellement sont Kubewarden et Elemental.

Conditions préalables

Vous devez vous connecter en tant qu’administrateur pour pouvoir voir et interagir avec la page de gestion des extensions.

Installation des extensions

  1. Cliquez sur ☰ > Extensions sous Configuration.

  2. Si ce n’est pas déjà installé dans Apps, vous devez activer l’opérateur d’extension en cliquant sur le bouton Activer.

    • Cliquez sur OK pour ajouter le dépôt d’extensions Rancher si votre installation n’est pas isolée physiquement. Sinon, décochez la case pour le faire et cliquez sur OK.

    Dépôt d’extensions Rancher

  3. Sur la page Extensions, cliquez sur l’onglet Disponible pour sélectionner les extensions que vous souhaitez installer.

  4. Si aucune extension n’est affichée comme disponible, vous pouvez ajouter manuellement des dépôts comme suit :

    4.1. En haut à droite de l’écran, cliquez sur ⋮ > Gérer les dépôts > Créer.

    4.2. Ajoutez le nom du dépôt souhaité, en veillant également à spécifier l’URL du dépôt Git et la branche Git.

    4.3. Cliquez à nouveau sur Créer en bas à droite pour terminer.

    Gérer les dépôts

  5. Sous l’onglet Disponible, cliquez sur Installer l’extension et la version souhaitées comme dans l’exemple ci-dessous. Vous pouvez également mettre à jour votre extension depuis cet écran, car le bouton Mettre à jour apparaîtra sur l’extension si une mise à jour est disponible.

    Installer Kubewarden

  6. Cliquez sur le bouton Rafraîchir la page qui apparaîtra après l’installation réussie de votre extension. Notez qu’un utilisateur connecté qui vient d’installer une extension ne verra pas de changement dans l’interface utilisateur à moins qu’il ne rafraîchisse la page.

    Bouton Rafraîchir

Mise à jour et mise à niveau des extensions

  1. Cliquez sur ☰ > Extensions sous Configuration.

  2. Sélectionnez l’onglet Mises à jour.

  3. Cliquez sur Mettre à jour.

S’il existe une nouvelle version de l’extension, un bouton Mettre à jour sera également visible sur la carte associée à l’extension dans l’onglet Disponible.

Suppression des extensions

  1. Cliquez sur ☰, puis cliquez sur le nom de votre grappe locale.

  2. Dans la barre latérale, sélectionnez Apps  Apps installées.

  3. Trouvez le nom du chart que vous souhaitez supprimer et sélectionnez la case à cocher à côté.

  4. Cliquez sur Supprimer.

Suppression des dépôts d’extensions

  1. Cliquez sur ☰ > Extensions sous Configuration.

  2. En haut à droite, cliquez sur ⋮ > Gérer les dépôts.

  3. Trouvez le nom du dépôt d’extension que vous souhaitez supprimer. Sélectionnez la case à cocher à côté du nom du dépôt, puis cliquez sur Supprimer.

Suppression des images de conteneur des dépôts d’extensions

  1. Cliquez sur ☰, puis sélectionnez Extensions, sous Configuration.

  2. En haut à droite, cliquez sur ⋮ > Gérer les catalogues d’extensions.

  3. Trouvez le nom de l’image de conteneur que vous souhaitez supprimer, puis cliquez sur ⋮ > Désinstaller.

Désinstallation des extensions

Il existe deux façons de désinstaller ou de désactiver une extension :

  1. Sous l’onglet Installé, cliquez sur le bouton Désinstaller de l’extension que vous souhaitez supprimer.

    Désinstaller les extensions

  2. Sur la page de gestion des extensions, cliquez sur ⋮ > Désactiver le support des extensions. Cela désactivera toutes les extensions installées.

    Désactiver les extensions

Vous devez recharger la page après avoir désactivé les extensions, sinon des problèmes d’affichage peuvent survenir.

Développement des extensions

Pour apprendre à développer vos propres extensions, référez-vous au guide officiel Guide de démarrage.

Travailler avec des extensions dans un environnement isolé physiquement

Si vous avez l’intention de travailler avec des extensions dans un environnement isolé physiquement, vous devez effectuer quelques étapes supplémentaires avant de pouvoir accomplir certaines tâches.

Accéder aux extensions de l’interface utilisateur de Rancher dans un environnement isolé physiquement

Rancher fournit certaines extensions, telles que Kubewarden et Elemental, via l’image de conteneur ui-plugin-catalog à https://hub.docker.com/r/rancher/ui-plugin-catalog/tags.. Si vous essayez d’installer ces extensions dans un environnement isolé physiquement, vous devez rendre l’image ui-plugin-catalog accessible.

  1. Dupliquez l’image ui-plugin-catalog vers un registre privé :

  export REGISTRY_ENDPOINT=<my-private-registry-endpoint> # e.g. "my-private-registry.com"
  docker pull rancher/ui-plugin-catalog:<tag>
  docker tag rancher/ui-plugin-catalog:<tag> $REGISTRY_ENDPOINT/rancher/ui-plugin-catalog:<tag>
  docker push $REGISTRY_ENDPOINT/rancher/ui-plugin-catalog:<tag>
2. Use the mirrored image to create a Kubernetes https://kubernetes.io/docs/concepts/workloads/controllers/deployment/[deployment]:
  ```yaml
  apiVersion: apps/v1
  kind: Deployment
  metadata:
    name: ui-plugin-catalog
    namespace: cattle-ui-plugin-system
    labels:
      catalog.cattle.io/ui-extensions-catalog-image: ui-plugin-catalog
  spec:
    replicas: 1
    selector:
      matchLabels:
        catalog.cattle.io/ui-extensions-catalog-image: ui-plugin-catalog
    template:
      metadata:
        namespace: cattle-ui-plugin-system
        labels:
          catalog.cattle.io/ui-extensions-catalog-image: ui-plugin-catalog
      spec:
        containers:
        - name: server
          image: <my-private-registry-endpoint>/rancher/ui-plugin-catalog:<tag>
          imagePullPolicy: Always
        imagePullSecrets:
          - name: <my-registry-credentials>

  1. Exposez le déploiement en créant un service ClusterIP :
    ```yaml
    apiVersion: v1
    kind: Service
    metadata:
    name: ui-plugin-catalog-svc
    namespace: cattle-ui-plugin-system
    spec:
    ports :

    • name: catalog-svc-port
      port: 8080 protocole: TCP portCible: 8080 sélecteur: catalog.cattle.io/ui-extensions-catalog-image: ui-plugin-catalog type: ClusterIP `

  2. Créez un ClusterRepo qui cible le service ClusterIP:

      apiVersion: catalog.cattle.io/v1
  kind: ClusterRepo
  metadata:
 name: ui-plugin-catalog-repo
  spec:
 url: http://ui-plugin-catalog-svc.cattle-ui-plugin-system:8080

Après avoir configuré ces ressources avec succès, vous pouvez installer les extensions à partir du manifeste ui-plugin-charts dans votre environnement isolé physiquement.

Importer et installer des extensions dans un environnement isolé physiquement

  1. Trouvez l’adresse du dépôt d’images de conteneur que vous souhaitez importer en tant qu’extension. Vous devez importer et utiliser la dernière version taguée de l’image pour vous assurer de recevoir les dernières fonctionnalités et mises à jour de sécurité.

    • (Optionnel) Si l’image de conteneur est privée : Créer un secret de registre dans l’espace de noms cattle-ui-plugin-system. Entrez le domaine de l’adresse de l’image dans le champ Nom de domaine du dépôt.

  2. Cliquez sur ☰, puis sélectionnez Extensions, sous Configuration.

  3. En haut à droite, cliquez sur ⋮ > Gérer les catalogues d’extensions.

  4. Sélectionnez le bouton Importer le catalogue d’extensions.

  5. Entrez l’adresse de l’image dans le champ Référence d’image du catalogue.

    • (Optionnel) Si l’image de conteneur est privée, sélectionnez le secret que vous venez de créer dans le menu déroulant Secrets de tirage.

  6. Cliquez sur Charger. L’extension sera maintenant En attente.

  7. Retournez à la page Extensions.

  8. Sélectionnez l’onglet Disponible, et cliquez sur Recharger pour vous assurer que la liste des extensions est à jour.

  9. Trouvez l’extension que vous venez d’ajouter, et cliquez sur Installer.

Mettre à jour un dépôt d’extensions dans un environnement isolé physiquement

Les dépôts d’extensions qui ne sont pas isolés physiquement sont automatiquement mis à jour. Si le dépôt est isolé physiquement, vous devez le mettre à jour manuellement.

Tout d’abord, dupliquez les dernières modifications vers votre registre privé en suivant les mêmes étapes que pour initialement importer et installer un dépôt d’extensions.

Après avoir dupliqué les dernières modifications, suivez ces étapes :

  1. Cliquez sur ☰ > Local.

  2. Dans la barre latérale, sélectionnez Charges de travail  Déploiements.

  3. Dans le menu déroulant des espaces de noms, sélectionnez cattle-ui-plugin-system.

  4. Trouvez l’espace de noms cattle-ui-plugin-system.

  5. Sélectionnez le déploiement ui-plugin-catalog.

  6. Cliquez sur ⋮ > Modifier la configuration.

  7. Mettez à jour le champ Image du conteneur dans le conteneur du déploiement avec la dernière image.

  8. Cliquez sur Enregistrer.