Skip to content

[8.x] Fix order of operations in instructions. (#195503)#195524

Merged
kibanamachine merged 1 commit intoelastic:8.xfrom
kibanamachine:backport/8.x/pr-195503
Oct 9, 2024
Merged

[8.x] Fix order of operations in instructions. (#195503)#195524
kibanamachine merged 1 commit intoelastic:8.xfrom
kibanamachine:backport/8.x/pr-195503

Conversation

@kibanamachine
Copy link
Copy Markdown
Contributor

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

## Summary

The enroll command must be executed after the elastic-agent is running.
This updates the instructions so that users are told to enable and start
the agent before running the `enroll` command to ensure the socket file
is created and available.

This fixes issues with errors like this:

```
{"log.level":"info","@timestamp":"2024-10-08T20:47:06.857Z","log.origin":{"function":"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff","file.name":"cmd/enroll_cmd.go","file.line":518},"message":"Starting enrollment to URL: https://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/","ecs.version":"1.6.0"}
{"log.level":"info","@timestamp":"2024-10-08T20:47:08.681Z","log.origin":{"function":"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff","file.name":"cmd/enroll_cmd.go","file.line":481},"message":"Restarting agent daemon, attempt 0","ecs.version":"1.6.0"}
{"log.level":"error","@timestamp":"2024-10-08T20:47:08.683Z","log.origin":{"function":"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff","file.name":"cmd/enroll_cmd.go","file.line":495},"message":"Restart attempt 0 failed: 'rpc error: code = Unavailable desc = connection error: desc = \"transport: Error while dialing: dial unix /usr/share/elastic-agent/elastic-agent.sock: connect: no such file or directory\"'. Waiting for 2s","ecs.version":"1.6.0"}
```

### Checklist

N/A

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

(cherry picked from commit 13c2c76)
@kibanamachine kibanamachine added the backport This PR is a backport of another PR label Oct 9, 2024
@kibanamachine kibanamachine enabled auto-merge (squash) October 9, 2024 00:06
@botelastic botelastic Bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 9, 2024
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/fleet (Team:Fleet)

@kibanamachine kibanamachine merged commit d3c0b00 into elastic:8.x Oct 9, 2024
@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
fleet 1.8MB 1.8MB +6.0B

cc @rhass

rhass added a commit that referenced this pull request Oct 9, 2024
# Backport

This will backport the following commits from `main` to `8.15`:
- [Fix order of operations in instructions.
(#195503)](#195503)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Ryan
Hass","email":"rhass@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-09T00:01:48Z","message":"Fix
order of operations in instructions. (#195503)\n\n## Summary\r\n\r\nThe
enroll command must be executed after the elastic-agent is
running.\r\nThis updates the instructions so that users are told to
enable and start\r\nthe agent before running the `enroll` command to
ensure the socket file\r\nis created and available.\r\n\r\nThis fixes
issues with errors like
this:\r\n\r\n```\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:06.857Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":518},\"message\":\"Starting
enrollment to URL:
https://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:08.681Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":481},\"message\":\"Restarting
agent daemon, attempt
0\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"error\",\"@timestamp\":\"2024-10-08T20:47:08.683Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":495},\"message\":\"Restart
attempt 0 failed: 'rpc error: code = Unavailable desc = connection
error: desc = \\\"transport: Error while dialing: dial unix
/usr/share/elastic-agent/elastic-agent.sock: connect: no such file or
directory\\\"'. Waiting for
2s\",\"ecs.version\":\"1.6.0\"}\r\n```\r\n\r\n###
Checklist\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13c2c7663546da0f6b34e5dd85932ebc74ecafa7","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v9.0.0","backport:prev-major","v8.16.0"],"number":195503,"url":"https://github.com/elastic/kibana/pull/195503","mergeCommit":{"message":"Fix
order of operations in instructions. (#195503)\n\n## Summary\r\n\r\nThe
enroll command must be executed after the elastic-agent is
running.\r\nThis updates the instructions so that users are told to
enable and start\r\nthe agent before running the `enroll` command to
ensure the socket file\r\nis created and available.\r\n\r\nThis fixes
issues with errors like
this:\r\n\r\n```\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:06.857Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":518},\"message\":\"Starting
enrollment to URL:
https://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:08.681Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":481},\"message\":\"Restarting
agent daemon, attempt
0\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"error\",\"@timestamp\":\"2024-10-08T20:47:08.683Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":495},\"message\":\"Restart
attempt 0 failed: 'rpc error: code = Unavailable desc = connection
error: desc = \\\"transport: Error while dialing: dial unix
/usr/share/elastic-agent/elastic-agent.sock: connect: no such file or
directory\\\"'. Waiting for
2s\",\"ecs.version\":\"1.6.0\"}\r\n```\r\n\r\n###
Checklist\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13c2c7663546da0f6b34e5dd85932ebc74ecafa7"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195503","number":195503,"mergeCommit":{"message":"Fix
order of operations in instructions. (#195503)\n\n## Summary\r\n\r\nThe
enroll command must be executed after the elastic-agent is
running.\r\nThis updates the instructions so that users are told to
enable and start\r\nthe agent before running the `enroll` command to
ensure the socket file\r\nis created and available.\r\n\r\nThis fixes
issues with errors like
this:\r\n\r\n```\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:06.857Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":518},\"message\":\"Starting
enrollment to URL:
https://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"info\",\"@timestamp\":\"2024-10-08T20:47:08.681Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":481},\"message\":\"Restarting
agent daemon, attempt
0\",\"ecs.version\":\"1.6.0\"}\r\n{\"log.level\":\"error\",\"@timestamp\":\"2024-10-08T20:47:08.683Z\",\"log.origin\":{\"function\":\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\",\"file.name\":\"cmd/enroll_cmd.go\",\"file.line\":495},\"message\":\"Restart
attempt 0 failed: 'rpc error: code = Unavailable desc = connection
error: desc = \\\"transport: Error while dialing: dial unix
/usr/share/elastic-agent/elastic-agent.sock: connect: no such file or
directory\\\"'. Waiting for
2s\",\"ecs.version\":\"1.6.0\"}\r\n```\r\n\r\n###
Checklist\r\n\r\nN/A\r\n\r\n### For maintainers\r\n\r\n- [ ] This was
checked for breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13c2c7663546da0f6b34e5dd85932ebc74ecafa7"}},{"branch":"8.x","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/195524","number":195524,"state":"MERGED","mergeCommit":{"sha":"d3c0b006da9d607904f9e395849b99cf11a4413f","message":"[8.x]
Fix order of operations in instructions. (#195503) (#195524)\n\n#
Backport\n\nThis will backport the following commits from `main` to
`8.x`:\n- [Fix order of operations in
instructions.\n(#195503)](https://github.com/elastic/kibana/pull/195503)\n\n<!---
Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the
[Backport
tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT
[{\"author\":{\"name\":\"Ryan\nHass\",\"email\":\"rhass@users.noreply.github.com\"},\"sourceCommit\":{\"committedDate\":\"2024-10-09T00:01:48Z\",\"message\":\"Fix\norder
of operations in instructions. (#195503)\\n\\n##
Summary\\r\\n\\r\\nThe\nenroll command must be executed after the
elastic-agent is\nrunning.\\r\\nThis updates the instructions so that
users are told to\nenable and start\\r\\nthe agent before running the
`enroll` command to\nensure the socket file\\r\\nis created and
available.\\r\\n\\r\\nThis fixes\nissues with errors
like\nthis:\\r\\n\\r\\n```\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:06.857Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":518},\\\"message\\\":\\\"Starting\nenrollment
to
URL:\nhttps://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.681Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":481},\\\"message\\\":\\\"Restarting\nagent
daemon,
attempt\n0\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"error\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.683Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":495},\\\"message\\\":\\\"Restart\nattempt
0 failed: 'rpc error: code = Unavailable desc = connection\nerror: desc
= \\\\\\\"transport: Error while dialing: dial
unix\n/usr/share/elastic-agent/elastic-agent.sock: connect: no such file
or\ndirectory\\\\\\\"'. Waiting
for\n2s\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n```\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\nN/A\\r\\n\\r\\n###
For maintainers\\r\\n\\r\\n- [ ] This was\nchecked for breaking API
changes and
was\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"13c2c7663546da0f6b34e5dd85932ebc74ecafa7\",\"branchLabelMapping\":{\"^v9.0.0$\":\"main\",\"^v8.16.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"Team:Fleet\",\"v9.0.0\",\"backport:prev-major\"],\"title\":\"Fix\norder
of operations
in\ninstructions.\",\"number\":195503,\"url\":\"https://github.com/elastic/kibana/pull/195503\",\"mergeCommit\":{\"message\":\"Fix\norder
of operations in instructions. (#195503)\\n\\n##
Summary\\r\\n\\r\\nThe\nenroll command must be executed after the
elastic-agent is\nrunning.\\r\\nThis updates the instructions so that
users are told to\nenable and start\\r\\nthe agent before running the
`enroll` command to\nensure the socket file\\r\\nis created and
available.\\r\\n\\r\\nThis fixes\nissues with errors
like\nthis:\\r\\n\\r\\n```\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:06.857Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":518},\\\"message\\\":\\\"Starting\nenrollment
to
URL:\nhttps://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.681Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":481},\\\"message\\\":\\\"Restarting\nagent
daemon,
attempt\n0\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"error\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.683Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":495},\\\"message\\\":\\\"Restart\nattempt
0 failed: 'rpc error: code = Unavailable desc = connection\nerror: desc
= \\\\\\\"transport: Error while dialing: dial
unix\n/usr/share/elastic-agent/elastic-agent.sock: connect: no such file
or\ndirectory\\\\\\\"'. Waiting
for\n2s\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n```\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\nN/A\\r\\n\\r\\n###
For maintainers\\r\\n\\r\\n- [ ] This was\nchecked for breaking API
changes and
was\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"13c2c7663546da0f6b34e5dd85932ebc74ecafa7\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v9.0.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/195503\",\"number\":195503,\"mergeCommit\":{\"message\":\"Fix\norder
of operations in instructions. (#195503)\\n\\n##
Summary\\r\\n\\r\\nThe\nenroll command must be executed after the
elastic-agent is\nrunning.\\r\\nThis updates the instructions so that
users are told to\nenable and start\\r\\nthe agent before running the
`enroll` command to\nensure the socket file\\r\\nis created and
available.\\r\\n\\r\\nThis fixes\nissues with errors
like\nthis:\\r\\n\\r\\n```\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:06.857Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).enrollWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":518},\\\"message\\\":\\\"Starting\nenrollment
to
URL:\nhttps://<REDACTED>.fleet.us-west-2.aws.elastic.cloud:443/\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"info\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.681Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":481},\\\"message\\\":\\\"Restarting\nagent
daemon,
attempt\n0\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n{\\\"log.level\\\":\\\"error\\\",\\\"@timestamp\\\":\\\"2024-10-08T20:47:08.683Z\\\",\\\"log.origin\\\":{\\\"function\\\":\\\"github.com/elastic/elastic-agent/internal/pkg/agent/cmd.(*enrollCmd).daemonReloadWithBackoff\\\",\\\"file.name\\\":\\\"cmd/enroll_cmd.go\\\",\\\"file.line\\\":495},\\\"message\\\":\\\"Restart\nattempt
0 failed: 'rpc error: code = Unavailable desc = connection\nerror: desc
= \\\\\\\"transport: Error while dialing: dial
unix\n/usr/share/elastic-agent/elastic-agent.sock: connect: no such file
or\ndirectory\\\\\\\"'. Waiting
for\n2s\\\",\\\"ecs.version\\\":\\\"1.6.0\\\"}\\r\\n```\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\nN/A\\r\\n\\r\\n###
For maintainers\\r\\n\\r\\n- [ ] This was\nchecked for breaking API
changes and
was\n[labeled\\r\\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\",\"sha\":\"13c2c7663546da0f6b34e5dd85932ebc74ecafa7\"}}]}]\nBACKPORT-->\n\nCo-authored-by:
Ryan Hass <rhass@users.noreply.github.com>"}}]}] BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR Team:Fleet Team label for Observability Data Collection Fleet team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants