schema.adoc

ChRIS Configuration YAML Spec

Table of Contents

• File Specification
  • version
  • on
  • cube
• Common Types
  • User

A ChRIS configuration file is a YAML file which describes the state of a ChRIS system.

File Specification

Not all fields are required. Most of them can be guessed or inferred.

version

Type: Literal[1.1]

on

Information about the ChRIS system.

on.cube_url

Type: string

URL of ChRIS backend.

on.chris_superuser

Type: User

Admin user of ChRIS backend, i.e. user who is able to register plugins to ChRIS.

on.public_store

Type: list[string]

Default: [https://cube.chrisproject.org/api/v1/]

Specify public instance(s) of ChRIS stores from where to get plugins from.

cube

ChRIS backend description.

cube.users

Type: list[User]

cube.compute_resource

Type: list[ComputeResource]

cube.compute_resource[*] (ComputeResource)

cube.compute_resource[*].name

Type: string

cube.compute_resource[*].url

Type: string

cube.compute_resource[*].username

Type: string

cube.compute_resource[*].password

Type: string

cube.compute_resource[*].description

Type: string

cube.compute_resource[*].innetwork

Type: bool

cube.plugins

Type: list[string | Plugin]

If value is a string, then it may represent any of: peer CUBE plugin url, plugin name, image tag, code repository URL.

cube.plugins[*].url

Type: str

A peer CUBE plugin URL, e.g. https://cube.chrisproject.org/api/v1/plugins/99/

cube.plugins[*].name

Type: str

Name of a plugin in a peer CUBE, e.g. pl-dircopy

cube.plugins[*].version

Type: str

Version of plugin, e.g. 1.0.0

cube.plugins[*].dock_image

Type: str

Container image manifest, e.g. docker.io/fnndsc/pl-dircopy:latest

cube.plugins[*].public_repo

Type: str

URL of a source code repository, e.g. https://github.com/FNNDSC/pl-dircopy

cube.plugins[*].compute_resource

Type: list[str]

Names of which compute environments to register this plugin to.

If unspecified, use cube.compute_resource[0].

cube.pipelines

Type: list[string | Pipeline]

cube.pipelines[*] (Pipeline)

If an element of cube.pipelines is a string, then it is interpreted as a PipelineSource.

cube.pipelines[*].src (PipelineSource)

A PipelineSource is one of:

• A ChRIS store pipeline, e.g. https://cube.chrisproject.org/api/v1/pipelines/1/

• A URI (starting with http://, https://, ipfs://, …​) of a JSON pipeline description.

• A path on the local filesystem to a JSON pipeline description.

The JSON pipeline description may specify its plugin_tree as either a serialized string or an object.

cube.pipelines[*].owner

Type: str

Username of ChRIS user defined in cube.users which owns this pipeline. If not specified, then the default is cube.users[0].

Common Types

User

An object {username: string, password: string}