CKS: Allow affinity group selection during cluster creation by Damans227 · Pull Request #12386 · apache/cloudstack

Damans227 · 2026-01-07T18:22:26Z

Description

This PR adds support for specifying affinity groups during CKS (CloudStack Kubernetes Service) cluster creation, allowing users to control VM placement for high availability.

Changes:

New nodeaffinitygroups parameter for createKubernetesCluster API
Supports per-node-type (CONTROL, WORKER, ETCD) affinity group assignment
New kubernetes_cluster_affinity_group_map table for normalized storage

Design doc:

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Allow+users+to+select+affinity+group+during+managed+CKS+cluster+creation

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

cmk based api testing:

Test results

Screen recording

Screencast.from.2026-01-13.06-47-14.mp4

Screenshots

How Has This Been Tested?

Tested on simulator environment
Added Unit tests
Tested against KVM

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

Invalid affinity group UUID
Invalid node type
Duplicate node type entries
Clusters without affinity groups (backward compatibility)

…to CreateKubernetesClusterCmd

…ency

…ndling and enhance node type validation tests

…ubernetesClusterVO

…bernetesClusterManagerImpl

…lusterVO to support multiple IDs

…erviceHelper and related classes

…ting kubernetes_cluster

blueorangutan · 2026-01-07T19:53:01Z

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

codecov · 2026-01-08T06:10:51Z

Codecov Report

❌ Patch coverage is 70.07042% with 85 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.88%. Comparing base (c465caf) to head (777897a).
⚠️ Report is 206 commits behind head on main.

Files with missing lines	Patch %	Lines
...bernetes/cluster/KubernetesClusterManagerImpl.java	68.21%	37 Missing and 4 partials ⚠️
.../dao/KubernetesClusterAffinityGroupMapDaoImpl.java	0.00%	25 Missing ⚠️
...er/actionworkers/KubernetesClusterStartWorker.java	0.00%	5 Missing ⚠️
...kubernetes/cluster/CreateKubernetesClusterCmd.java	0.00%	5 Missing ⚠️
...s/cluster/KubernetesClusterAffinityGroupMapVO.java	86.20%	3 Missing and 1 partial ⚠️
...ubernetes/cluster/KubernetesServiceHelperImpl.java	96.55%	1 Missing and 1 partial ⚠️
.../actionworkers/KubernetesClusterDestroyWorker.java	0.00%	1 Missing ⚠️
...KubernetesClusterResourceModifierActionWorker.java	0.00%	1 Missing ⚠️
.../kubernetes/cluster/ScaleKubernetesClusterCmd.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12386      +/-   ##
============================================
+ Coverage     17.76%   17.88%   +0.11%     
- Complexity    15859    16062     +203     
============================================
  Files          5923     5932       +9     
  Lines        530470   531718    +1248     
  Branches      64823    65001     +178     
============================================
+ Hits          94243    95094     +851     
- Misses       425682   425992     +310     
- Partials      10545    10632      +87

Flag	Coverage Δ
uitests	`3.58% <ø> (+<0.01%)`	⬆️
unittests	`18.98% <70.07%> (+0.13%)`	⬆️

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 · 2026-01-17T02:54:12Z

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

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	`Failure`	28.83	test_kubernetes_clusters.py

test/integration/component/test_kubernetes_cluster_affinity_groups.py

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql

nvazquez · 2026-01-23T11:44:56Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

        List<KubernetesUserVmResponse> vmResponses = new ArrayList<>();
        List<KubernetesClusterVmMapVO> vmList = kubernetesClusterVmMapDao.listByClusterId(kubernetesCluster.getId());
-        ResponseView respView = ResponseView.Restricted;
+        ResponseView userVmResponseView = ResponseView.Restricted;


...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

Damans227 · 2026-01-26T20:01:56Z

Added docs pr: apache/cloudstack-documentation#620

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql

Pearl1594

code overall lgtm

...bernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesServiceHelperImpl.java

harikrishna-patnala · 2026-02-02T11:44:32Z

@blueorangutan package

blueorangutan · 2026-02-02T11:46:05Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-02-02T12:29:26Z

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

nvazquez · 2026-02-11T15:19:49Z

@blueorangutan package

blueorangutan · 2026-02-11T15:26:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-02-11T16:16:26Z

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

nvazquez · 2026-02-11T19:52:17Z

@blueorangutan test

blueorangutan · 2026-02-11T19:54:03Z

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

DaanHoogland

clgtm (afaics) , will need some 3rd person testing, but looks really promissing.

blueorangutan · 2026-02-12T11:28:41Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.13	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	6.03	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	48.84	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	48.84	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	30.77	test_snapshots.py
test_01_snapshot_usage	`Error`	24.81	test_usage.py
test_01_vpn_usage	`Error`	1.09	test_usage.py
test_01_redundant_vpc_site2site_vpn	`Failure`	378.74	test_vpc_vpn.py

nvazquez · 2026-02-13T03:07:01Z

...src/main/java/com/cloud/kubernetes/cluster/dao/KubernetesClusterAffinityGroupMapDaoImpl.java

+    @Override
+    public List<Long> listAffinityGroupIdsByClusterIdAndNodeType(long clusterId, String nodeType) {
+        List<KubernetesClusterAffinityGroupMapVO> maps = listByClusterIdAndNodeType(clusterId, nodeType);
+        return maps.stream().map(KubernetesClusterAffinityGroupMapVO::getAffinityGroupId).collect(Collectors.toList());


I think a null check should be needed at this point, to cover cases in which the affinity group is not passed for the node type

nvazquez · 2026-02-13T03:12:34Z

.../src/main/java/com/cloud/kubernetes/cluster/actionworkers/KubernetesClusterActionWorker.java

    }
+
+    protected List<Long> getAffinityGroupIdsForNodeType(KubernetesClusterNodeType nodeType) {
+        return new ArrayList<>(kubernetesClusterAffinityGroupMapDao.listAffinityGroupIdsByClusterIdAndNodeType(


Here as well, can we add checks for null or empty list?

nvazquez · 2026-02-13T03:14:11Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

+
+    protected void setAffinityGroupResponseForNodeType(KubernetesClusterResponse response, long clusterId, String nodeType) {
+        List<Long> affinityGroupIds = kubernetesClusterAffinityGroupMapDao.listAffinityGroupIdsByClusterIdAndNodeType(clusterId, nodeType);
+        if (affinityGroupIds == null || affinityGroupIds.isEmpty()) {


Minor: can use CollectionUtils.isEmpty(affinityGroupIds) here

nvazquez · 2026-02-13T03:33:28Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

+            Long nodeHostId = node.getHostId();
+            String nodeHostName = getHostName(nodeHostId);
+
+            if ("host anti-affinity".equalsIgnoreCase(affinityGroupType)) {


What about adding the following checks to not rely on a string comparisson?

Inject AffinityGroupService on the class level

Add the following method on AffinityGroupService interface: protected Map<String, AffinityGroupProcessor> getAffinityTypeToProcessorMap()

Mark this method as public on AffinityGroupServiceImpl (definition already exists)

Obtain the AffinityGroupProcessor for the affinity group type (adding null checks) and replace the string comparisson to processor instanceof HostAntiAffinityProcessor and processor isinstanceof HostAffinityProcessor

What do you think?

nvazquez · 2026-02-13T03:33:43Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

+    }
+
+    protected void validateNewNodesAntiAffinity(List<Long> nodeIds, AffinityGroupVO affinityGroup, KubernetesCluster cluster) {
+        if (!"host anti-affinity".equalsIgnoreCase(affinityGroup.getType())) {


Daman Arora added 21 commits January 6, 2026 08:51

Add NODE_TYPE_AFFINITY_GROUP_MAP constant and affinity group mapping …

fe0a2a3

…to CreateKubernetesClusterCmd

Merge branch 'main' into implement-cks-node-affinity

9f137af

Implement getAffinityGroupNodeTypeMap in kubernetes service helper

a7e5270

Rename kubernetesClusterHelper to kubernetesServiceHelper for consist…

58804a3

…ency

Refactor KubernetesServiceHelperImplTest to include affinity group ha…

1114f75

…ndling and enhance node type validation tests

Add affinity group columns to kubernetes_cluster table

319c0f6

Add affinity group ID fields and accessors to KubernetesCluster and K…

8bf7a45

…ubernetesClusterVO

Add affinity group handling for worker, control, and etcd nodes in Ku…

4706d03

…bernetesClusterManagerImpl

Refactor affinity group handling in KubernetesCluster and KubernetesC…

fe5c026

…lusterVO to support multiple IDs

Update affinity group handling to support multiple IDs in KubernetesS…

4da3bce

…erviceHelper and related classes

Refactor affinity group tests in KubernetesServiceHelperImplTest

58799c2

Add per node type affinity group support for cks

0706410

use a new table kubernetes_cluster_affinity_group_map instead of exis…

a13f360

…ting kubernetes_cluster

add new resource KubernetesClusterAffinityGroupMap

6e3ede9

Refactor affinity group mapping

f625d6e

use updated getAffinityGroupNodeTypeMap

35a7bab

use DAO query instead of parsing comma-separated UUIDs

af97ea3

remove affinity group mappings when a cluster is deleted

c58dee0

use @component for spring bean

e0d4183

remove affinity group on cleanup in mcloud managed cks

201e563

add affinty groups to cks list response

2405249

boring-cyborg bot added component:api component:kubernetes labels Jan 7, 2026

cleanup

96c0705

DaanHoogland added this to the 4.23.0 milestone Jan 8, 2026

Daman Arora added 3 commits January 8, 2026 11:27

add unit tests

a05581c

add affinity group details to user VM response

8f5ee6d

update user VM response handling in KubernetesClusterManagerImpl

d27b2f4

DaanHoogland reviewed Jan 19, 2026

View reviewed changes

test/integration/component/test_kubernetes_cluster_affinity_groups.py Outdated Show resolved Hide resolved

test/integration/component/test_kubernetes_cluster_affinity_groups.py Outdated Show resolved Hide resolved

Refactor cleanup logic

3bb4d02

Damans227 requested a review from DaanHoogland January 22, 2026 13:47

nvazquez reviewed Jan 23, 2026

View reviewed changes

Daman Arora added 2 commits January 23, 2026 09:57

Update charset

f9b98d7

split validateNodeAffinityGroups to submethods

1be8744

Damans227 requested a review from nvazquez January 26, 2026 19:51

Damans227 mentioned this pull request Jan 26, 2026

cks: add affinity group support for CKS cluster nodes apache/cloudstack-documentation#620

Open

Pearl1594 reviewed Jan 26, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql Outdated Show resolved Hide resolved

revert charset of webhook_filter table to utf8mb4

6d8a7d8

kiranchavala self-assigned this Jan 28, 2026

Damans227 requested a review from Pearl1594 January 28, 2026 14:15

Pearl1594 reviewed Jan 28, 2026

View reviewed changes

...bernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesServiceHelperImpl.java Outdated Show resolved Hide resolved

Update error message

777897a

Damans227 requested a review from Pearl1594 January 28, 2026 16:54

Damans227 marked this pull request as ready for review February 11, 2026 15:26

DaanHoogland approved these changes Feb 12, 2026

View reviewed changes

DaanHoogland added the status:needs-testing label Feb 12, 2026

nvazquez reviewed Feb 13, 2026

View reviewed changes

Conversation

Damans227 commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes:

Design doc:

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

cmk based api testing:

Screen recording

Screenshots

How Has This Been Tested?

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

Uh oh!

blueorangutan commented Jan 7, 2026

Uh oh!

codecov bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jan 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nvazquez Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Damans227 commented Jan 26, 2026

Uh oh!

Uh oh!

Pearl1594 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

harikrishna-patnala commented Feb 2, 2026

Uh oh!

blueorangutan commented Feb 2, 2026

Uh oh!

blueorangutan commented Feb 2, 2026

Uh oh!

nvazquez commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

nvazquez commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Feb 12, 2026

Uh oh!

nvazquez Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Damans227 commented Jan 7, 2026 •

edited

Loading

codecov bot commented Jan 8, 2026 •

edited

Loading