Skip to content
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.

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

[Index Management] Improve index settings editor #175714

Open
yuliacech opened this issue Jan 26, 2024 · 2 comments
Open

[Index Management] Improve index settings editor #175714

yuliacech opened this issue Jan 26, 2024 · 2 comments
Labels
enhancement New value added to drive a business result Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@yuliacech
Copy link
Contributor

Read only display

The settings tab in the index details page displays a read-only code block with a JSON object returned from the request GET <index_name>/_settings?expand_wildcards=none&flat_settings=false&local=false&include_defaults=true (see this file).

Screenshot 2024-01-25 at 16 31 35

Edit mode

When "edit" mode is toggled, the code block is replaced by a code editor, where a subset of settings is displayed even though the user is free to use the editor and change any settings they want.

Screenshot 2024-01-25 at 15 26 21

The subset of settings is selected as follows (see this file):
On stateful

  1. From the defaults returned by the above request, only those are picked that are in the list below
[
  'index.number_of_replicas',
  'index.blocks.read_only_allow_delete',
  'index.codec',
  'index.priority',
  'index.query.default_field',
  'index.refresh_interval',
  'index.write.wait_for_active_shards',
]
  1. Additionally all settings returned by the above request, all are displayed except those in the list below
[
  'index.creation_date',
  'index.number_of_shards',
  'index.provided_name',
  'index.uuid',
  'index.version.created',
  'index.compound_format',
  'index.data_path',
  'index.format',
  'index.number_of_routing_shards',
  'index.sort.field',
  'index.sort.missing',
  'index.sort.mode',
  'index.sort.order',
  'index.routing_partition_size',
  'index.store.type',
]

On serverless

  • From defaults and settings only those are picked that are in the list below (only those are available on serverless)
[
  'index.blocks.write',
  'index.blocks.read',
  'index.blocks.read_only',
  'index.blocks.metadata',
  'index.codec',
  'index.default_pipeline',
  'index.lifecycle.origination_date',
  'index.final_pipeline',
  'index.similarity',
  'index.analysis',
  'index.query.default_field',
  'index.refresh_interval',
  'index.query_string.lenient',
  'index.sort.missing',
  'index.sort.order',
  'index.sort.mode',
  'index.sort.field',
  'index.mapping.ignore_malformed',
  'index.mapping.coerce',
  'index.mapping.total_fields.limit',
  'index.merge.policy.deletes_pct_allowed',
  'index.merge.policy.max_merge_at_once',
  'index.merge.policy.expunge_deletes_allowed',
  'index.merge.policy.floor_segment',
]

These lists of index defaults and settings that are displayed or hidden in the editor need to be updated and verified with the Elasticsearch team. Also a more structured UI for index setting editing could be useful: for a set of defaults/settings that are expected to be changed often by users, we could provide more usable form inputs (similar to Mappings editor in the index template creation wizard for example).

@yuliacech yuliacech added enhancement New value added to drive a business result Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Jan 26, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

yuliacech added a commit that referenced this issue Jan 30, 2024
…9303)

## Summary
Fixes #169016
This PR puts back the functionality that existed prior to 8.11 when the
new index page was
[introduced](#165705) (see any
8.10 or earlier deployments to see how the settings editor worked). The
autocomplete is only showing the settings that are displayed in the
editor after the edit mode has been enabled. There is no autocomplete
suggestions for all settings that can be changed. There is an
[issue](#175714) to track work
to improve the overall UX in the index settings editor.

### Screenshots 

<img width="1214" alt="Screenshot 2024-01-29 at 10 30 17"
src="https://github.com/elastic/kibana/assets/6585477/9e42993c-a735-4856-8f70-e65ad112c36e">


#### 8.10 and earlier versions

<img width="723" alt="Screenshot 2024-01-29 at 10 28 49"
src="https://github.com/elastic/kibana/assets/6585477/47b59668-f338-4212-88bd-f682df1e0d2a">



Summarize your PR. If it involves visual changes include a screenshot or
gif.


### 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&mdash;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&mdash;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 <[email protected]>
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this issue Feb 15, 2024
…stic#169303)

## Summary
Fixes elastic#169016
This PR puts back the functionality that existed prior to 8.11 when the
new index page was
[introduced](elastic#165705) (see any
8.10 or earlier deployments to see how the settings editor worked). The
autocomplete is only showing the settings that are displayed in the
editor after the edit mode has been enabled. There is no autocomplete
suggestions for all settings that can be changed. There is an
[issue](elastic#175714) to track work
to improve the overall UX in the index settings editor.

### Screenshots 

<img width="1214" alt="Screenshot 2024-01-29 at 10 30 17"
src="https://github.com/elastic/kibana/assets/6585477/9e42993c-a735-4856-8f70-e65ad112c36e">


#### 8.10 and earlier versions

<img width="723" alt="Screenshot 2024-01-29 at 10 28 49"
src="https://github.com/elastic/kibana/assets/6585477/47b59668-f338-4212-88bd-f682df1e0d2a">



Summarize your PR. If it involves visual changes include a screenshot or
gif.


### 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&mdash;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&mdash;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 <[email protected]>
fkanout pushed a commit to fkanout/kibana that referenced this issue Mar 4, 2024
…stic#169303)

## Summary
Fixes elastic#169016
This PR puts back the functionality that existed prior to 8.11 when the
new index page was
[introduced](elastic#165705) (see any
8.10 or earlier deployments to see how the settings editor worked). The
autocomplete is only showing the settings that are displayed in the
editor after the edit mode has been enabled. There is no autocomplete
suggestions for all settings that can be changed. There is an
[issue](elastic#175714) to track work
to improve the overall UX in the index settings editor.

### Screenshots 

<img width="1214" alt="Screenshot 2024-01-29 at 10 30 17"
src="https://github.com/elastic/kibana/assets/6585477/9e42993c-a735-4856-8f70-e65ad112c36e">


#### 8.10 and earlier versions

<img width="723" alt="Screenshot 2024-01-29 at 10 28 49"
src="https://github.com/elastic/kibana/assets/6585477/47b59668-f338-4212-88bd-f682df1e0d2a">



Summarize your PR. If it involves visual changes include a screenshot or
gif.


### 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&mdash;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&mdash;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 <[email protected]>
@alisonelizabeth alisonelizabeth removed the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Sep 17, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 17, 2024
@alisonelizabeth alisonelizabeth added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Sep 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-management (Team:Kibana Management)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Development

No branches or pull requests

3 participants