Log previous and new value of configuration when reset/update API is called by sudo87 · Pull Request #10769 · apache/cloudstack

sudo87 · 2025-04-24T04:05:54Z

Description

This PR handles 5th scenario mentioned in #6880
During reset and update configuration, system will log existing and incoming value.

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)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

codecov · 2025-04-24T04:13:36Z

Codecov Report

Attention: Patch coverage is 43.47826% with 26 lines in your changes missing coverage. Please review.

Project coverage is 16.95%. Comparing base (64828f6) to head (fd401eb).
Report is 53 commits behind head on main.

Files with missing lines	Patch %	Lines
.../cloud/configuration/ConfigurationManagerImpl.java	43.47%	22 Missing and 4 partials ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #10769 +/- ##
============================================
+ Coverage 16.40% 16.95% +0.54% - Complexity 13630 14422 +792 
============================================
Files 5705 5719 +14 Lines 503722 531340 +27618 Branches 61034 71603 +10569 ============================================
+ Hits 82647 90075 +7428 - Misses 411889 431175 +19286 - Partials 9186 10090 +904

Flag	Coverage Δ
uitests	`4.16% <ø> (+0.16%)`	⬆️
unittests	`17.81% <43.47%> (+0.55%)`	⬆️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

shwstppr · 2025-04-24T08:32:32Z

@blueorangutan package

blueorangutan · 2025-04-24T08:34:03Z

@shwstppr 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 · 2025-04-24T09:55:40Z

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

1. Change type for scope paramter for method updateConfiguration and validateConfigurationValue 2. Standardize scope variable to be of ConfigKey type and scopeVal as string

DaanHoogland

clgtm

sudo87 · 2025-04-24T15:09:12Z

@blueorangutan package

blueorangutan · 2025-04-24T15:10:03Z

@sudo87 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 · 2025-04-24T16:39:58Z

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

DaanHoogland · 2025-05-12T09:13:16Z

@blueorangutan test

blueorangutan · 2025-05-12T09:14:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

shwstppr

code lgtm

blueorangutan · 2025-05-13T01:50:52Z

[SF] Trillian test result (tid-13269)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 56812 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10769-t13269-kvm-ol8.zip
Smoke tests completed. 124 look OK, 17 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_2FA_enabled	`Error`	0.03	test_2fa.py
test_2FA_setup	`Error`	0.03	test_2fa.py
test_UpdateConfigParamWithScope	`Error`	0.06	test_global_settings.py
test_UpdateConfigParamWithScope	`Error`	0.06	test_global_settings.py
test_01_deploy_vm_with_extraconfig_throws_exception_kvm	`Error`	0.04	test_deploy_vm_extra_config_data.py
test_02_deploy_vm_with_extraconfig_kvm	`Error`	0.04	test_deploy_vm_extra_config_data.py
test_03_update_vm_with_extraconfig_kvm	`Error`	0.05	test_deploy_vm_extra_config_data.py
test_04_deploy_vm_with_extraconfig_throws_exception_vmware	`Error`	0.04	test_deploy_vm_extra_config_data.py
test_05_deploy_vm_with_extraconfig_vmware	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_06_deploy_vm_with_extraconfig_throws_exception_xenserver	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_07_deploy_vm_with_extraconfig_xenserver	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_03_vpc_internallb_haproxy_stats_on_all_interfaces	`Error`	2.40	test_internal_lb.py
test_04_rvpc_internallb_haproxy_stats_on_all_interfaces	`Error`	2.43	test_internal_lb.py
test_01_disable_account_settings_for_domain	`Error`	8.62	test_enable_account_settings_for_domain.py
test_02_enable_account_settings_for_domain	`Error`	9.35	test_enable_account_settings_for_domain.py
test_03_enable_account_settings_for_domain	`Error`	8.34	test_enable_account_settings_for_domain.py
test_01_auto_enable_disable_kvm_host	`Error`	0.11	test_host_control_state.py
test_02_disable_host_overrides_auto_enable_kvm_host	`Error`	0.10	test_host_control_state.py
test_03_enable_host_does_not_override_auto_disable_kvm_host	`Error`	0.10	test_host_control_state.py
ContextSuite context=TestMetrics>:setup	`Error`	0.00	test_metrics_api.py
test_01_non_strict_host_anti_affinity	`Failure`	146.08	test_nonstrict_affinity_group.py
test_02_non_strict_host_affinity	`Error`	87.28	test_nonstrict_affinity_group.py
test_01_add_primary_storage_disabled_host	`Error`	40.10	test_primary_storage.py
test_01_primary_storage_scope_change	`Error`	0.11	test_primary_storage_scope.py
test_another_user_can_allocate_ip_after_quarantined_has_ended_network	`Error`	9.09	test_quarantined_ips.py
test_another_user_can_allocate_ip_after_quarantined_has_ended_vpc	`Error`	0.45	test_quarantined_ips.py
test_only_owner_can_allocate_ip_in_quarantine_network	`Error`	0.52	test_quarantined_ips.py
test_only_owner_can_allocate_ip_in_quarantine_vpc	`Error`	0.50	test_quarantined_ips.py
ContextSuite context=TestScaleVm>:teardown	`Error`	0.03	test_scale_vm.py
test_01_sys_vm_start	`Failure`	0.13	test_secondary_storage.py
ContextSuite context=TestCpuCapServiceOfferings>:setup	`Error`	0.00	test_service_offerings.py
ContextSuite context=TestVmAutoScaling>:setup	`Error`	0.00	test_vm_autoscaling.py
test_01_deploy_vm_on_specific_host	`Error`	0.11	test_vm_deployment_planner.py
test_04_deploy_vm_on_host_override_pod_and_cluster	`Error`	0.15	test_vm_deployment_planner.py
test_02_restore_vm_strict_tags_failure	`Failure`	54.72	test_vm_strict_host_tags.py
test_02_scale_vm_strict_tags_failure	`Failure`	59.98	test_vm_strict_host_tags.py
test_06_deploy_vm_on_any_host_with_strict_tags_failure	`Failure`	6.83	test_vm_strict_host_tags.py

sudo87 · 2025-05-13T13:21:43Z

@blueorangutan test

blueorangutan · 2025-05-13T13:24:03Z

@sudo87 a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-05-14T05:08:32Z

[SF] Trillian test result (tid-13290)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 53732 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10769-t13290-kvm-ol8.zip
Smoke tests completed. 130 look OK, 11 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_2FA_enabled	`Error`	0.04	test_2fa.py
test_2FA_setup	`Error`	0.04	test_2fa.py
test_UpdateConfigParamWithScope	`Error`	0.07	test_global_settings.py
test_UpdateConfigParamWithScope	`Error`	0.07	test_global_settings.py
test_01_deploy_vm_with_extraconfig_throws_exception_kvm	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_02_deploy_vm_with_extraconfig_kvm	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_03_update_vm_with_extraconfig_kvm	`Error`	0.04	test_deploy_vm_extra_config_data.py
test_04_deploy_vm_with_extraconfig_throws_exception_vmware	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_05_deploy_vm_with_extraconfig_vmware	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_06_deploy_vm_with_extraconfig_throws_exception_xenserver	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_07_deploy_vm_with_extraconfig_xenserver	`Error`	0.03	test_deploy_vm_extra_config_data.py
test_03_vpc_internallb_haproxy_stats_on_all_interfaces	`Error`	1.44	test_internal_lb.py
test_04_rvpc_internallb_haproxy_stats_on_all_interfaces	`Error`	2.45	test_internal_lb.py
test_01_disable_account_settings_for_domain	`Error`	8.54	test_enable_account_settings_for_domain.py
test_02_enable_account_settings_for_domain	`Error`	8.89	test_enable_account_settings_for_domain.py
test_03_enable_account_settings_for_domain	`Error`	8.18	test_enable_account_settings_for_domain.py
test_01_auto_enable_disable_kvm_host	`Error`	0.09	test_host_control_state.py
test_02_disable_host_overrides_auto_enable_kvm_host	`Error`	0.09	test_host_control_state.py
test_03_enable_host_does_not_override_auto_disable_kvm_host	`Error`	0.08	test_host_control_state.py
ContextSuite context=TestMetrics>:setup	`Error`	0.00	test_metrics_api.py
test_another_user_can_allocate_ip_after_quarantined_has_ended_network	`Error`	8.82	test_quarantined_ips.py
test_another_user_can_allocate_ip_after_quarantined_has_ended_vpc	`Error`	0.46	test_quarantined_ips.py
test_only_owner_can_allocate_ip_in_quarantine_network	`Error`	0.42	test_quarantined_ips.py
test_only_owner_can_allocate_ip_in_quarantine_vpc	`Error`	0.41	test_quarantined_ips.py
ContextSuite context=TestScaleVm>:teardown	`Error`	0.03	test_scale_vm.py
ContextSuite context=TestVmAutoScaling>:setup	`Error`	0.00	test_vm_autoscaling.py
test_02_restore_vm_strict_tags_failure	`Failure`	61.87	test_vm_strict_host_tags.py
test_02_scale_vm_strict_tags_failure	`Failure`	63.19	test_vm_strict_host_tags.py
test_06_deploy_vm_on_any_host_with_strict_tags_failure	`Failure`	3.83	test_vm_strict_host_tags.py

shwstppr · 2025-05-14T05:16:07Z

@sudo87 changes seem to be causing some issues with configuration behaviour. Please check

sudo87 · 2025-05-15T14:11:10Z

@blueorangutan package

blueorangutan · 2025-05-15T14:12:04Z

@sudo87 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 · 2025-05-15T15:41:14Z

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

sudo87 · 2025-05-15T16:28:52Z

@blueorangutan test

blueorangutan · 2025-05-15T16:30:04Z

@sudo87 a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-05-16T08:44:17Z

[SF] Trillian test result (tid-13326)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 55396 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10769-t13326-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_01_deployVMInSharedNetwork	`Failure`	60.92	test_network.py
ContextSuite context=TestSharedNetworkWithConfigDrive>:teardown	`Error`	62.03	test_network.py

borisstoyanov

LGTM
at change:

2025-05-27 13:48:28,627 DEBUG [c.c.a.ApiServlet] (qtp1390913202-20:[ctx-66866e36]) (logid:8c585b80) ===START=== 10.0.3.251 -- GET name=account.cleanup.interval&value=86401&command=updateConfiguration&response=json&sessionkey=utE1RMWP4uWKuF4-zwHxMF02YAA
2025-05-27 13:48:28,627 DEBUG [c.c.a.ApiServlet] (qtp1390913202-20:[ctx-66866e36]) (logid:8c585b80) Two factor authentication is already verified for the user 2, so skipping
2025-05-27 13:48:28,634 DEBUG [c.c.a.ApiServer] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) CIDRs from which account 'Account [{"accountName":"admin","id":2,"uuid":"a32bf6a3-3afd-11f0-928a-1e00fe0001d8"}]' is allowed to perform API calls: 0.0.0.0/0,::/0
2025-05-27 13:48:28,636 INFO [o.a.c.a.DynamicRoleBasedAPIAccessChecker] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) Account for user id a32cc71b-3afd-11f0-928a-1e00fe0001d8 is Root Admin or Domain Admin, all APIs are allowed.
2025-05-27 13:48:28,636 DEBUG [o.a.c.a.StaticRoleBasedAPIAccessChecker] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) RoleService is enabled. We will use it instead of StaticRoleBasedAPIAccessChecker.
2025-05-27 13:48:28,636 DEBUG [o.a.c.r.ApiRateLimitServiceImpl] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) API rate limiting is disabled. We will not use ApiRateLimitService.
2025-05-27 13:48:28,642 DEBUG [c.c.c.ConfigurationManagerImpl] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) Not proceeding with configuration [account.cleanup.interval]'s range validation, as it does not have a specified range.
2025-05-27 13:48:28,650 DEBUG [c.c.c.ConfigurationManagerImpl] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) Config: account.cleanup.interval value is updated from: 86400 to 86401 for scope: Global
2025-05-27 13:48:28,651 WARN [o.a.c.m.w.WebhookServiceImpl] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) Skipping delivering event Event {"description":"{\"details\":\" Name: account.cleanup.interval New Value: 86401\",\"event\":\"CONFIGURATION.VALUE.EDIT\",\"status\":\"Completed\"}","eventId":null,"eventType":"CONFIGURATION.VALUE.EDIT","eventUuid":null,"resourceType":"Configuration","resourceUUID":null} to any webhook as account ID is missing
2025-05-27 13:48:28,652 WARN [o.a.c.f.e.EventDistributorImpl] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) Failed to publish event [category: ActionEvent, type: CONFIGURATION.VALUE.EDIT] on bus webhookEventBus
2025-05-27 13:48:28,661 DEBUG [c.c.a.ApiServlet] (qtp1390913202-20:[ctx-66866e36, ctx-24c069b4]) (logid:8c585b80) ===END=== 10.0.3.251 -- GET name=account.cleanup.interval&value=86401&command=updateConfiguration&response=json&sessionkey=utE1RMWP4uWKuF4-zwHxMF02YAA

at reset:

2025-05-27 13:49:07,619 DEBUG [c.c.c.ConfigurationManagerImpl] (qtp1390913202-20:[ctx-8d531200, ctx-f988c6e7]) (logid:49586a24) Config: account.cleanup.interval value is updated from: 86401 to 86400 for scope: Global
2025-05-27 13:49:07,621 WARN [o.a.c.m.w.WebhookServiceImpl] (qtp1390913202-20:[ctx-8d531200, ctx-f988c6e7]) (logid:49586a24) Skipping delivering event Event {"description":"{\"details\":\" Name: account.cleanup.interval New Value: 86400\",\"event\":\"CONFIGURATION.VALUE.EDIT\",\"status\":\"Completed\"}","eventId":null,"eventType":"CONFIGURATION.VALUE.EDIT","eventUuid":null,"resourceType":"Configuration","resourceUUID":null} to any webhook as account ID is missing

shwstppr · 2025-06-03T12:19:08Z

@blueorangutan package

blueorangutan · 2025-06-03T12:20:03Z

@shwstppr 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 · 2025-06-03T13:33:53Z

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

DaanHoogland · 2025-06-03T13:40:54Z

@blueorangutan test

blueorangutan · 2025-06-03T13:42:03Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-06-04T06:17:50Z

[SF] Trillian test result (tid-13464)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 56690 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10769-t13464-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_router_dhcphosts	`Failure`	27.21	test_router_dhcphosts.py

…called (apache#10769)

Log previous and new value of configuration before reset/update
7280d5b

sudo87 changed the title ~~Log previous and new value of configuration before reset/update~~Log previous and new value of configuration when reset/update API is calledApr 24, 2025

DaanHoogland reviewed Apr 24, 2025
View reviewed changes

Comment threadserver/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java Outdated

Following changes are done in this commit:
74a00c4
1. Change type for scope paramter for method updateConfiguration and validateConfigurationValue 2. Standardize scope variable to be of ConfigKey type and scopeVal as string

boring-cyborgBot added the component:vpc label Apr 24, 2025

sudo87 requested a review from DaanHoogland April 24, 2025 11:33

DaanHoogland approved these changes Apr 24, 2025
View reviewed changes

shwstppr approved these changes May 12, 2025
View reviewed changes

sudo87 added 2 commits May 15, 2025 09:24

Merge branch 'main' into logConfigUpdate
9a7de41

Fix updateCfg for null scope, it is considered Global
fd401eb

DaanHoogland reviewed May 15, 2025
View reviewed changes

Comment threadserver/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

DaanHoogland added the status:needs-testing label May 16, 2025

borisstoyanov self-assigned this May 16, 2025

sudo87 requested a review from borisstoyanov May 16, 2025 12:13

borisstoyanov approved these changes May 27, 2025
View reviewed changes

sudo87 assigned yadvr and unassigned borisstoyanov May 30, 2025

yadvr modified the milestones: 4.20.2, 4.21.0 Jun 3, 2025

yadvr removed the status:needs-testing label Jun 3, 2025

shwstppr closed this Jun 3, 2025

shwstppr reopened this Jun 3, 2025

DaanHoogland merged commit fa85a75 into apache:mainJun 4, 2025

sudo87 deleted the logConfigUpdate branch June 4, 2025 10:27

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Jun 19, 2025
Log previous and new value of configuration when reset/update API is …
1984642
…called (apache#10769)

sureshanaparti moved this to Done in Apache CloudStack 4.21.0 Jul 14, 2025

Uh oh!

Conversation

sudo87 commented Apr 24, 2025• 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):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecovBot commented Apr 24, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

shwstppr commented Apr 24, 2025

Uh oh!

blueorangutan commented Apr 24, 2025

Uh oh!

Uh oh!

blueorangutan commented Apr 24, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

sudo87 commented Apr 24, 2025

Uh oh!

blueorangutan commented Apr 24, 2025

Uh oh!

blueorangutan commented Apr 24, 2025

Uh oh!

DaanHoogland commented May 12, 2025

Uh oh!

blueorangutan commented May 12, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented May 13, 2025

Uh oh!

sudo87 commented May 13, 2025

Uh oh!

blueorangutan commented May 13, 2025

Uh oh!

blueorangutan commented May 14, 2025

Uh oh!

shwstppr commented May 14, 2025

Uh oh!

Uh oh!

sudo87 commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

sudo87 commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

blueorangutan commented May 16, 2025

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Jun 3, 2025

Uh oh!

blueorangutan commented Jun 3, 2025

Uh oh!

blueorangutan commented Jun 3, 2025

Uh oh!

DaanHoogland commented Jun 3, 2025

Uh oh!

blueorangutan commented Jun 3, 2025

Uh oh!

blueorangutan commented Jun 4, 2025

Uh oh!

Reviewers

Assignees

sudo87 commented Apr 24, 2025•
edited
Loading

codecovBot commented Apr 24, 2025•
edited
Loading