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

[Request][ESS] Document advanced setting that allows users to disable ES|QL in ESS #5163

Closed
nastasha-solomon opened this issue May 5, 2024 · 1 comment
Assignees
Labels
blocked An issue that's currently blocked because it’s pending info or action from stakeholders. Docset: ESS Issues that apply to docs in the Stack release Effort: Medium Issues that take moderate but not substantial time to complete Feature: ES|QL Feature: Rules Feature: Timeline Priority: High Issues that are time-sensitive and/or are of high customer importance v8.14.0

Comments

@nastasha-solomon
Copy link
Contributor

Description

ES|QL and related Security features in Timeline and Rules will be enabled by default in 8.14. If users want to disable ES|QL, they can toggle the enableESQL advanced setting off under the General section.

esql-advanced-setting

When the enableESQL advanced setting is toggled on (which is its default state):

  • The ES|QL tab in Timeline is available
    • The ES|QL option is available in Discover by Platform)
  • The ES|QL rule type exists in Rule Creation (Additionally available in Elasticsearch Query Stack rule)

When the enableESQL advanced setting is toggled off:

  • The ES|QL tab in Timeline doesn't display
  • Users cannot select the ES|QL rule type when creating a new rule

Exceptions that allow backward compatibility:
(The following notes were copied from https://github.com/elastic/security-team/issues/9313)

  • If a Timeline was saved prior to disabling ES|QL, these Timelines can be opened with the ES|QL tab available, and a user likewise could save a new Timeline with a modified query (although this seems like a workaround, it is consistent with Discover)
  • If an ES|QL rule was created prior to disabling ES|QL, this ES|QL rule can still be enabled and edited in the rule management. Additionally, a user can duplicate and create a new ES|QL rule (although this seems like a workaround, it is consistent with stack rules)

Background & resources

Which documentation set does this change impact?

ESS only

ESS release

8.14

Serverless release

N/A

Feature differences

N/A

API docs impact

N/A

Prerequisites, privileges, feature flags

N/A

@nastasha-solomon nastasha-solomon added Feature: Rules Feature: Timeline Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Medium Issues that take moderate but not substantial time to complete Docset: ESS Issues that apply to docs in the Stack release v8.14.0 Feature: ES|QL labels May 5, 2024
@nastasha-solomon nastasha-solomon self-assigned this May 5, 2024
@nastasha-solomon nastasha-solomon added the blocked An issue that's currently blocked because it’s pending info or action from stakeholders. label May 5, 2024
@nastasha-solomon
Copy link
Contributor Author

ESS docs updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked An issue that's currently blocked because it’s pending info or action from stakeholders. Docset: ESS Issues that apply to docs in the Stack release Effort: Medium Issues that take moderate but not substantial time to complete Feature: ES|QL Feature: Rules Feature: Timeline Priority: High Issues that are time-sensitive and/or are of high customer importance v8.14.0
Projects
None yet
Development

No branches or pull requests

1 participant