Web UI configuration reference
COMMERCIAL FEATURE: Access web UI configuration in the packaged Sensu Go distribution.
For more information, see Get started with commercial features.
Web UI configuration allows you to define certain display options for the Sensu web UI, such as which web UI theme to use, the number of items to list on each page, and which URLs and linked images to expand.
You can define a single custom web UI configuration to federate to all, some, or only one of your clusters.
NOTE: Each cluster should have only one web configuration.
Web UI configuration specification
Top-level attributes
type |
|
description |
Top-level attribute that specifies the resource type. For web UI configuration, the type should always be GlobalConfig . |
required |
Required for web UI configuration in wrapped-json or yaml format. |
type |
String |
example |
|
api_version |
|
description |
Top-level attribute that specifies the Sensu API group and version. For web UI configuration in this version of Sensu, the api_version should always be web/v1 . |
required |
Required for web UI configuration in wrapped-json or yaml format. |
type |
String |
example |
|
metadata |
|
description |
Top-level scope that contains the web UI configuration’s name and created_by information. |
required |
true |
type |
Map of key-value pairs |
example |
"metadata": {
"name": "custom-web-ui",
"created_by": "admin"
}
|
spec |
|
description |
Top-level map that includes web UI configuration spec attributes. |
required |
Required for web UI configuration in wrapped-json or yaml format. |
type |
Map of key-value pairs |
example |
"spec": {
"always_show_local_cluster": false,
"default_preferences": {
"page_size": 50,
"theme": "classic"
},
"link_policy": {
"allow_list": true,
"urls": [
"https://example.com",
"steamapp://34234234",
"//google.com",
"//*.google.com",
"//bob.local",
"https://grafana-host/render/metrics?width=500&height=250#sensu.io.graphic"
]
}
}
|
name |
|
description |
Name for the web UI configuration that is used internally by Sensu. |
required |
true |
type |
String |
example |
|
created_by |
|
description |
Username of the Sensu user who created or last updated the web UI configuration. Sensu automatically populates the created_by field when the web UI configuration is created or updated. The admin user, cluster admins, and any user with access to the GlobalConfig resource can create and update web UI configurations. |
required |
false |
type |
String |
example |
|
Spec attributes
always_show_local_cluster |
|
description |
Use only in federated environments. Set to true to display the cluster the user is currently connected to in the namespace switcher. To omit local cluster details, set to false . |
required |
false |
type |
Boolean |
default |
false |
example |
"always_show_local_cluster": false
|
default_preferences |
|
description |
Global default page size and theme preferences for all users. |
required |
false |
type |
Map of key-value pairs |
example |
"default_preferences": {
"page_size": 50,
"theme": "classic"
}
|
link_policy |
|
description |
For labels or annotations that contain a URL, the policy for which domains are valid and invalid targets for conversion to a link or an image. |
required |
false |
type |
Map of key-value pairs |
example |
"link_policy": {
"allow_list": true,
"urls": [
"https://example.com",
"steamapp://34234234",
"//google.com",
"//*.google.com",
"//bob.local",
"https://grafana-host/render/metrics?width=500&height=250#sensu.io.graphic"
]
}
|
Default preferences attributes
page_size |
|
description |
The number of items users will see on each page. |
required |
false |
type |
Integer |
default |
25 |
example |
|
theme |
|
description |
The theme users will see.
NOTE: If an individual user’s settings conflict with the web UI configuration settings, Sensu will use the individual user’s settings.
For example, if a user’s system is set to dark mode and their web UI settings are configured to use their system settings, the user will see dark mode in Sensu’s web UI, even if you set the theme to classic in your web UI configuration.
|
required |
false |
type |
String |
default |
sensu |
allowed values |
sensu , classic , uchiwa , tritanopia , and deuteranopia |
example |
|
Link policy attributes
allow_list |
|
description |
If the list of URLs acts as an allow list, true . If the list of URLs acts as a deny list, false . As an allow list, only matching URLs will be expanded. As a deny list, matching URLs will not be expanded, but any other URLs will be expanded. |
required |
false |
type |
Boolean |
default |
false |
example |
|
urls |
|
description |
The list of URLs to use as an allow or deny list.
NOTE: For images from services that may not have an easily distinguishable file extension, append the anchor #sensu.io.graphic to the image URLs.
|
required |
false |
type |
Array |
example |
"urls": [
"https://example.com",
"steamapp://34234234",
"//google.com",
"//*.google.com",
"//bob.local",
"https://grafana-host/render/metrics?width=500&height=250#sensu.io.graphic"
]
|
Web UI configuration examples
In this web UI configuration example:
- Details for the local cluster will not be displayed
- Each page will list 50 items
- The web UI will use the classic theme
- Expanded links and images will be allowed for the listed URLs
type: GlobalConfig
api_version: web/v1
metadata:
name: custom-web-ui
spec:
always_show_local_cluster: false
default_preferences:
page_size: 50
theme: classic
link_policy:
allow_list: true
urls:
- https://example.com
- steamapp://34234234
- //google.com
- //*.google.com
- //bob.local
- https://grafana-host/render/metrics?width=500&height=250#sensu.io.graphic
{
"type": "GlobalConfig",
"api_version": "web/v1",
"metadata": {
"name": "custom-web-ui",
"created_by": "admin"
},
"spec": {
"always_show_local_cluster": false,
"default_preferences": {
"page_size": 50,
"theme": "classic"
},
"link_policy": {
"allow_list": true,
"urls": [
"https://example.com",
"steamapp://34234234",
"//google.com",
"//*.google.com",
"//bob.local",
"https://grafana-host/render/metrics?width=500&height=250#sensu.io.graphic"
]
}
}
}