To use the new features in the refactored dispatcher, a new submission format was required and as YAML supports comments, it was decided to adopt YAML as the new format.
Online YAML Parser.
The submission format schema has not been created, so the detail may change and errors in the content might not be picked up by the code, so take care when preparing new files.
Warning
This code is in ongoing development and the formats may change without notice. Only a very restricted set of actions and device types are supported. The refactored code can only be used from the command line and requires sudo access on the dispatcher. No-one except LAVA developers should be expecting to use any of these files.
The basic structure of the submission YAML is:
The parameters for a job must include:
Other parameters commonly supported include:
device_type: kvm
job_name: kvm-pipeline
job_timeout:
minutes: 15 # timeout for the whole job (default: ??h)
action_timeout:
minutes: 5 # default timeout applied for each action; can be overriden in the action itself (default: ?h)
priority: medium
In YAML, a list has a name, then a colon then an indented set of items, each of which is preceded by a hyphen:
actions:
- deploy:
Within a single action, like deploy, the parameters for that action are expressed as a hash (or dict in python terminology). In YAML, this is presented as an indented block of lines without a preceding hyphen.
actions:
- deploy:
timeout:
minutes: 20
to: tmpfs
image: http://images.validation.linaro.org/kvm-debian-wheezy.img.gz
os: debian
This stanza describes a deployment strategy where the timeout for the entire deployment action is 20 minutes, the deployment happens to tmpfs (it is up to the python code for the strategy to work out what this means or fail the validation of the pipeline). The deployment uses an image and the deployment data to be used is that for a Debian system.
As the refactoring proceeds, other media can be supported in the to instruction and other deployment types can be supported apart from image. The final schema will need to express the available values for deployment strategies, boot strategies and test strategies. A new strategy will need support in the Basic structure for device_type configuration for each type which supports that strategy and in the python code to implement a pipeline for that strategy.
The rest of the actions are listed in the same way - the name of the top level Strategy Action class as a list item, the parameters for that action class as a dictionary.
Individual actions and parameters are described under Dispatcher actions.
device_type: kvm
job_name: kvm-pipeline
job_timeout:
minutes: 15 # timeout for the whole job (default: ??h)
action_timeout:
minutes: 5 # default timeout applied for each action; can be overriden in the action itself (default: ?h)
priority: medium
actions:
- deploy:
timeout:
minutes: 20
to: tmpfs
image: http://images.validation.linaro.org/kvm-debian-wheezy.img.gz
os: debian
# if root_partition partition is not present:
# - look for a partitions labelled "root" or "ROOT" or "Root" (i.e. case insensitive)
# - look into device configuration
root_partition: 1
- boot:
method: kvm
media: tmpfs
failure_retry: 2
- test:
failure_retry: 3
name: kvm-basic-singlenode # is not present, use "test $N"
timeout:
minutes: 5 # uses install:deps, so takes longer than singlenode01
definitions:
- repository: git://git.linaro.org/qa/test-definitions.git
from: git
path: ubuntu/smoke-tests-basic.yaml
# name: if not present, use the name from the YAML. The name can
# also be overriden from the actual commands being run by
# calling the lava-test-suite-name API call (e.g.
# `lava-test-suite-name FOO`).
name: smoke-tests
- repository: http://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/single-node/singlenode03.yaml
name: singlenode-advanced
- submit_results:
stream: /anonymous/codehelp/
To see an example of how the sample YAML would look as a python snippet, use the Online YAML Parser.
To take advantage of the new dispatcher design and to make the LAVA device configuration more consistent, a new format is being created for the device_type and device configuration files, again using YAML.
The device type outlines which strategies devices of this type are able to support. The parameters and commands contained in the device_type configuration will apply to all devices of this type.
The main block is a dictionary of actions. Each item is the name of the strategy containing a list of arguments. All strategies require a method of how that strategy can be implemented. The methods supported by this device type appear as a list.
actions:
deploy:
# list of deployment methods which this device supports
methods:
- image
# no need for root-part, the MountAction will need to sort that out.
boot:
# list of boot methods which this device supports.
methods:
- qemu
# Action specific stanza
command:
# allows for the one type to support different binaries
amd64:
qemu_binary: qemu-system-x86_64
# only overrides can be overridden in the Job
overrides:
- boot_cmds
- qemu_options
parameters:
boot_cmds:
- root: /dev/sda1
- console: ttyS0,115200
qemu_options:
- -nographic
machine:
accel=kvm:tcg
net:
- nic,model=virtio
- user
Individual devices then populate parameters for a specified device_type. A device can only have one device_type.
device_type: kvm
root_part: 1
architecture: amd64
memory: 512
image
An image deployment involves downloading the image and applying a LAVA overlay to the image using loopback mounts. The LAVA overlay includes scripts to automate the tests and the test definitions supplied to the test strategy.
Example code block:
- deploy:
timeout:
minutes: 20
to: tmpfs
image: http://images.validation.linaro.org/kvm-debian-wheezy.img.gz
os: debian
# if root_partition partition is not present:
# - look for a partitions labelled "root" or "ROOT" or "Root" (i.e. case insensitive)
# - look into device configuration
root_partition: 1
Currently, there is only one Test strategy and the method for distinguishing between this and any later strategy has not been finalised.
Example code block:
- test:
failure_retry: 3
name: kvm-basic-singlenode # is not present, use "test $N"
# only s, m & h are supported.
timeout:
minutes: 5 # uses install:deps, so takes longer than singlenode01
definitions:
- repository: git://git.linaro.org/qa/test-definitions.git
from: git
path: ubuntu/smoke-tests-basic.yaml
# name: if not present, use the name from the YAML. The name can
# also be overriden from the actual commands being run by
# calling the lava-test-suite-name API call (e.g.
# `lava-test-suite-name FOO`).
name: smoke-tests
- repository: http://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/single-node/singlenode03.yaml
name: singlenode-advanced
This is an optional parameter that can be added to any YAML job definition. It takes a list of key: value arguments which can be used later to query the test results and find similar jobs (incoming features).
Example:
metadata:
foo: bar
bar: foo
The submission back to the server web frontend will include the entire pipeline but the methods for doing this have not yet been written.