Skip to content

Enforce Restricted Fields usage when no default value #345

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

Merged
merged 4 commits into from
Feb 7, 2022
+14 −5
Merged

Enforce Restricted Fields usage when no default value #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a9331af
Enforce Restricted Fields usage when no default value
Feb 4, 2022
5aca07b
Merge branch 'master' into admin-config-boundary
eytan-avisror Feb 4, 2022
c321e16
Update zz_generated.deepcopy.go
Feb 4, 2022
3806286
Add return to errors.Wrap()
Feb 4, 2022
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
1 change: 0 additions & 1 deletion api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions controllers/provisioners/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ package provisioners

import (
"fmt"
"k8s.io/apimachinery/pkg/labels"
"strings"

"k8s.io/apimachinery/pkg/labels"

"github.com/ghodss/yaml"
"github.com/keikoproj/instance-manager/api/v1alpha1"
"github.com/keikoproj/instance-manager/controllers/common"
Expand Down Expand Up @@ -176,7 +177,7 @@ func (c *ProvisionerConfiguration) setRestrictedFields(unstructuredInstanceGroup
setFieldInAnyConditional = true
err := unstructured.SetNestedField(unstructuredInstanceGroup, field, path...)
if err != nil {
errors.Wrap(err, "failed to set nested field")
return errors.Wrap(err, "failed to set nested field")
}
}
}
Expand All @@ -187,7 +188,13 @@ func (c *ProvisionerConfiguration) setRestrictedFields(unstructuredInstanceGroup
// default value exists for restricted path
err := unstructured.SetNestedField(unstructuredInstanceGroup, field, path...)
if err != nil {
errors.Wrap(err, "failed to set nested field")
return errors.Wrap(err, "failed to set nested field")
}
} else {
// if no default value exist, make sure to ignore CR value for restricted fields
err := unstructured.SetNestedField(unstructuredInstanceGroup, nil, path...)
if err != nil {
return errors.Wrap(err, "failed to set nested field to nil")
}
}
}
Expand Down
5 changes: 4 additions & 1 deletion controllers/provisioners/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ func TestSetDefaultsRestricted(t *testing.T) {
- spec.eks.configuration.labels
- spec.eks.configuration.securityGroups
- spec.eks.configuration.instanceType
- spec.strategy`
- spec.strategy
- spec.eks.configuration.suspendProcesses`

mockConditionals := `
- annotationSelector: "instancemgr.keikoproj.io/os-family=windows"
Expand Down Expand Up @@ -135,6 +136,7 @@ spec:

cm := MockConfigMap(MockConfigData("boundaries", mockBoundaries, "defaults", mockDefaults, "conditionals", mockConditionals))
cr := MockResource()
cr.Spec.EKSSpec.EKSConfiguration.SuspendedProcesses = []string{"AZRebalance"}
cr.Spec.EKSSpec.EKSConfiguration.EksClusterName = "someCluster"
cr.Spec.EKSSpec.EKSConfiguration.NodeSecurityGroups = []string{"sg-000000000000"}
cr.Spec.EKSSpec.EKSConfiguration.InstanceType = "m5.xlarge"
Expand All @@ -155,6 +157,7 @@ spec:
},
}))
g.Expect(c.InstanceGroup.Spec.EKSSpec.EKSConfiguration.NodeSecurityGroups).To(gomega.Equal([]string{"sg-123456789012"}))
g.Expect(c.InstanceGroup.Spec.EKSSpec.EKSConfiguration.SuspendedProcesses).To(gomega.BeNil())
g.Expect(c.InstanceGroup.Spec.EKSSpec.EKSConfiguration.InstanceType).To(gomega.Equal("m5.large"))
g.Expect(c.InstanceGroup.Spec.EKSSpec.EKSConfiguration.Labels).To(gomega.Equal(MockLabels("label-key", "label-value")))
g.Expect(c.InstanceGroup.Spec.EKSSpec.EKSConfiguration.Taints).To(gomega.Equal([]corev1.Taint{MockTaint("taint-key", "taint-value", "NoSchedule")}))
Expand Down