Data gathering agent configuration

These schemas specify how the configurator itself is configured to display editable forms for the agent’s configuration.

Agent configuration UI configuration

https://gros.liacs.nl/schema/agent-config/config.json

config-agent-config

config-agent-config

Configuration for the configurator.
type	object
properties
listen_address	Bind IP address to listen to.
	ip_address
listen_port	Port to listen to.
	port
listen_host	Hostname of the web UI that users must use to connect to.
	type	string
	format	hostname
ssh_host	Hostname of controller API.
	type	string
	format	hostname
ssh_https_port	Port of controller API for version update checks.
	port
ssh_https_cert	Filename of certificate of controller API.
	type	string
update_timeout	Milliseconds to wait for update check.
	type	integer
	minimum	0
agent_host	Hostname of agent related to configuration UI.
	type	string
	format	hostname
agent_port	Port of agent with scraper API.
	port
scrape_timeout	Milliseconds to wait for scraper API.
	type	integer
	minimum	0
export_path	Path to dropins and exported data of the agent.
	type	string
config_path	Path to agent settings and credentials.
	type	string
key_path	Path to SSH key storage.
	type	string
visualization_url	URL of visualizations of collected data.
	type	string
	format	uri
jira_url	URL of JIRA instance.
	type	string
	format	uri
bigboat_placeholder	Example base URL for BigBoat.
	type	string
	format	uri
quality_time_placeholder	Example base URL for Quality-time.
	type	string
	format	uri
sonar_placeholder	Example base URL for SonarQube.
	type	string
	format	uri
version_control_placeholder	Example domain name of a version control system.
	type	string
	format	hostname
version_control_port_sample	Example domain name and port number of a version control system.
	type	string
jenkins_placeholder	Example domain name (and optional port number) of Jenkins CI.
	type	string

ip_address

type	string
oneOf	format	ipv4
	format	ipv6

port

type	integer
maximum	65535
minimum	0

Agent configuration form specification

https://gros.liacs.nl/schema/agent-config/form.json

form

form

type	object
patternProperties
.+	Group within the form.
	type	object
	properties
	name	Name of the form group.
		type	string
	icon	FontAwesome class names of an icon.
		type	string
	cloneable	Whether it is possible to fill in a list of values for all the fields in the group by duplicating the group.
		type	boolean
		default	False
	fields	type	object
		patternProperties
		.+	Field within the form.
			Agent configuration form field

Agent configuration form field

type	object
properties
field	Type of the field.
	type	string
	enum	number, boolean, array, password, email, tel, url, date, plain_string, string, host, map
fields	Fields within the field.
	type	object
	patternProperties
	.+	Agent configuration form field
required	Whether it is required to fill in a value for the field.
	type	boolean
	default	False
label	Label of the field.
	type	string
choices	A mapping of choice values (to store) and displayed values that the field can have.
	type	object
	patternProperties
	.*	type	string
widget	Widget to use for the field.
	type	string
	enum	text, email, number, hidden, color, tel, date, checkbox, select, multipleCheckbox, multipleRadio, multipleSelect, label, safe_password, password, plain_textarea, textarea
hint	Information to display alongside the field as a hint to what to input.
	type	string
longer_hint	Information to display as a popup as a hint to what to input.
	type	string
placeholder	Mustache template for a placeholder value of the field.
	type	string
option	Location to store the value of the field in: Configuration file, section and key.
	type	array
	items	type	string
	maxItems	3
	minItems	3
expand	Whether the field should be hidden by default, only shown when an option to expand the form group is pressed.
	type	boolean
	default	False
cloneable	Whether it is possible to fill in a list of values for the field by duplicating the field.
	type	boolean
	default	False