Akamas Docs
3.4.0
Ask or search…
K

Component template

Components are defined using a YAML manifest with the following structure:
1
name: branin
2
description: The branin analytical function
3
componentType: function_branin
4
properties:
5
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:
1
name: JVM_1
2
description: The first jvm of the system
3
componentType: java-openjdk-11
4
properties:
5
hostname: ycsb1.dev.akamas.io
6
username: ubuntu
Example of a component for the Linux operating system:
1
name: os_1
2
description: The operating system of team 1
3
componentType: Ubuntu-20.04
4
properties:
5
hostname: ycsb1.dev.akamas.io
6
username: ubuntu
Last modified 4mo ago