Dashboard YAML structure

Full commands Examples Directory

command

Required

Dict

	type	description	default	required
name	String	Command name		True
description	String	Command description		False
variables	List	List of variables with optional CLI arguments		False
execute	Dict	Data type to execute		True

---

Variables

Optional

List

Example

variables:
  - name: namespace
    default: .*
    cliArgument:
      enable: true
      short: -n
      required: false
  - name: pod
    default: .*
    cliArgument:
      enable: true
      short: -po
      required: false

	type	description	default	required
name	String	variable name ,, also used for the CLI argument name		True
default	String	devault value for the variable		True
cliArgument	Dict	CLI argument options for the variable		False

cliArgument

Optional

Dict

	type	description	default	required
enable	Boolean	Enable CLI argument for the variable		True
short	String	short for the argument		True
required	Boolean	Wether the argument is required to run the command	False	False

---

execute

Required

Dict

	type	description	default	required
type	String	Data type Options: [advancedTable]		True
advancedTableColumns	List	Required with ​​advancedTable​​ Data type List of metrics, where each metric represent a column on the table		True
custom_key	String	custom key for the metric result key,	default labels result string composed of summed labels .. ex. sum(metric) by (pod, namespace)	False
executeadvancedTableOptions	Dict	Graph options with advancedTable data type		False

advancedTableColumns

Required

List

	type	description	default	required
COULMN NAME EX: - memory usage:	String	Column name (User Input name)	plain	True
metric	String	Prometheus metric to qurey		True
metricUnit	String	metric result value unit Options: [None, kb, byte, mb, gb, tb, seconds, percentage]	byte	False
autoConvertValue	Boolean	Auto convert the metric value based on the metricUnit .. for example, if metric value is in byte, it would be converted to kb, mb, gb .. etc.	False	False

advancedTableOptions

Optional

Dict

	type	description	default	required
tableType	String	Table type - Allowed Options	plain	False
showValue	Boolean	Show value column	True	False
headersUppercase	Boolean	Show the table header in Upecase	True	False
autoConvertValue	Boolean	Auto convert the metric value based on the metricUnit .. for example, if metric value is in byte, it would be converted to kb, mb, gb .. etc.	False	False
showTableIndex	Boolean	Show table Index on the left	True	False
updateIntervalSeconds	Integer	Data update interval	5	False