Skip to content

🌱Add image validation for openstack machine #2665

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🌱Add image validation for openstack machine #2665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions api/v1beta1/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package v1beta1

import (
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/utils/ptr"

"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/optional"
Expand Down Expand Up @@ -75,6 +76,24 @@ func (f *ImageFilter) IsZero() bool {
return f.Name == nil && len(f.Tags) == 0
}

// Validate performs validation on [ImageParam], returning a list of field errors using the provided base path.
// It is intended to be used in the validation webhooks of resources containing [ImageParam].
func (i *ImageParam) Validate(base field.Path) field.ErrorList {
var errors field.ErrorList
// Not possible to validate the image if it is missing
if i == nil {
errors = append(errors, field.Required(&base, "Image is required"))
return errors
}
if i.Filter.Name == nil || i.Filter.Tags == nil {
errors = append(errors, field.Required(base.Child("Image filter"), "Either Name or Tags of image are missing"))
}
if i.ImageRef.Name == "" {
errors = append(errors, field.Required(base.Child("ORC image Referecne"), "ORC image is missing"))
}
return errors
}

type ExternalRouterIPParam struct {
// The FixedIP in the corresponding subnet
FixedIP string `json:"fixedIP,omitempty"`
Expand Down
22 changes: 19 additions & 3 deletions pkg/webhooks/openstackmachine_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,18 @@ type openStackMachineWebhook struct{}
var _ webhook.CustomValidator = &openStackMachineWebhook{}

// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
var allErrs field.ErrorList
newObj, err := castToOpenStackMachine(objRaw)
if err != nil {
return nil, err
}

err = webhook.validate(newObj)
if err != nil {
return nil, err
}

if newObj.Spec.RootVolume != nil && newObj.Spec.AdditionalBlockDevices != nil {
for _, device := range newObj.Spec.AdditionalBlockDevices {
if device.Name == "root" {
Expand All @@ -73,7 +78,7 @@ func (*openStackMachineWebhook) ValidateCreate(_ context.Context, objRaw runtime
}

// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
newObj, err := castToOpenStackMachine(newObjRaw)
if err != nil {
return nil, err
Expand Down Expand Up @@ -121,7 +126,7 @@ func (*openStackMachineWebhook) ValidateUpdate(_ context.Context, oldObjRaw, new
}

// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
return nil, nil
}

Expand All @@ -132,3 +137,14 @@ func castToOpenStackMachine(obj runtime.Object) (*infrav1.OpenStackMachine, erro
}
return cast, nil
}

func (webhook *openStackMachineWebhook) validate(newObj *infrav1.OpenStackMachine) error {
var allErrs field.ErrorList

allErrs = append(allErrs, newObj.Spec.Image.Validate(*field.NewPath("Spec", "Image"))...)

if len(allErrs) == 0 {
return nil
}
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackMachine").GroupKind(), newObj.Name, allErrs)
}
22 changes: 19 additions & 3 deletions pkg/webhooks/openstackmachinetemplate_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,19 @@ type openStackMachineTemplateWebhook struct{}
var _ webhook.CustomValidator = &openStackMachineTemplateWebhook{}

// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
newObj, err := castToOpenStackMachineTemplate(objRaw)
if err != nil {
return nil, err
}

var allErrs field.ErrorList

err = webhook.validate(newObj)
if err != nil {
return nil, err
}

if newObj.Spec.Template.Spec.ProviderID != nil {
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "template", "spec", "providerID"), "cannot be set in templates"))
}
Expand All @@ -64,7 +69,7 @@ func (*openStackMachineTemplateWebhook) ValidateCreate(_ context.Context, objRaw
}

// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
var allErrs field.ErrorList
oldObj, err := castToOpenStackMachineTemplate(oldObjRaw)
if err != nil {
Expand Down Expand Up @@ -92,7 +97,7 @@ func (*openStackMachineTemplateWebhook) ValidateUpdate(ctx context.Context, oldO
}

// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
func (webhook *openStackMachineTemplateWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
return nil, nil
}

Expand All @@ -103,3 +108,14 @@ func castToOpenStackMachineTemplate(obj runtime.Object) (*infrav1.OpenStackMachi
}
return cast, nil
}

func (webhook *openStackMachineTemplateWebhook) validate(newObj *infrav1.OpenStackMachineTemplate) error {
var allErrs field.ErrorList

allErrs = append(allErrs, newObj.Spec.Template.Spec.Image.Validate(*field.NewPath("Spec", "Template", "Spec", "Image"))...)

if len(allErrs) == 0 {
return nil
}
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackMachineTemplate").GroupKind(), newObj.Name, allErrs)
}
21 changes: 18 additions & 3 deletions pkg/webhooks/openstackserver_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,16 @@ type openStackServerWebhook struct{}
var _ webhook.CustomValidator = &openStackServerWebhook{}

// ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.Object) (admission.Warnings, error) {
var allErrs field.ErrorList
newObj, err := castToOpenStackServer(objRaw)
if err != nil {
return nil, err
}
err = webhook.validate(newObj)
if err != nil {
return nil, err
}

if newObj.Spec.RootVolume != nil && newObj.Spec.AdditionalBlockDevices != nil {
for _, device := range newObj.Spec.AdditionalBlockDevices {
Expand All @@ -75,7 +79,7 @@ func (*openStackServerWebhook) ValidateCreate(_ context.Context, objRaw runtime.
}

// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
func (webhook *openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, newObjRaw runtime.Object) (admission.Warnings, error) {
oldObj, err := castToOpenStackServer(oldObjRaw)
if err != nil {
return nil, err
Expand Down Expand Up @@ -124,7 +128,7 @@ func (*openStackServerWebhook) ValidateUpdate(ctx context.Context, oldObjRaw, ne
}

// ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type.
func (*openStackServerWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
func (webhook *openStackServerWebhook) ValidateDelete(_ context.Context, _ runtime.Object) (admission.Warnings, error) {
return nil, nil
}

Expand All @@ -135,3 +139,14 @@ func castToOpenStackServer(obj runtime.Object) (*infrav1alpha1.OpenStackServer,
}
return cast, nil
}

func (webhook *openStackServerWebhook) validate(newObj *infrav1alpha1.OpenStackServer) error {
var allErrs field.ErrorList

allErrs = append(allErrs, newObj.Spec.Image.Validate(*field.NewPath("Spec", "Image"))...)

if len(allErrs) == 0 {
return nil
}
return apierrors.NewInvalid(infrav1.SchemeGroupVersion.WithKind("OpenStackServer").GroupKind(), newObj.Name, allErrs)
}