Component template

Components are defined using a YAML manifest with the following structure:

name: branin
description: The branin analytical function
componentType: function_branin
properties:
  hostname: function-server

and properties:

Field
Type
Value restrictions
Is required
Default value
Description

name

string

should match the following regexp:

^[a-zA-Z][a-zA-Z0-9_]*$

that is only letters, number and underscores, no initial number of underscore

Notice: this should not match the name of another component

TRUE

The name of the component.

description

string

TRUE

A description to characterize the component.

componentType

string

notice: this should match the name of an existing component-type

TRUE

The name of the component-type that defines the type of the component.

properties

object

FALSE

General custom properties of the component. These properties can be defined freely and usually have the purpose to expose information useful for configuring the component.

Examples

Example of a component for OpenJDK11:

name: JVM_1
description: The first jvm of the system
componentType: java-openjdk-11
properties:
  hostname: ycsb1.dev.akamas.io
  username: ubuntu

Example of a component for the Linux operating system:

name: os_1
description: The operating system of team 1
componentType: Ubuntu-20.04
properties:
  hostname: ycsb1.dev.akamas.io
  username: ubuntu

Last updated