[docs] Add Elastic Agent doc changes for 7.9 #20437
Conversation
dedemorton
added
docs
needs_backport
botelastic
bot
added
needs_team
💚 Build Succeeded
Expand to view the summary
Build stats
|
|
Pinging @elastic/ingest-management (Team:Ingest Management) |
dedemorton
changed the title
|
@EricDavisX @hbharding This PR needs to be reviewed and merged before elastic/observability-docs#80 will pass. Note my comment in the original description for how to proceed with reviewing the tabbed panel "widgets." |
|
@dedemorton hi - I am reviewing. I have some minor and some more important feedback, but none of it is preventative to merging to get the delta smaller for our discussions. Not sure if you want to make more changes now or push it in and keep iterating? Here are the first 2 items I wanted to confirm (first is not a bug maybe, probably process thing I need help on): 1)this page links to 8.0, which is not available as GA (correctly). is it right that its pointing to 8.0 ? https://beats_20437.docs-preview.app.elstc.co/guide/en/ingest-management/master/elastic-agent-installation.html
might be easier to do a zoom but I'm happy to write out my thoughts to post in-line feedback |
Yup, it's right. I use a variable to resolve the version. When I port this change to 7.9, it will show the correct version. I've temporarily set the Happy to zoom if that's easier for you. Might be more efficient because I've done some things to work around the current design and should explain those because I expect more changes before GA. |
|
@EricDavisX Oh heck. I just realized that the override is in the other PR. I'll add it here so you can see the commands properly in the preview without having to look at the diff. |
|
For details, I just finished reviewing - here is what I have and it is less impactful than I thought, the docs are in really good shape here, well done! 1a) the powershell command when run on windows will actually 'start' the agent too. we could move steps 3-5 to the 'start agent' page? Its ok to leave them here, but its a little more consistent to have just the 'unzip' step here and move the '.\install-service-elastic-agent.ps1' script to after the enroll command. 1b) and in general I'd like to brainstorm on how we can de-emphasize the regular 'Linux' tab and usage, we should encourage them to .deb/.rpm usage if at all possible since it facilitates persistent Agent install and the .tar.gz usage does not. Can we at least add some language there to this effect on the linux tab? something like "We recommend to use the .deb or .rpm installation methods if at all possible to support persistent Agent execution' ? not sure what else you think on this. The enroll process page: 2a) all enrollments need to be done as Administrator (sudo) level, but Windows is the only one that calls this out. Can we add a sentence similar to or further enhanced as to what is in the product UI? That line I wrote (to the best of my ability) is: 2b) can we change this "to generate an enrollment token." 2c) under step 4 for Windows, this depends on what you decided in feedback item 1) above. If you want to leave step 1 alone you could cite that this is optional to 'start Elastic Agent if, needed'. It should already be running after the .ps1 script is run. This is in regards to the line: 2d) for macOS start up, the Endpoint team was going to confirm some steps to configure it as a service manually, would you want to put those in here, maybe? 3a) on the stop Elastic Agent view, can we tweak this a bit: 4a) we need to remove the citation of the --staging command, it is intended to be for internal use only.
Happy to zoom to go over this so its more clear, if needed |
|
@EricDavisX OK, I think I've addressed most of your concerns, except the CLI topic, which I plan to update next. |
|
Approval was received via slack to merge this because it's required to get the overall ingest management PR building in elastic/observability-docs#80. We will iterate over all the content again during that review and follow up with another PR in the beats repo, if necessary. |
💚 Build Succeeded
Expand to view the summary
Build stats
|
* [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
* [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
* [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
* [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
dedemorton
removed
the
needs_backport
* [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
…#20502) * [docs] Add ingest management doc changes for 7.9 * Update Beats agent docs with other 7.9 changes * Add copy of js/css to reduce dependencies * Temporarily override release state * Fix bug in platform selector * Add changes from review
Adds beats-related ingest management changes for 7.9. Preview: https://beats_20437.docs-preview.app.elstc.co/guide/en/ingest-management/master/elastic-agent-installation-configuration.html (look at Elastic Agent changes only)
Requires elastic/observability-docs#80
REVIEWERS: Our tabbed panels are evolving. We need to inject the HTML directly into the build right now, but that will change in the future. For now, the best way to review the content there is to look at the rendered content in the preview.
Please don't review the javascript or css (that's already been reviewed--I'm just copying it here).