Akamas Docs
3.4.0
Ask or search…
K

Parameter template

Parameters are defined using a YAML manifest with the following structure:
1
parameters:
2
- name: jvm_heap_size
3
description: the size of the heap of the jvm
4
unit: megabytes
5
restart: false
6
- name: jvm_survival_ratio
7
description: 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
A supported unit or a custom unit (see supported units of measure)
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
1
parameters:
2
- name: jvm_maxHeapSize
3
description: Maximum heap size
4
unit: megabytes
5
restart: true
6
- name: jvm_newRatio
7
description: Ratio of old/new generation sizes
8
restart: true
9
- name: jvm_maxTenuringThreshold
10
description: Maximum value for tenuring threshold
11
restart: true
12
- name: jvm_survivorRatio
13
description: Ratio of eden/survivor space size
14
restart: true
15
- name: jvm_concurrentGCThreads
16
description: Number of threads concurrent garbage collection will use
17
unit: threads
18
restart: true
19
- name: jvm_gcType
20
description: Type of the garbage collection algorithm
21
restart: true
The following represents a set of CPU-related parameters for the Linux operating system
1
parameters:
2
# CPU Related
3
- name: os_cpu_sched_min_granularity_ns
4
description: Target minimum scheduler period in which a single task will run
5
unit: nanoseconds
6
restart: false
7
- name: os_cpu_sched_wakeup_granularity_ns
8
unit: nanoseconds
9
description: desc
10
restart: false
11
- name: os_cpu_sched_migration_cost_ns
12
unit: nanoseconds
13
description: desc
14
restart: false
15
- name: os_cpu_sched_child_runs_first
16
description: desc
17
restart: false
18
- name: os_cpu_sched_latency_ns
19
unit: nanoseconds
20
description: desc
21
restart: false
22
- name: os_cpu_sched_autogroup_enabled
23
description: desc
24
restart: false
25
- name: os_cpu_sched_nr_migrate
26
description: desc
27
restart: false
Last modified 1mo ago