Notify users when upgrades are available or restart is required for network or VPC by vishesh92 · Pull Request #7610 · apache/cloudstack

vishesh92 · 2023-06-09T04:44:35Z

Description

This PR adds a feature in UI to notify when:

a new version of CloudStack is available (only for admins)
Custom alert message set in config.json

On login, if there are any networks or VPCs which need restart, insert a message in the notification panel.

This PR also adds a small UI improvement in the UI to show which network/UI requires restart and filtering networks/VPCs which require restart.

P.S. - As of now, after upgrading ACS restart required is not set to true for network or VPC even if the router needs an upgrade.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

Custom alert message (configured in config.json)

This is useful if the operator wants to display a custom message to the users. The operator needs to set the message by setting the value of alertMessage in the config.json. Type of message can be configured by alertMessageType in config.json. Possible values are success, info, warning and error.

Details

New release available for cloudstack

Details

Restart required notification

Details

Show in UI that a restart is required

Details

Add filter on restart required

Details

How Has This Been Tested?

codecov · 2023-06-09T05:42:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.57%. Comparing base (a5f5560) to head (29410de).
Report is 13 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##               main    #7610     +/-   ##
===========================================
  Coverage     15.57%   15.57%             
- Complexity    12047    12048      +1     
===========================================
  Files          5505     5505             
  Lines        482621   482680     +59     
  Branches      61174    60013   -1161     
===========================================
+ Hits          75176    75188     +12     
- Misses       399141   399187     +46     
- Partials       8304     8305      +1

Flag	Coverage Δ
uitests	`4.17% <ø> (+<0.01%)`	⬆️
unittests	`16.35% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

vishesh92 · 2023-06-12T04:22:45Z

Replaced notification with an alert component.

yadvr · 2023-06-15T08:18:49Z

@vishesh92 I suppose this a screenshot for admin; a user I would prefer a single alert (too many makes the UI look poor). Click that could open a form with more details. Also, can we merge notification for both guest networks and VPCs? (for the end user these are just networks.

Alternatively; you can display as part of the dashboard (perhaps not top of the UI) - let's discuss. Let me try if the demo env can be used to test changes for further feedback.

@blueorangutan ui

blueorangutan · 2023-06-15T08:19:03Z

@rohityadavcloud a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

vishesh92 · 2023-06-15T08:23:21Z

@rohityadavcloud I manually changed the value of restartrequired in database to true to test this. Version check should work with 4.19-SNAPSHOT.

blueorangutan · 2023-06-15T08:32:36Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/7610 (QA-JID-121)

DaanHoogland

clgtm

github-actions · 2023-08-16T16:54:37Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

shwstppr

Looks okay largely but existing comments needs to be addressed

shwstppr · 2023-10-10T11:01:35Z

@vishesh92 can you please look into merge conflicts and outstanding comments? SHould this be considered for 4.19?

vishesh92 · 2023-10-10T12:24:05Z

@shwstppr Have some changes that needs to be done. Leaving this PR for 4.19.1 or 4.20. I will update the milestone.

sureshanaparti · 2024-03-12T10:10:36Z

@vishesh92 Is this PR targeted for 4.19.1? If so, please rebase and update target branch.

sureshanaparti · 2024-06-23T15:41:44Z

@vishesh92 Please resolve the conflicts, & check/address the comments. Thanks.

blueorangutan · 2024-08-30T10:58:04Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-08-30T12:18:16Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10883

vishesh92 · 2024-09-02T07:34:52Z

@blueorangutan package

blueorangutan · 2024-09-02T07:36:03Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-09-02T08:40:37Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10903

vishesh92 · 2024-09-02T11:37:56Z

@blueorangutan package

blueorangutan · 2024-09-02T11:40:03Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-09-02T12:46:23Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10909

vishesh92 · 2024-09-03T05:19:59Z

@blueorangutan package

blueorangutan · 2024-09-03T05:22:04Z

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-09-03T06:24:24Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10922

shwstppr

Code looks good

shwstppr · 2024-09-03T10:01:57Z

+
+          api('listNetworks', { restartrequired: true, forvpc: false }).then(response => {
+            if (response.listnetworksresponse.count > 0) {
+              store.dispatch('AddHeaderNotice', {
+                key: 'NETWORK_RESTART_REQUIRED',
+                title: i18n.global.t('label.network.restart.required'),
+                description: i18n.global.t('message.network.restart.required'),
+                path: '/guestnetwork/',
+                query: { restartrequired: true, forvpc: false },
+                status: 'done',
+                timestamp: new Date()
+              })
+            }
+          }).catch(ignored => {})
+
+          api('listVPCs', { restartrequired: true }).then(response => {
+            if (response.listvpcsresponse.count > 0) {
+              store.dispatch('AddHeaderNotice', {
+                key: 'VPC_RESTART_REQUIRED',
+                title: i18n.global.t('label.vpc.restart.required'),
+                description: i18n.global.t('message.vpc.restart.required'),
+                path: '/vpc/',
+                query: { restartrequired: true },
+                status: 'done',
+                timestamp: new Date()
+              })
+            }
+          }).catch(ignored => {})


@vishesh92 are these used? We are showing a header notice and then also a warn label for individual network/vpc?

Yes. This adds a notification in notifications drop down. Which results in something like below

And the warn label is shown on network and vpc page if the resource needs a restart.

DaanHoogland · 2024-09-03T11:40:12Z

@blueorangutan ui

blueorangutan · 2024-09-03T11:41:04Z

@DaanHoogland a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2024-09-03T11:58:32Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/7610 (QA-JID-438)

DaanHoogland

lgtm, tested in qa and a lab env by manipulating the (meta) data storages

…etwork or VPC (apache#7610) Co-authored-by: Harikrishna <harikrishna.patnala@gmail.com> Co-authored-by: dahn <daan.hoogland@gmail.com>

NuxRo · 2025-10-03T09:57:04Z

Good feature, but anything that makes CloudStack rely on external resources should be disable-able.

Some/Many corporate environments are run in closed down intranets where this is causing UI errors and generating reports from users. I know of at least 2 such situations.

boring-cyborg bot added the component:UI label Jun 9, 2023

DaanHoogland added this to the 4.19.0.0 milestone Jun 22, 2023

yadvr requested review from DaanHoogland, harikrishna-patnala and shwstppr June 27, 2023 09:28

harikrishna-patnala reviewed Jun 30, 2023

View reviewed changes

Comment thread ui/public/locales/en.json Outdated

Comment thread ui/src/store/modules/user.js Outdated

DaanHoogland reviewed Jul 3, 2023

View reviewed changes

Comment thread ui/public/locales/en.json Outdated

DaanHoogland approved these changes Jul 3, 2023

View reviewed changes

github-actions bot added the status:has-conflicts label Aug 16, 2023

shwstppr reviewed Oct 10, 2023

View reviewed changes

Comment thread ui/src/components/page/GlobalLayout.vue Outdated

vishesh92 modified the milestones: 4.19.0.0, 4.19.1.0 Oct 10, 2023

sureshanaparti added the status:waiting-for-author label Jun 23, 2024

sureshanaparti modified the milestones: 4.19.1.0, 4.19.2 Jun 24, 2024

vishesh92 force-pushed the notify-user-on-upgrade branch from 87ce972 to 932bd69 Compare July 23, 2024 20:42

github-actions bot removed the status:has-conflicts label Jul 23, 2024

vishesh92 removed this from the 4.19.2.0 milestone Jul 24, 2024

yadvr added this to the 4.20.0.0 milestone Jul 31, 2024

apache deleted a comment from blueorangutan Aug 30, 2024

vishesh92 changed the title ~~UI: Notify users when upgrades are available or restart is required~~ UI: Notify users when upgrades are available or restart is required for network or VPC Sep 2, 2024

vishesh92 force-pushed the notify-user-on-upgrade branch from 479f9c4 to 8854016 Compare September 2, 2024 07:34

vishesh92 changed the title ~~UI: Notify users when upgrades are available or restart is required for network or VPC~~ Notify users when upgrades are available or restart is required for network or VPC Sep 2, 2024

Remove banner related changes

27046cb

vishesh92 force-pushed the notify-user-on-upgrade branch from 8854016 to 27046cb Compare September 2, 2024 11:29

Update VirtualRouterElement.java

29410de

vishesh92 requested a review from shwstppr September 3, 2024 06:07

shwstppr approved these changes Sep 3, 2024

View reviewed changes

DaanHoogland approved these changes Sep 4, 2024

View reviewed changes

DaanHoogland marked this pull request as ready for review September 4, 2024 07:22

DaanHoogland merged commit f9451fc into apache:main Sep 4, 2024

DaanHoogland deleted the notify-user-on-upgrade branch September 4, 2024 07:24

Conversation

vishesh92 commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

Custom alert message (configured in config.json)

New release available for cloudstack

Restart required notification

Show in UI that a restart is required

Add filter on restart required

How Has This Been Tested?

Uh oh!

codecov bot commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

vishesh92 commented Jun 12, 2023

Uh oh!

yadvr commented Jun 15, 2023

Uh oh!

blueorangutan commented Jun 15, 2023

Uh oh!

vishesh92 commented Jun 15, 2023

Uh oh!

blueorangutan commented Jun 15, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 16, 2023

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shwstppr commented Oct 10, 2023

Uh oh!

vishesh92 commented Oct 10, 2023

Uh oh!

sureshanaparti commented Mar 12, 2024

Uh oh!

sureshanaparti commented Jun 23, 2024

Uh oh!

blueorangutan commented Aug 30, 2024

Uh oh!

blueorangutan commented Aug 30, 2024

Uh oh!

vishesh92 commented Sep 2, 2024

Uh oh!

blueorangutan commented Sep 2, 2024

Uh oh!

blueorangutan commented Sep 2, 2024

Uh oh!

vishesh92 commented Sep 2, 2024

Uh oh!

blueorangutan commented Sep 2, 2024

Uh oh!

blueorangutan commented Sep 2, 2024

Uh oh!

vishesh92 commented Sep 3, 2024

Uh oh!

blueorangutan commented Sep 3, 2024

Uh oh!

blueorangutan commented Sep 3, 2024

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr Sep 3, 2024

Choose a reason for hiding this comment

Uh oh!

vishesh92 Sep 3, 2024

Choose a reason for hiding this comment

vishesh92 commented Jun 9, 2023 •

edited

Loading

codecov bot commented Jun 9, 2023 •

edited

Loading