Utilisation d'une configuration d'exécution
Lorsque vous créez une session de bloc-notes, vous pouvez ajouter des clés de variable d'environnement personnalisées et des URL de référentiel Git à utiliser dans les sessions de bloc-notes.
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 Data Science renvoie automatiquement la valeur.
Variables d'environnement géré de service
Nom de clé de variable |
Description |
Spécifié par |
---|---|---|
|
OCID de la location à laquelle appartient le bloc-notes. |
Alimenté automatiquement par Data Science. |
|
OCID du projet associé à la session de bloc-notes en cours |
Alimenté automatiquement par Data Science. |
|
OCID du compartiment du projet auquel le bloc-notes est associé. |
Alimenté automatiquement par Data Science. |
|
OCID utilisateur. |
Alimenté automatiquement par Data Science. |
|
OCID de la session de bloc-notes en cours |
Alimenté automatiquement par Data Science. |
|
OCID de compartiment de la session de bloc-notes en cours |
Alimenté automatiquement par Data Science. |
|
Chemin du jeton de principal de ressource OCI. |
Alimenté automatiquement par Data Science. |
|
ID du jeton de principal de ressource OCI. |
Alimenté automatiquement par Data Science. |
|
URL de script de cycle de vie de session de bloc-notes à exécuter lors de la création. |
Indiqué par l'utilisateur. |
|
URL de script de cycle de vie de session de bloc-notes à exécuter lors de l'activation. |
Indiqué par l'utilisateur. |
|
URL du script de cycle de vie de session de bloc-notes à exécuter lors de la désactivation. |
Indiqué par l'utilisateur. |
|
URL de script de cycle de vie de session de bloc-notes à exécuter lors de la suppression. |
Indiqué par l'utilisateur. |
|
Espace de noms Object Storage pour les journaux de sortie de script de cycle de vie de bloc-notes. |
Indiqué par l'utilisateur. |
|
Bucket Object Storage pour les journaux de sortie de script de cycle de vie de bloc-notes. |
Indiqué par l'utilisateur. |
|
Désactivez le téléchargement de fichiers à partir du client JupyterLab et de l'API de téléchargement JupyterLab. Définissez la valeur sur Vrai pour désactiver la fonctionnalité de téléchargement. |
Indiqué par l'utilisateur. |
SHM_SIZE |
Espace mémoire partagé, entrez la taille de la mémoire suivie des unités : g pour le Go, m pour le Mo et b pour les octets. Par exemple, entrez 128g pour 128 Go d'espace de mémoire partagée. | Indiqué par l'utilisateur. |
Clés de variable d'environnement personnalisées
Outre les variables fournies par le système, vous pouvez ajouter des clés de variable d'environnement personnalisées aux sessions de bloc-notes. Lorsque vous créez une session de bloc-notes, ajoutez des variables personnalisées en tant que paires clé-valeur dans la section Configuration d'exécution.
- Contraintes sur les paires clé-valeur
-
-
Les clés et les valeurs font la distinction entre les minuscules et les majuscules.
-
Les clés doivent commencer par une lettre ou un trait de soulignement, et contenir uniquement des caractères alphanumériques ou des traits de soulignement.
-
La longueur de la clé est comprise entre 2 et 32 caractères.
-
La longueur de la valeur est comprise entre 1 et 256 caractères.
-
Les clés ne peuvent pas démarrer avec l'espace de noms réservé au service de
oci_internal_
. -
Les clés ne peuvent pas être des variables gérées par service.
-
Pour une session de bloc-notes existante, désactivez cette dernière. Ensuite, lorsque vous activez le bloc-notes, ajoutez les paires clé-valeur dans la section Runtime configuration.
Utilisation de clés de variable d'environnement personnalisées pour gérer les scripts de cycle de vie de session de bloc-notes
Vous pouvez utiliser les scripts de cycle de vie de session de bloc-notes pour exécuter un script personnalisé avec différents états de cycle de vie de session de bloc-notes, comme suit :
-
Créer
-
Activer
-
Désactiver
-
Suppression
Pour exécuter un script de cycle de vie de bloc-notes, transmettez une clé gérée par le service dans la section Configuration d'exécution qui indique l'état de cycle de vie dans lequel exécuter le script. Dans le champ de valeur correspondant, indiquez l'URI de fichier OCI Object Storage où le script de cycle de vie a été téléchargé.
L'état du bloc-notes ne change pas tant que le script n'est pas terminé pour supprimer et désactiver les états de cycle de vie. Créez et activez des scripts de cycle de vie exécutés en parallèle avec la session de bloc-notes afin qu'aucun retard de démarrage ne se produise.
Nous avons fourni plusieurs exemples de scripts de cycle de vie de bloc-notes qui peuvent être modifiés pour s'adapter à divers cas d'utilisation.
Un groupe dynamique et une stratégie de session de bloc-notes pour utiliser un principal de ressource doivent être créés pour utiliser des scripts de cycle de vie de bloc-notes. Les droits d'accès en lecture doivent être accordés au groupe dynamique de bloc-notes pour le bucket Object Storage contenant les scripts de cycle de vie.
Les clés de variable d'environnement de script de cycle de vie de session de bloc-notes sont les suivantes :
NB_ONCREATE_SCRIPT_URL
NB_ONACTIVATE_SCRIPT_URL
NB_ONDEACTIVATE_SCRIPT_URL
NB_ONDELETE_SCRIPT_URL
La stratégie IAM suivante doit être ajoutée à ces clés pour permettre à Data Science de lire des objets à partir du bucket 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 bloc-notes précédentes, la valeur doit être un URI de fichier OCI Object Storage vers les scripts téléchargés. Le format d'URI est https://objectstorage.region.oraclecloud.com/n/object-storage-namespace/b/bucket/o/filename
. Vous pouvez trouver l'URI de fichier dans la section Détails de l'objet.
Les clés de variable d'environnement de script de sortie de cycle de vie de session de bloc-notes sont les suivantes :
NB_SCRIPT_OUTPUT_LOG_NAMESPACE
NB_SCRIPT_OUTPUT_LOG_BUCKET
La stratégie IAM suivante doit être ajoutée à ces clés pour permettre à Data Science de créer et de télécharger des journaux de sortie vers le bucket 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 blocs-notes dans le même chemin que la configuration d'exécution dans le répertoire /opt/log/odsc.log
.
Le téléchargement de journal a lieu avec une opération de désactivation ou de suppression de session de bloc-notes, qui vous donne la possibilité de vérifier le statut du traitement de script car vous perdez l'accès à la session de bloc-notes. Cette option n'est pas prise en charge pour la création et l'activation de scripts.
Utilisation d'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 bloc-notes à 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.
Le service peut cloner un référentiel Git dans un répertoire local d'une session de bloc-notes, puis utiliser Git.
- Contraintes Git
-
-
Le bloc-notes doit disposer d'un accès Internet pour le référentiel Git à cloner.
-
Seuls les dépôts 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 bloc-notes
-
- Recherchez les clones des référentiels Git dans le répertoire
/home/datascience/repos
d'une session de bloc-notes. - Pour connaître le statut d'un clone, par exemple Succès, Echec ou En cours, accédez à
/opt/log/odsc.log
. - Pour les journaux en mode verbose, accédez à
/var/log/jupyterlab/runtime_config.log
.
- Recherchez les clones des référentiels Git dans le répertoire
Accédez aux journaux à partir d'un terminal dans une session de bloc-notes.
Pour une session de bloc-notes existante, désactivez cette dernière. Ensuite, lorsque vous activez le bloc-notes, ajoutez l'URL du référentiel Git dans la section Configuration d'exécution.
Si vous activez une session de classeur avec de nouvelles URL de référentiel Git, toute URL répertoriée dans la section Configuration d'exécution, y compris les URL précédentes des sessions de classeur désactivées, est également clonée vers le répertoire /home/datascience/repos
du classeur.
Pour enlever un référentiel cloné d'une session de bloc-notes, vous pouvez le supprimer du répertoire /home/datascience/repos
de la session de bloc-notes.
Pour remplacer un ancien clone d'un bloc-notes désactivé par un nouveau, supprimez l'URL du référentiel Git indésirable répertoriée dans la section Configuration d'exécution, ajoutez la nouvelle URL, puis activez la session de bloc-notes.