Gestion des versions de JupyterLab dans Amazon SageMaker Studio Classic

L’interface d’Amazon SageMaker Studio Classic est basée sur JupyterLab, un environnement de développement interactif basé sur le Web pour les blocs-notes, le code et les données. Studio Classic prend uniquement en charge l’utilisation de JupyterLab 3.

Si vous avez créé votre domaine et votre profil utilisateur à l’aide de la AWS Management Console avant le 31/08/2022 ou à l’aide de l’AWS Command Line Interface avant le 22/02/2023, votre instance Studio Classic est JupyterLab 1 par défaut. Depuis le 01/07/2024, vous ne pouvez plus créer d’applications Studio Classic exécutant JupyterLab 1.

JupyterLab 3

JupyterLab 3 inclut les fonctionnalités suivantes qui ne sont pas disponibles dans les versions précédentes. Pour plus d'informations sur ces fonctionnalités, consultez JupyterLab 3.0 est sorti ! (Français non garanti).

Changements importants apportés à JupyterLab 3

Tenez compte des éléments suivants lorsque vous utilisez JupyterLab 3 :

Restriction de la version de JupyterLab par défaut à l’aide d’une clé de condition de politique IAM

Vous pouvez utiliser les clés de condition de politique IAM pour limiter la version de JupyterLab que vos utilisateurs peuvent lancer.

La politique suivante montre comment limiter la version de JupyterLab au niveau du domaine.

JSON

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "BlockJupyterLab3DomainLevelAppCreation",
            "Effect": "Deny",
            "Action": [
                "sagemaker:CreateDomain",
                "sagemaker:UpdateDomain"
            ],
            "Resource": "*",
            "Condition": {
                "ForAnyValue:ArnLike": {
                    "sagemaker:ImageArns": "arn:aws:sagemaker:us-east-1:111122223333:image/jupyter-server-3"
                }
            }
        }
    ]
}

La politique suivante montre comment limiter la version de JupyterLab au niveau du profil utilisateur.

JSON

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "BlockUsersFromCreatingJupyterLab3Apps",
            "Effect": "Deny",
            "Action": [
                "sagemaker:CreateUserProfile",
                "sagemaker:UpdateUserProfile"
            ],
            "Resource": "*",
            "Condition": {
                "ForAnyValue:ArnLike": {
                    "sagemaker:ImageArns": "arn:aws:sagemaker:us-east-1:111122223333:image/jupyter-server-3"
                }
            }
        }
    ]
}

La politique suivante montre comment limiter la version de JupyterLab au niveau de l’application. La demande CreateApp doit inclure l'ARN de l'image pour que cette politique s'applique.

JSON

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "BlockJupyterLab3AppLevelAppCreation",
            "Effect": "Deny",
            "Action": "sagemaker:CreateApp",
            "Resource": "*",
            "Condition": {
                "ForAnyValue:ArnLike": {
                    "sagemaker:ImageArns": "arn:aws:sagemaker:us-east-1:111122223333:image/jupyter-server-3"
                }
            }
        }
    ]
}

Définition d’une version de JupyterLab par défaut

Les sections suivantes montrent comment définir une version par défaut de JupyterLab pour Studio Classic à l’aide de la console ou de l’AWS CLI. 

À partir de la console

Vous pouvez sélectionner la version par défaut de JupyterLab à utiliser au niveau du domaine ou du profil utilisateur lors de la création de la ressource. Pour définir la version par défaut de JupyterLab à l'aide de la console, consultez Présentation du domaine Amazon SageMaker AI. 

À partir de l'interface AWS CLI

Vous pouvez sélectionner la version par défaut de JupyterLab à utiliser au niveau du domaine ou du profil utilisateur à l'aide de l'interface AWS CLI. 

Pour définir la version par défaut de JupyterLab à l’aide de l’interface AWS CLI, vous devez inclure l’ARN de la version par défaut de JupyterLab souhaitée dans le cadre d’une commande AWS CLI. Cet ARN diffère en fonction de la version et de la région du domaine SageMaker AI. 

Le tableau suivant répertorie les ARN des versions disponibles de JupyterLab pour chaque région :

Création ou mise à jour d’un domaine

Vous pouvez définir une version par défaut de JupyterServer au niveau du domaine en invoquant CreateDomain ou UpdateDomain et en passant le champ UserSettings.JupyterServerAppSettings.DefaultResourceSpec.SageMakerImageArn.

L'exemple suivant montre comment créer un domaine avec JupyterLab 3 par défaut, à l'aide de l'interface AWS CLI :

aws --region <REGION> \
sagemaker create-domain \
--domain-name <NEW_DOMAIN_NAME> \
--auth-mode <AUTHENTICATION_MODE> \
--subnet-ids <SUBNET-IDS> \
--vpc-id <VPC-ID> \
--default-user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

L'exemple suivant montre comment mettre à jour un domaine pour utiliser JupyterLab 3 par défaut, à l'aide de l'interface AWS CLI :

aws --region <REGION> \
sagemaker update-domain \
--domain-id <YOUR_DOMAIN_ID> \
--default-user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

Création ou mise à jour d'un profil utilisateur

Vous pouvez définir une version par défaut de JupyterServer au niveau du profil utilisateur en invoquant CreateUserProfile ou UpdateUserProfile et en passant le champ UserSettings.JupyterServerAppSettings.DefaultResourceSpec.SageMakerImageArn.

L'exemple suivant montre comment créer un profil utilisateur avec JupyterLab 3 par défaut sur un domaine existant, à l'aide de l'interface AWS CLI :

aws --region <REGION> \
sagemaker create-user-profile \
--domain-id <YOUR_DOMAIN_ID> \
--user-profile-name <NEW_USERPROFILE_NAME> \
--query UserProfileArn --output text \
--user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

L’exemple suivant montre comment mettre à jour un profil utilisateur pour utiliser JupyterLab 3 par défaut, à l’aide de l’interface AWS CLI :

aws --region <REGION> \
sagemaker update-user-profile \
 --domain-id <YOUR_DOMAIN_ID> \
 --user-profile-name <EXISTING_USERPROFILE_NAME> \
--user-settings '{
  "JupyterServerAppSettings": {
    "DefaultResourceSpec": {
      "SageMakerImageArn": "arn:aws:sagemaker:<REGION>:<ACCOUNT_ID>:image/jupyter-server-3",
      "InstanceType": "system"
    }
  }
}'

Affichage et mise à jour de la version de JupyterLab d'une application depuis la console

L’exemple suivant montre comment afficher et mettre à jour la version de JupyterLab d’une application.

Installation d’extensions JupyterLab et Jupyter Server

Dans JupyterLab 3, vous devez activer l’environnement conda de studio avant d’installer les extensions. La méthode utilisée pour cela diffère si vous installez les extensions depuis Studio Classic ou en utilisant un script de configuration du cycle de vie.

Installation d’extensions depuis Studio Classic

Pour installer des extensions depuis Studio Classic, vous devez activer l’environnement studio avant d’installer les extensions.

# Before installing extensions
conda activate studio

# Install your extensions
pip install <JUPYTER_EXTENSION>

# After installing extensions
conda deactivate

Installation d’extensions à l’aide d’un script de configuration du cycle de vie

Si vous installez les extensions JupyterLab et Jupyter Server dans votre script de configuration de cycle de vie, vous devez modifier votre script pour qu’il fonctionne avec JupyterLab 3. Les sections suivantes présentent le code nécessaire pour les scripts existant et nouveau de configuration de cycle de vie.

Script existant de configuration de cycle de vie

Si vous réutilisez un script existant de configuration de cycle de vie qui doit fonctionner avec les deux versions de JupyterLab, utilisez le code suivant dans votre script :

# Before installing extension
export AWS_SAGEMAKER_JUPYTERSERVER_IMAGE="${AWS_SAGEMAKER_JUPYTERSERVER_IMAGE:-'jupyter-server'}"
if [ "$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE" = "jupyter-server-3" ] ; then
   eval "$(conda shell.bash hook)"
   conda activate studio
fi;

# Install your extensions
pip install <JUPYTER_EXTENSION>


# After installing extension
if [ "$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE" = "jupyter-server-3" ]; then
   conda deactivate
fi;

Nouveau script de configuration de cycle de vie

Si vous écrivez un nouveau script de configuration du cycle de vie qui utilise uniquement JupyterLab 3, vous pouvez utiliser le code suivant dans votre script :

# Before installing extension
eval "$(conda shell.bash hook)"
conda activate studio


# Install your extensions
pip install <JUPYTER_EXTENSION>


conda deactivate