[Fleet] Display message explaining why agent is not upgradeable by criamico · Pull Request #173253 · elastic/kibana

criamico · 2023-12-13T10:33:33Z

Closes #171840
Also implements the UI part of #173281

Summary

When trying to upgrade a single agent that is not upgradeable, the error message doesn't specify why the agent cannot be upgraded. This PR is introducing:

More granular error messages in the endpoint POST agent/{agent_id}/upgrade. The messages are now different depending on which conditions are met. For the case when the agent is reported not upgradeable from elastic agent, there is now an error message the states it explicitly.
When clicking on the upgrade 1 agent from the bulk actions, if the agent is not upgradeable the submit button is now greyed out and a message explaining the reason is shown:

The same warning appears when clicking on other upgrade actions in the bulk action menu, but only for a single agent. Multiple upgrades have not been changed.

In the agents list, reuse the existing tooltip besides the version to show the same messages when the agent is not upgradeable:

Checklist

Unit or functional tests were updated or added to match the most common scenarios

ghost · 2023-12-13T10:33:46Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
/oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

criamico · 2023-12-13T10:34:12Z

/ci

criamico · 2023-12-14T10:34:46Z

@elasticmachine merge upstream

criamico · 2023-12-14T10:35:09Z

/ci

elasticmachine · 2023-12-14T10:56:32Z

Pinging @elastic/fleet (Team:Fleet)

x-pack/plugins/fleet/common/services/is_agent_upgradeable.test.ts

kpollich · 2023-12-14T13:37:26Z

x-pack/plugins/fleet/common/services/is_agent_upgradeable.test.ts

+describe('Fleet - getNotUpgradeableMessage', () => {
+  it('if agent reports not upgradeable with agent version < latest agent version', () => {
+    expect(getNotUpgradeableMessage(getAgent({ version: '7.9.0' }), '8.0.0')).toBe(
+      'agent is marked as not upgradeable in elastic-agent.'


Suggested change

'agent is marked as not upgradeable in elastic-agent.'

'agent cannot be upgraded through Fleet. It may be running in a container.'

cc @cmacknz - Any input on this particular message? I feel we don't want to surface something as technical as the supervisor process/PID 1 details here, but something explicit would be helpful until we get a more granular reason from #173281. Tried to borrow some wording from https://www.elastic.co/guide/en/fleet/current/elastic-agent-container.html#_what_you_need.

My suggestion would be something like "It may be running in a container or is not installed as a service".

That second scenario is the case where someone has just executed ./elastic-agent.exe directly out of the installation directory.

x-pack/plugins/fleet/common/services/is_agent_upgradeable.test.ts

x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts

criamico · 2023-12-14T13:56:41Z

@kpollich thanks for the review, I'm going to update the messages and I'll also add a tooltip since it's a very easy change. We already have a tooltip on the version numbers of the agent list, we just need to reuse the same function.

kpollich · 2023-12-14T13:58:28Z

Perfect, @criamico thank you!

…-fix'

criamico · 2023-12-18T10:08:13Z

@elasticmachine merge upstream

criamico · 2023-12-18T15:45:13Z

@elasticmachine merge upstream

juliaElastic · 2023-12-18T15:53:14Z

x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts

+  if (getRecentUpgradeInfoForAgent(agent).hasBeenUpgradedRecently) {
+    const timeToWaitMins = getRecentUpgradeInfoForAgent(agent).timeToWaitMins;
+    const elapsedMinsSinceUpgrade = getRecentUpgradeInfoForAgent(agent).elapsedMinsSinceUpgrade;
+    // const upgradeStarted = moment().subtract(AGENT_UPGRADE_COOLDOWN_IN_MIN - timeToWaitMins).minutes();


nit: comment should be removed

juliaElastic · 2023-12-18T15:54:39Z

...ins/fleet/public/applications/fleet/sections/agents/components/agent_upgrade_modal/index.tsx

+                  <em>
+                    <FormattedMessage
+                      id="xpack.fleet.upgradeAgents.upgradeSingleTimeout"
+                      // TODO: Add link to docs regarding agent upgrade cooldowns


do we have an issue for this in ingest-docs?

Not sure, the comment was already there, I tried to find docs for it but couldn't. I can open an issue for it

juliaElastic

LGTM 🚀

criamico · 2023-12-19T08:31:07Z

@elasticmachine merge upstream

Kyle's on PTO

criamico · 2023-12-19T10:21:12Z

@elasticmachine merge upstream

kibana-ci · 2023-12-19T11:36:08Z

💚 Build Succeeded

Buildkite Build
Commit: 6f4e429

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	954	955	+1

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.2MB	1.2MB	+1.0KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`fleet`	157.4KB	158.9KB	+1.6KB

History

💚 Build #184006 succeeded d2f82b0
💚 Build #183876 succeeded e39a363
💔 Build #183670 failed dda1a56
💔 Build #183638 failed ce16768
💔 Build #183596 failed 0fa37d6
💔 Build #183581 failed 0827248

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

cc @criamico

Fixes #173370 Closes #171941 ## Summary Show a warning when download upgrade is failing. This PR addresses a specific case of `upgrade downloading`: when the upgrade started but it's failing with an error. In this case, since 8.12, the agent metadata have a `retry_msg` that can be used to distinguish this case from the regular upgrade. I'm also fixing one smaller bug that I introduced with #173253, the tooltip shown in the case when the agent is not upgradeable was hiding the badge, so I'm moving the if as the last one in the function. ## Testing - Have an 8.12 agent installed with Multipass (it needs to be upgradeable) - Change the download binary url to something broken: `sourceURI: https://artifacts.elastic.co/notdownloads/` - Force upgrade from dev tools: ``` POST kbn:/api/fleet/agents/c3f09103-4e69-4a36-bee2-84223bedef36/upgrade { "version": "8.12.0", "force": true } ``` - Go to agent overview, the badge will show "upgrading" but will also have a warning icon with a tooltip, showing the retry message and the `retry_until` time in humanized format (retry until...remaining): ![Screenshot 2024-01-02 at 16 54 20](https://github.com/elastic/kibana/assets/16084106/ac340e7d-5151-4e4e-b6a6-731a113ff984) This way the message shows the values present in the agent metadata. - Same is reported in the agent list table: ![Screenshot 2024-01-02 at 16 54 28](https://github.com/elastic/kibana/assets/16084106/1f8823c4-9e5c-4f4c-9cdc-2839b16214bb) - After a while the retries will be finished and the agent will show the regular "upgrade failed" badge (this was already implemented): ![Screenshot 2023-12-21 at 12 07 27](https://github.com/elastic/kibana/assets/16084106/c1d5bf67-a4fd-4b04-aa8d-24dc8d4af54e) ### Checklist - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

criamico added 2 commits December 12, 2023 15:41

Display message explaining why agent is not upgradeable

24e24c2

Move function to common/services and add it to backend as well

67f0db0

criamico added the Team:Fleet Team label for Observability Data Collection Fleet team label Dec 13, 2023

criamico added the v8.13.0 label Dec 13, 2023

criamico self-assigned this Dec 13, 2023

criamico added 2 commits December 13, 2023 17:37

Add tests and small fixes

7bb953e

Update integration tests

29055d1

Merge branch 'main' into 171840_upgradeable_agent_UI

0827248

criamico added the release_note:enhancement label Dec 14, 2023

criamico marked this pull request as ready for review December 14, 2023 10:56

criamico requested a review from a team as a code owner December 14, 2023 10:56

criamico added 2 commits December 14, 2023 13:00

Fix broken test

0fa37d6

Fix test again

ed01269

criamico mentioned this pull request Dec 14, 2023

[Fleet] Add tooltip when upgradeable = false and "Upgrade agent" action is disabled #173281

Open

kpollich previously requested changes Dec 14, 2023

View reviewed changes

criamico and others added 4 commits December 14, 2023 15:19

Improve strings wording and add tooltip in agents list

ce16768

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

0279cae

…-fix'

Create constants and fix tests

dda1a56

Improve error message when reported from elastic agent

67027a2

Merge branch 'main' into 171840_upgradeable_agent_UI

e39a363

criamico requested a review from kpollich December 18, 2023 11:32

Merge branch 'main' into 171840_upgradeable_agent_UI

e555ef7

juliaElastic reviewed Dec 18, 2023

View reviewed changes

juliaElastic approved these changes Dec 18, 2023

View reviewed changes

Remove leftover comment

d2f82b0

Merge branch 'main' into 171840_upgradeable_agent_UI

6973b7e

Merge branch 'main' into 171840_upgradeable_agent_UI

6f4e429

criamico merged commit 63f4e38 into elastic:main Dec 19, 2023

kibanamachine added the backport:skip This PR does not require backporting label Dec 19, 2023

criamico deleted the 171840_upgradeable_agent_UI branch December 19, 2023 11:36

criamico mentioned this pull request Dec 21, 2023

[Fleet] Show warning when download upgrade is failing #173844

Merged

1 task

This was referenced Mar 8, 2024

[REQUEST]: Fleet - Improve agent upgrade docs elastic/ingest-docs#966

Closed

[Fleet] Display warning when trying to upgrade agent to version > max fleet server version #178079

Merged

	'agent is marked as not upgradeable in elastic-agent.'
	'agent cannot be upgraded through Fleet. It may be running in a container.'

Conversation

criamico commented Dec 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

ghost commented Dec 13, 2023

🤖 GitHub comments

Uh oh!

criamico commented Dec 13, 2023

Uh oh!

criamico commented Dec 14, 2023

Uh oh!

criamico commented Dec 14, 2023

Uh oh!

elasticmachine commented Dec 14, 2023

Uh oh!

Uh oh!

kpollich Dec 14, 2023

Choose a reason for hiding this comment

Uh oh!

cmacknz Dec 14, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

criamico commented Dec 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kpollich commented Dec 14, 2023

Uh oh!

criamico commented Dec 18, 2023

Uh oh!

criamico commented Dec 18, 2023

Uh oh!

juliaElastic Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

juliaElastic Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

criamico Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

juliaElastic left a comment

Choose a reason for hiding this comment

Uh oh!

criamico commented Dec 19, 2023

Uh oh!

criamico commented Dec 19, 2023

Uh oh!

kibana-ci commented Dec 19, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

criamico commented Dec 13, 2023 •

edited

Loading

criamico commented Dec 14, 2023 •

edited

Loading