kibana

mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00

History

Elena Stoeva b9cab392b2 [Serverless][Advanced Settings] Add validations on user input (#170234 ) Addresses https://github.com/elastic/kibana/issues/168684 ## Summary This PR adds validations of the user input for a some of the uiSettings (see https://github.com/elastic/kibana/issues/168684) based on the `schema` that is provided in the setting definitions. We do this by exposing a `validateValue` API from the uiSettings browser-side client, which calls an internal validate route to the server. Then `validateValue` is called in the `onChange` handlers of the setting input fields, utilising `debounce` to reduce the number of requests to the server. Note: One of the validation requirements is for validating that the `defaultIndex` setting value is an existing data view. This is a more complicated validation and will be addressed in a separate PR. ![defaultAnomalyScore](`4fb99993`-9c2d-4c92-8ea4-bacdb58f7be4) ![defaultThreatIndex](`264fa663`-43cb-44a1-9435-4de0fa1e957a) ### How to test Testing the validations in serverless: 1. Start Es with `yarn es serverless` and Kibana with `yarn serverless-{es/oblt/security}` 2. Go to Management -> Advanced settings 3. Verify that the UI provides correct validation error messages for [the settings that require validation](https://github.com/elastic/kibana/issues/168684). Verify that self-managed Kibana is not affected: There should be no validations in self-managed Kibana and setting an invalid value for an advanced setting should be allowed and shouldn't cause any errors. @elastic/kibana-core team, I know you're no longer code owners of the uiSettings service, but any feedback on those changes will be highly appreciated. 🙏 <!--- ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: \| Risk \| Probability \| Severity \| Mitigation/Notes \| \|---------------------------\|-------------\|----------\|-------------------------\| \| Multiple Spaces—unexpected behavior in non-default Kibana Space. \| Low \| High \| Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. \| \| Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. \| High \| Low \| Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. \| \| Code should gracefully handle cases when feature X or plugin Y are disabled. \| Medium \| High \| Unit tests will verify that any feature flag or plugin combination still results in our service operational. \| \| [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) \| ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>		2023-11-16 11:07:51 -07:00
..
kibana.yml	[Unified Search] Move autocomplete logic to unified search plugin (#129977 )	2022-04-22 11:02:56 +05:00
node.options	[node] Enable openssl legacy provider (#163190 )	2023-08-30 11:51:10 -07:00
README.md	Fix config stacking order (#158827 )	2023-06-05 15:15:07 +02:00
serverless.es.yml	[Serverless] Disabled stack monitoring in serverless (#170016 )	2023-11-16 17:33:11 +01:00
serverless.oblt.yml	[Serverless] Disabled stack monitoring in serverless (#170016 )	2023-11-16 17:33:11 +01:00
serverless.security.yml	[Serverless] Disabled stack monitoring in serverless (#170016 )	2023-11-16 17:33:11 +01:00
serverless.yml	[Serverless][Advanced Settings] Add validations on user input (#170234 )	2023-11-16 11:07:51 -07:00

README.md

as work on serverless picks up we will add config values to these files that define how Kibana will run in "serverless" modes. To start Kibana locally with this configuration, pass --serverless={mode} or run yarn serverless-{mode}

valid modes are currently: es, oblt, and security

configuration is applied in the following order, later values override

serverless.yml (serverless configs go first)
serverless.{mode}.yml (serverless configs go first)
base config, in this preference order:

my-config.yml(s) (set by --config)
env-config.yml (described by env.KBN_CONFIG_PATHS)
kibana.yml (default @ env.KBN_PATH_CONF/kibana.yml)

kibana.dev.yml
serverless.dev.yml
serverless.{mode}.dev.yml