Configurer les services de notebook

Les services de notebook offrent une interface Web pour notebooks Python qui permet d’analyser les données géospatiales. Grâce aux notebooks, vous pouvez réaliser des analyses, automatiser des processus et visualiser immédiatement les données et les résultats d’analyse dans un contexte géographique.

Les notebooks constituent un environnement associant code, visualisations et cartes à la volée, et outils de données. Dans l’éditeur de notebooks, vous pouvez écrire, documenter et exécuter du code Python à partir d’un même emplacement.

Les services de notebook incluent les ressources Python Esri suivantes :

• ArcGIS API for Python : vous permet d’intégrer des cartes dynamiques et des outils de données géospatiales dans vos notebooks.
• ArcPy : autorise l’écriture de scripts Python dans votre organisation.

Licence :

Cette fonctionnalité est disponible à deux niveaux de licence :

• Une licence ArcGIS Notebook Services est fournie avec la licence ArcGIS Enterprise on Kubernetes. Cette licence permet aux membres de l’organisation de créer des notebooks à l’aide du runtime ArcGIS Notebook Python 3 Standard et d’automatiser les processus de notebook à l’aide de tâches planifiées, de webhooks et d’outils Web.
• Une licence ArcGIS Notebook Services Advanced est disponible sous forme de fonctionnalité Premium qui donne accès au runtime ArcGIS Notebook Python 3 Advanced avec des fonctionnalités ArcPy supplémentaires qui vont au-delà de ce qu’offre la licence ArcGIS Notebook Services.

Remarque :

Pour prendre en charge les services de notebook, la configuration des proxys inverses externes ou des équilibreurs de charge doit être définie de telle sorte qu’ils puissent transmettre le trafic du WebSocket aux cibles dorsales et que les sessions restent ouvertes 10 minutes.

Configurer les services de notebook

Les étapes de configuration suivantes peuvent entraîner la modification de votre déploiement ArcGIS Enterprise on Kubernetes dans votre organisation. Examinez-les attentivement avant de continuer.

Activer les services de notebook

Pour activer les services de notebook, vous devez configurer un espace de travail de notebook et activer la fonctionnalité dans ArcGIS Enterprise Manager.

Remarque :

Avant d’activer les services de notebook, vérifiez que le quota de ressources et le nombre de nœuds worker alloués par votre administrateur suffisent à prendre en charge cette fonctionnalité Premium.

1. Dans ArcGIS Enterprise Manager, cliquez sur le bouton Capabilities (Fonctionnalités) dans la barre latérale.

   La page des fonctionnalités apparaît.

2. Activez le bouton bascule Notebook services (Notebook Services).

   La boîte de dialogue Configure workspace (Configurer l’espace de travail) apparaît et vous invite à spécifier les valeurs nécessaires. L’espace de travail permet de stocker les fichiers associés aux notebooks de chaque membre de l’organisation.

3. Fournissez les informations nécessaires :
   1. Pour Volume type (Type de volume), sélectionnez Dynamic (Dynamique) ou Static (Statique) pour indiquer la façon dont vous souhaitez provisionner un volume persistant pour l’espace de travail. Utilisez Static (Statique) lorsque la demande de volume persistant (PVC) doit être liée à un volume persistant (PV) existant. Utilisez Dynamic (Dynamique) lorsqu’un nouveau volume persistant doit être provisionné via la classe de stockage spécifiée. Pour en savoir plus, prenez connaissance des considérations concernant le provisionnement dynamique et le provisionnement statique.

      Remarque :

      Pour cet espace de travail, le volume persistant doit être de type FileSystem et prendre en charge le mode d’accès ReadWriteMany (RWX). Avant de configurer un espace de travail de notebook, vérifiez que le volume persistant que vous allouez à cet espace de travail prend en charge le mode d’accès RWX. De plus, pour assurer la prise en charge du volume persistant, vous pouvez être amené à installer un pilote de prise en charge dans votre cluster Kubernetes

   2. Saisissez un nom dans la zone de texte Volume name (Nom du volume).

      Si vous sélectionnez Static (Statique), vous devez fournir un nom de volume.

   3. Pour Storage class name (Nom de la classe de stockage), attribuez à la classe de stockage le nom de votre choix ou, si vous avez déjà défini une classe de stockage, nommez la classe de stockage pour le volume.

      Remarque :

      Le nom de la classe de stockage est requis pour l’option Dynamic (Dynamique) et facultative pour Static (Statique).

      Remarque :

      Lors de la liaison à un volume persistant existant pour lequel aucune classe de stockage n’a été définie, laissez le nom de la classe de stockage vide. Si une classe de stockage par défaut est configurée dans le cluster, le contrôleur d’admission DefaultStorageClass ajoute la classe de stockage par défaut et empêche la liaison de la réclamation de volume persistant. En pareil cas, les administrateurs doivent ajouter la spécification de classe de stockage au volume existant ou supprimer la configuration de la classe de stockage par défaut.

   4. Dans Size (GiB) (Taille [Gio]), définissez la taille du volume persistant.

      La taille minimale est de 100 Gio. La valeur doit correspondre à la taille du volume persistant existant en cas de liaison statique. Si la valeur est supérieure à la taille du volume persistant, la réclamation de volume persistant ne peut pas être liée au volume persistant.

      Remarque :

      Un seul espace de travail de notebook peut être configuré pour votre organisation. Sa taille de stockage est limitée à la valeur spécifiée au moment où il a été créé. Veillez à attribuer une taille suffisante à l’espace de travail de façon à répondre à vos besoins actuels et futurs.

   5. Cliquez sur Save (Enregistrer).

   Un message s’affiche pour indiquer que le processus d’activation peut prendre du temps.

   Une demande d’activation des services de notebook est envoyée. Ce processus valide les conditions préalables et active les ressources de prise en charge. Un service d’automatisation des notebooks démarre automatiquement.

Si l’activation de la fonctionnalité échoue, répétez les étapes ci-dessus pour vous assurer que l’espace de travail a été configuré, que la licence des services de notebook est valide et disponible et que les services système ont été démarrés. Passez en revue les journaux pour identifier les exigences pour cette capacité.

Vous pouvez éventuellement déployer un deamonSet pour précharger les images des services de notebook. Cela contribuera à améliorer le temps nécessaire pour ouvrir un notebook pour la première fois. Le temps d’expiration défini pour le chargement initial d’un notebook est d’1 minute.

Les services de notebook sont maintenant configurés. Vous pouvez commencer à utiliser des notebooks dans votre organisation. Découvrez comment créer un notebook et comment publier un notebook en tant qu’outil Web.

Par ailleurs, découvrez comment ajuster les paramètres pour la fonctionnalité de services de notebook.

Paramètres des services de notebook

Après avoir activé les services de notebook, vous pouvez consulter et mettre à jour les paramètres associés tels que les ressources de prise en charge pour les runtimes applicables, la taille de WebSocket, le nombre maximal d’instantanés par élément de notebook, etc.

La fonctionnalité de services de notebook comprend trois onglets principaux qui vous permettent de consulter ou mettre à jour les paramètres : Overview (Vue d’ensemble), Properties (Propriétés) et Runtimes.

• Overview (Vue d’ensemble) : déterminez le statut de votre service d’automatisation des notebooks, le nombre de déploiements de notebook en cours d’exécution et la classe de stockage affectée à l’espace de travail de notebook dédié.
• Properties (Propriétés) : gérez les limites associées aux déploiements de notebook interactifs et automatisés.
• Runtimes : consultez et mettez à jour les paramètres des runtimes de services de notebook disponibles.

Consulter et mettre à jour les propriétés

Les propriétés suivantes peuvent être consultées et mises à jour dans ArcGIS Enterprise Manager :

• WebSocket size (MB) (Taille du WebSocket [Mo]) : taille maximale (en mégaoctets) d’un paquet transmis entre le serveur et les navigateurs client via le protocole WebSocket. L’utilisation de WebSocket vise à favoriser une communication bidirectionnelle efficace et sécurisée avec les clients. La valeur par défaut de cette propriété est 16 Mo. Vous pouvez être amené à élever cette limite si un notebook doit transmettre un volume de données particulièrement important au site du serveur.
• Idle notebook threshold (minutes) (Seuil pour les notebooks inactifs (minutes)) : cette propriété régit la fermeture des notebooks inactifs. Les notebooks ouverts mais inactifs pendant un certain laps de temps (exprimé en minutes) sont automatiquement fermés. Le noyau du notebook s’est arrêté. La valeur par défaut est 7 minutes.
• Empty deployment threshold (Seuil pour les déploiements vides) : cette propriété définit la durée pendant laquelle un déploiement de notebooks peut rester ouvert (en minutes) sans exécuter de notebook actif. Lorsque cette valeur est atteinte, le déploiement se ferme automatiquement. La valeur par défaut est 60 minutes. Comme le seuil de notebooks inactifs, vous pouvez réduire cette valeur pour préserver les ressources.
• Maximum snapshots per notebook item (Nombre maximal d’instantanés par élément de notebook) : cette propriété limite le nombre d’instantanés autorisés pour un élément de notebook. La valeur par défaut est 5.

Pour afficher et mettre à jour les propriétés, procédez comme suit :

1. Connectez-vous à ArcGIS Enterprise Manager en tant qu’administrateur.
2. Cliquez sur la page Capabilities (Fonctionnalités).
3. Sur la fiche Notebook Services, cliquez sur Settings (Paramètres).
4. Cliquez sur la page Properties (Propriétés).

   Si vous modifiez l’une des valeurs des paramètres, le bouton Save (Enregistrer) devient disponible.

5. Cliquez sur Save (Enregistrer) pour conserver vos mises à jour.

Consulter et mettre à jour les runtimes

Vous pouvez effectuer les tâches de gestion des runtimes suivantes dans ArcGIS Enterprise Manager :

• Consulter les runtimes disponibles.
• Dupliquer un runtime créé par le système pour en faire un runtime créé par l’utilisateur. Chaque runtime peut être configuré séparément, ce qui permet à différents types de tâches d’utiliser des runtimes avec des paramètres différents.
• Afficher et modifier à jour les ressources système disponibles par déploiement de runtime. Si plusieurs utilisateurs créent des notebooks simultanément, vous pouvez surveiller l’utilisation et ajuster ces paramètres selon les besoins.
• Contrôler les nœuds où les pods d’un runtime peuvent être planifiés. Le contrôle du placement des pods est pratique lorsque des tâches exigent des ressources (telles qu’un GPU) disponibles uniquement sur certains nœuds du cluster.

Pour consulter ou modifier un runtime, procédez comme suit :

1. Connectez-vous à ArcGIS Enterprise Manager en tant qu’administrateur.
2. Cliquez sur la page Capabilities (Fonctionnalités).
3. Sur la fiche Notebook Services, cliquez sur Settings (Paramètres).
4. Cliquez sur la page Runtimes pour afficher la liste des runtimes disponibles.
5. Pour créer un runtime, cliquez sur Duplicate (Dupliquer) en regard du runtime créé par le système que vous avez l’intention de dupliquer.
6. Cliquez sur le nom du runtime à consulter ou à mettre à jour.
7. Pour afficher ou modifier les ressources auxquelles chaque déploiement de runtime peut accéder, procédez comme suit :
   1. Cliquez sur Runtime settings (Paramètres du runtime).
   2. Affichez ou modifiez les valeurs CPU requests (Demandes de CPU) et CPU limits (Limites de CPU).
   3. Affichez ou modifiez les valeurs Memory requests (Demandes de mémoire), Memory limits (Limites de mémoire), Maximum swap memory (Mémoire d’échange maximale) et Shared memory (Mémoire partagée).
   4. Utilisez le bouton bascule Enable GPU (Activer le GPU) et la valeur GPU units (Unités de GPU) pour afficher ou modifier l’accès du runtime aux ressources GPU. GPU Units (Unités de GPU) représente le nombre de GPU par nœud.

      Remarque :

      Votre cluster Kubernetes doit être configuré pour activer les ressources GPU. Pour plus d’informations, consultez la rubrique Configurer des nœuds compatibles avec les processeurs graphiques (GPU).

   5. Cliquez sur Save (Enregistrer) pour conserver les mises à jour.
8. Pour consulter ou modifier les paramètres de placement des pods pour un runtime, procédez comme suit :
   1. Cliquez sur Pod placement (Placement des pods).
   2. Affichez ou modifiez les valeurs Node affinity (Affinité des nœuds) et Tolerations (Tolérances).

      Si vous configurez l’affinité des nœuds pour les services de notebook compatibles avec les GPU, utilisez les valeurs suivantes :

      • Type : Required (Obligatoire)
      • Key (Clé) : spécifiez la clé utilisée pour étiqueter le nœud GPU, par exemple notebook.
      • Operator (Opérateur) : In (Dans)
      • Value (Valeur) : spécifiez la valeur utilisée pour étiqueter le nœud GPU, par exemple NotebooksGPUNode.

      Si vous configurez des tolérances pour les services de notebook compatibles avec les GPU, utilisez les valeurs suivantes :

      • Effect (Effet) : No Execute (Ne pas exécuter)
      • Key (Clé) : nvidia.com/gpu
      • Operator (Opérateur) : Exists (Existe)
   3. Si vous configurez de nouvelles valeurs Node affinity (Affinité des nœuds) ou Tolerations (Tolérances), cliquez sur Add (Ajouter).
   4. Cliquez sur Save (Enregistrer) pour conserver les mises à jour.
9. Pour consulter les bibliothèques incluses dans le runtime, cliquez sur Manifest (Manifeste).