Configuration of the cockpit dogu
Prerequisite
- Cockpit is successfully installed
Configuration possibilities
The Cockpit-Dogu is configured via the registry. There are several ways to configure values in the registry. Briefly one can:
- configure a dogu with
cesapp edit-config <dogu>
(recommended) - update the configuration values using a blueprint
- manually adjust the keys with `etcdctl
Configuration
All configuration keys for cockpit settings have the key prefix config/cockpit/
.
Cockpit provides the following settings:
Physical memory limit
- Configuration key path:
container_config/memory_limit
- Content: limits the memory (RAM) of the Docker container for Cockpit.
- Data type: Binary memory specification.
- Valid values: integer followed by [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).
- Example:
1750m
= 1750 MebiByte
Physical swap limit
- Configuration key path:
container_config/swap_limit
- Content: limits Docker container swap for Cockpit.
- Data type: Binary memory specification.
- Valid values: integer followed by [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).
- Example:
1750m
= 1750 MebiByte
Welcome Dashboard
- Configuration key path:
welcomeDashboard
- Content: Sets the content of the welcome dashboard for the cockpit
- Optional
- Data type: JSON dashboard description.
-
Notes:
- If the content does not match a correct JSON format, the default dashboard will be displayed.
- The maximum possible size of a JSON dashboard description is 2 MB.
-
Example:
{ "welcomeDashboard": { "title": "Custom Welcome Dashboard", "structure": "12/4-4-4", "rows": [ { "columns": [ { "styleClass": "col-md-12", "widgets": [], "cid": "1495540024138-67" } ] }, { "columns": [ { "styleClass": "col-md-4", "widgets": [ { "type": "clock", "config": { "timePattern": "HH:mm:ss", "datePattern": "YYYY-MM-DD" }, "title": "Clock", "titleTemplateUrl": "../src/templates/widget-title.html", "editTemplateUrl": "../src/templates/widget-edit.html", "wid": "1495540110609-91" }, { "type": "linklist", "config": { "links": [ { "title": "Custom Link", "href": "https://custom.com" } ] }, "title": "Links", "titleTemplateUrl": "../src/templates/widget-title.html", "editTemplateUrl": "../src/templates/widget-edit.html", "wid": "1495526407267-47" } ], "cid": "1495540024149-69" } ] } ], "titleTemplateUrl": "app/dashboard/partials/custom-dashboard-title.html" } }
Pinned Dashboard
- Configuration key path:
pinnedDashboard
- Content: the pinned dashboard is displayed to every user and cannot be modified, moved or removed. The format and restrictions are the same as for the welcome dashboard.
- Optional
- Data type: JSON dashboard description.
-
Notes:
- The maximum possible size of a JSON dashboard description is 2 MB.
-
Example:
{ "title": "Pinned dashboard", "structure": "4-8", "rows": [ { "columns": [ { "styleClass": "col-md-4", "widgets": [ { "type": "clock", "config": { "timePattern": "HH:mm:ss", "datePattern": "YYYY-MM-DD" }, "title": "Clock", "titleTemplateUrl": "../src/templates/widget-title.html", "editTemplateUrl": "../src/templates/widget-edit.html", "wid": "1495540110609-91" } ], "cid": "1515578484127-21" } ] } ] }