captnbp / workspace-configs

workspace-configs

Usage

In your docker file, you are going to want to download this repo and then use the install scripts for the notebooks you'd like to use. Make sure you using the latest tag/release (e.g. 2021q1-v1 in the example). Do not use the develop branch.

# Note: Make sure you are using the latest release if you'd like the latest version of the workspaces
# https://github.com/dominodatalab/workspace-configs/releases/latest
RUN mkdir -p /var/opt/workspaces && cd /tmp && \
    wget https://github.com/dominodatalab/workspace-configs/archive/2021q1-v1.zip && \
    unzip 2021q1-v1.zip && \
    cp -Rf workspace-configs-2021q1-v1/* /var/opt/workspaces && \
    rm -rf /var/opt/workspaces/workspace-logos /var/opt/workspaces/README.md && \
    rm -rf /tmp/workspace-configs-2021q1-v1 /tmp/2021q1-v1.zip

# Or you can also use the latest un-released changes from this repo
RUN mkdir -p /var/opt/workspaces && cd /tmp && \
    wget https://github.com/dominodatalab/workspace-configs/archive/refs/heads/develop.zip && \
    unzip develop.zip && \
    cp -Rf workspace-configs-develop/* /var/opt/workspaces && \
    rm -rf /var/opt/workspaces/workspace-logos /var/opt/workspaces/README.md && \
    rm -rf /tmp/workspace-configs-develop /tmp/develop.zip

Add the desired workspaces to your Dockerfile instructions:

# Install Jupyter from workspaces
RUN chmod +x /var/opt/workspaces/jupyter/install && /var/opt/workspaces/jupyter/install

# Install Jupyter Lab from workspaces
RUN chmod +x /var/opt/workspaces/Jupyterlab/install && /var/opt/workspaces/Jupyterlab/install

# Install R Studio from workspaces
RUN chmod +x /var/opt/workspaces/rstudio/install && /var/opt/workspaces/rstudio/install

# Install ttyd Terminal from workspaces
RUN chmod +x /var/opt/workspaces/ttyd/install && /var/opt/workspaces/ttyd/install

# Install VS Code from workspaces
RUN chmod +x /var/opt/workspaces/vscode/install && /var/opt/workspaces/vscode/install

# Install H2O Flow from workspaces
RUN chmod +x /var/opt/workspaces/h2o/install && /var/opt/workspaces/h2o/install

# Install Zeppelin from workspaces
RUN chmod +x /var/opt/workspaces/Zeppelin/install && /var/opt/workspaces/Zeppelin/install

Add the properties.yaml to Pluggable Workspace Tools.
Workspace Properties:

• Jupyter
• Jupyter Lab
• R Studio
• ttyd Terminal
• VS Code
• H2O Flow
• Zeppelin

Project Structure

Create a directory for each workspace application -- e.g. jupyter, rstudio.

In that directory, create these files:

1. install - A Bash script for installing the application and its required packages, and for adding static configuration files.
   This script will be executed as root when building the Docker image for the environment that will offer this workspace application.

2. init - An optional Bash script for configuring the workspace application just before it starts. For instance, for creating a customized configuration file from a template, using environment variables.
   This script will be executed as root in the post-setup script of a Domino run, when launching an workspace, so it will have access to write to any file.

3. start - A Bash script for launching the workspace application. This script must start the application's web server and block until that process is terminated.
   It will be executed as a regular user as part of the run launch command.

4. properties.yaml - This is a text file in YAML format specifying the Domino configuration properties for launching instances of this workspace.

5. etc/ - An optional directory containing any additional files that are required by the scripts mentioned above. For instance, configuration files, or templates for generating configuration files.

Make all of bash scripts files executable:

chmod +x install start start