Skip to content

systemslab submit

Description Submit an experiment to be run by SystemsLab
Usagesystemslab submit [OPTIONS] <SPEC>

Description

The systemslab submit command submits a new experiment to be run by the requested SystemsLab server. The experiment is specified by an experiment specification file.

Experiment Specification

The experiment specification file describes the steps that will be taken to perform the experiment: what jobs are run, what steps each of them runs, and where they can be scheduled. The experiment specification can be written in json, yaml, or jsonnet. Which one is loaded will depend on the extension of the provided file. If the path does not have an extension then yaml will be assumed.

See the experiment specification reference for documentation of the JSON object that the experiment specification file should expand to.

Options

OptionDefaultDescription
-n, --nameThe name of this experiment.
--tail Wait for the experiment to complete and its log messages in the meantime.
-p, --param Pass a parameter to use when evaluating the experiment specification. If --context is specified, then the parameter value will also be recorded within the context.
--context Attach this experiment to the provided context.
--jpath Add an extra include path to use when resolving jsonnet imports.
--jsonnet-max-stack200 Limit the recursion depth that the jsonnet vm is allowed to reach when evaluating jsonnet files.

Common Options

OptionDefaultDescription
--systemslab-url The URL at which to access the systemslab server.
--colorauto Controls when color is used in the output. Possible values are auto, always, and never.
--output-formatlong Output format to use when outputting messages. long will result output designed to be human-readable while short is short output meant to be used within scripts.

Environment Variables

VariableDescription
SYSTEMSLAB_URLSpecify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url.