aws-orbit-workbench

(★ 147)

A Data Platform built for AWS, powered by Kubernetes.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - config.yaml
  - feature_request.md
  - issue_template_simple.md
- - jupyterlab-extensions.yml
  - static-checking.yml
- CODEOWNERS
- PULL_REQUEST_TEMPLATE.md
- - __init__.py
  - __main__.py
  - __metadata__.py
  - bundle.py
  - cdk.py
  - cleanup.py
  - docker.py
  - exceptions.py
  - k8s.py
  - messages.py
  - py.typed
  - remote.py
  - sh.py
  - toolkit.py
  - utils.py
- - index.md
- .gitignore
- fix.sh
- LICENSE
- MANIFEST.in
- mkdocs.yml
- NOTICE
- pyproject.toml
- README.md
- remote-requirements.txt
- requirements-dev.in
- requirements-dev.txt
- requirements.txt
- setup.cfg
- setup.py
- update_repo.sh
- validate.sh
- VERSION
- - components.drawio
  - env.drawio
  - team-space.drawio
- Okta.md
- orbit.svg
- - .dockerignore
  - .gitignore
  - bashrc
  - build.sh
  - bundle.sh
  - conda_bashrc.sh
  - Dockerfile
  - fix.sh
  - jupyter_server_config.py
  - pyproject.toml
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - toolkit_helper.json
  - validate.sh
  - VERSION
- - deploy.sh
  - Dockerfile
  - VERSION
- - build_image.sh
  - build_inventory.sh
  - Dockerfile
  - extra_images.txt
  - image_inventory.txt
  - toolkit_helper.json
  - VERSION
- - .dockerignore
  - Dockerfile
  - fix.sh
  - pull_docker.sh
  - README
  - toolkit_helper.json
  - validate.sh
  - VERSION
- - jupyterlab_orbit.json
- - __init__.py
  - _version.py
  - url_router.py
- - catalog.tsx
  - compute.tsx
  - containers.tsx
  - index.ts
  - storage.tsx
  - team.tsx
  - tests.tsx
- - base.css
  - index.css
  - index.js
- .eslintignore
- .eslintrc.js
- .gitignore
- .prettierignore
- .prettierrc
- install.json
- MANIFEST.in
- package.json
- pyproject.toml
- README.md
- requirements-dev.in
- requirements-dev.txt
- requirements.txt
- setup.cfg
- setup.py
- tsconfig.json
- VERSION
- yarn.lock
- - orbit1.jpg
  - orbit1.png
  - orbit2.jpg
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - .gitignore
  - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - .gitignore
  - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- - fix.sh
  - MANIFEST.in
  - pyproject.toml
  - requirements-dev.in
  - requirements-dev.txt
  - requirements.txt
  - setup.cfg
  - setup.py
  - validate.sh
  - VERSION
- copy_samples.sh
- clean_buckets.py
- download_demo_data.py
- fix_confs.sh
- fix_plugins.sh
- generate_cli_wiki.sh
- init_codeartifact.sh
- init_sample_manifests.sh
- install_kubeview.sh
- orbit_launcher.sh
- prep_build_from_source.sh
- run-viewer.sh
- set_jupyter_user_pip_conf.sh
- sync_sample_resources.sh
- update_repo.sh
- upgrade_pip_packages.sh
- vars
- - __init__.py
  - common.py
  - controller.py
  - database.py
  - emr.py
  - glue_catalog.py
  - json.py
  - transformations.py
- fix.sh
- LICENSE
- MANIFEST.in
- NOTICE
- pyproject.toml
- README.md
- requirements-dev.in
- requirements-dev.txt
- requirements.txt
- setup.cfg
- setup.py
- update_repo.sh
- validate.sh
- VERSION
- - common_utils.py
  - custom_resources.py
  - pytest.ini
  - test_lake_admin.py
  - test_lake_creator.py
  - test_lake_creator_cleaner.py
  - test_lake_user.py
  - test_poddefault.py
  - test_userspace.py
- efs-utils.conf
- pyproject.toml
- setup.cfg
- add_user.py
- buildspec.yaml
- prep_trial.sh
- README
- trial_pipeline_cfn.yaml
.gitignore
CHANGELOG.md
cli-buildspec.yaml
CONTRIBUTING.md
demo_pipeline.yaml
deployment-role.yaml
LICENSE
NOTICE
README.md
release-requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/awslabs/aws-orbit-workbench

Downloads the entire project code from GitHub to your computer.

cd aws-orbit-workbench

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f images/jupyter-user/Dockerfile -t aws-orbit-workbench .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 aws-orbit-workbench

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd jupyterlab_orbit

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r cli/aws_orbit/remote_files/cdk/lambda_sources/cognito_post_authentication/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

✅ If it runs without errors and prints output in the terminal, it worked.