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.

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 snow upgrade bugs encountered during upgrade from beta #2773

Merged
merged 5 commits into from
Jul 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 pkg/clusterapi/name.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,16 @@ import (

"github.com/aws/eks-anywhere/pkg/api/v1alpha1"
"github.com/aws/eks-anywhere/pkg/cluster"
"github.com/aws/eks-anywhere/pkg/logger"
)

var nameRegex = regexp.MustCompile(`(.*?)(-)(\d+)$`)

// IncrementName takes an object name and increments the suffix number by one.
// This method is used for updating objects (e.g. machinetemplate, kubeadmconfigtemplate) that are either immutable
// or require recreation to trigger machine rollout. The original object name should follow the name convention of
// alphanumeric followed by dash digits, e.g. abc-1, md-0, kct-2. An error will be raised if the original name does not follow
// this pattern.
func IncrementName(name string) (string, error) {
match := nameRegex.FindStringSubmatch(name)
if match == nil {
Expand All @@ -25,6 +31,19 @@ func IncrementName(name string) (string, error) {
return ObjectName(match[1], n+1), nil
}

// IncrementNameWithFallbackDefault calls the IncrementName and fallbacks to use the default name if IncrementName
// returns an error. This method is used to accommodate for any objects with name breaking changes from a previous version.
// For example, in beta capi snowmachinetemplate is named after the eks-a snowmachineconfig name, without the '-1' suffix.
// We set the object name to the default new machinetemplate name after detecting the invalid old name.
func IncrementNameWithFallbackDefault(name, defaultName string) string {
n, err := IncrementName(name)
if err != nil {
logger.V(4).Info("Unable to increment object name (might due to changes of name format), fallback to the default name", "error", err.Error())
return defaultName
}
return n
}

func ObjectName(baseName string, version int) string {
return fmt.Sprintf("%s-%d", baseName, version)
}
Expand Down
29 changes: 29 additions & 0 deletions pkg/clusterapi/name_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,35 @@ func TestIncrementName(t *testing.T) {
}
}

func TestIncrementNameWithFallbackDefault(t *testing.T) {
tests := []struct {
name string
oldName string
defaultName string
want string
}{
{
name: "valid",
oldName: "cluster-1",
defaultName: "default",
want: "cluster-2",
},
{
name: "invalid format",
oldName: "cluster-1a",
defaultName: "default",
want: "default",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)
got := clusterapi.IncrementNameWithFallbackDefault(tt.oldName, tt.defaultName)
g.Expect(got).To(Equal(tt.want))
})
}
}

func TestObjectName(t *testing.T) {
tests := []struct {
name string
Expand Down
1 change: 1 addition & 0 deletions pkg/constants/constants.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const (
CapvSystemNamespace = "capv-system"
CaptSystemNamespace = "capt-system"
CapaSystemNamespace = "capa-system"
CapasSystemNamespace = "capas-system"
CertManagerNamespace = "cert-manager"
DefaultNamespace = "default"
EtcdAdmBootstrapProviderSystemNamespace = "etcdadm-bootstrap-provider-system"
Expand Down
1 change: 1 addition & 0 deletions pkg/executables/clusterctl.go
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ var providerNamespaces = map[string]string{
constants.DockerProviderName: constants.CapdSystemNamespace,
constants.CloudStackProviderName: constants.CapcSystemNamespace,
constants.AWSProviderName: constants.CapaSystemNamespace,
constants.SnowProviderName: constants.CapasSystemNamespace,
etcdadmBootstrapProviderName: constants.EtcdAdmBootstrapProviderSystemNamespace,
etcdadmControllerProviderName: constants.EtcdAdmControllerSystemNamespace,
kubeadmBootstrapProviderName: constants.CapiKubeadmBootstrapSystemNamespace,
Expand Down
49 changes: 17 additions & 32 deletions pkg/providers/snow/objects.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,8 @@ func ControlPlaneObjects(ctx context.Context, clusterSpec *cluster.Spec, kubeCli
if err != nil {
return nil, err
}
name, err := NewMachineTemplateName(new, old)
if err != nil {
return nil, err
}
new.SetName(name)

new.SetName(NewMachineTemplateName(new, old))

kubeadmControlPlane, err := KubeadmControlPlane(clusterSpec, new)
if err != nil {
Expand Down Expand Up @@ -98,17 +95,11 @@ func WorkersMachineAndConfigTemplate(ctx context.Context, kubeClient kubernetes.
}

// compare the old and new kubeadmConfigTemplate to determine whether to recreate new kubeadmConfigTemplate object
configName, err := NewKubeadmConfigTemplateName(newConfigTemplate, oldConfigTemplate)
if err != nil {
return nil, nil, err
}
configName := NewKubeadmConfigTemplateName(newConfigTemplate, oldConfigTemplate)

// compare the old and new machineTemplate as well as kubeadmConfigTemplate to determine whether to recreate
// new machineTemplate object
machineName, err := NewWorkerMachineTemplateName(newMachineTemplate, oldMachineTemplate, newConfigTemplate, oldConfigTemplate)
if err != nil {
return nil, nil, err
}
machineName := NewWorkerMachineTemplateName(newMachineTemplate, oldMachineTemplate, newConfigTemplate, oldConfigTemplate)

newConfigTemplate.SetName(configName)
newMachineTemplate.SetName(machineName)
Expand All @@ -120,48 +111,42 @@ func WorkersMachineAndConfigTemplate(ctx context.Context, kubeClient kubernetes.
return machines, configs, nil
}

func NewMachineTemplateName(new, old *snowv1.AWSSnowMachineTemplate) (string, error) {
func NewMachineTemplateName(new, old *snowv1.AWSSnowMachineTemplate) string {
if old == nil {
return new.GetName(), nil
return new.GetName()
}

if equality.Semantic.DeepDerivative(new.Spec, old.Spec) {
return old.GetName(), nil
return old.GetName()
}

return clusterapi.IncrementName(old.GetName())
return clusterapi.IncrementNameWithFallbackDefault(old.GetName(), new.GetName())
}

func NewWorkerMachineTemplateName(newMt, oldMt *snowv1.AWSSnowMachineTemplate, newKct, oldKct *bootstrapv1.KubeadmConfigTemplate) (string, error) {
name, err := NewMachineTemplateName(newMt, oldMt)
if err != nil {
return "", err
}
func NewWorkerMachineTemplateName(newMt, oldMt *snowv1.AWSSnowMachineTemplate, newKct, oldKct *bootstrapv1.KubeadmConfigTemplate) string {
name := NewMachineTemplateName(newMt, oldMt)

if oldKct == nil {
return name, nil
return name
}

if recreateKubeadmConfigTemplateNeeded(newKct, oldKct) {
name, err = clusterapi.IncrementName(oldMt.GetName())
if err != nil {
return "", err
}
name = clusterapi.IncrementNameWithFallbackDefault(oldMt.GetName(), newMt.GetName())
}

return name, nil
return name
}

func NewKubeadmConfigTemplateName(new, old *bootstrapv1.KubeadmConfigTemplate) (string, error) {
func NewKubeadmConfigTemplateName(new, old *bootstrapv1.KubeadmConfigTemplate) string {
if old == nil {
return new.GetName(), nil
return new.GetName()
}

if recreateKubeadmConfigTemplateNeeded(new, old) {
return clusterapi.IncrementName(old.GetName())
return clusterapi.IncrementNameWithFallbackDefault(old.GetName(), new.GetName())
}

return old.GetName(), nil
return old.GetName()
}

func recreateKubeadmConfigTemplateNeeded(new, old *bootstrapv1.KubeadmConfigTemplate) bool {
Expand Down
98 changes: 98 additions & 0 deletions pkg/providers/snow/objects_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,45 @@ func TestControlPlaneObjects(t *testing.T) {
g.Expect(got).To(Equal([]runtime.Object{wantCAPICluster(), wantSnowCluster(), kcp, mt}))
}

func TestControlPlaneObjectsUpgradeFromBetaMachineTemplateName(t *testing.T) {
g := newSnowTest(t)
mt := wantSnowMachineTemplate()
g.kubeconfigClient.EXPECT().
Get(
g.ctx,
"snow-test",
constants.EksaSystemNamespace,
&controlplanev1.KubeadmControlPlane{},
).
DoAndReturn(func(_ context.Context, _, _ string, obj *controlplanev1.KubeadmControlPlane) error {
obj.Spec.MachineTemplate.InfrastructureRef.Name = "test-cp"
return nil
})
g.kubeconfigClient.EXPECT().
Get(
g.ctx,
"test-cp",
constants.EksaSystemNamespace,
&snowv1.AWSSnowMachineTemplate{},
).
DoAndReturn(func(_ context.Context, _, _ string, obj *snowv1.AWSSnowMachineTemplate) error {
mt.DeepCopyInto(obj)
obj.SetName("test-cp")
obj.Spec.Template.Spec.InstanceType = "updated-instance-type"
return nil
})

wantMachineTemplateName := "snow-test-control-plane-1"
mt.SetName(wantMachineTemplateName)
mt.Spec.Template.Spec.InstanceType = "sbe-c.large"
kcp := wantKubeadmControlPlane()
kcp.Spec.MachineTemplate.InfrastructureRef.Name = wantMachineTemplateName

got, err := snow.ControlPlaneObjects(g.ctx, g.clusterSpec, g.kubeconfigClient)
g.Expect(err).To(Succeed())
g.Expect(got).To(Equal([]runtime.Object{wantCAPICluster(), wantSnowCluster(), kcp, mt}))
}

func TestControlPlaneObjectsOldControlPlaneNotExists(t *testing.T) {
g := newSnowTest(t)
mt := wantSnowMachineTemplate()
Expand Down Expand Up @@ -198,6 +237,65 @@ func TestWorkersObjects(t *testing.T) {
g.Expect(got).To(Equal([]runtime.Object{md, wantKubeadmConfigTemplate(), mt}))
}

func TestWorkersObjectsFromBetaMachineTemplateName(t *testing.T) {
g := newSnowTest(t)
mt := wantSnowMachineTemplate()
g.kubeconfigClient.EXPECT().
Get(
g.ctx,
"snow-test-md-0",
constants.EksaSystemNamespace,
&clusterv1.MachineDeployment{},
).
DoAndReturn(func(_ context.Context, _, _ string, obj *clusterv1.MachineDeployment) error {
wantMachineDeployment().DeepCopyInto(obj)
obj.Spec.Template.Spec.InfrastructureRef.Name = "test-wn"
obj.Spec.Template.Spec.Bootstrap.ConfigRef.Name = "test-wn"
return nil
})
g.kubeconfigClient.EXPECT().
Get(
g.ctx,
"test-wn",
constants.EksaSystemNamespace,
&bootstrapv1.KubeadmConfigTemplate{},
).
DoAndReturn(func(_ context.Context, _, _ string, obj *bootstrapv1.KubeadmConfigTemplate) error {
wantKubeadmConfigTemplate().DeepCopyInto(obj)
obj.SetName("test-wn")
obj.Spec.Template.Spec.PreKubeadmCommands = []string{
"new command",
}
return nil
})
g.kubeconfigClient.EXPECT().
Get(
g.ctx,
"test-wn",
constants.EksaSystemNamespace,
&snowv1.AWSSnowMachineTemplate{},
).
DoAndReturn(func(_ context.Context, _, _ string, obj *snowv1.AWSSnowMachineTemplate) error {
mt.DeepCopyInto(obj)
obj.SetName("test-wn")
obj.Spec.Template.Spec.InstanceType = "updated-instance-type"
return nil
})

wantMachineTemplateName := "snow-test-md-0-1"
mt.SetName(wantMachineTemplateName)
md := wantMachineDeployment()
md.Spec.Template.Spec.InfrastructureRef.Name = wantMachineTemplateName
kct := wantKubeadmConfigTemplate()
wantKctName := "snow-test-md-0-1"
kct.SetName(wantKctName)
md.Spec.Template.Spec.Bootstrap.ConfigRef.Name = wantKctName

got, err := snow.WorkersObjects(g.ctx, g.clusterSpec, g.kubeconfigClient)
g.Expect(err).To(Succeed())
g.Expect(got).To(Equal([]runtime.Object{md, kct, mt}))
}

func TestWorkersObjectsOldMachineDeploymentNotExists(t *testing.T) {
g := newSnowTest(t)
mt := wantSnowMachineTemplate()
Expand Down
12 changes: 10 additions & 2 deletions pkg/providers/snow/snow.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ func (p *SnowProvider) EnvMap(clusterSpec *cluster.Spec) (map[string]string, err

func (p *SnowProvider) GetDeployments() map[string][]string {
return map[string][]string{
"capas-system": {"capas-controller-manager"},
constants.CapasSystemNamespace: {"capas-controller-manager"},
}
}

Expand Down Expand Up @@ -231,7 +231,15 @@ func (p *SnowProvider) GenerateMHC(clusterSpec *cluster.Spec) ([]byte, error) {
}

func (p *SnowProvider) ChangeDiff(currentSpec, newSpec *cluster.Spec) *types.ComponentChangeDiff {
return nil
if currentSpec.VersionsBundle.Snow.Version == newSpec.VersionsBundle.Snow.Version {
return nil
}

return &types.ComponentChangeDiff{
ComponentName: constants.SnowProviderName,
NewVersion: newSpec.VersionsBundle.Snow.Version,
OldVersion: currentSpec.VersionsBundle.Snow.Version,
}
}

func (p *SnowProvider) RunPostControlPlaneUpgrade(ctx context.Context, oldClusterSpec *cluster.Spec, clusterSpec *cluster.Spec, workloadCluster *types.Cluster, managementCluster *types.Cluster) error {
Expand Down
22 changes: 22 additions & 0 deletions pkg/providers/snow/snow_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -739,3 +739,25 @@ func TestUpgradeNeededMachineConfigs(t *testing.T) {
})
}
}

func TestChangeDiffNoChange(t *testing.T) {
g := NewWithT(t)
provider := givenProvider(t)
clusterSpec := givenEmptyClusterSpec()
g.Expect(provider.ChangeDiff(clusterSpec, clusterSpec)).To(BeNil())
}

func TestChangeDiffWithChange(t *testing.T) {
g := NewWithT(t)
provider := givenProvider(t)
clusterSpec := givenEmptyClusterSpec()
newClusterSpec := clusterSpec.DeepCopy()
clusterSpec.VersionsBundle.Snow.Version = "v1.0.2"
newClusterSpec.VersionsBundle.Snow.Version = "v1.0.3"
want := &types.ComponentChangeDiff{
ComponentName: "snow",
NewVersion: "v1.0.3",
OldVersion: "v1.0.2",
}
g.Expect(provider.ChangeDiff(clusterSpec, newClusterSpec)).To(Equal(want))
}