teradata/regulus-workspaces repository overview

⁠Teradata Regulus workspaces (technical preview)

Workspaces provides a project centric deployment service for regulus clusters. Configuration is available via web UI on port 3000. Client interactions with Jupyter extentions or the workspacesctl command line tool are available via grpc on port 3282

For detailed documentation, please see here: PENDING⁠

⁠How to use this image

As workspaces will be provisioning cloud infrastructure, cloud service credentials with the appropriate permissions must be exported for use in the container.

⁠AWS

export AWS_ACCESS_KEY_ID="<AWS_ACCESS_KEY_ID>"
export AWS_SECRET_ACCESS_KEY="<AWS_SECRET_ACCESS_KEY>"

and optionally

export AWS_SESSION_TOKEN="<AWS_SESSION_TOKEN>"

If workspaces is running on an ec2 instance using an instance-profile with appropriate role permissions, they will be picked up automaticaly and exporting the variables above is not required. See the workspaces deploment documentation at PENDING⁠ for details.

⁠Start a container and persist user data on a docker-managed volume

docker volume create workspaces
docker run \
  -e "accept_license=Y" \
  -p 127.0.0.1:3000:3000/tcp \
  -p 127.0.0.1:3282:3282/tcp \
  -v workspaces:/etc/td \
  teradata/regulus-workspaces:latest

⁠Start a container and bind to an existing directory:

docker run \
  -e "accept_license=Y" \
  -p 127.0.0.1:3000:3000/tcp \
  -p 127.0.0.1:3282:3282/tcp \
  -v /path/to/my/directory:/etc/td \
  teradata/regulus-workspaces:latest

⁠This container can be run with teradata/regulus-jupyter via docker compose, see PENDING⁠ for details.

⁠Support

PENDING⁠

⁠License

By passing the value Y to the environment variable accept_license, you are expressing that you have a valid and existing license for the edition and version of the Teradata Workspaces License that you intend to use. You also agree that your use of Teradata Workspaces running in a Docker container image will be governed by the terms of the license. The Teradata Workspaces License Agreement is located here: https://github.com/Teradata/jupyterextensions/blob/master/licensefiles/license.txt⁠.