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

[Ingest Manager] Update fleet instructions to run agent as a service #73491

Merged

Conversation

nchaulet
Copy link
Member

@nchaulet nchaulet commented Jul 28, 2020

Summary

Resolve #73135

Update instructions to run agent as a service.
This will be backported to 7.9 as it's a prerequisite for the endpoint plugin.

@hbharding I updated the instructions on windows to click on services as the script is doing it automatically.

UI Change

Screen Shot 2020-07-28 at 3 48 03 PM

@nchaulet nchaulet added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.9.0 labels Jul 28, 2020
@nchaulet nchaulet requested a review from a team July 28, 2020 15:49
@nchaulet nchaulet self-assigned this Jul 28, 2020
@botelastic botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Jul 28, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/ingest-management (Team:Ingest Management)

@EricDavisX
Copy link
Contributor

EricDavisX commented Jul 28, 2020

I didn't realize the ps1 script was going to be able to start up the service - this is great, thank you for updating the language. Knowing this, I think we could remove the whole Windows footnote that starts 'Alternatively, you can...'. It isn't helpful to guide them to the lesser path, that I can tell. And, leaving as it is, might be interpreted as users thinking they can skip both commands, skipping the enrollment - which they cannot. So, I'd like to see the line removed if we can? @hbharding
@nchaulet

@ph
Copy link
Contributor

ph commented Jul 28, 2020

Looks good to me, @mostlyjason ?

@nchaulet
Copy link
Member Author

Just removed the Alternatively, you can ... text

@nchaulet
Copy link
Member Author

@elasticmachine merge upstream

Comment on lines 26 to 37
const macOsLinuxTarCommand = `
./elastic-agent enroll ${enrollArgs}
./elastic-agent run`;

const linuxDebRpmCommand = `
./elastic-agent enroll ${enrollArgs}
systemctl enable elastic-agent
systemctl start elastic-agent`;

const windowsCommand = `
./elastic-agent enroll ${enrollArgs}
./install-service-elastic-agent.ps1`;

This comment was marked as outdated.

Copy link
Contributor

Choose a reason for hiding this comment

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

I can't comment to formal style guides, but it feels more readable to me here as committed.

Copy link
Contributor

Choose a reason for hiding this comment

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

this suggestion doesn't affect how the commands are displayed in the UI. however this suggestion is probably no longer relevant due to #73491 (comment)

<EuiSpacer size="l" />
<EuiText>
<FormattedMessage
id="xpack.ingestManager.enrollmentInstructions.macLinuxTarInstructions"

This comment was marked as outdated.

Copy link
Contributor

Choose a reason for hiding this comment

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

yes - its specific to any of the .tar.gz usage which do not currently support persistent Agent installs.

Copy link
Contributor

Choose a reason for hiding this comment

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

thanks @EricDavisX. in that case I would suggest moving this under macOS/Linux heading as a small and subdued color subtitle. the current placement made me think this was applicable to all instructions

<EuiText>
<FormattedMessage
id="xpack.ingestManager.enrollmentInstructions.macLinuxTarInstructions"
defaultMessage="You will need to run {command} if the agent’s system reboots. This is a known limitiation in 7.9."
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel that we don't need to call the release version here. @dedemorton can you suggest better text for this?

Copy link
Contributor

Choose a reason for hiding this comment

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

@jen-huang @dedemorton I think it is very helpful to have *some message here about persistence support. However if we wish to change it to say 'current release' instead of '7.9' I won't argue it, except to say it would be good to get this in all the sooner to get the back-port done.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jen-huang Looks like you worked this out? I think it's best to describe what users need to do rather than calling this out as a known limitation in this version.

Copy link
Contributor

@jen-huang jen-huang left a comment

Choose a reason for hiding this comment

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

Github ate part of my review...

This set of suggestions works with my other suggestions for the commands to remove the <pre> tags and styling in favor of the built-in EuiCodeBlock whiteSpace="pre" option.

@nchaulet
Copy link
Member Author

@elasticmachine merge upstream

Copy link
Contributor

@jen-huang jen-huang left a comment

Choose a reason for hiding this comment

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

Thanks for the quick turnaround on changes. Tested locally, LGTM 👍🏻

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Build metrics

async chunks size

id value diff baseline
ingestManager 1.1MB +2.5KB 1.1MB

History

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

@nchaulet nchaulet merged commit 93d45fc into elastic:master Jul 28, 2020
@nchaulet nchaulet deleted the feature-update-fleet-instructions-73135 branch July 28, 2020 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.9.0 v7.10.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Ingest Manager] service install script needs to be called out in Fleet 'enroll' dialog
7 participants