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] _source changes in index and component templates #198621

Closed
bitzandeb opened this issue Oct 31, 2024 · 1 comment · Fixed by #199854
Closed

[Index Management] _source changes in index and component templates #198621

bitzandeb opened this issue Oct 31, 2024 · 1 comment · Fixed by #199854
Assignees
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
Milestone

Comments

@bitzandeb
Copy link

To support synthetic _source, there are a number of updates needed for both index and component templates' mapping advanced options UI where _source configuration is currently exposed.

At a high level, this work should include:

  • Updating the existing toggle to a dropdown with options Stored _source, Synthetic _source, and Disabled _source - options will vary depending on product / license
  • Changes to descriptive text and callouts depending on product / license / index mode selection
  • Defaults depending on the index mode selected within the first step of data stream configuration
@bitzandeb bitzandeb 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 Oct 31, 2024
@elasticmachine
Copy link
Contributor

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

@alisonelizabeth alisonelizabeth added this to the 8.17 milestone Nov 11, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Nov 19, 2024
Closes elastic#198621

## Summary

This PR adds support for the synthetic _source field in the mappings
Advanced options.

Stored option:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 19"
src="https://github.com/user-attachments/assets/086f7a3e-9ca1-42de-9f9c-d3599d839ccf">

Synthetic option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 27"
src="https://github.com/user-attachments/assets/3700bced-212a-4378-b51a-ab7a0f4f7b99">

Disabled option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 36"
src="https://github.com/user-attachments/assets/c7ddcbae-7c78-4477-824e-99b144a1f750">

https://github.com/user-attachments/assets/399d0f95-a5dd-4874-bb8c-e95d6ed38465

How to test:
1. Start Es with `yarn es snapshot --license` (we need Enterprise
license to see the Synthetic source option) and Kibana with `yarn start`
2. Go to Index templates/Component templates and start creating a
template
3. At the Mappings step, go to Advanced options.
4. Verify that selecting a _source field option translates to the
correct Es request.
5. In Index templates form, verify that the default _source option
depends on the index mode selected in the Logistics step. For LogsDB and
Time series index mode, the default should be synthetic mode; otherwise,
the stored option.
6. Verify that in Basic license, the synthetic option is not displayed.

### Checklist

- [x] 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)
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] 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))
- [x] 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))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 8be679a)
paulinashakirova pushed a commit to paulinashakirova/kibana that referenced this issue Nov 26, 2024
Closes elastic#198621

## Summary

This PR adds support for the synthetic _source field in the mappings
Advanced options.

Stored option:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 19"
src="https://github.com/user-attachments/assets/086f7a3e-9ca1-42de-9f9c-d3599d839ccf">

Synthetic option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 27"
src="https://github.com/user-attachments/assets/3700bced-212a-4378-b51a-ab7a0f4f7b99">

Disabled option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 36"
src="https://github.com/user-attachments/assets/c7ddcbae-7c78-4477-824e-99b144a1f750">




https://github.com/user-attachments/assets/399d0f95-a5dd-4874-bb8c-e95d6ed38465




How to test:
1. Start Es with `yarn es snapshot --license` (we need Enterprise
license to see the Synthetic source option) and Kibana with `yarn start`
2. Go to Index templates/Component templates and start creating a
template
3. At the Mappings step, go to Advanced options.
4. Verify that selecting a _source field option translates to the
correct Es request.
5. In Index templates form, verify that the default _source option
depends on the index mode selected in the Logistics step. For LogsDB and
Time series index mode, the default should be synthetic mode; otherwise,
the stored option.
6. Verify that in Basic license, the synthetic option is not displayed.



### Checklist

- [x] 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)
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] 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))
- [x] 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))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

---------

Co-authored-by: kibanamachine <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
Closes elastic#198621

## Summary

This PR adds support for the synthetic _source field in the mappings
Advanced options.

Stored option:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 19"
src="https://github.com/user-attachments/assets/086f7a3e-9ca1-42de-9f9c-d3599d839ccf">

Synthetic option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 27"
src="https://github.com/user-attachments/assets/3700bced-212a-4378-b51a-ab7a0f4f7b99">

Disabled option selected:
<img width="1184" alt="Screenshot 2024-11-14 at 19 19 36"
src="https://github.com/user-attachments/assets/c7ddcbae-7c78-4477-824e-99b144a1f750">




https://github.com/user-attachments/assets/399d0f95-a5dd-4874-bb8c-e95d6ed38465




How to test:
1. Start Es with `yarn es snapshot --license` (we need Enterprise
license to see the Synthetic source option) and Kibana with `yarn start`
2. Go to Index templates/Component templates and start creating a
template
3. At the Mappings step, go to Advanced options.
4. Verify that selecting a _source field option translates to the
correct Es request.
5. In Index templates form, verify that the default _source option
depends on the index mode selected in the Logistics step. For LogsDB and
Time series index mode, the default should be synthetic mode; otherwise,
the stored option.
6. Verify that in Basic license, the synthetic option is not displayed.



### Checklist

- [x] 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)
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] 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))
- [x] 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))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

---------

Co-authored-by: kibanamachine <[email protected]>
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

Successfully merging a pull request may close this issue.

4 participants