Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix cloudprofile validation #1020

Merged
merged 5 commits into from
Jan 29, 2025
Merged

Fix cloudprofile validation #1020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bfa3d7e
Fix cloudprofile validation
hebelsan Nov 19, 2024
72ab010
Cleanup
hebelsan Dec 18, 2024
4718475
Make use of gardener utils
hebelsan Dec 20, 2024
c704026
Add additional test case
hebelsan Dec 20, 2024
851ddf9
Improve error message
hebelsan Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/admission/validator/cloudprofile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ func (cp *cloudProfile) Validate(_ context.Context, newObj, _ client.Object) err
return err
}

return azurevalidation.ValidateCloudProfileConfig(cpConfig, providerConfigPath).ToAggregate()
return azurevalidation.ValidateCloudProfileConfig(cpConfig, cloudProfile.Spec.MachineImages, providerConfigPath).ToAggregate()
}
23 changes: 3 additions & 20 deletions pkg/admission/validator/namespacedcloudprofile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ func (p *namespacedCloudProfile) validateMachineImages(providerConfig *api.Cloud
machineImagesPath := field.NewPath("spec.providerConfig.machineImages")
for i, machineImage := range providerConfig.MachineImages {
idxPath := machineImagesPath.Index(i)
allErrs = append(allErrs, validation.ValidateMachineImage(idxPath, machineImage)...)
allErrs = append(allErrs, validation.ValidateProviderMachineImage(idxPath, machineImage)...)
}

profileImages := util.NewCoreImagesContext(machineImages)
parentImages := util.NewV1beta1ImagesContext(parentSpec.MachineImages)
providerImages := newProviderImagesContext(providerConfig.MachineImages)
providerImages := validation.NewProviderImagesContext(providerConfig.MachineImages)

for _, machineImage := range profileImages.Images {
// Check that for each new image version defined in the NamespacedCloudProfile, the image is also defined in the providerConfig.
Expand All @@ -126,7 +126,7 @@ func (p *namespacedCloudProfile) validateMachineImages(providerConfig *api.Cloud
for _, version := range machineImage.Versions {
_, existsInParent := parentImages.GetImageVersion(machineImage.Name, version.Version)
for _, expectedArchitecture := range version.Architectures {
if _, exists := providerImages.GetImageVersion(machineImage.Name, versionArchitectureKey(version.Version, expectedArchitecture)); !existsInParent && !exists {
if _, exists := providerImages.GetImageVersion(machineImage.Name, validation.VersionArchitectureKey(version.Version, expectedArchitecture)); !existsInParent && !exists {
allErrs = append(allErrs, field.Required(
field.NewPath("spec.providerConfig.machineImages"),
fmt.Sprintf("machine image version %s@%s is not defined in the NamespacedCloudProfile providerConfig", machineImage.Name, version.Version),
Expand Down Expand Up @@ -178,23 +178,6 @@ func (p *namespacedCloudProfile) validateMachineImages(providerConfig *api.Cloud
return allErrs
}

func providerMachineImageKey(v api.MachineImageVersion) string {
return versionArchitectureKey(v.Version, ptr.Deref(v.Architecture, constants.ArchitectureAMD64))
}

func versionArchitectureKey(version, architecture string) string {
return version + "-" + architecture
}

func newProviderImagesContext(providerImages []api.MachineImages) *util.ImagesContext[api.MachineImages, api.MachineImageVersion] {
return util.NewImagesContext(
utils.CreateMapFromSlice(providerImages, func(mi api.MachineImages) string { return mi.Name }),
func(mi api.MachineImages) map[string]api.MachineImageVersion {
return utils.CreateMapFromSlice(mi.Versions, func(v api.MachineImageVersion) string { return providerMachineImageKey(v) })
},
)
}

func (p *namespacedCloudProfile) validateMachineTypes(providerConfig *api.CloudProfileConfig, machineTypes []core.MachineType, parentSpec gardencorev1beta1.CloudProfileSpec) field.ErrorList {
allErrs := field.ErrorList{}

Expand Down
74 changes: 66 additions & 8 deletions pkg/apis/azure/validation/cloudprofile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,43 @@ import (
"fmt"
"strings"

"github.com/gardener/gardener/extensions/pkg/util"
"github.com/gardener/gardener/pkg/apis/core"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
"github.com/gardener/gardener/pkg/utils"
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/utils/ptr"
"k8s.io/utils/strings/slices"

apisazure "github.com/gardener/gardener-extension-provider-azure/pkg/apis/azure"
)

// ValidateCloudProfileConfig validates a CloudProfileConfig object.
func ValidateCloudProfileConfig(cloudProfile *apisazure.CloudProfileConfig, fldPath *field.Path) field.ErrorList {
func ValidateCloudProfileConfig(cpConfig *apisazure.CloudProfileConfig, machineImages []core.MachineImage, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}

allErrs = append(allErrs, validateDomainCount(cloudProfile.CountFaultDomains, fldPath.Child("countFaultDomains"))...)
allErrs = append(allErrs, validateDomainCount(cloudProfile.CountUpdateDomains, fldPath.Child("countUpdateDomains"))...)
allErrs = append(allErrs, validateDomainCount(cpConfig.CountFaultDomains, fldPath.Child("countFaultDomains"))...)
allErrs = append(allErrs, validateDomainCount(cpConfig.CountUpdateDomains, fldPath.Child("countUpdateDomains"))...)

machineImagesPath := fldPath.Child("machineImages")
if len(cloudProfile.MachineImages) == 0 {
if len(cpConfig.MachineImages) == 0 {
allErrs = append(allErrs, field.Required(machineImagesPath, "must provide at least one machine image"))
return allErrs
}
for i, machineImage := range cloudProfile.MachineImages {

// validate all provider images fields
for i, machineImage := range cpConfig.MachineImages {
idxPath := machineImagesPath.Index(i)
allErrs = append(allErrs, ValidateMachineImage(idxPath, machineImage)...)
allErrs = append(allErrs, ValidateProviderMachineImage(idxPath, machineImage)...)
}

allErrs = append(allErrs, validateProviderImagesMapping(cpConfig.MachineImages, machineImages, field.NewPath("spec").Child("machineImages"))...)

return allErrs
}

// ValidateMachineImage validates a CloudProfileConfig MachineImages entry.
func ValidateMachineImage(validationPath *field.Path, machineImage apisazure.MachineImages) field.ErrorList {
// ValidateProviderMachineImage validates a CloudProfileConfig MachineImages entry.
func ValidateProviderMachineImage(validationPath *field.Path, machineImage apisazure.MachineImages) field.ErrorList {
allErrs := field.ErrorList{}

if len(machineImage.Name) == 0 {
Expand Down Expand Up @@ -96,6 +105,36 @@ func ValidateMachineImage(validationPath *field.Path, machineImage apisazure.Mac
return allErrs
}

// verify that for each cp image a provider image exists
func validateProviderImagesMapping(cpConfigImages []apisazure.MachineImages, machineImages []core.MachineImage, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}

providerImages := NewProviderImagesContext(cpConfigImages)

// for each image in the CloudProfile, check if it exists in the CloudProfileConfig
for idxImage, machineImage := range machineImages {
machineImagePath := fldPath.Index(idxImage)
if _, existsInParent := providerImages.GetImage(machineImage.Name); !existsInParent {
allErrs = append(allErrs, field.Required(machineImagePath, fmt.Sprintf("must provide a provider image mapping for image %q", machineImage.Name)))
continue
}

// validate that for each version and architecture of an image in the cloud profile a
// corresponding provider specific image in the cloud profile config exists
for versionIdx, version := range machineImage.Versions {
imageVersionPath := machineImagePath.Child("versions").Index(versionIdx)
for _, expectedArchitecture := range version.Architectures {
if _, exists := providerImages.GetImageVersion(machineImage.Name, VersionArchitectureKey(version.Version, expectedArchitecture)); !exists {
allErrs = append(allErrs, field.Required(imageVersionPath,
fmt.Sprintf("must provide an image mapping for version %q and architecture: %s", version.Version, expectedArchitecture)))
}
}
}
}

return allErrs
}

// validateProvidedImageIdCount validates that only one of urn/id/communityGalleryImageID/sharedGalleryImageID is provided
func validateProvidedImageIdCount(version apisazure.MachineImageVersion, fldPath *field.Path) field.ErrorList {
allErrs := field.ErrorList{}
Expand Down Expand Up @@ -146,3 +185,22 @@ func validateDomainCount(domainCount []apisazure.DomainCount, fldPath *field.Pat

return allErrs
}

func providerMachineImageKey(v apisazure.MachineImageVersion) string {
return VersionArchitectureKey(v.Version, ptr.Deref(v.Architecture, v1beta1constants.ArchitectureAMD64))
}

// VersionArchitectureKey returns a key for a version and architecture.
func VersionArchitectureKey(version, architecture string) string {
return version + "-" + architecture
}

// NewProviderImagesContext creates a new images context for provider images.
func NewProviderImagesContext(providerImages []apisazure.MachineImages) *util.ImagesContext[apisazure.MachineImages, apisazure.MachineImageVersion] {
return util.NewImagesContext(
utils.CreateMapFromSlice(providerImages, func(mi apisazure.MachineImages) string { return mi.Name }),
func(mi apisazure.MachineImages) map[string]apisazure.MachineImageVersion {
return utils.CreateMapFromSlice(mi.Versions, func(v apisazure.MachineImageVersion) string { return providerMachineImageKey(v) })
},
)
}
Loading
Loading