feat: Nutanix VM image preflight check #1130

dlipovetsky · 2025-05-20T00:24:30Z

What problem does this PR solve?:
Implements a preflight check that verifies the Nutanix VM images referenced by the Cluster spec.

The VM IMages check reads various various topology variables, and I have defined a pseudo-check that intializes the variables from the Cluster spec.

The VM Images check also uses a Prism Central API client. I have defined a pseudo-check that initializes this client.

Which issue(s) this PR fixes:
Fixes #

How Has This Been Tested?:

Special notes for your reviewer:

Stacked on #1129

I am working on unit tests. The Nutanix client is difficult to mock, so creating the tests is taking more time than I expected.

jimmidyson · 2025-06-04T12:09:13Z

Preflight failures work nicely! Not sure it's what we want here but at least it works!

ImageLookup is not yet supported

dlipovetsky · 2025-06-04T16:30:23Z

The Nutanix e2e test is failing because it uses imageLookup, and the check does not yet support that. I'm working on it.

Update: I will add support for imageLookup in a separate PR. For now, we will allow it with a warning.

> kubectl create --dry-run=server -f test-cluster.yaml
Warning: cluster.spec.topology.workers.machineDeployments[.name=md-0].variables[.name=workerConfig].value.nutanix.machineDetails uses imageLookup, which is not yet supported by checks
cluster.cluster.x-k8s.io/dlag created (server dry run)

dlipovetsky · 2025-06-11T18:22:11Z

From @yanhua121: If the credential check fails, failures from other checks are just noise. Can we exclude them?

Update: Addressed in 7cc0676

dkoshkin

Looking good, had a question on the clients.

pkg/webhook/preflight/nutanix/clients.go

dkoshkin

Thanks!

jimmidyson · 2025-06-16T09:30:53Z

~~I'm wondering why we are doing this in here rather than in CAPX? Sorry if this has been discussed before!~~ EDIT: Ah yes because we're validating the variable value rather than the rendered cluster resource to prevent invalid data being persisted.

The base branch was changed.

pkg/webhook/preflight/nutanix/specs.go

github-actions · 2025-06-17T15:51:01Z

Automated PR Comment From Black Duck SCA

❌ Found dependencies violating policy!

Policies Violated	Dependency	License(s)	Vulnerabilities	Short Term Recommended Upgrade	Long Term Recommended Upgrade	Resolved / Filtered Out
Unknown	github.com/samber/lo (github.com/samber/lo:v1.51.0)	Unknown License				❕

dlipovetsky · 2025-06-17T16:03:42Z

Neither of the two failing checks failed before...

dlipovetsky · 2025-06-17T16:11:28Z

Blackduck is giving a false negative here.

github.com/samber/lo has had an MIT license since its initial commit.

And it has the same license in the v1.51.0 tag: https://github.com/samber/lo/blob/v1.51.0/LICENSE

(For reference, the dependency was changed by #1160, and the Blackduck scan also failed for the same reason there)

Allow imageLookup with warning

Mock nutanix clients to allow unit tests

* Refactor nutanixChecker to allow unit tests of all checks. * Add unit tests. * Fix field reported when spec init for worker spec fails. * Fix handling of credentials "Insecure" option. * Use lowercase 'v' in errors that refers to the Nutanix client

Use the correct check name

Run VM Image check only if Nutanix clients are initialized. This avoids returning errors that are not actionable. The user will see an error from the credentials check only.

Remove unused v4 client mock

Merge separate v3 and v4 clients into one

Remove unused code

Implement Check interface.

Refactor to simplify, and remove need to checker factory.

Address linter complaint

dlipovetsky · 2025-06-17T20:06:01Z

Rebased because #1164 merged.

@jimmidyson

🤖 I have created a release *beep* *boop* --- ## 0.30.0 (2025-06-24)  ## What's Changed ### Exciting New Features 🎉 * feat: Build with Go 1.24.4 to fix CVEs by @jimmidyson in #1157 * feat: add requests and limits to registry containers by @dkoshkin in #1158 * feat: Add preflight checks framework by @dlipovetsky in #1129 * feat: Preflight check opt-out by @dlipovetsky in #1156 * feat: Nutanix VM image preflight check by @dlipovetsky in #1130 * feat: update addons by @dkoshkin in #1168 * feat: Enforce MD replicas within cluster autoscaler bounds by @jimmidyson in #1169 * feat(preflight): Storage container checks for Nutanix by @thunderboltsid in #1136 * feat: update Nutanix CSI to 3.3.4 by @dkoshkin in #1179 ### Fixes 🔧 * fix: update CNCF registry version to 2.3.4, app version 2.8.3 by @dkoshkin in #1150 * fix: registry addon headless service port by @dkoshkin in #1159 * fix: preserve registry addon root CA on move by @dkoshkin in #1155 * fix: Add noderegistration patch to previous handler by @jimmidyson in #1177 ### Other Changes * build: include regclient/regsync image for registry addon by @dkoshkin in #1148 * test: Add update test helpers by @jimmidyson in #1162 * test(e2e): Nutanix 1.33.1 testing by @jimmidyson in #1164 * build: Update all tools by @jimmidyson in #1165 * refactor: add global feature.Gates variable by @dkoshkin in #1167 * ci: new env variable to set --feature-gates by @dkoshkin in #1166 * build: github.com/hashicorp/go-retryablehttp@v0.7.8 to fix CVE by @jimmidyson in #1170 * docs: Update link to default Cilium values in cni.md by @yannickstruyf3 in #1173 * docs: Fix up Cilium config link (again) & icons by @jimmidyson in #1176 ## New Contributors * @yannickstruyf3 made their first contribution in #1173 **Full Changelog**: v0.29.0...v0.30.0 --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Shalin Patel <shalin.patel@nutanix.com>

github-actions bot added the feature label May 20, 2025

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from 4780b5f to 265a77a Compare May 20, 2025 23:59

dlipovetsky marked this pull request as draft May 21, 2025 23:52

dlipovetsky mentioned this pull request May 22, 2025

feat: Add preflight checks framework #1129

Merged

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch 4 times, most recently from fb9d8a1 to f0cb9f8 Compare June 3, 2025 17:30

dlipovetsky marked this pull request as ready for review June 3, 2025 23:14

github-actions bot added feature and removed feature labels Jun 4, 2025

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from ca0bc94 to f440ff1 Compare June 6, 2025 04:51

dlipovetsky mentioned this pull request Jun 6, 2025

feat(preflight): Storage container checks for Nutanix #1136

Merged

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from 98103a7 to a1a08d3 Compare June 11, 2025 23:02

dkoshkin reviewed Jun 11, 2025

View reviewed changes

pkg/webhook/preflight/nutanix/clients.go Outdated Show resolved Hide resolved

dkoshkin previously approved these changes Jun 12, 2025

View reviewed changes

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from 6ab50f2 to 93299d2 Compare June 13, 2025 20:32

Base automatically changed from dlipovetsky/preflight-checks-framework to main June 17, 2025 15:20

github-actions bot added feature and removed feature labels Jun 17, 2025

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from 93299d2 to 365033c Compare June 17, 2025 15:47

dlipovetsky requested review from thunderboltsid and dkoshkin June 17, 2025 15:47

dkoshkin approved these changes Jun 17, 2025

View reviewed changes

github-actions bot reviewed Jun 17, 2025

View reviewed changes

pkg/webhook/preflight/nutanix/specs.go Outdated Show resolved Hide resolved

dlipovetsky added 12 commits June 17, 2025 13:04

feat: Nutanix VM image preflight check

1993179

fixup! feat: Nutanix VM image preflight check

da8abb6

Allow imageLookup with warning

fixup! feat: Nutanix VM image preflight check

0eaea5a

Mock nutanix clients to allow unit tests

fixup! fixup! feat: Nutanix VM image preflight check

d8bf980

Use the correct check name

fixup! feat: Nutanix VM image preflight check

ad484cf

Run VM Image check only if Nutanix clients are initialized. This avoids returning errors that are not actionable. The user will see an error from the credentials check only.

fixup! feat: Nutanix VM image preflight check

4273c03

Remove unused v4 client mock

fixup! feat: Nutanix VM image preflight check

05b342e

Merge separate v3 and v4 clients into one

fixup! feat: Nutanix VM image preflight check

19ab822

Remove unused code

fixup! feat: Nutanix VM image preflight check

f567dfe

Implement Check interface.

fixup! feat: Nutanix VM image preflight check

91a8748

Refactor to simplify, and remove need to checker factory.

fixup! feat: Nutanix VM image preflight check

ed9b787

Address linter complaint

dlipovetsky force-pushed the dlipovetsky/preflight-nutanix-vmimage branch from 97075a2 to ed9b787 Compare June 17, 2025 20:05

thunderboltsid approved these changes Jun 17, 2025

View reviewed changes

dlipovetsky merged commit 35fd169 into main Jun 17, 2025
22 of 23 checks passed

dlipovetsky deleted the dlipovetsky/preflight-nutanix-vmimage branch June 17, 2025 20:33

jimmidyson mentioned this pull request Jun 18, 2025

release(main): v0.30.0 #1171

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Nutanix VM image preflight check #1130

feat: Nutanix VM image preflight check #1130

Uh oh!

dlipovetsky commented May 20, 2025 •

edited

Loading

Uh oh!

jimmidyson commented Jun 4, 2025

Uh oh!

dlipovetsky commented Jun 4, 2025 •

edited

Loading

Uh oh!

dlipovetsky commented Jun 11, 2025 •

edited

Loading

Uh oh!

dkoshkin left a comment

Uh oh!

Uh oh!

dkoshkin left a comment

Uh oh!

jimmidyson commented Jun 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025

Uh oh!

dlipovetsky commented Jun 17, 2025

Uh oh!

dlipovetsky commented Jun 17, 2025 •

edited

Loading

Uh oh!

dlipovetsky commented Jun 17, 2025

Uh oh!

Uh oh!

Uh oh!

feat: Nutanix VM image preflight check #1130

feat: Nutanix VM image preflight check #1130

Uh oh!

Conversation

dlipovetsky commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jimmidyson commented Jun 4, 2025

Uh oh!

dlipovetsky commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

dkoshkin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dkoshkin left a comment

Choose a reason for hiding this comment

Uh oh!

jimmidyson commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025

Automated PR Comment From Black Duck SCA

❌ Found dependencies violating policy!

Uh oh!

dlipovetsky commented Jun 17, 2025

Uh oh!

dlipovetsky commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dlipovetsky commented Jun 17, 2025

Uh oh!

Uh oh!

Uh oh!

dlipovetsky commented May 20, 2025 •

edited

Loading

dlipovetsky commented Jun 4, 2025 •

edited

Loading

dlipovetsky commented Jun 11, 2025 •

edited

Loading

jimmidyson commented Jun 16, 2025 •

edited

Loading

dlipovetsky commented Jun 17, 2025 •

edited

Loading