Getting Started


For Admins


For Users


Plugins


SSO Provider Integration


Development


Testing


Usage

orbit [OPTIONS] COMMAND [ARGS]…

Options

--help  Show this message and exit.

Commands

build    Build images,profiles,etc in your Orbit Workbench.
delete   Delete images,profiles,etc in your Orbit Workbench.
deploy   Deploy foundation,env,teams in your Orbit Workbench.
destroy  Destroy foundation,env,etc in your Orbit Workbench.
init     Creates a Orbit Workbench manifest model file (yaml) where all…
list     List images,profiles,etc in your Orbit Workbench.
run      Execute containers in the Orbit environment

Commands

build

Build images,profiles,etc in your Orbit Workbench.

Usage:

build [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

image

Build and Deploy a new Docker image into ECR.

Usage:

build image [OPTIONS]

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -d, --dir TEXT        Dockerfile directory.  [required]
  -n, --name TEXT       Image name.  [required]
  -s, --script TEXT     Build script to run before the image build.
  -t, --team TEXT       One or more Teams to deploy the image to (can de
                        declared multiple times).

  --build-arg TEXT      One or more --build-arg parameters to pass to the
                        Docker build command.

  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

profile

Build and Deploy a new Docker image into ECR.

Usage:

build profile [OPTIONS] PROFILE

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -t, --team TEXT       Orbit Team.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

delete

Delete images,profiles,etc in your Orbit Workbench.

Usage:

delete [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

image

Destroy a Docker image from ECR.

Usage:

delete image [OPTIONS]

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -n, --name TEXT       Image name.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

profile

Build and Deploy a new Docker image into ECR.

Usage:

delete profile [OPTIONS]

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -t, --team TEXT       Orbit Team.  [required]
  -p, --profile TEXT    Profile name to delete  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

deploy

Deploy foundation,env,teams in your Orbit Workbench.

Usage:

deploy [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

env

Deploy a Orbit Workbench environment based on a manisfest file (yaml).

Usage:

deploy env [OPTIONS]

Options:

  -f, --filename TEXT             The target Orbit Workbench manifest file
                                  (yaml).

  -u, --username TEXT             Dockerhub username (Required only for the
                                  first deploy).

  -p, --password TEXT             Dockerhub password (Required only for the
                                  first deploy).

  --skip-images / --no-skip-images
                                  Skip Docker images updates (Usually for
                                  development purpose).  [default: False]

  --debug / --no-debug            Enable detailed logging.  [default: False]
  --help                          Show this message and exit.

foundation

Deploy a Orbit Workbench foundation based on a manisfest file (yaml).

Usage:

deploy foundation [OPTIONS]

Options:

  -f, --filename TEXT             The target Orbit Workbench manifest file
                                  (yaml).

  -n, --name TEXT                 The Name of the Orbit Foundation deployment
  -u, --username TEXT             Dockerhub username (Required only for the
                                  first deploy).

  -p, --password TEXT             Dockerhub password (Required only for the
                                  first deploy).

  --codeartifact-domain TEXT      CodeArtifact Domain to pull packages from.
  --codeartifact-repository TEXT  CodeArtifact Repository to pull packages
                                  from.

  --internet-accessiblity / --no-internet-accessiblity
                                  Configure for deployment to Private
                                  (internet accessiblity) or Isolated (no
                                  internet accessibility) subnets.  [default:
                                  True]

  --debug / --no-debug            Enable detailed logging.  [default: False]
  --help                          Show this message and exit.

teams

Deploy a Orbit Workbench environment based on a manisfest file (yaml).

Usage:

deploy teams [OPTIONS]

Options:

  -f, --filename TEXT   The target Orbit Workbench manifest file (yaml).
  -u, --username TEXT   Dockerhub username (Required only for the first
                        deploy).

  -p, --password TEXT   Dockerhub password (Required only for the first
                        deploy).

  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

destroy

Destroy foundation,env,etc in your Orbit Workbench.

Usage:

destroy [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

env

Destroy a Orbit Workbench environment based on a manisfest file (yaml).

Usage:

destroy env [OPTIONS]

Options:

  -e, --env TEXT        Destroy Orbit Environment.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

foundation

Destroy a Orbit Workbench environment based on a manisfest file (yaml).

Usage:

destroy foundation [OPTIONS]

Options:

  -n, --name TEXT       Destroy Orbit Foundation.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

teams

Destroy a Orbit Workbench environment based on a manisfest file (yaml).

Usage:

destroy teams [OPTIONS]

Options:

  -e, --env TEXT        Destroy Orbit Teams.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

init

Creates a Orbit Workbench manifest model file (yaml) where all your deployment settings will rest.

Usage:

init [OPTIONS]

Options:

  -n, --name TEXT                 The name of the Orbit Workbench enviroment.
                                  MUST be unique per AWS account.  [default:
                                  my-env]

  -r, --region TEXT               AWS Region name (e.g. us-east-1). If None,
                                  it will be infered.

  --foundation / --no-foundation  Create Orbit foundation default manifest.
                                  [default: True]

  --debug / --no-debug            Enable detailed logging.  [default: False]
  --help                          Show this message and exit.

list

List images,profiles,etc in your Orbit Workbench.

Usage:

list [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

env

List all Docker images available into the target environment.

Usage:

list env [OPTIONS]

Options:

  --debug / --no-debug            Enable detailed logging.  [default: False]
  --variable [all|landing-page|teams|toolkitbucket]
                                  [default: all]
  --help                          Show this message and exit.

image

List all Docker images available into the target environment.

Usage:

list image [OPTIONS]

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -r, --region TEXT     AWS Region name (e.g. us-east-1). If None, it will be
                        infered.

  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

profile

Build and Deploy a new Docker image into ECR.

Usage:

list profile [OPTIONS]

Options:

  -e, --env TEXT        Orbit Environment.  [required]
  -t, --team TEXT       Orbit Team.  [required]
  --debug / --no-debug  Enable detailed logging.  [default: False]
  --help                Show this message and exit.

run

Execute containers in the Orbit environment

Usage:

run [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

notebook

Run notebook in a container

Usage:

run notebook [OPTIONS] INPUT

Options:

  -e, --env TEXT                Orbit Environment to execute container in.
                                [required]

  -t, --team TEXT               Orbit Team Space to execute container in.
                                [required]

  -u, --user TEXT               Jupyter user to execute container as.
                                [default: jovyan]

  --wait / --no-wait            Wait for execution to complete.  [default:
                                False]

  --delay INTEGER               If --wait, this is the number of seconds to
                                sleep between container state checks.

  --max-attempts INTEGER        If --wait, this is the number of times to
                                check container state before failing.

  --tail-logs / --no-tail-logs  If --wait, print a tail of container logs
                                after execution completes.  [default: False]

  --debug / --no-debug          Enable detailed logging.  [default: False]
  --help                        Show this message and exit.

python

Run python script in a container

Usage:

run python [OPTIONS] INPUT

Options:

  -e, --env TEXT                Orbit Environment to execute container in.
                                [required]

  -t, --team TEXT               Orbit Team Space to execute container in.
                                [required]

  -u, --user TEXT               Jupyter user to execute container as.
                                [default: jovyan]

  --wait / --no-wait            Wait for execution to complete.  [default:
                                False]

  --delay INTEGER               If --wait, this is the number of seconds to
                                sleep between container state checks.

  --max-attempts INTEGER        If --wait, this is the number of times to
                                check container state before failing.

  --tail-logs / --no-tail-logs  If --wait, print a tail of container logs
                                after execution completes.  [default: False]

  --debug / --no-debug          Enable detailed logging.  [default: False]
  --help                        Show this message and exit.