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

Update Resolver generator script documentation #69912

Merged
merged 1 commit into from
Jun 25, 2020

Conversation

oatkiller
Copy link
Contributor

Summary

The documentation was a bit out of date:

  • referenced legacy endpoint plugin
  • had bad advice on starting Kibana (indicated that you should enable securitySolution, which is default enabled.)
  • contained an out of date copy of the result of running the script with the --help flag.

Checklist

Delete any items that are not applicable to this PR.

For maintainers

@oatkiller oatkiller requested review from a team as code owners June 25, 2020 12:07
@oatkiller oatkiller added release_note:skip Skip the PR/issue when compiling release notes v7.9.0 Feature:Endpoint Elastic Endpoint feature labels Jun 25, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/endpoint-app-team (Feature:Endpoint)

@@ -13,52 +13,10 @@ Example command sequence to get ES and kibana running with sample data after ins

`yarn es snapshot` -> starts ES

`npx yarn start --xpack.securitySolution.enabled=true --no-base-path` -> starts kibana
`npx yarn start --no-base-path` -> starts kibana. Note: you may need other configurations steps to start the security solution with endpoint support.
Copy link
Contributor

Choose a reason for hiding this comment

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

--xpack.ingestManager.enabled=true and --xpack.ingestManager.fleet.enabled=true aren't needed here?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think xpack.ingestManager.enabled might default to true and it automatically turns on fleet as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@michaelolo24 Right now other stuff is needed, but I don't want to host documentation about that here. When that stuff changes, I'd rather document it in one place. I think we used to have a README file, but I don't see it now.

We could add instructions to this file: https:/elastic/kibana/blob/master/x-pack/plugins/security/README.md and then link to that file from this one.

Copy link
Contributor

Choose a reason for hiding this comment

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

If it's defaulted, then no need :) Was just making sure.


Resolver generator CLI options:
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 for removing this

@oatkiller oatkiller merged commit a51ad2d into elastic:master Jun 25, 2020
@oatkiller oatkiller deleted the update-resolver-generator-docs branch June 25, 2020 12:52
oatkiller pushed a commit to oatkiller/kibana that referenced this pull request Jun 25, 2020
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jun 25, 2020
* master: (45 commits)
  [QA] Unskip functional tests (elastic#69760)
  [SIEM][Detection Engine] - Update DE to work with new exceptions schema (elastic#69715)
  Fixes elastic#69639: Ignore url.url fields above 2048 characters (elastic#69863)
  PR: Provide limit warnings to user when API limits are reached. (elastic#69590)
  [Maps] Remove broken button (elastic#69853)
  Makes usage collection methods available on start (elastic#69836)
  [SIEM][CASE] Improve Jira's labelling (elastic#69892)
  [Logs UI] Access ML via the programmatic plugin API (elastic#68905)
  [ML] DF Analytics: Creation wizard part 3 (elastic#69456)
  Update Resolver generator script documentation (elastic#69912)
  [ML] Changes View results button text on new job page (elastic#69809)
  Add master branch to backport config (elastic#69893)
  [Ingest Manager] Kibana, not EPR, controls removable packages (elastic#69761)
  unskips 'Events columns' test (elastic#69684)
  [ML] Changes the ML overview empty analytics panel text (elastic#69801)
  [DOCS] Emphasizes where File Data Visualizer is located. (elastic#69812)
  add the `exactRoute` property to app registration (elastic#69772)
  Bump backport to 5.4.6 (elastic#69880)
  [Logs UI] ML log integration splash screen (elastic#69288)
  Clean up TSVB type client code to conform to the schema (elastic#68519)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Endpoint Elastic Endpoint feature release_note:skip Skip the PR/issue when compiling release notes v7.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants