[DEPRECATED] Sagemaker Studio Docker UI Extension - UI to manage Docker integration for SageMaker Studio

Refer to new Local Mode by SageMaker service for recommended alternative This JupyterLab extension interacts with docker hosts and SageMaker Studio Docker CLI to provide customers with interactive UI to launch and manage docker hosts from within SageMaker Studio.

This extension is composed of a Python package named sagemaker-studio-docker-ui for the server extension and a NPM package named sagemaker-studio-docker-ui for the frontend extension.

Requirements

• Requires SageMaker Studio Docker CLI Extension to be installed.
• Compatible with JupyterServer running Jupyter Lab v1.0 or v3.0

Installation Steps

Use Studio LifeCycle configuration and attach it to JupyterServer app.

#!/bin/bash

set -eux

cd ~
if cd sagemaker-studio-docker-cli-extension
then
    git reset --hard
    git pull
else
    git clone https://github.com/aws-samples/sagemaker-studio-docker-cli-extension.git
    cd sagemaker-studio-docker-cli-extension
fi
nohup ./setup.sh > docker_setup.out 2>&1 &

if cd ~/sagemaker-studio-docker-ui-extension
then
    git reset --hard
    git pull
    cd
else
    cd
    git clone https://github.com/aws-samples/sagemaker-studio-docker-ui-extension.git
fi

nohup ~/sagemaker-studio-docker-ui-extension/setup.sh > docker_setup.out 2>&1 &

Setting up proxy

To setup a proxy through environment variables, use either /home/sagemaker/.bash_profile or /home/sagemaker/.bashrc to set any required environment variables. This extension will make sure to source one of these files if it was able to detect them before running any CLI commands.

Below is an example of a script you can use in your life cycle configuration:

# Required to enable yum access proxy for JupyterServer App
sudo bash -c "echo proxy=<proxy server>:<port> >> /etc/yum.conf"

# Required to enable both CLI and UI extension to access proxy for JupyterServer or KernelGateway
cat > ~/.bash_profile << EOF
export http_proxy=<proxy server>:<port>
export https_proxy=<proxy server>:<port>
export HTTPS_PROXY=<proxy server>:<port>
export HTTP_PROXY=<proxy server>:<port>
export NO_PROXY=127.0.0.1,localhost,169.254.169.254,.ec2.internal
export no_proxy=127.0.0.1,localhost,169.254.169.254,.ec2.internal
EOF

source ~/.bash_profile

# Required for installing docker on JupyterServer
sudo -u root bash -c "cat > /root/.bash_profile << EOF
export http_proxy=<proxy server>:<port>
export https_proxy=<proxy server>:<port>
export HTTPS_PROXY=<proxy server>:<port>
export HTTP_PROXY=<proxy server>:<port>
export NO_PROXY=127.0.0.1,localhost,169.254.169.254,.ec2.internal
export no_proxy=127.0.0.1,localhost,169.254.169.254,.ec2.internal
EOF"

Troubleshooting

This extension logs its activity to /home/sagemaker-user/.sagemaker_studio_docker_cli/ui_extension.log

Security

See CONTRIBUTING for more information.

License

This project is licensed under the MIT-0 License.