Dashboard file
| File name | Resource |
|---|---|
*.dashboard.yaml | Dashboard |
GitOps file for a single space.
Queries
panels[].queries[].query, panels[].query each take a Hamelin query, either inline as a string or as { $ref: <path> } pointing at a .hmln file. A $ref path is case-sensitive and must stay inside the GitOps directory.
Identity
originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.id: Server-assigned id. Absent until the resource exists.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
defaultTimeRange | string | Required | |
folder | string | Optional | A Folder by its originKey (managed in this repo) or its server id (FLD_…). |
id | string | Optional | Server-assigned id. Absent until the resource exists. Pattern: ^DSH_[A-Z0-9]{1,7}$. |
name | string | Required | |
originKey | string | Required | GitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$. |
panels | array of object (four variants) | Optional | Defaults to []. |
panels[][markdown].content | string | Optional | Defaults to . |
panels[][markdown].id | string | Required | |
panels[][markdown].layout | object | Required | |
panels[][markdown].layout.h | integer | Required | Minimum 1. |
panels[][markdown].layout.w | integer | Required | Minimum 1. Maximum 24. |
panels[][markdown].layout.x | integer | Required | Minimum 0. Maximum 23. |
panels[][markdown].layout.y | integer | Required | Minimum 0. |
panels[][markdown].title | object | Optional | |
panels[][markdown].title.align | enum | Optional | One of left, center, right. |
panels[][markdown].title.size | enum | Optional | One of sm, md, lg. |
panels[][markdown].title.text | string | Required | |
panels[][markdown].type | string | Required | Always markdown. |
panels[][title].collapsed | boolean | Optional | Defaults to false. |
panels[][title].id | string | Required | |
panels[][title].layout | object | Required | |
panels[][title].layout.h | integer | Required | Minimum 1. |
panels[][title].layout.w | integer | Required | Minimum 1. Maximum 24. |
panels[][title].layout.x | integer | Required | Minimum 0. Maximum 23. |
panels[][title].layout.y | integer | Required | Minimum 0. |
panels[][title].title | object | Required | |
panels[][title].title.align | enum | Optional | One of left, center, right. |
panels[][title].title.size | enum | Optional | One of sm, md, lg. |
panels[][title].title.text | string | Required | |
panels[][title].type | string | Required | Always title. |
panels[][table].id | string | Required | |
panels[][table].layout | object | Required | |
panels[][table].layout.h | integer | Required | Minimum 1. |
panels[][table].layout.w | integer | Required | Minimum 1. Maximum 24. |
panels[][table].layout.x | integer | Required | Minimum 0. Maximum 23. |
panels[][table].layout.y | integer | Required | Minimum 0. |
panels[][table].query | object (one variants) | Required | Or a string. |
panels[][table].query[variant 1].$ref | string | Required | Path to a .hmln file, relative to this file. Must not be empty. |
panels[][table].timeRange | string | Optional | Defaults to . |
panels[][table].title | object | Optional | |
panels[][table].title.align | enum | Optional | One of left, center, right. |
panels[][table].title.size | enum | Optional | One of sm, md, lg. |
panels[][table].title.text | string | Required | |
panels[][table].type | string | Required | Always table. |
panels[][vega-lite].id | string | Required | |
panels[][vega-lite].layout | object | Required | |
panels[][vega-lite].layout.h | integer | Required | Minimum 1. |
panels[][vega-lite].layout.w | integer | Required | Minimum 1. Maximum 24. |
panels[][vega-lite].layout.x | integer | Required | Minimum 0. Maximum 23. |
panels[][vega-lite].layout.y | integer | Required | Minimum 0. |
panels[][vega-lite].queries | array of object | Optional | |
panels[][vega-lite].queries[].id | string | Required | Must not be empty. |
panels[][vega-lite].queries[].name | string | Required | Must not be empty. |
panels[][vega-lite].queries[].query | object (one variants) | Required | Or a string. |
panels[][vega-lite].queries[].query[variant 1].$ref | string | Required | Path to a .hmln file, relative to this file. Must not be empty. |
panels[][vega-lite].query | object (one variants) | Optional | Retired: use queries. Read as the panel's only query when queries is absent. Or a string. |
panels[][vega-lite].query[variant 1].$ref | string | Required | Path to a .hmln file, relative to this file. Must not be empty. |
panels[][vega-lite].spec | object | Required | |
panels[][vega-lite].timeRange | string | Optional | Defaults to . |
panels[][vega-lite].title | object | Optional | |
panels[][vega-lite].title.align | enum | Optional | One of left, center, right. |
panels[][vega-lite].title.size | enum | Optional | One of sm, md, lg. |
panels[][vega-lite].title.text | string | Required | |
panels[][vega-lite].type | string | Required | Always vega-lite. |
refreshInterval | integer | Required | |
spaceId | string | Required | Space the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$. |
templateVariables | array of object (two variants) | Optional | Defaults to []. |
templateVariables[][primitive].defaultValue | string | Optional | At most 1024 characters. |
templateVariables[][primitive].description | string | Optional | At most 1024 characters. |
templateVariables[][primitive].id | string | Required | Must not be empty. |
templateVariables[][primitive].kind | string | Required | Always primitive. |
templateVariables[][primitive].name | string | Required | Pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters. |
templateVariables[][primitive].type | enum | Required | One of int, double, boolean, string, interval. |
templateVariables[][primitive].values | array of string | Required | At most 200 items. |
templateVariables[][identifier_fragment].defaultValue | string | Required | Pattern: ^[a-zA-Z0-9_]+$. At most 1024 characters. |
templateVariables[][identifier_fragment].description | string | Optional | At most 1024 characters. |
templateVariables[][identifier_fragment].id | string | Required | Must not be empty. |
templateVariables[][identifier_fragment].kind | string | Required | Always identifier_fragment. |
templateVariables[][identifier_fragment].name | string | Required | Pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters. |
templateVariables[][identifier_fragment].values | array of string | Required | At least 1 item. At most 200 items. |
In a content pack
A content pack's source directory uses the same file, with these differences:
- Not used in a pack:
originKey,spaceId. - These fields are new in a pack, or have a different type, requirement or meaning there:
| Field | Type | Required | Description |
|---|---|---|---|
folder | string | Optional | id of a Folder file in the same pack. Omit to place the item at the pack root. Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$. |
id | string | Required | Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$. |
Related
Perpetual CLI 0.5.0