Skip to content

Add an example of uiSettings override #135385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matschaffer merged 5 commits into from
Jun 30, 2022
Merged

Add an example of uiSettings override #135385

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
551607d
Add an example of uiSettings override
matschaffer Jun 29, 2022
8faf5ca
Update docs/developer/architecture/core/uisettings-service.asciidoc
matschaffer Jun 29, 2022
5402a97
Update docs/developer/architecture/core/uisettings-service.asciidoc
matschaffer Jun 30, 2022
c86f4bb
Update docs/developer/architecture/core/uisettings-service.asciidoc
matschaffer Jun 30, 2022
5995e5f
Update docs/developer/architecture/core/uisettings-service.asciidoc
matschaffer Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/developer/architecture/core/uisettings-service.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ Configuration through the Advanced Settings UI is restricted to users authorised
=== Configuration with UI settings overrides
experimental[] When a setting is configured as an override in kibana.yml, it will override any other value stored in the config saved object. If an override is misconfigured, it will fail config validation and prevent Kibana from starting up. The override applies to Kibana as a whole for all spaces and users and the option will be disabled in the Advanced Settings page. We refer to these as "global" overrides.
Comment thread
matschaffer marked this conversation as resolved.

Use the top-level `uiSettings` key for this, for example:

[source,yaml]
----
# Display times in UTC
uiSettings:
overrides:
"dateFormat:tz": "UTC"
----

[[client-side-usage]]
=== Client side usage
On the client, the `uiSettings` service is exposed directly from `core` and the {kib-repo}blob/{branch}/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md[client] provides plugins access to the `config` entries stored in {es}.
Expand Down