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

Add a validation if the controller is paused during cluster upgrade #7585

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Add a validation if the controller is paused during cluster upgrade #7585

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
12 changes: 12 additions & 0 deletions pkg/validations/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,15 @@ func ValidateEksaReleaseExistOnManagement(ctx context.Context, k kubernetes.Clie
}
return nil
}

// ValidatePauseAnnotation checks if the target cluster has annotation anywhere.eks.amazonaws.com/paused set to true or not.
func ValidatePauseAnnotation(ctx context.Context, k KubectlClient, cluster *types.Cluster, clusterName string) error {
currentCluster, err := k.GetEksaCluster(ctx, cluster, clusterName)
if err != nil {
return err
}
if currentCluster.IsReconcilePaused() {
return fmt.Errorf("cluster cannot be upgraded with paused cluster controller reconciler")
}
return nil
}
55 changes: 55 additions & 0 deletions pkg/validations/cluster_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,3 +618,58 @@ func TestValidateEksaReleaseExistOnManagement(t *testing.T) {
})
}
}

func TestValidatePauseAnnotation(t *testing.T) {
mgmtName := "test"
tests := []struct {
name string
gotCluster *anywherev1.Cluster
wantErr error
}{
{
name: "success",
gotCluster: &anywherev1.Cluster{
ObjectMeta: v1.ObjectMeta{
Name: mgmtName,
Annotations: map[string]string{},
},
Spec: anywherev1.ClusterSpec{
ManagementCluster: anywherev1.ManagementCluster{
Name: mgmtName,
},
},
},
wantErr: nil,
},
{
name: "success",
gotCluster: &anywherev1.Cluster{
ObjectMeta: v1.ObjectMeta{
Name: mgmtName,
Annotations: map[string]string{"anywhere.eks.amazonaws.com/paused": "true"},
},
Spec: anywherev1.ClusterSpec{
ManagementCluster: anywherev1.ManagementCluster{
Name: mgmtName,
},
},
},
wantErr: fmt.Errorf("cluster cannot be upgraded with paused cluster controller reconciler"),
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
tt := newTest(t, withKubectl())
ctx := context.Background()

tt.kubectl.EXPECT().GetEksaCluster(ctx, managementCluster(mgmtName), mgmtName).Return(tc.gotCluster, nil)

err := validations.ValidatePauseAnnotation(ctx, tt.kubectl, managementCluster(mgmtName), mgmtName)
if err != nil {
tt.Expect(err.Error()).To(ContainSubstring(tc.wantErr.Error()))
} else {
tt.Expect(tc.wantErr).To(BeNil())
}
})
}
}
8 changes: 8 additions & 0 deletions pkg/validations/upgradevalidations/preflightvalidations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ func (u *UpgradeValidations) PreflightValidations(ctx context.Context) []validat
Name: u.Opts.WorkloadCluster.Name,
KubeconfigFile: u.Opts.ManagementCluster.KubeconfigFile,
}

upgradeValidations := []validations.Validation{
func() *validations.ValidationResult {
return resultForRemediableValidation(
Expand Down Expand Up @@ -123,6 +124,13 @@ func (u *UpgradeValidations) PreflightValidations(ctx context.Context) []validat
Silent: true,
}
},
func() *validations.ValidationResult {
return &validations.ValidationResult{
Name: "validate eksa controller is not paused",
Remediation: fmt.Sprintf("remove cluster controller reconciler pause annotation %s before upgrading the cluster %s", u.Opts.Spec.Cluster.PausedAnnotation(), targetCluster.Name),
Err: validations.ValidatePauseAnnotation(ctx, k, targetCluster, targetCluster.Name),
}
},
}

if u.Opts.Spec.Cluster.IsManaged() {
Expand Down
6 changes: 3 additions & 3 deletions pkg/validations/upgradevalidations/preflightvalidations_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ func TestPreflightValidationsTinkerbell(t *testing.T) {
k.EXPECT().ValidateNodes(ctx, kubeconfigFilePath).Return(tc.nodeResponse)
k.EXPECT().ValidateClustersCRD(ctx, workloadCluster).Return(tc.crdResponse)
k.EXPECT().GetClusters(ctx, workloadCluster).Return(tc.getClusterResponse, nil)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(4)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(5)
upgradeValidations := upgradevalidations.New(opts)
err := validations.ProcessValidationResults(upgradeValidations.PreflightValidations(ctx))
if err != nil && err.Error() != tc.wantErr.Error() {
Expand Down Expand Up @@ -1116,7 +1116,7 @@ func TestPreflightValidationsVsphere(t *testing.T) {
k.EXPECT().ValidateNodes(ctx, kubeconfigFilePath).Return(tc.nodeResponse)
k.EXPECT().ValidateClustersCRD(ctx, workloadCluster).Return(tc.crdResponse)
k.EXPECT().GetClusters(ctx, workloadCluster).Return(tc.getClusterResponse, nil)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(4)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(5)
if opts.Spec.Cluster.IsManaged() {
k.EXPECT().GetEksaCluster(ctx, workloadCluster, workloadCluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(4)
}
Expand Down Expand Up @@ -1354,7 +1354,7 @@ func TestPreFlightValidationsGit(t *testing.T) {
k.EXPECT().ValidateNodes(ctx, kubeconfigFilePath).Return(tc.nodeResponse)
k.EXPECT().ValidateClustersCRD(ctx, workloadCluster).Return(tc.crdResponse)
k.EXPECT().GetClusters(ctx, workloadCluster).Return(tc.getClusterResponse, nil)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(4)
k.EXPECT().GetEksaCluster(ctx, workloadCluster, clusterSpec.Cluster.Name).Return(existingClusterSpec.Cluster, nil).MaxTimes(5)
k.EXPECT().GetEksaFluxConfig(ctx, clusterSpec.Cluster.Spec.GitOpsRef.Name, gomock.Any(), gomock.Any()).Return(existingClusterSpec.FluxConfig, nil).MaxTimes(1)
k.EXPECT().GetEksaOIDCConfig(ctx, clusterSpec.Cluster.Spec.IdentityProviderRefs[0].Name, gomock.Any(), gomock.Any()).Return(existingClusterSpec.OIDCConfig, nil).MaxTimes(1)
k.EXPECT().GetEksaAWSIamConfig(ctx, clusterSpec.Cluster.Spec.IdentityProviderRefs[1].Name, gomock.Any(), gomock.Any()).Return(existingClusterSpec.AWSIamConfig, nil).MaxTimes(1)
Expand Down
Loading