Commands reference

The library has a command line interface to interact with the datamesh and storage system for bulk operations and administration tasks.

Authentication to Oceanum.io

$ oceanum auth --help
Usage: oceanum auth [OPTIONS] COMMAND [ARGS]...

  Authentication commands

Options:
  --help  Show this message and exit.

Commands:
  login
  logout

Oceanum PRAX commands

Main Command

$ oceanum prax --help
Usage: oceanum prax [OPTIONS] COMMAND [ARGS]...

  Oceanum PRAX Projects Management

Options:
  --help  Show this message and exit.

Commands:
  allow      Manage resources permissions
  create     Create resources
  delete     Delete resources
  deploy     Deploy a PRAX Project Specfile
  describe   Describe resources
  list       List resources
  logs       View container logs
  resume     Resume Tasks, Pipelines and Builds runs.
  retry      Retry Tasks, Pipelines and Builds runs.
  stop       Stop Tasks, Pipelines and Builds runs.
  submit     Submit Tasks, Pipelines and Builds runs.
  terminate  Terminate Tasks, Pipelines and Builds runs.
  update     Update resources
  validate   Validate PRAX Project Specfile

Validate Project specification file

Validate project specification file

$ oceanum prax validate --help
Usage: oceanum prax validate [OPTIONS] SPECFILE

  Validate PRAX Project Specfile

Options:
  --help  Show this message and exit.

Create or update a project specification file

$ oceanum prax deploy --help
Usage: oceanum prax deploy [OPTIONS] SPECFILE

  Deploy a PRAX Project Specfile

Options:
  --name TEXT         Set the resource name
  --org TEXT          Set Project Organization
  --user TEXT         Set Project Owner email
  --wait BOOLEAN      Wait for project to be deployed
  -s, --secrets TEXT  Replace existing secret data values, i.e secret-
                      name:key1=value1,key2=value2
  --help              Show this message and exit.

Project management commands

List project specifications

$ oceanum prax list projects --help
Usage: oceanum prax list projects [OPTIONS]

  List PRAX Projects

Options:
  --search TEXT  Search by project name or description
  --status TEXT  filter by Project status
  --org TEXT     Set Project Organization
  --user TEXT    Set Project Owner email
  --help         Show this message and exit.

Describe project

$ oceanum prax describe project --help
Usage: oceanum prax describe project [OPTIONS] PROJECT_NAME

  Describe a PRAX Project

Options:
  --show-spec  Show project spec
  --only-spec  Show only project spec
  --org TEXT   Set Project Organization
  --user TEXT  Set Project Owner email
  --help       Show this message and exit.

Update project

$ oceanum prax update project --help
Usage: oceanum prax update project [OPTIONS] PROJECT_NAME

  Update Project parameters

Options:
  --org TEXT          Set Project Organization
  --user TEXT         Set Project Owner email
  --description TEXT  Update project description
  --active BOOLEAN    Update project status
  --help              Show this message and exit.

Manage project permissions

$ oceanum prax allow project --help
Usage: oceanum prax allow project [OPTIONS] PROJECT_NAME

Options:
  --org TEXT        Set Project Organization
  --user TEXT       Set Project Owner email
  -g, --group TEXT
  -u, --user TEXT
  -a, --assign      Allow to assign project permissions
  -v, --view        Allow to view the project
  -c, --change      Allow to change the project, implies --view
  -d, --delete      Allow to delete the project, implies --view and --change
  --help            Show this message and exit.

Delete project

$ oceanum prax delete project --help
Usage: oceanum prax delete project [OPTIONS] PROJECT_NAME

Options:
  --org TEXT   Set Project Organization
  --user TEXT  Set Project Owner email
  --help       Show this message and exit.

Route commands

List services and apps routes

$ oceanum prax list routes --help
Usage: oceanum prax list routes [OPTIONS]

  List PRAX Routes

Options:
  --search TEXT                   Search by route name, project_name or
                                  project description
  --org TEXT                      Organization name
  --user TEXT                     Route owner email
  --status TEXT                   Route status
  --project TEXT                  Project name
  --stage TEXT                    Stage name
  --open-access                   Show only open-access routes or private
                                  routes with False
  --tier [backend|frontend]       Select only 'frontend' or 'backend' routes
  -o, --output [table|json|yaml]  Output format
  --help                          Show this message and exit.

Describe a service or an app route

$ oceanum prax describe route --help
Usage: oceanum prax describe route [OPTIONS] ROUTE_NAME

  Describe a PRAX Service or App Route

Options:
  --help  Show this message and exit.

Update service or apps route thumbnail

$ oceanum prax update route thumbnail --help
Usage: oceanum prax update route thumbnail [OPTIONS] ROUTE_NAME THUMBNAIL_FILE

  Update a PRAX Route thumbnail

Options:
  --help  Show this message and exit.

Manage service or app access permissions

$ oceanum prax allow route --help
Usage: oceanum prax allow route [OPTIONS] ROUTE_NAME

Options:
  -g, --group TEXT
  -u, --user TEXT
  -v, --view        Allow to view the route
  -c, --change      Allow to change the route, implies --view
  -a, --assign      Allow to assign route permissions
  --help            Show this message and exit.

Pipeline commands

List pipelines

$ oceanum prax list pipelines --help
Usage: oceanum prax list pipelines [OPTIONS]

  List PRAX Pipelines

Options:
  --search TEXT                   Search by names or description
  --org TEXT                      Set Project Organization
  --user TEXT                     Set Project Owner email
  --project TEXT                  Set Project Name
  --stage TEXT                    Set Project Stage
  -o, --output [table|json|yaml]  Output format
  --help                          Show this message and exit.

Describe pipeline

$ oceanum prax describe pipeline --help
Usage: oceanum prax describe pipeline [OPTIONS] NAME

  Describe PRAX Pipeline

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Submit pipeline run

$ oceanum prax submit pipeline --help
Usage: oceanum prax submit pipeline [OPTIONS] NAME

  Submit PRAX Pipeline

Options:
  --org TEXT            Set Project Organization
  --user TEXT           Set Project Owner email
  --project TEXT        Set Project Name
  --stage TEXT          Set Project Stage
  -p, --parameter TEXT  Pipeline parameters
  --help                Show this message and exit.

Terminate Pipeline run

$ oceanum prax terminate pipeline --help
Usage: oceanum prax terminate pipeline [OPTIONS] NAME

  Terminate PRAX Pipeline

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Retry pipeline run

$ oceanum prax retry pipeline --help
Usage: oceanum prax retry pipeline [OPTIONS] NAME

  Retry PRAX Pipeline

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Task commands

List tasks

$ oceanum prax list tasks --help
Usage: oceanum prax list tasks [OPTIONS]

  List all PRAX Tasks

Options:
  --search TEXT                   Search by names or description
  --org TEXT                      Set Project Organization
  --user TEXT                     Set Project Owner email
  --project TEXT                  Set Project Name
  --stage TEXT                    Set Project Stage
  -o, --output [table|json|yaml]  Output format
  --help                          Show this message and exit.

Describe task

$ oceanum prax describe task --help
Usage: oceanum prax describe task [OPTIONS] NAME

  Describe PRAX Task

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Submit task run

$ oceanum prax submit task --help
Usage: oceanum prax submit task [OPTIONS] NAME

  Submit PRAX Task

Options:
  --org TEXT            Set Project Organization
  --user TEXT           Set Project Owner email
  --project TEXT        Set Project Name
  --stage TEXT          Set Project Stage
  -p, --parameter TEXT  Task parameters
  --help                Show this message and exit.

Terminate task run

$ oceanum prax terminate task --help
Usage: oceanum prax terminate task [OPTIONS] NAME

  Terminate PRAX Task

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Retry task run

$ oceanum prax retry task --help
Usage: oceanum prax retry task [OPTIONS] NAME

  Retry PRAX Task

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Build commands

List builds

$ oceanum prax list builds --help
Usage: oceanum prax list builds [OPTIONS]

  List all PRAX Builds

Options:
  --search TEXT                   Search by names or description
  --org TEXT                      Set Project Organization
  --user TEXT                     Set Project Owner email
  --project TEXT                  Set Project Name
  --stage TEXT                    Set Project Stage
  -o, --output [table|json|yaml]  Output format
  --help                          Show this message and exit.

Describe build

$ oceanum prax describe build --help
Usage: oceanum prax describe build [OPTIONS] NAME

  Describe PRAX Build

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Submit build run

$ oceanum prax submit build --help
Usage: oceanum prax submit build [OPTIONS] NAME

  Submit PRAX Build

Options:
  --org TEXT            Set Project Organization
  --user TEXT           Set Project Owner email
  --project TEXT        Set Project Name
  --stage TEXT          Set Project Stage
  -p, --parameter TEXT  Build parameters
  --help                Show this message and exit.

Terminate build run

$ oceanum prax terminate build --help
Usage: oceanum prax terminate build [OPTIONS] NAME

  Terminate PRAX Build

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.

Retry build run

$ oceanum prax retry build --help
Usage: oceanum prax retry build [OPTIONS] NAME

  Retry PRAX Build

Options:
  --org TEXT      Set Project Organization
  --user TEXT     Set Project Owner email
  --project TEXT  Set Project Name
  --stage TEXT    Set Project Stage
  --help          Show this message and exit.