Merge pull request #26 from absynthe/main

Created a script for disabling automatic start of notebook kernels

Author: durgasury

README.md

@@ -12,6 +12,7 @@ Lifecycle Configurations provide a mechanism to customize the Jupyter Server and
 * [install-autoshutdown-server-extension](scripts/install-autoshutdown-server-extension) (Recommended) - Installs only the server part of idle-kernel shutdown extension. No external dependencies to install, recommended to use in VPCOnly mode with restricted Internet connectivity. Idle timelimit has to be set using Life Cycle Configuration script.
 * [install-autoshutdown-extension](scripts/install-autoshutdown-extension) - Installs the auto idle-kernel shutdown extension on the Jupyter Server. This install allows users to set idle timeout limit using the UI. ***Note***: *The UI plugin is only compatible with JupyterLab v1.0. See [JupyterLab versioning](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jl.html) for JupyterLab versions in SageMaker Studio.*
 * [install-lsp-features](scripts/install-lsp-features) - Installs coding assistance tools to enable features like auto-completion, linting, and hover suggestions in Studio JupyterLab v3+.
+* [disable-automatic-kernel-start](disable-automatic-kernel-start) - Disables automatic starting of kernel when opening notebooks. Only works with Studio JupyterLab v3.3+.
 * [install-pip-package-on-kernel](scripts/install-pip-package-on-kernel) - Installs a python package with pip on a Studio Kernel
 * [set-git-config](scripts/set-git-config) - This script sets the username and email address in Git config.
 * [set-git-credentials](scripts/set-git-credentials) - Adds the user's git credentials to Secret Manager and configures git to fetch the credentials from there when needed

scripts/disable-automatic-kernel-start/on-jupyter-server-start.sh

@@ -0,0 +1,21 @@
+# This script configures page settings for your Jupyter Server in order to disable automatic startup of kernels on notebook access.
+
+#!/bin/bash
+ 
+set -eux
+
+export AWS_SAGEMAKER_JUPYTERSERVER_IMAGE="${AWS_SAGEMAKER_JUPYTERSERVER_IMAGE:-'jupyter-server'}"
+if [ "$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE" != "jupyter-server-3" ] ; then
+    echo "SageMaker version '$AWS_SAGEMAKER_JUPYTERSERVER_IMAGE' does not match 'jupyter-server-3'"
+    echo "Skipping install (which depends on JupyterLab v3)"
+    exit 0
+fi
+
+echo "Creating Jupyter page config."
+mkdir -p ~/.jupyter/labconfig
+touch ~/.jupyter/labconfig/page_config.json
+echo {\"notebookStartsKernel\": false} > ~/.jupyter/labconfig/page_config.json
+
+# Restart Jupyter to make sure configuration is picked up
+echo "Restarting Jupyter server..."
+restart-jupyter-server