kibana/x-pack/plugins/banners
Mikhail Shustov 5fde16c2b3
Do not mutate config in place during deprecations (#99629)
* refactor config deprecations to avoid config mutations

* remove dynamic access keys in core deprecations.

* refactor custom config deprecations to match the new signature

* improve config deprecations fixtures for nested keys

* add a test for xpack.banner config deprecations

* key --> path, add a test for invalid command
2021-05-11 05:41:48 -04:00
..
common
public
server Do not mutate config in place during deprecations (#99629) 2021-05-11 05:41:48 -04:00
jest.config.js
kibana.json
README.md
tsconfig.json

Kibana banners plugin

Allow to add a header banner that will be displayed on every page of the Kibana application

Configuration

The plugin's configuration prefix is xpack.banners

The options are

  • placement

The placement of the banner. The allowed values are:

  • disabled - The banner will be disabled

  • top - The banner will be displayed in the header

  • textContent

The text content that will be displayed inside the banner, either plain text or markdown

  • textColor

The color of the banner's text. Must be a valid hex color

  • backgroundColor

The color for the banner's background. Must be a valid hex color

Configuration example

kibana.yml

xpack.banners:
  placement: 'top'
  textContent: 'Production environment - Proceed with **special levels** of caution'
  textColor: '#FF0000'
  backgroundColor: '#CC2211'