[Fleet] Elastic Agent upgrade states UI #167539

jillguyonnet · 2023-09-28T16:08:35Z

Summary

Closes https://github.com/elastic/ingest-dev/issues/1937

This PR implements the UI side of the new Elastic Agent upgrade states.

Note: the following changes will be present regardless of whether Elastic Agent has upgrade details:

Wider Version column
Upgrade available text is now a badge

Screenshots

Steps to reproduce

Note: the Elastic Agent changes are not ready yet, so the proposed testing steps aim to mock the upgrade states by editing the agent document(s) manually.

Run Kibana on this branch.
Enroll at least one agent (or more to test more quickly).
Create a "super duper user" in order to edit the agent document(s) (see below). Use this user to edit your agent document(s) and add upgrade details (see below for examples). ⚠️ These upgrade details won't stay for very long, so make sure to check the UI immediately.
In Fleet UI, check that the UI correctly reflects the upgrade state (badge and tooltip).
Check that an upgrading agent with no upgrade details correctly gets a tooltip informing that the upgrade details are not available. This can be mocked by editing the agent document again and setting upgrade_started_at to some timestamp and upgraded_at to null.

How to create a "super duper user"

In dev tools, run the following two commands:

PUT _security/role/super_duper_user
{
  "cluster" : [
    "all"
  ],
  "indices" : [
    {
      "names" : [
        "*"
      ],
      "privileges" : [
        "all"
      ],
      "field_security" : {
        "grant" : [
          "*"
        ],
        "except" : [ ]
      },
      "allow_restricted_indices" : true
    }
  ],
  "applications" : [ ],
  "run_as" : [ ],
  "metadata" : { },
  "transient_metadata" : {
    "enabled" : true
  }
}

PUT _security/user/strong_user
{

    "roles": [
      "super_duper_user",
      "superuser"
    ],
    "full_name": "Super Duper User",
    "email": "super@elastic.co",
    "password": "changeme",
    "metadata": {},
    "enabled": true
  
}

Adding upgrade details to an agent

Example commands:

POST .fleet-agents/_update/<agent_id>
{
  "doc": {
    "upgrade_details": {
      "target_version": "8.11",
      "action_id": "xxxxxxxx",
      "state": "UPG_SCHEDULED",
      "metadata": {
        "scheduled_at": "2023-10-04T16:34:12Z" // edit this to a better time to check that the number of hours in the tooltip message is correct
      }
    }
  }
}

POST .fleet-agents/_update/<agent_id>
{
  "doc": {
    "upgrade_details": {
      "target_version": "8.11",
      "action_id": "xxxxxxxx",
      "state": "UPG_DOWNLOADING",
      "metadata": {
        "download_percent": 16.4
      }
    }
  }
}

POST .fleet-agents/_update/<agent_id>
{
  "doc": {
    "upgrade_details": {
      "target_version": "8.11",
      "action_id": "xxxxxxxx",
      "state": "UPG_FAILED",
      "metadata": {
        "failed_state": "UPG_DOWNLOADING",
        "error_msg": "Something went BOOM"
      }
    }
  }
}

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

apmmachine · 2023-09-28T16:08:51Z

🤖 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!)

jillguyonnet · 2023-10-03T14:13:46Z

@elasticmachine merge upstream

x-pack/plugins/fleet/common/types/models/agent.ts

jillguyonnet · 2023-10-04T12:52:51Z

@elasticmachine merge upstream

jillguyonnet · 2023-10-04T13:16:48Z

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx

+    );
+  }
+
+  // TODO: check logic


This is something I'm not sure of: we want to show this tooltip if the agent is upgrading but doesn't have upgrade details. Is this check a proper way to do this?

Changed the check to upgrade_started_at:* AND NOT upgraded_at:* (thanks @juliaElastic).
@ycombinator Could you confirm this is correct?

This predicate makes sense to me. And I think it's clever to show the tooltip in this scenario (agent is upgrading but we don't have upgrade details) as it encourages users to upgrade to 8.12.

My only feedback would be to somehow not hardcode the 8.12 if possible because we don't know yet when the entire implementation of the upgrade details (including the Agent side of things) will be done. I'm reasonably sure we're on track for 8.12 on the Agent side of things but if, for some odd reason, we don't make that, how can we remember to update this tooltip text? Or perhaps, to be safe, we could pull out just the code for this scenario into a separate PR that we merge at the very end, when we're absolutely sure of the version upgrade details will be available, end-to-end?

I agree hardcoding the version number is not ideal.

Perhaps a narrow way to be safe could be to define a minVersion variable, currently undefined, and only render the tooltip when its value is set. Then, when the changes are ready on Agent side, we would have to remember to open a PR to set the value to 8.12 or another.

@juliaElastic WDYT?

Sounds good, we could create a small gh issue and put in this sprint so we don't forget to set the variable.

@ycombinator I've pushed this change and the other one (no download percent indication in the tooltip if 0) and opened a WIP followup PR to set the version: #168638 that could be merged after the Agent changes are ready.

Could you confirm whether we're ok to merge this PR and add a task to elastic/elastic-agent#3119 to ping Fleet team to merge #168638 when you are ready on your end?

elasticmachine · 2023-10-04T14:43:44Z

Pinging @elastic/fleet (Team:Fleet)

juliaElastic · 2023-10-05T08:39:32Z

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx

+            id="xpack.fleet.agentUpgradeStatusTooltip.upgradeDownloading"
+            defaultMessage="Downloading the new agent artifact version ({downloadPercent}%)."
+            values={{
+              downloadPercent: agentUpgradeDetails?.metadata.download_percent,


Is download_percent going to be always populated? If not, maybe we should set 0 if not set.

It should exist and be populated if the state is UPG_DOWNLOADING, otherwise I don't think it's set.

In saying that, I think it's a really good idea to fall back to 0 in case for some reason the agent doesn't have a download percent. Thanks for the suggesting, will add!

May I suggest that if the download_percent field is not set OR if it's set to 0, we don't include it in the message? In other words, would it be possible to start including the download percent value in the message only when download_percent > 0? Otherwise we could end up showing a download percent of 0 to the user for the entire time we're in the UPG_DOWNLOADING state and then suddenly move to the next state, which might be a bit confusing.

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx

juliaElastic · 2023-10-05T08:43:04Z

.../applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.test.tsx

+          },
+        },
+      });
+      expectBadgeLabel(results, 'Upgrade failed');


nit: the tooltip text could be verified for cases where there is a text with variables

juliaElastic

Looks great, some minor comments, otherwise 🚀

criamico · 2023-10-05T08:44:34Z

x-pack/plugins/fleet/server/constants/mappings.ts

@@ -295,6 +295,47 @@ export const AGENT_MAPPINGS = {
    upgrade_status: {
      type: 'keyword',
    },
+    upgrade_details: {


Adding this comment based on our offline discussion.
This mappings file is there for the only purpose of helping in the KQL validation. It's not adding any new field to the agent index mappings as those live in Elasticsearch repo. I think you'll need to open a separate PR there.

Also, this makes me think that the comment I had on this file is not super clear, so I'll open a small PR to better clarify what's the purpose of this file.

However this is a nice addition because it will enable the KQL searchbox to search on the newly defined fields.

I just checked the existing mappings and noticed that they were added already in this PR elastic/elasticsearch#98680. So you should be good there :)

Thank you for checking this @criamico! 👍

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx

criamico

LGTM 🚢

jillguyonnet · 2023-10-05T15:15:29Z

@juliaElastic @criamico @zombieFox
The following changes have been pushed (updated screenshots in description):

Improved tooltip message for scheduled state: the tooltip now reads "less than 15 minute/30 minutes/1 hour/2 hours..." (there are a comment and a unit test for the function).
"Upgrade available" is no longer a warning icon and a text, but a white badge (no tooltip).
Unit tests for tooltip messages.

Thanks all for your feedback! I have one remaining question: FF 8.11.0 was on Oct 3 - should I keep 8.11.0 as the version for this PR (that includes the label text for when the agent has no upgrade details) or should it be changed?

kpollich · 2023-10-05T15:20:06Z

FF 8.11.0 was on Oct 3 - should I keep 8.11.0 as the version for this PR (that includes the label text for when the agent has no upgrade details) or should it be changed?

I don't think this needs to land in 8.11.0 especially since we're still waiting on agent's implementation for this to really be "active" correct? Perhaps we should change this to target 8.12?

jillguyonnet · 2023-10-05T15:24:01Z

Thanks @kpollich - looking at elastic/elastic-agent#3119 this does seem to make sense.

Changing to 8.12.0 unless there are any objections.

jillguyonnet · 2023-10-09T07:19:34Z

@elasticmachine merge upstream

jillguyonnet · 2023-10-11T15:07:34Z

@elasticmachine merge upstream

jillguyonnet · 2023-10-11T16:07:19Z

@elasticmachine merge upstream

jillguyonnet · 2023-10-12T07:41:54Z

@elasticmachine merge upstream

kibana-ci · 2023-10-12T08:53:07Z

💚 Build Succeeded

Buildkite Build
Commit: d316025

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	940	941	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	1084	1085	+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	+4.8KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`fleet`	42	43	+1

Unknown metric groups

API count

id	before	after	diff
`fleet`	1202	1203	+1

History

💔 Build #167050 failed 02ad0e7
💚 Build #166205 succeeded 8fa8b8d
💔 Build #165661 failed 24997fc
💛 Build #165330 was flaky ca8b9cb
💔 Build #164899 failed 2cb1843

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

cc @jillguyonnet

kpollich · 2023-10-17T12:27:16Z

Merging as this is green + approved and Jill is on PTO 🙂

## Summary Followup to elastic#167539. Closes elastic/ingest-dev#2568. As the version on which agents will have upgrade details is not known yet, we decided to defer showing the tooltip for agents that don't until it is (cf. elastic#167539 (comment)). This PR sets the version to 8.12. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

jillguyonnet added 2 commits October 2, 2023 10:45

[Fleet] Elastic Agent upgrade states UI

6e3c15f

Add missing states and wire backend

1f3a351

jillguyonnet force-pushed the fleet/agent-upgrade-states-ui branch from e654e14 to 1f3a351 Compare October 3, 2023 09:46

jillguyonnet added 2 commits October 3, 2023 12:05

Fix logic for upgrading agents without details

7f92daf

Add unit test

bc385e3

Merge branch 'main' into fleet/agent-upgrade-states-ui

2cb1843

jillguyonnet commented Oct 3, 2023

View reviewed changes

x-pack/plugins/fleet/common/types/models/agent.ts Outdated Show resolved Hide resolved

Feedback

45e4a14

Merge branch 'main' into fleet/agent-upgrade-states-ui

c7b070e

jillguyonnet added Team:Fleet Team label for Observability Data Collection Fleet team v8.11.0 release_note:enhancement labels Oct 4, 2023

jillguyonnet self-assigned this Oct 4, 2023

Add forgotten file

781e381

jillguyonnet commented Oct 4, 2023

View reviewed changes

jillguyonnet added 2 commits October 4, 2023 15:51

Fix logic for upgrading agents without details 2

00b0da9

Change tooltip text

ca8b9cb

jillguyonnet marked this pull request as ready for review October 4, 2023 14:43

jillguyonnet requested a review from a team as a code owner October 4, 2023 14:43

juliaElastic reviewed Oct 5, 2023

View reviewed changes

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx Outdated Show resolved Hide resolved

juliaElastic reviewed Oct 5, 2023

View reviewed changes

...ublic/applications/fleet/sections/agents/agent_list_page/components/agent_upgrade_status.tsx Outdated Show resolved Hide resolved

juliaElastic reviewed Oct 5, 2023

View reviewed changes

juliaElastic approved these changes Oct 5, 2023

View reviewed changes

criamico reviewed Oct 5, 2023

View reviewed changes

criamico approved these changes Oct 5, 2023

View reviewed changes

jillguyonnet added 2 commits October 5, 2023 11:38

Add badge icons and fix badge vertical alignment

3692afd

Implement feedback

a4fb06b

jillguyonnet added v8.12.0 and removed v8.11.0 labels Oct 5, 2023

Change target version to 8.12

24997fc

kibanamachine and others added 2 commits October 9, 2023 03:19

Merge branch 'main' into fleet/agent-upgrade-states-ui

8fa8b8d

Feedback

7bde2e3

Merge branch 'main' into fleet/agent-upgrade-states-ui

4d15695

Merge branch 'main' into fleet/agent-upgrade-states-ui

02ad0e7

jillguyonnet mentioned this pull request Oct 11, 2023

[Fleet] Enable agent upgrade tooltip #168638

Merged

Merge branch 'main' into fleet/agent-upgrade-states-ui

d316025

kpollich merged commit d70e4c7 into elastic:main Oct 17, 2023

kibanamachine added the backport:skip This commit does not require backporting label Oct 17, 2023

jillguyonnet deleted the fleet/agent-upgrade-states-ui branch October 23, 2023 08:24

kilfoyle mentioned this pull request Oct 27, 2023

Document agent detailed upgrade states elastic/ingest-docs#596

Merged

kpollich mentioned this pull request Oct 31, 2023

[elastic_agent] Create a dashboard that displays details for agent activity elastic/integrations#8358

Closed

jillguyonnet mentioned this pull request Nov 10, 2023

[Fleet] Prevent agent upgrade requests when already upgrading #170963

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Elastic Agent upgrade states UI #167539

[Fleet] Elastic Agent upgrade states UI #167539

jillguyonnet commented Sep 28, 2023 •

edited

Loading

apmmachine commented Sep 28, 2023

jillguyonnet commented Oct 3, 2023

jillguyonnet commented Oct 4, 2023

jillguyonnet Oct 4, 2023 •

edited

Loading

jillguyonnet Oct 4, 2023

ycombinator Oct 11, 2023

jillguyonnet Oct 11, 2023

juliaElastic Oct 11, 2023

jillguyonnet Oct 11, 2023

elasticmachine commented Oct 4, 2023

juliaElastic Oct 5, 2023

jillguyonnet Oct 5, 2023

jillguyonnet Oct 5, 2023

ycombinator Oct 11, 2023

juliaElastic Oct 5, 2023

juliaElastic left a comment

criamico Oct 5, 2023

criamico Oct 5, 2023

jillguyonnet Oct 5, 2023

criamico left a comment

jillguyonnet commented Oct 5, 2023

kpollich commented Oct 5, 2023

jillguyonnet commented Oct 5, 2023 •

edited

Loading

jillguyonnet commented Oct 9, 2023

jillguyonnet commented Oct 11, 2023

jillguyonnet commented Oct 11, 2023

jillguyonnet commented Oct 12, 2023

kibana-ci commented Oct 12, 2023

API count

kpollich commented Oct 17, 2023

[Fleet] Elastic Agent upgrade states UI #167539

[Fleet] Elastic Agent upgrade states UI #167539

Conversation

jillguyonnet commented Sep 28, 2023 • edited Loading

Summary

Screenshots

Steps to reproduce

How to create a "super duper user"

Adding upgrade details to an agent

Checklist

apmmachine commented Sep 28, 2023

🤖 GitHub comments

jillguyonnet commented Oct 3, 2023

jillguyonnet commented Oct 4, 2023

jillguyonnet Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliaElastic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

criamico left a comment

Choose a reason for hiding this comment

jillguyonnet commented Oct 5, 2023

kpollich commented Oct 5, 2023

jillguyonnet commented Oct 5, 2023 • edited Loading

jillguyonnet commented Oct 9, 2023

jillguyonnet commented Oct 11, 2023

jillguyonnet commented Oct 11, 2023

jillguyonnet commented Oct 12, 2023

kibana-ci commented Oct 12, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

API count

History

kpollich commented Oct 17, 2023

jillguyonnet commented Sep 28, 2023 •

edited

Loading

jillguyonnet Oct 4, 2023 •

edited

Loading

jillguyonnet commented Oct 5, 2023 •

edited

Loading