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

Documents how to change the default security index #4695

Merged
merged 5 commits into from
Jan 31, 2024

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Jan 26, 2024

First pass at fixing #4653.

@e40pud please let me know what you think, if we should add any more info and if this addresses the need. Thanks!

@benironside benironside added enhancement New feature or request v8.12.0 v8.13.0 labels Jan 26, 2024
@benironside benironside self-assigned this Jan 26, 2024
@benironside benironside requested a review from a team as a code owner January 26, 2024 21:41
Copy link

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@benironside benironside requested a review from e40pud January 26, 2024 21:41
@e40pud
Copy link
Contributor

e40pud commented Jan 29, 2024

@benironside sorry, I did not really clarify well what docs we want to add. I updated the original ticket and added UPDATED section there:

It is not possible to change data view for the Alerts page and the data view for the page bound to .alerts-security.alerts-default index pattern.
Would be nice to add a docs note about that.

Let me know if you have questions about it.

@benironside benironside marked this pull request as draft January 30, 2024 17:11
e40pud
e40pud previously approved these changes Jan 30, 2024
Copy link
Contributor

@e40pud e40pud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this together!

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks, @benironside!

docs/getting-started/data-views-in-sec.asciidoc Outdated Show resolved Hide resolved
docs/getting-started/data-views-in-sec.asciidoc Outdated Show resolved Hide resolved

image::images/dataview-filter-example.gif[video showing how to filter the active data view]

This only allows you to add index patterns that match indices that currently contain data (other index patterns are unavailable). Note that any changes made are saved in the current browser window and won't persist if you open a new tab.

To permanently modify a {data-source}, delete an existing {data-source} or create a new one, you need the required permissions.
To learn more, refer to {apm-app-ref}/data-views.html[{kib} {data-sources-cap}].
NOTE: You cannot update the data view for the Alerts page. It always shows data from `.alerts-security.alerts-default`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@e40pud can we tweak the UI copy so it aligns with this note? The current copy could be interpreted as: you must go elsewhere to update the data view for the Alerts page.

Screenshot 2024-01-30 at 2 55 42 PM

If it's still possible to change the copy, I'd suggest this:

You can't modify the data view for the Alerts page.

If that version is too blunt and overly formal, here's a slightly softer version:

This page's data view can't be adjusted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not bound to Alerts page only. Same happens on rule details page. Also, there is another similar message that we show on the timeline. So, general message looks better to me.

Screen.Recording.2024-01-31.at.16.47.22.mov

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, interesting. Thanks for pointing out these other areas @e40pud -- I wasn't aware of them. Would it be ok if we continued this conversation in https://github.com/elastic/security-docs/issues/4718 so that we're not blocking this doc issue from being closed and merged?

benironside added a commit that referenced this pull request Jan 31, 2024
* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
mergify bot pushed a commit that referenced this pull request Jan 31, 2024
* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)
benironside added a commit that referenced this pull request Jan 31, 2024
* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Jan 31, 2024
) (#4731)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Jan 31, 2024
) (#4726)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Jan 31, 2024
…4695) (#4721)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4730)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4729)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4722)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4728)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4727)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4725)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4724)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
benironside added a commit that referenced this pull request Feb 1, 2024
) (#4723)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit 225f3c8)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
joepeeples added a commit that referenced this pull request Jul 17, 2024
Serverless follow up to #4695
joepeeples added a commit that referenced this pull request Jul 19, 2024
* Add admonition to serverless

Serverless follow up to #5513

* Update serverless to match ESS

Serverless follow up to #4695

* Fix URL variable/attribute

Should use `kibana-ref` instead of apm-app-ref since this has nothing to do with APM

* No-op change to trigger build

(i hope)
mergify bot pushed a commit that referenced this pull request Jul 19, 2024
* Add admonition to serverless

Serverless follow up to #5513

* Update serverless to match ESS

Serverless follow up to #4695

* Fix URL variable/attribute

Should use `kibana-ref` instead of apm-app-ref since this has nothing to do with APM

* No-op change to trigger build

(i hope)

(cherry picked from commit 9e7d734)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
mergify bot pushed a commit that referenced this pull request Jul 19, 2024
* Add admonition to serverless

Serverless follow up to #5513

* Update serverless to match ESS

Serverless follow up to #4695

* Fix URL variable/attribute

Should use `kibana-ref` instead of apm-app-ref since this has nothing to do with APM

* No-op change to trigger build

(i hope)

(cherry picked from commit 9e7d734)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
joepeeples added a commit that referenced this pull request Jul 19, 2024
…kport #5582) (#5586)

* (Doc+) Alerts UI cannot be CCS [serverless] + bonus fixes (#5582)

* Add admonition to serverless

Serverless follow up to #5513

* Update serverless to match ESS

Serverless follow up to #4695

* Fix URL variable/attribute

Should use `kibana-ref` instead of apm-app-ref since this has nothing to do with APM

* No-op change to trigger build

(i hope)

(cherry picked from commit 9e7d734)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joepeeples added a commit that referenced this pull request Jul 19, 2024
…kport #5582) (#5585)

* (Doc+) Alerts UI cannot be CCS [serverless] + bonus fixes (#5582)

* Add admonition to serverless

Serverless follow up to #5513

* Update serverless to match ESS

Serverless follow up to #4695

* Fix URL variable/attribute

Should use `kibana-ref` instead of apm-app-ref since this has nothing to do with APM

* No-op change to trigger build

(i hope)

(cherry picked from commit 9e7d734)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
acorretti pushed a commit that referenced this pull request Nov 19, 2024
) (#4729)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit eb7373e)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
acorretti pushed a commit that referenced this pull request Nov 19, 2024
) (#4727)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit eb7373e)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
acorretti pushed a commit that referenced this pull request Nov 19, 2024
) (#4730)

* Documents how to change the default security index (#4695)

* First draft

* incorporates feedback

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/getting-started/data-views-in-sec.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

---------

Co-authored-by: Nastasha Solomon <[email protected]>
(cherry picked from commit eb7373e)

# Conflicts:
#	docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

* Update docs/getting-started/data-views-in-sec.asciidoc

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants