Prioritize copying templates from other secondary storages instead of downloading them #10363

winterhazel · 2025-02-11T02:39:48Z

Description

After adding a new secondary storage, CloudStack will always try to download public templates/ISOs that have URLs from the source to the new secondary storage, even if it already exists on another one. Due to this behavior, if the URL does not exist anymore, the template will not become available at the new storage; and if the template has been updated at the source, it will not be installed because of checksum mismatch. This forces operators to manually copy/move templates to the new secondary storage.

To solve this issue, this PR creates the zone-scoped setting copy.public.templates.from.other.storages. When enabled, CloudStack will try to copy templates/ISOs from other secondary storages in the same zone before attempting to downloading them from the source. It is enabled by default.

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

How Has This Been Tested?

With the setting enabled

I deleted all existing secondary storages, and registered an empty one (SS 1). I verified that the SSVM started to download the templates that were registered.
I registered another template, and immediately also registered secondary storage 2. I verified that the templates available in SS 1 were copied to SS 2, and that the last registered template was being downloaded to both secondary storages.
Inside SS 1, I deleted the first half of templates; inside SS 2, I deleted the other half of templates. Then, I added SS 3. I verified that all the templates were copied to SS 3. SS 1 and SS 2 were not synchronized yet, so they still had only half of the templates each.
I restarted the SSVM's service. I verified that the first half of templates was copied from SS 1 to SS 2, and that the other half was copied from SS 2 to SS 1.
I deleted SS 1 and SS 2. Then, I deployed a VM using each one of the templates, and verified that they were deployed successfully.

With the setting disabled

I disabled the setting and added SS 4. I verified that the SSVM started to download the templates to SS 4 from the source instead of copying them.
Migration: I marked all templates as private so that they are not downloaded to new secondary storages. Then, I added SS 5 and called migrateSecondaryStorageData to migrate data from SS 4 to SS 5. I verified that the templates were migrated successfully.

winterhazel · 2025-02-11T02:40:03Z

@blueorangutan package

blueorangutan · 2025-02-11T02:42:03Z

@winterhazel 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.

codecov · 2025-02-11T02:47:24Z

Codecov Report

❌ Patch coverage is 13.87755% with 211 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.23%. Comparing base (494c56a) to head (a2a9559).
⚠️ Report is 3 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...tack/engine/orchestration/StorageOrchestrator.java	0.00%	93 Missing ⚠️
.../cloudstack/storage/image/TemplateServiceImpl.java	33.67%	65 Missing ⚠️
...ack/engine/orchestration/DataMigrationUtility.java	0.00%	53 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #10363      +/-   ##
============================================
+ Coverage     16.22%   16.23%   +0.01%     
- Complexity    13358    13371      +13     
============================================
  Files          5657     5657              
  Lines        498686   498854     +168     
  Branches      60526    60539      +13     
============================================
+ Hits          80918    81003      +85     
- Misses       408744   408820      +76     
- Partials       9024     9031       +7

Flag	Coverage Δ
uitests	`4.00% <ø> (ø)`
unittests	`17.09% <13.87%> (+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.

🚀 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.

blueorangutan · 2025-02-11T04:11:34Z

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

DaanHoogland

makes functional sense, but needs testing

winterhazel · 2025-02-24T12:45:29Z

@blueorangutan package

blueorangutan · 2025-02-24T12:46:04Z

@winterhazel 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.

...hestration/src/main/java/org/apache/cloudstack/engine/orchestration/StorageOrchestrator.java

engine/storage/image/src/main/java/org/apache/cloudstack/storage/image/TemplateServiceImpl.java

blueorangutan · 2025-02-24T13:04:01Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12548

winterhazel · 2025-02-25T13:51:01Z

@blueorangutan package

blueorangutan · 2025-02-25T13:52:04Z

@winterhazel 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-02-25T14:53:57Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12562

DaanHoogland · 2025-02-26T13:40:57Z

@winterhazel I marked this for 4.21 as it is based off main, but would this be a good improvement for 4.20.1 as well?

JoaoJandre · 2025-02-26T15:39:55Z

@winterhazel could you fix the compilation errors?

blueorangutan · 2025-02-26T15:51:19Z

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

winterhazel · 2025-02-26T17:48:22Z

@winterhazel I marked this for 4.21 as it is based off main, but would this be a good improvement for 4.20.1 as well?

Yeah, it would be great to have it in 4.20.1. I'll rebase.

… downloading them

winterhazel · 2025-02-26T17:55:43Z

@blueorangutan package

blueorangutan · 2025-02-26T17:58:03Z

@winterhazel 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-02-26T19:25:55Z

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

weizhouapache · 2025-09-11T10:44:27Z

@blueorangutan package

blueorangutan · 2025-09-11T10:46:04Z

@weizhouapache 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-09-11T13:34:53Z

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

DaanHoogland · 2025-09-15T09:46:13Z

@weizhouapache , this seems a non-functional change and an improvement. Can we mark it for a future 4.20 update if it doesn’t make 4.20.2?

weizhouapache · 2025-09-15T10:24:46Z

@weizhouapache , this seems a non-functional change and an improvement. Can we mark it for a future 4.20 update if it doesn’t make 4.20.2?

@DaanHoogland
I moved it to 4.20.3 milestone and let the next RM to decide

blueorangutan · 2025-12-09T10:38:37Z

[SF] Trillian Build Failed (tid-14934)

winterhazel · 2025-12-14T00:04:28Z

@blueorangutan package

blueorangutan · 2025-12-14T00:06:04Z

@winterhazel 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-12-14T01:25:41Z

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

harikrishna-patnala · 2025-12-15T10:08:52Z

@blueorangutan test

blueorangutan · 2025-12-15T10:10:03Z

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

harikrishna-patnala

code LGTM

blueorangutan · 2025-12-15T10:44:04Z

[SF] Trillian Build Failed (tid-14987)

blueorangutan · 2025-12-16T00:16:22Z

[SF] Trillian test result (tid-14984)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 51621 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10363-t14984-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_sys_vm_start	`Failure`	0.10	test_secondary_storage.py

harikrishna-patnala · 2025-12-16T05:18:56Z

[SF] Trillian test result (tid-14984) Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8 Total time taken: 51621 seconds Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10363-t14984-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_sys_vm_start Failure 0.10 test_secondary_storage.py

@winterhazel can you please check if this failure is related to this PR change ?

winterhazel · 2025-12-16T11:41:45Z

@winterhazel can you please check if this failure is related to this PR change ?

@harikrishna-patnala it is unrelated. Also failing on other PRs: #12198 (comment)

harikrishna-patnala · 2025-12-18T09:53:23Z

I've tested few cases of adding a new secondary storage with few available and unavailable templates on the server.

Upon adding the new storage, all the templates came to downloaded and ready state.

@winterhazel for your information, I'm also working on another similar change where in the templates to be copied from a secondary storage of another zone if it is available and accessible. This case can happen when a new zone is added and a new secondary storage is added into it. Thank you.

* 4.22: Update templateConfig.sh to not break with directorys with space on t… (#10898) Fix VM and volume metrics listing regressions (#12284) packaging: use latest cmk release link directly (#11429) api:rename RegisterCmd.java => RegisterUserKeyCmd.java (#12259) Prioritize copying templates from other secondary storages instead of downloading them (#10363) Show time correctly in the backup schedule UI (#12012) kvm: use preallocation option for fat disk resize (#11986) Python exception processing static routes fixed (#11967) KVM memballooning requires free page reporting and autodeflate (#11932) api: create/register/upload template with empty template tag (#12234)

boring-cyborg bot added component:orchestration component:storage labels Feb 11, 2025

DaanHoogland approved these changes Feb 11, 2025

View reviewed changes

JoaoJandre reviewed Feb 24, 2025

View reviewed changes

...hestration/src/main/java/org/apache/cloudstack/engine/orchestration/StorageOrchestrator.java Outdated Show resolved Hide resolved

engine/storage/image/src/main/java/org/apache/cloudstack/storage/image/TemplateServiceImpl.java Show resolved Hide resolved

DaanHoogland added this to the 4.21.0 milestone Feb 26, 2025

Prioritize copying templates from other secondary storages instead of…

246c850

… downloading them

winterhazel force-pushed the prioritize-copying-public-templates branch from 9501c57 to 246c850 Compare February 26, 2025 17:54

boring-cyborg bot added component:compute component:kvm labels Feb 26, 2025

winterhazel changed the base branch from main to 4.20 February 26, 2025 17:54

winterhazel removed component:kvm component:compute labels Feb 26, 2025

winterhazel removed this from the 4.21.0 milestone Feb 26, 2025

Pearl1594 added this to the 4.20.2 milestone Jun 3, 2025

weizhouapache modified the milestones: 4.20.2, 4.22.0 Sep 11, 2025

weizhouapache modified the milestones: 4.22.0, 4.20.3 Sep 15, 2025

winterhazel marked this pull request as draft November 7, 2025 23:59

winterhazel added 2 commits December 13, 2025 20:36

Merge branch '4.20' into prioritize-copying-public-templates

f5e0159

Treat some corner cases

a2a9559

winterhazel marked this pull request as ready for review December 14, 2025 00:04

harikrishna-patnala approved these changes Dec 15, 2025

View reviewed changes

harikrishna-patnala merged commit e8200a0 into apache:4.20 Dec 18, 2025
25 of 26 checks passed

This was referenced Dec 18, 2025

Allow copy of templates from secondary storages of other zone when adding a new secondary storage #12296

Open

Allow copy of templates from secondary storages of same or other zone when adding a new secondary storage apache/cloudstack-documentation#611

Open

Prioritize copying templates from other secondary storages instead of downloading them #10363

Prioritize copying templates from other secondary storages instead of downloading them #10363

Uh oh!

Conversation

winterhazel commented Feb 11, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

How Has This Been Tested?

With the setting enabled

With the setting disabled

Uh oh!

winterhazel commented Feb 11, 2025

Uh oh!

blueorangutan commented Feb 11, 2025

Uh oh!

codecov bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Feb 11, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

winterhazel commented Feb 24, 2025

Uh oh!

blueorangutan commented Feb 24, 2025

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Feb 24, 2025

Uh oh!

winterhazel commented Feb 25, 2025

Uh oh!

blueorangutan commented Feb 25, 2025

Uh oh!

blueorangutan commented Feb 25, 2025

Uh oh!

DaanHoogland commented Feb 26, 2025

Uh oh!

JoaoJandre commented Feb 26, 2025

Uh oh!

blueorangutan commented Feb 26, 2025

Uh oh!

winterhazel commented Feb 26, 2025

Uh oh!

winterhazel commented Feb 26, 2025

Uh oh!

blueorangutan commented Feb 26, 2025

Uh oh!

blueorangutan commented Feb 26, 2025

Uh oh!

weizhouapache commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

DaanHoogland commented Sep 15, 2025

Uh oh!

weizhouapache commented Sep 15, 2025

Uh oh!

blueorangutan commented Dec 9, 2025

Uh oh!

winterhazel commented Dec 14, 2025

Uh oh!

blueorangutan commented Dec 14, 2025

Uh oh!

blueorangutan commented Dec 14, 2025

Uh oh!

harikrishna-patnala commented Dec 15, 2025

Uh oh!

blueorangutan commented Dec 15, 2025

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Dec 15, 2025

codecov bot commented Feb 11, 2025 •

edited

Loading