Parameters are defined using a YAML manifest with the following structure:
parameters: - name:jvm_heap_sizedescription:the size of the heap of the jvmunit:megabytesrestart:false - name:jvm_survival_ratiodescription:the ratio of the two survivor spaces in the jvm gc
with the following properties:
Field
Type
Value restrictions
Is required
Default Value
Description
name
string
It should contain only lower/uppercase letters, numbers or underscores. It should start only with a letter. No spaces are allowed.
TRUE
The name of the parameter
description
string
TRUE
A description characterizing the parameter
unit
string
FALSE
empty unit
The unit of measure of the parameter
restart
boolean
FALSE
FALSE
If the use of the parameters for changing the configuration of a system should cause the system to be restarted.
Notice that parameter definitions are shared across all the workspaces on the same Akamas installation, and require an account with administrative privileges to manage them.
Example
The following represents a set of parameters for a JVM component
parameters: - name:jvm_maxHeapSizedescription:Maximum heap sizeunit:megabytesrestart:true - name:jvm_newRatiodescription:Ratio of old/new generation sizesrestart:true - name:jvm_maxTenuringThresholddescription:Maximum value for tenuring thresholdrestart:true - name:jvm_survivorRatiodescription:Ratio of eden/survivor space sizerestart:true - name:jvm_concurrentGCThreadsdescription:Number of threads concurrent garbage collection will useunit:threadsrestart:true - name:jvm_gcTypedescription:Type of the garbage collection algorithmrestart:true
The following represents a set of CPU-related parameters for the Linux operating system
parameters:# CPU Related - name:os_cpu_sched_min_granularity_nsdescription:Target minimum scheduler period in which a single task will rununit:nanosecondsrestart:false - name:os_cpu_sched_wakeup_granularity_nsunit:nanosecondsdescription:descrestart:false - name:os_cpu_sched_migration_cost_nsunit:nanosecondsdescription:descrestart:false - name:os_cpu_sched_child_runs_firstdescription:descrestart:false - name:os_cpu_sched_latency_nsunit:nanosecondsdescription:descrestart:false - name:os_cpu_sched_autogroup_enableddescription:descrestart:false - name:os_cpu_sched_nr_migratedescription:descrestart:false