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 flyout instruction to work with the install subcommand. #79180

Closed
ph opened this issue Oct 1, 2020 · 17 comments · Fixed by #79525
Closed

[Ingest Manager] Update flyout instruction to work with the install subcommand. #79180

ph opened this issue Oct 1, 2020 · 17 comments · Fixed by #79525
Assignees
Labels
Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@ph
Copy link
Contributor

ph commented Oct 1, 2020

The current flyout with the instruction look like this.

Screen Shot 2020-10-01 at 1 30 08 PM

With the addition of the [install/uninstall](elastic/beats#21019 subcommand we can simplify the setup process with the following.

From the agent’s directory, run the appropriate command to install, enroll and start an Elastic Agent. You can reuse these commands to setup agents on more than one machine. Be sure to run the install steps as a user with Administrator privilege on the system.

macOS, Linux

$ ./elastic-agent install -f --kibana-url https://18d799305eb949ccaea7242db1f0739a.eastus2.staging.azure.foundit.no:443 --enrollment-token NEk4MjVYUUIzcko0LXRJSlVnMno6NmRiV2dvSGNULU9zcml0YklBN0d4Zw==

Windows

$ .\elastic-agent.exe install -f --kibana-url https://18d799305eb949ccaea7242db1f0739a.eastus2.staging.azure.foundit.no:443 --enrollment-token NEk4MjVYUUIzcko0LXRJSlVnMno6NmRiV2dvSGNULU9zcml0YklBN0d4Zw==

To remove the following waiting on confirmation from @EricDavisX

Linux (.deb and .rpm)

elastic-agent enroll https://18d799305eb949ccaea7242db1f0739a.eastus2.staging.azure.foundit.no:443 NEk4MjVYUUIzcko0LXRJSlVnMno6NmRiV2dvSGNULU9zcml0YklBN0d4Zw==
systemctl enable elastic-agent
systemctl start elastic-agent

@EricDavisX @mostlyjason WDYT? should we just skip the linux, deb/rpm and redirect the user to the documentation?

@ph ph added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 1, 2020
@elasticmachine
Copy link
Contributor

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

@EricDavisX
Copy link
Contributor

Hi - @ph I'd take a slightly different route, please confirm if there is a downstream or future reason this wouldn't work... and you can decide what you like best:

Based on testing, it looks like .deb and .rpm are working just fine with install, so I'd list them lumped together with macOS and have just 2 sections in the flyout (instead of the 3) that we have now (one for 'Windows' and one for 'Linux / macOS'. And the command need only look slightly different between the 2 sections.

I do suggest to keep windows separate, because people that know windows (even if they aren't using it!) often insist that Windows syntax listed should have a .exe on it even if it doesn't need it to work in powershell. :)

test results:
Screen Shot 2020-10-02 at 8 09 13 AM

This way we can avoid citing any of the older commands or linux systemctl commands, tho we can keep them in the docs since we want to keep supporting and testing them.

@ph
Copy link
Contributor Author

ph commented Oct 2, 2020

@EricDavisX Good point on windows.

I would not have expected this to work on Debian/RPM, this is not installing a second Elastic-Agent when you do that?

@nchaulet
Copy link
Member

nchaulet commented Oct 2, 2020

@ph @EricDavisX should we have different instructions for Linux (.deb and .rpm) ?

@EricDavisX
Copy link
Contributor

I don't know the inner workings, I'd have to test to check it, to PH's question. But as I know it, we don't need separate info for .deb and .rpm - those users will unarchive / extract the files as they know for the archive type, and from that point on the instructions should be the same for 'install'

@mostlyjason
Copy link
Contributor

Yes I'd skip the deb/rpm instructions here and just offer a link to the docs. This will help us offer a simpler UX for our main recommended use case, and we'd treat deb/rpm as advanced use cases. Could saying something like "See the [Elastic Agent docs] for more instructions and options."

@nchaulet
Copy link
Member

nchaulet commented Oct 5, 2020

Also last question does the install command work standalone agents too?

@mostlyjason
Copy link
Contributor

Do standalone agents need to be installed? What behavior would that have?

@blakerouse
Copy link

Yes install command works for standalone agents. You would want to install a standalone agent if you want it to survive a reboot of the system, which in most cases you would.

@ghost
Copy link

ghost commented Oct 6, 2020

Hi Eric

We have created 08 testcases for this ticket and found that changes for install flyout are not reflected on latest 7.10.0-SNAPSHOT cloud environment with commit 2ace108 for merged PR #79525.

Kibana_commit

We have reported bug #79631 for the same and failed the 08 testcases under Updated flyout instruction to work with Install subcommand TestRun.

We will re-execute the tests once bug #79631 is fixed.

We have created 08 testcases for this ticket

@EricDavisX
Copy link
Contributor

EricDavisX commented Oct 6, 2020

ok, they may have missed the build kick off for the build you're using. we can check the hash commit for timing and figure it out.

  • it was merged around 6PM EST on Oct 5 - the build kicks off and completes around 7 AM EST on Oct 6, but isn't available until after 11 due to post-processing to push it to cloud. So, its not a new bug it just wasn't available.

@EricDavisX
Copy link
Contributor

its in the current build - confirmed. I will test it out a bit myself

@EricDavisX
Copy link
Contributor

found a small bug in the current build, fixed here - #79730 fyi.

  • we can follow up more on testing later. I have confirmed Windows as well (using the Kibana Endpoint demo server)

@ghost
Copy link

ghost commented Oct 7, 2020

Hi Eric

Thank you for sharing the feedback.

We have executed 08 testcases under Updated flyout instruction to work with Install subcommand(https://elastic.testrail.io/index.php?/runs/view/718) TestRun on latest 8.0.0-SNAPSHOT Kibana cloud environment with commit 6f98372 .

Screenshot:
kibana_commit

We have failed 02 testcases due to merged bug #79730 (#79730) not reflected on above 8.0.0-SNAPSHOT Kibana cloud environment and failed 01 testcase due to Query below:

Query:
Following text displayed under Enroll and start the Elastic-agent header under Add Agent->Enroll in Fleet tab on 8.0.0-SNAPSHOT Kibana cloud environment does not match with the text displayed under #79180_desc #79180 (comment)

Text displayed:
'From the agent directory, run the appropriate command to install, enroll, and start an Elastic Agent. You can reuse these commands to set up agents on more than one host. Requires administrator privileges.'

Screenshot:
query_flyout

Expected Text:
From the agent’s directory, run the appropriate command to install, enroll and start an Elastic Agent. You can reuse these commands to setup agents on more than one machine. Be sure to run the install steps as a user with Administrator privilege on the system.

Please confirm if it is the expected behavior.

@EricDavisX
Copy link
Contributor

Jason is opening a new ticket with specifics of what we want to iterate / improve on against what we already have. we can track it there - for now hold off on test suite updates, or other new tickets. thanks for raising it! @rahulgupta-qasource

@ghost
Copy link

ghost commented Oct 12, 2020

Hi Eric,

Thank you for sharing the feedback.

We have passed the below 02 testcases under Updated flyout instruction to work with Install subcommand TestRun as changes for #79730 bug fix are now reflected on latest 8.0.0-SNAPSHOT Kibana cloud environment with commit 5d71db0 .

Test-Case Link Title Status Remark
C34199 Validate Non interactive elastic-agent install command is displayed for Linux and macOS under Linux, macOS header Pass -
C34200 Validate Non interactive elastic-agent install command is displayed for Windows under Windows header Pass

Please let us know if anything is missing from our end.

@ghost
Copy link

ghost commented Oct 16, 2020

Hi Eric,

As per discussion in ingest weekly call, we have updated the failed testcase C34201 with the following current text message displayed under Enroll and start the Elastic Agent header on Enroll in fleet tab flyout :

Text displayed:
From the agent directory, run the appropriate command to install, enroll, and start an Elastic Agent. You can reuse these commands to set up agents on more than one host. Requires administrator privileges.
message_flyout

and passed it under Updated flyout instruction to work with Install subcommand TestRun on 7.10.0 BC2 Kibana cloud environment with commit f1c0bdd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants