Update Timeline Template README.md #95814

peasead · 2021-03-30T16:28:57Z

Summary

xpack.security_solution.signalsIndex is listed to be added to kibana.dev.yml, however that generates:

FATAL  Error: Unknown configuration key(s): "xpack.security_solution.signalsIndex". \
Check for spelling errors and ensure that expected plugins are installed.

I think this should be xpack.securitySolution.signalsIndex

This is for the steps to create a timeline template.

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials

For maintainers

This was checked for breaking API changes and was labeled appropriately

Update to xpack.securitySolution.signalsIndex

elasticmachine · 2021-03-30T16:28:58Z

Pinging @elastic/kibana-docs (Team:Docs)

Added some clarification to create the `.siem-signals-elastic-default` index or the `hard_reset` will error.

peasead · 2021-04-09T05:35:21Z

Is there anything I need to do for this?

nastasha-solomon · 2021-04-12T18:58:21Z

@peasead apologies for the delayed response. Would you mind sharing where you're seeing this issue in our Security docs? I searched our docs for "xpack.security_solution.signalsIndex", "kibana.dev.yml", and variations of both but was unable to find mentions of either.
cc: @jmikell821

peasead · 2021-04-15T14:05:08Z

This is where I saw that. Is that improper? I noticed when I was trying to make a Timeline Template PR.

https://github.com/elastic/kibana/blob/master/x-pack/plugins/security_solution/server/lib/detection_engine/README.md

Open your kibana.dev.yml file and add these lines:
xpack.security_solution.signalsIndex: .siem-signals-${your user id}

nastasha-solomon · 2021-04-15T14:33:04Z

@peasead ah ok. The readme that you shared looks like internal documentation for devs--I thought you were referring to these public-facing docs (which is what @jmikell821 and I maintain):
https://www.elastic.co/guide/en/security/master/timeline-templates-ui.html

peasead · 2021-04-21T16:44:08Z

@nastasha-solomon do you know what group I need to ping to get the right visibility on this?

spong · 2021-04-21T17:07:12Z

x-pack/plugins/security_solution/server/lib/detection_engine/README.md

@@ -35,7 +35,7 @@ source ~/.zshrc
 Open your `kibana.dev.yml` file and add these lines:

 ```sh
-xpack.security_solution.signalsIndex: .siem-signals-${your user id}
+xpack.securitySolution.signalsIndex: .siem-signals-${your user id}


Thanks for catching and updating this @peasead! 👍

spong · 2021-04-21T17:12:03Z

x-pack/plugins/security_solution/server/lib/detection_engine/README.md

@@ -46,6 +46,8 @@ server log [22:05:22.277] [info][status][plugin:alerting@8.0.0] Status changed f
 server log [22:05:22.270] [info][status][plugin:actions@8.0.0] Status changed from uninitialized to green - Ready
 ```

+Go into Kibana and load the default detection rules or manually create the `.siem-signals-elastic-default` index.


Is this necessary? The following step of running the hard_reset.sh script will manage creating the signals index.

kibana/x-pack/plugins/security_solution/server/lib/detection_engine/scripts/hard_reset.sh

Lines 22 to 24 in 4584a8b

# re-create the signal index

./delete_signal_index.sh

./post_signal_index.sh

peasead · 2021-05-04T20:47:32Z

Is this documentation update waiting on anything from me?

spong · 2021-05-11T02:32:53Z

Is this documentation update waiting on anything from me?

I think just the feedback around the extra step. I went ahead and updated, so this should be g2g. Approving and setting to auto-merge then. Thanks again for catching and updating this @peasead! 🙂

kibanamachine · 2021-05-13T02:38:25Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 95814 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-05-14T02:48:24Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 95814 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-05-17T02:58:24Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 95814 or prevent reminders by adding the backport:skip label.

## Summary `xpack.security_solution.signalsIndex` is listed to be added to `kibana.dev.yml`, however that generates: ``` FATAL Error: Unknown configuration key(s): "xpack.security_solution.signalsIndex". \ Check for spelling errors and ensure that expected plugins are installed. ``` I think this should be `xpack.securitySolution.signalsIndex` This is for the steps to create a timeline template. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### 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)

kibanamachine · 2021-05-17T19:45:02Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

## Summary `xpack.security_solution.signalsIndex` is listed to be added to `kibana.dev.yml`, however that generates: ``` FATAL Error: Unknown configuration key(s): "xpack.security_solution.signalsIndex". \ Check for spelling errors and ensure that expected plugins are installed. ``` I think this should be `xpack.securitySolution.signalsIndex` This is for the steps to create a timeline template. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### 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: Andrew Pease <7442091+peasead@users.noreply.github.com>

Update README.md

cc82289

Update to xpack.securitySolution.signalsIndex

peasead added Team:Docs docs documentation labels Mar 30, 2021

peasead requested a review from a team as a code owner March 30, 2021 16:28

Update README.md

b194e69

Added some clarification to create the `.siem-signals-elastic-default` index or the `hard_reset` will error.

peasead added release_note:fix v7.13.0 and removed v7.13.0 labels Mar 30, 2021

KOTungseth requested review from jmikell821 and nastasha-solomon April 7, 2021 14:26

spong reviewed Apr 21, 2021

View reviewed changes

spong requested a review from a team April 21, 2021 17:22

spalger added v7.14.0 and removed v7.13.0 labels Apr 21, 2021

spong added 2 commits May 10, 2021 20:31

Removing extra instruction

a0ccb6b

Aaand extra space :)

7268757

spong approved these changes May 11, 2021

View reviewed changes

spong enabled auto-merge (squash) May 11, 2021 02:33

spong merged commit 4831826 into master May 11, 2021

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 13, 2021

spong deleted the timeline-template-commit-doc-fix-1 branch May 13, 2021 14:07

spong added the auto-backport Deprecated: Automatically backport this PR after it's merged label May 17, 2021

kibanamachine mentioned this pull request May 17, 2021

[7.x] Update Timeline Template README.md (#95814) #100237

Merged

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Timeline Template README.md #95814

Update Timeline Template README.md #95814

peasead commented Mar 30, 2021

elasticmachine commented Mar 30, 2021

peasead commented Apr 9, 2021

nastasha-solomon commented Apr 12, 2021

peasead commented Apr 15, 2021

nastasha-solomon commented Apr 15, 2021

peasead commented Apr 21, 2021

spong Apr 21, 2021

spong Apr 21, 2021

peasead commented May 4, 2021

spong commented May 11, 2021

kibanamachine commented May 13, 2021

kibanamachine commented May 14, 2021

kibanamachine commented May 17, 2021

kibanamachine commented May 17, 2021

	# re-create the signal index
	./delete_signal_index.sh
	./post_signal_index.sh

Update Timeline Template README.md #95814

Update Timeline Template README.md #95814

Conversation

peasead commented Mar 30, 2021

Summary

Checklist

For maintainers

elasticmachine commented Mar 30, 2021

peasead commented Apr 9, 2021

nastasha-solomon commented Apr 12, 2021

peasead commented Apr 15, 2021

nastasha-solomon commented Apr 15, 2021

peasead commented Apr 21, 2021

spong Apr 21, 2021

Choose a reason for hiding this comment

spong Apr 21, 2021

Choose a reason for hiding this comment

peasead commented May 4, 2021

spong commented May 11, 2021

kibanamachine commented May 13, 2021

kibanamachine commented May 14, 2021

kibanamachine commented May 17, 2021

kibanamachine commented May 17, 2021

💚 Backport successful