RemotiveTopology Cloud Launcher

Type: object

Describes how to launch a RemotiveTopology instance in the cloud. Lives at the root of a launcher archive as <name>.launcher.yaml, where <name> is the topology project directory name. All paths are relative to the topology project root, i.e. the directory the archive is extracted into.

 No Additional Properties

root schema
Type: const

The JSON schema version of this launcher descriptor.

Specific value: "https://files.remotivelabs.com/schemas/launcher-0.1.schema.json"

root topology_instances
Type: array

Instance files passed to remotive topology build as -f flags, in the order listed. Later files override earlier ones.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root topology_instances instance_path
Type: object

A relative path to a RemotiveTopology instance file (*.instance.yaml).

root topology_instances topology_instances items allOf relative_path
Type: string

A path relative to the topology project root. Must not be absolute and must not escape the project root.

 Must match regular expression: ^(?!/)(?!\.\.(/|$))(?!.*/\.\.(/|$)).+$

Must be at least 1 characters long

root topology_instances topology_instances items allOf item 1
Type: object
Must match regular expression: \.instance\.ya?ml$

root compose_overlays
Type: array Default: []

Extra docker compose -f overlay files applied on top of the generated docker-compose.yml, in the order listed. Empty when the topology needs no overlays.

All items must be unique

No Additional Items

Each item of this array must be:

root compose_overlays yaml_path
Type: object

A relative path to a YAML file.

root compose_overlays compose_overlays items allOf relative_path
Type: string

A path relative to the topology project root. Must not be absolute and must not escape the project root.

Same definition as topology_instances_items_allOf_i0
root compose_overlays compose_overlays items allOf item 1
Type: object
Must match regular expression: \.ya?ml$

root compose_profiles
Type: array Default: []

docker compose --profile values enabled for the long-running stack. Do NOT list the test profile here: the launcher runs test_service separately so its exit code gives the pass/fail verdict.

All items must be unique

No Additional Items

Each item of this array must be:

root compose_profiles compose_name
Type: string

A docker compose service or profile name.

 Must match regular expression: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

root test_service
Type: string

Compose service run with docker compose run <test_service> when the launcher is asked to run topology tests (runTopologyTests=true). Its exit code is the test verdict. The service is expected to sit behind a compose profile of the same name that is not part of compose_profiles.

Same definition as compose_profiles_items

root forward_ports
Type: array Default: []

Topology ports reachable during the keep-alive window.

 No Additional Items

Each item of this array must be:

root forward_ports named_port
Type: object

A TCP port on the topology host, labelled with a human-readable name. Both fields are required.

 No Additional Properties

root forward_ports forward_ports items name
Type: string

Display name used when exposing the port, e.g. as the tunnel name or the adb device label.

Must match regular expression: ^\S(.*\S)?$

Must be at least 1 characters long

root forward_ports forward_ports items port
Type: integer

A TCP port number.

Value must be greater or equal to 1 and lesser or equal to 65535

root adb_devices
Type: array Default: []

Android devices (e.g. Cuttlefish virtual devices) exposed by the topology that the launcher should connect to with adb connect on the given port, presented under the given name.

 No Additional Items

Each item of this array must be:

root adb_devices named_port
Type: object

A TCP port on the topology host, labelled with a human-readable name. Both fields are required.

Same definition as forward_ports_items