Update Beats tutorials for security on by default #120388

joshdover · 2021-12-03T17:53:00Z

Summary

Adds YAML block, copy, and doc links to on-prem Beats tutorials about how to configure Beats for the self-signed cert generated by Elasticsearch in secure-by-default mode for 8.0. There's a lot of whitespace changes and it's all mostly copy and paste, not nearly as big as looks.

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

joshdover · 2021-12-03T18:04:02Z

src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts

-        defaultMessage:
-          'First time using Filebeat? See the [Quick Start]({guideLinkUrl}).\n\
+export const createFilebeatInstructions = (context: TutorialContext) => {
+  const SSL_DOC_URL = `https://www.elastic.co/guide/en/beats/filebeat/${context.kibanaVersion}/configuration-ssl.html#ca-sha256`;


Here's where we use the Kibana version

Another use case for #95389

TinaHeiligers

Adding the Kibana version to the tutorials seems safe enough.

joshdover · 2021-12-03T18:04:32Z

src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts

+        textPost: i18n.translate(
+          'home.tutorials.common.filebeatInstructions.config.osxTextPostMarkdown',
+          {
+            defaultMessage:
+              'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of \
+              Elasticsearch, and {kibanaUrlTemplate} is the URL of Kibana. To [configure SSL]({configureSslUrl}) with the \
+              default certificate generated by Elasticsearch, add its fingerprint in {esCertFingerprintTemplate} and set the \
+              verification mode to {selfSignedCaTemplate}.',
+            values: {
+              passwordTemplate: '`<password>`',
+              esUrlTemplate: '`<es_url>`',
+              kibanaUrlTemplate: '`<kibana_url>`',
+              configureSslUrl: SSL_DOC_URL,
+              esCertFingerprintTemplate: '`<es cert fingerprint>`',
+              selfSignedCaTemplate: '`self_signed_ca`',
+            },
+          }
+        ),


And here's where we actually update the instructions (similar below for each OS). Apologize for all the whitespace changes 😄

TinaHeiligers

Adding the kibana version makes sense and, yes, this is another use-case for server-side doclinks.
nit: we need to make sure the tutorials give info about what is required and what isn't. I imagine someone going through a tutorial to get their data indexed and only finding out later that they missed a required config.

TinaHeiligers · 2021-12-03T18:13:14Z

src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts

+          {
+            defaultMessage:
+              'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of \
+              Elasticsearch, and {kibanaUrlTemplate} is the URL of Kibana. To [configure SSL]({configureSslUrl}) with the \


We should mention when configuring SSL is required for the deployment, if possible. Tutorials help guide folks through the process flow and giving more information around what is required and what isn't.

I've added a comment to the yaml block that indicates this, let me know what you think. Additionally, the docs that we're linking to here will be updated with additional information before the 8.0 release.

@mostlyjason Feel free to let me know if you think we should make any adjustments to the copy here.

TinaHeiligers · 2021-12-03T18:14:55Z

src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts

+          {
+            defaultMessage:
+              'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of \
+            Elasticsearch, and {kibanaUrlTemplate} is the URL of Kibana. To [configure SSL]({configureSslUrl}) with the \


Same comment about guiding folks about required vs optional config

TinaHeiligers · 2021-12-03T18:15:10Z

src/plugins/home/server/tutorials/instructions/filebeat_instructions.ts

+          {
+            defaultMessage:
+              'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of \
+            Elasticsearch, and {kibanaUrlTemplate} is the URL of Kibana. To [configure SSL]({configureSslUrl}) with the \


optional or required?

elasticmachine · 2021-12-03T18:53:25Z

Pinging @elastic/kibana-core (Team:Core)

elasticmachine · 2021-12-03T18:53:26Z

Pinging @elastic/fleet (Team:Fleet)

pgayvallet

LGTM once the unused i18n keys are removed

src/plugins/home/server/services/tutorials/tutorials_registry.ts

…s-tutorials

joshdover · 2021-12-07T13:56:18Z

I've updated this to use the new ca_trusted_fingerprint config value that was added in elastic/beats#29229 instead of ca_sha256 + verification_mode: self_signed_ca

kibana-ci · 2021-12-07T15:08:16Z

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`home`	102	103	+1

Unknown metric groups

API count

id	before	after	diff
`home`	132	133	+1

History

💔 Build #11068 failed 1dd84bb
💔 Build #11052 failed adb28097e63ccedcfa28aa743c52e87d09114c7a

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @joshdover

kibanamachine · 2021-12-07T15:11:46Z

💚 Backport successful

Status	Branch	Result
✅	8.0

This backport PR will be merged automatically after passing CI.

Co-authored-by: Josh Dover <[email protected]>

joshdover requested a review from TinaHeiligers December 3, 2021 17:53

joshdover commented Dec 3, 2021

View reviewed changes

TinaHeiligers reviewed Dec 3, 2021

View reviewed changes

joshdover commented Dec 3, 2021

View reviewed changes

TinaHeiligers reviewed Dec 3, 2021

View reviewed changes

joshdover added 7 commits December 3, 2021 19:25

Add kibanaVersion to TutorialContext

107e214

Add self-signed fields to filebeat tutorials

9891beb

Add self-signed fields to metricbeat tutorials

b96f439

Add self-signed fields to auditbeat tutorials

8b6c9db

Add self-signed fields to functionbeat tutorials

9e09954

Add self-signed fields to heartbeat tutorials

1794928

Add self-signed fields to winlogbeat tutorials

abdc9a2

joshdover force-pushed the sec-by-default/beats-tutorials branch from adb2809 to abdc9a2 Compare December 3, 2021 18:47

Fix jest tests

1dd84bb

joshdover marked this pull request as ready for review December 3, 2021 18:53

joshdover requested a review from a team as a code owner December 3, 2021 18:53

joshdover self-assigned this Dec 3, 2021

joshdover enabled auto-merge (squash) December 3, 2021 18:54

joshdover disabled auto-merge December 3, 2021 18:56

pgayvallet approved these changes Dec 7, 2021

View reviewed changes

src/plugins/home/server/services/tutorials/tutorials_registry.ts Outdated Show resolved Hide resolved

joshdover added 2 commits December 7, 2021 14:37

Merge remote-tracking branch 'upstream/main' into sec-by-default/beat…

470c187

…s-tutorials

PR comments + fix i18n check

b742dc0

Update instructions to use ca_trusted_fingerprint

4adeb34

joshdover enabled auto-merge (squash) December 7, 2021 13:56

joshdover merged commit fcd47f3 into elastic:main Dec 7, 2021

kibanamachine mentioned this pull request Dec 7, 2021

[8.0] Update Beats tutorials for security on by default (#120388) #120629

Merged

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 7, 2021

Update Beats tutorials for security on by default (elastic#120388)

a497c33

kibanamachine added a commit that referenced this pull request Dec 7, 2021

Update Beats tutorials for security on by default (#120388) (#120629)

3ca624a

Co-authored-by: Josh Dover <[email protected]>

TinLe pushed a commit to TinLe/kibana that referenced this pull request Dec 22, 2021

Update Beats tutorials for security on by default (elastic#120388)

17dcd15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Beats tutorials for security on by default #120388

Update Beats tutorials for security on by default #120388

joshdover commented Dec 3, 2021 •

edited

Loading

joshdover Dec 3, 2021

joshdover Dec 3, 2021

TinaHeiligers left a comment

joshdover Dec 3, 2021

TinaHeiligers left a comment

TinaHeiligers Dec 3, 2021

joshdover Dec 3, 2021

joshdover Dec 3, 2021

TinaHeiligers Dec 3, 2021

TinaHeiligers Dec 3, 2021

elasticmachine commented Dec 3, 2021

elasticmachine commented Dec 3, 2021

pgayvallet left a comment

joshdover commented Dec 7, 2021

kibana-ci commented Dec 7, 2021

API count

kibanamachine commented Dec 7, 2021

Update Beats tutorials for security on by default #120388

Update Beats tutorials for security on by default #120388

Conversation

joshdover commented Dec 3, 2021 • edited Loading

Summary

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Dec 3, 2021

elasticmachine commented Dec 3, 2021

pgayvallet left a comment

Choose a reason for hiding this comment

joshdover commented Dec 7, 2021

kibana-ci commented Dec 7, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

API count

History

kibanamachine commented Dec 7, 2021

💚 Backport successful

joshdover commented Dec 3, 2021 •

edited

Loading