Utilisation d'une configuration d'exécution

Lorsque vous créez une session de carnet, vous pouvez ajouter des clés de variable d'environnement personnalisées et des URL de référentiel Git à utiliser dans des sessions de carnet.

Note

Ne nommez pas les clés de variable d'environnement avec les noms d'environnement gérés par le service dans le tableau suivant, car les clés attendent certaines valeurs ou le service de science des données retourne automatiquement la valeur.

Variables d'environnement géré de service

Nom de la clé de variable

Description

Spécifié par

TENANCY_OCID

OCID de la location à laquelle appartient le carnet.

Alimenté automatiquement par le service de science des données.

PROJECT_OCID

OCID du projet associé à la session de carnet courante.

Alimenté automatiquement par le service de science des données.

PROJECT_COMPARTMENT_OCID

OCID du compartiment du projet auquel le carnet est associé.

Alimenté automatiquement par le service de science des données.

USER_OCID

OCID de l'utilisateur.

Alimenté automatiquement par le service de science des données.

NB_SESSION_OCID

OCID de la session de carnet courante.

Alimenté automatiquement par le service de science des données.

NB_SESSION_COMPARTMENT_OCID

OCID du compartiment de la session de carnet courante.

Alimenté automatiquement par le service de science des données.

OCI_RESOURCE_PRINCIPAL_RPT_PATH

Chemin d'accès au jeton du principal de ressource OCI.

Alimenté automatiquement par le service de science des données.

OCI_RESOURCE_PRINCIPAL_RPT_ID

ID du jeton du principal de ressource OCI.

Alimenté automatiquement par le service de science des données.

NB_ONCREATE_SCRIPT_URL

URL du script de cycle de vie de la session de carnet à exécuter lors de la création.

Spécifiée par l'utilisateur.

NB_ONACTIVATE_SCRIPT_URL

URL du script de cycle de vie de la session de carnet à exécuter lors de l'activation.

Spécifiée par l'utilisateur.

NB_ONDEACTIVATE_SCRIPT_URL

URL du script de cycle de vie de la session de carnet à exécuter lors de la désactivation.

Spécifiée par l'utilisateur.

NB_ONDELETE_SCRIPT_URL

URL du script de cycle de vie de la session de carnet à exécuter lors de la suppression.

Spécifiée par l'utilisateur.

NB_SCRIPT_OUTPUT_LOG_NAMESPACE

Espace de noms du stockage d'objets pour les journaux de sortie du script de cycle de vie du carnet.

Spécifiée par l'utilisateur.

NB_SCRIPT_OUTPUT_LOG_BUCKET

Seau de stockage d'objets pour les journaux de sortie du script de cycle de vie des carnets.

Spécifiée par l'utilisateur.

SECURE_DATA_SESSION

Désactivez le téléchargement de fichier à partir du client JupyterLab et de l'API de téléchargement JupyterLab, réglez à Vrai pour désactiver la fonctionnalité de téléchargement.

Spécifiée par l'utilisateur.

SHM_SIZE Espace mémoire partagé, entrez la taille de la mémoire suivie des unités : g pour Go, m pour Mo et b pour octets. Par exemple, entrez 128g pour 128 Go d'espace mémoire partagé. Spécifiée par l'utilisateur.

Clés de variable d'environnement personnalisées

En plus des variables fournies par le système, vous pouvez ajouter des clés de variable d'environnement personnalisées aux sessions de carnet. Lors de la création d'une session de carnet, ajoutez des variables personnalisées en tant que paires clé- valeur dans la section Configuration de l'exécution.

Contraintes de paires clé-valeur
  • Les clés et les valeurs sont sensibles à la casse.

  • Les clés doivent commencer par une lettre ou un trait de soulignement et ne contenir que des caractères alphanumériques et des traits de soulignement.

  • La longueur de la clé est de 2 caractères au minimum et de 32 au maximum.

  • La longueur de la valeur est de 1 caractère au minimum et de 256 au maximum.

  • Les clés ne peuvent pas commencer par l'espace de noms réservé au service, oci_internal_.

  • Les clés ne peuvent pas être des variables gérées par le service.

Pour une session existante, désactivez les sessions de carnet. Après avoir activé le carnet, ajoutez les paires clé-valeur dans la section Configuration de l'exécution.

Utilisation de clés de variable d'environnement personnalisées pour gérer les scripts de cycle de vie des sessions de carnet

Vous pouvez utiliser les scripts de cycle de vie de session de carnet pour exécuter un script personnalisé à différents états de cycle de vie de session de carnet, comme suit :

  • Créer

  • Activer

  • Désactiver

  • Suppression

Pour exécuter un script de cycle de vie de carnet, transmettez une clé gérée par le service dans la section Configuration de l'exécution qui indique l'état du cycle de vie dans lequel exécuter le script. Dans le champ de valeur correspondant, spécifiez l'URI de fichier du service de stockage d'objets pour OCI où le script de cycle de vie a été chargé.

L'état du carnet ne change pas tant que le script n'est pas terminé pour la suppression et la désactivation des états du cycle de vie. Créez et activez des scripts de cycle de vie exécutés en parallèle avec la session de carnet afin qu'aucun retard de démarrage ne se produise.

Nous avons fourni plusieurs exemples de scripts de cycle de vie de carnet qui peuvent être modifiés pour s'adapter à divers cas d'utilisation.

Un groupe dynamique et une politique de carnet pour utiliser un principal de ressource de session de carnet doivent être créés pour utiliser des scripts de cycle de vie de carnet. Les autorisations de lecture doivent être accordées au groupe dynamique de carnets pour le seau de stockage d'objets contenant les scripts de cycle de vie.

Les clés de variable d'environnement du script de cycle de vie de session de carnet sont les suivantes :

NB_ONCREATE_SCRIPT_URL
NB_ONACTIVATE_SCRIPT_URL
NB_ONDEACTIVATE_SCRIPT_URL
NB_ONDELETE_SCRIPT_URL

La politique IAM suivante doit être ajoutée à ces clés pour permettre au service de science des données de lire des objets à partir de votre seau de scripts, comme dans l'exemple suivant :


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<scripts_bucket>',
            any {request.permission='OBJECT_INSPECT',
                 request.permission='OBJECT_READ'}}

Pour les clés gérées de service correspondant aux clés de script de cycle de vie de carnet précédentes, la valeur doit être un URI de fichier du service de stockage d'objets OCI pour les scripts chargés. Le format de l'URI est https://objectstorage.region.oraclecloud.com/n/object-storage-namespace/b/bucket/o/filename. Vous pouvez trouver l'URI du fichier dans la section Détails de l'objet.

Les clés de variable d'environnement du script de sortie du cycle de vie de la session de carnet sont les suivantes :

NB_SCRIPT_OUTPUT_LOG_NAMESPACE
NB_SCRIPT_OUTPUT_LOG_BUCKET

La politique IAM suivante doit être ajoutée à ces clés pour permettre au service de science des données de créer et de charger des journaux de sortie dans votre seau de journaux, comme dans l'exemple suivant :


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<logs_bucket>',
            any {request.permission='OBJECT_CREATE'}}

Les journaux de script de création et d'activation sont disponibles dans la session de carnets dans le même chemin que la configuration d'exécution dans le répertoire /opt/log/odsc.log.

Le chargement du journal se produit avec une opération de désactivation ou de suppression de session de carnet, qui vous permet de vérifier le statut du traitement du script, car vous perdez l'accès à la session de carnet. Cette opération n'est pas prise en charge pour la création et l'activation de scripts.

Utiliser une configuration d'exécution pour cloner un référentiel Git

Les référentiels Git peuvent être clonés dans des sessions de carnet à l'aide d'une configuration d'exécution. Seuls les référentiels Git publics peuvent être clonés avec cette approche. Pour cloner des référentiels Git privés, utilisez des clés SSH pour l'authentification.

Vous pouvez faire cloner un référentiel Git dans un répertoire local d'une session de carnet, puis utiliser Git.

Contraintes Git
  • Le carnet doit avoir un accès Internet pour permettre le clonage du référentiel Git.

  • Seuls les référentiels Git publics sont pris en charge.

  • Un maximum de trois URL de référentiels Git est autorisé.

  • La longueur maximale d'une URL est de 256 caractères.

Répertoires liés à Git dans les sessions de carnet
  • Recherchez les clones des référentiels Git dans le répertoire /home/datascience/repos d'une session de carnet.
  • Pour le statut du clone, par exemple Réussite, Échec ou En cours, allez à /opt/log/odsc.log.
  • Pour les journaux en mode verbose, allez à /var/log/jupyterlab/runtime_config.log.

Accédez aux journaux à partir d'un terminal d'une session de carnet.

Pour une session existante, désactivez les sessions de carnet. Après avoir activé le carnet, ajoutez l'URL du référentiel Git dans la section Configuration de l'exécution.

Si vous activez une session de carnet avec de nouvelles URL de référentiel Git, toute URL répertoriée dans la section Configuration de l'exécution, y compris les URL précédentes des sessions de carnet désactivées, est également clonée dans le répertoire /home/datascience/repos du carnet.

Pour supprimer un référentiel cloné d'une session de carnet, vous pouvez le supprimer du répertoire /home/datascience/repos de la session de carnet.

Pour remplacer un ancien clone d'un carnet désactivé par un nouveau clone, supprimez l'URL de référentiel Git non désirée indiquée dans la section Configuration de l'exécution, ajoutez la nouvelle URL, puis activez la session de carnet.