Developer Reference¶

Architecture¶

REST API Reference¶

Rendered documentation for SuperMaaS’ REST API can be found here; an interactive version can also be found at the /api/ endpoint of any running SuperMaaS deployment.

Command-Line Client¶

supermaasctl¶

SuperMaaS Command-Line Client

usage: supermaasctl [-h] [-u USER_HANDLE] [-d DEPLOYMENT] RESOURCE ...

-h, --help¶: show this help message and exit

-u <user_handle>, --user-handle <user_handle>¶: User handle for a running SuperMaaS deployment

-d <deployment>, --deployment <deployment>¶: URI of the SuperMaaS deployment

supermaasctl job¶

usage: supermaasctl job [-h] ACTION ...

-h, --help¶: show this help message and exit

supermaasctl job list¶

usage: supermaasctl job list [-h]

-h, --help¶: show this help message and exit

supermaasctl model¶

usage: supermaasctl model [-h] ACTION ...

-h, --help¶: show this help message and exit

supermaasctl model build¶

usage: supermaasctl model build [-h] [-a ARCHETYPE] build_path

build_path¶: Path to model build directory.

-h, --help¶: show this help message and exit

-a <archetype>, --archetype <archetype>¶: Model build archetype

supermaasctl model list¶

usage: supermaasctl model list [-h]

-h, --help¶: show this help message and exit

supermaasctl model push¶

usage: supermaasctl model push [-h] URL definition archive

url¶: The URL to push to.

definition¶: The .spdef file to push.

archive¶: The .sparc file to push.

-h, --help¶: show this help message and exit

supermaasctl pipeline¶

usage: supermaasctl pipeline [-h] ACTION ...

-h, --help¶: show this help message and exit

supermaasctl pipeline events¶

usage: supermaasctl pipeline events [-h] [-f] pipeline_id

pipeline_id¶: ID of pipeline to retrieve events for.

-h, --help¶: show this help message and exit

-f, --follow¶: Keep listening for events

supermaasctl pipeline list¶

usage: supermaasctl pipeline list [-h]

-h, --help¶: show this help message and exit

supermaasctl pipeline submit¶

usage: supermaasctl pipeline submit [-h] [-v]
                                    [-f {indefinitely,until-complete}]
                                    definition

definition¶: Path to pipeline definition

-h, --help¶: show this help message and exit

-v, --validate-only¶: Only validate the pipeline, do not run it.

-f {indefinitely,until-complete}, --follow {indefinitely,until-complete}¶

supermaasctl user¶

usage: supermaasctl user [-h] ACTION ...

-h, --help¶: show this help message and exit

supermaasctl user create¶

usage: supermaasctl user create [-h] handle name

handle¶: The user handle to use in credentialed API endpoints.

name¶: The display name to use in messages/notifications.

-h, --help¶: show this help message and exit

supermaasctl user list¶

usage: supermaasctl user list [-h]

-h, --help¶: show this help message and exit

SuperMaaS Packs¶

A SuperMaaS pack is an on-disk representation of a registerable artifact. At minimum a pack consists of a pack definition file (with a .spdef extension) which stores metadata about the artifact in question. Most kinds of packs also require an accompanying pack archive file (with a .sparc extension), which stores the artifact’s data files, which are fetched as necessary.

The schemas of pack definitions (and the layouts of the corresponding archive files) are subject to change over time, as newer capabilities are added to SuperMaaS. Compatibility with older versions of pack definitions are maintained on a best-effort basis. The schema for the current version of pack definition is shown below: