Normalize naming of Kubernetes clusters

[bernardodemarco]

Description

Kubernetes has naming conventions for some type of resources. It requires, for instance, that some of them must:

• contain at most 63 characters;
• contain only lowercase alphanumeric characters or -;
• start with an alphabetic character; and,
• end with an alphanumeric character.

More information regarding Kubernetes naming constraints can be found on its Object Names and IDs documentation section.

Apache CloudStack names the control and worker cluster nodes using the following format: <cluster-name> + <"control" | "node"> + <hash>. When generating the names of the nodes, firstly, the cluster name is normalized, in order to meet the Kubernetes naming requirements:

cloudstack/plugins/integrations/kubernetes-service/src/main/java/com/cloud/kubernetes/cluster/actionworkers/KubernetesClusterResourceModifierActionWorker.java

Lines 775 to 788 in 55c8138

	protected String getKubernetesClusterNodeNamePrefix() {
	String prefix = kubernetesCluster.getName();
	if (!NetUtils.verifyDomainNameLabel(prefix, true)) {
	prefix = prefix.replaceAll("[^a-zA-Z0-9-]", "");
	if (prefix.length() == 0) {
	prefix = kubernetesCluster.getUuid();
	}
	prefix = "k8s-" + prefix;
	}
	if (prefix.length() > 40) {
	prefix = prefix.substring(0, 40);
	}
	return prefix;
	}

However, not all required normalization operations are performed. When a Kubernetes cluster contains uppercase letters in its name, for instance, the static method NetUtils.verifyDomainLabel returns true (it verifies the domain name label in a case-insensitive manner). Thus, the uppercase letters are not removed from the string (prefix.replaceAll("[^a-zA-Z0-9-]", "") is not executed) and the Kubernetes nodes end up with names containing uppercase letters. As a consequence of that, some inconsistencies when consuming the Kubernetes services are faced, because Kubernetes is not able to properly identify its nodes.

Therefore, this PR applies all the required normalization steps to Kubernetes cluster names to always meet the above-mentioned naming requirements. When required, unsupported characters are removed, names are truncated and converted to lower case. Unit tests have been implemented to cover all possible normalization scenarios.

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

Bug Severity

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

How Has This Been Tested?

• Manually reproduced the unit tests scenarios

[bernardodemarco]

@blueorangutan package

[blueorangutan]

@bernardodemarco 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]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.18%. Comparing base (55c8138) to head (4fae561).
Report is 40 commits behind head on 4.19.

Additional details and impacted files

@@             Coverage Diff              @@
##               4.19   #10778      +/-   ##
============================================
+ Coverage     15.16%   15.18%   +0.01%     
- Complexity    11332    11368      +36     
============================================
  Files          5412     5416       +4     
  Lines        475033   475887     +854     
  Branches      57963    58091     +128     
============================================
+ Hits          72048    72260     +212     
- Misses       394930   395540     +610     
- Partials       8055     8087      +32     

Flag	Coverage Δ
uitests	4.28% <ø> (-0.02%)	⬇️
unittests	15.91% <100.00%> (+0.02%)	⬆️

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.

[weizhouapache]

good idea.
This will avoid some issues caused by the name of k8s nodes.
However, I suggest to try our best to generate the name matching the convention, instead of throwing an exception.
For example, lower the upper case, replace or remove unsupported chars, truncate the cluster name

[blueorangutan]

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

[bernardodemarco]

@weizhouapache yes, this approach would be much better from a UX perspective. I'll mark this PR as draft while I refactor it.

[bernardodemarco]

@blueorangutan package

[blueorangutan]

@bernardodemarco 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]

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

[DaanHoogland]

@blueorangutan test

[blueorangutan]

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

[blueorangutan]

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

Test	Result	Time (s)	Test File

[weizhouapache]

overall lgtm

not tested

[bernardodemarco]

@blueorangutan package

[blueorangutan]

@bernardodemarco 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]

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

[bernardodemarco]

@weizhouapache @Pearl1594, can we run the CI again for this one?

[bernardodemarco]

@julien-vaz, could you test this one, please?