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

validate if cluster FSID is empty #185

Merged
merged 2 commits into from
Nov 29, 2023
Merged

validate if cluster FSID is empty #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
035ad5c
validate if cluster FSID is empty
umangachapagain Nov 29, 2023
5d1c029
update ManifestWork for VRC when FSID is changed
umangachapagain Nov 29, 2023
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
11 changes: 4 additions & 7 deletions addons/token-exchange/agent_mirrorpeer_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import (
"crypto/sha1"
"encoding/hex"
"fmt"
"sort"
"strconv"
"time"

Expand Down Expand Up @@ -597,14 +596,12 @@ func (r *MirrorPeerReconciler) labelCephClusters(ctx context.Context, scr *multi
if found.Labels == nil {
found.Labels = make(map[string]string)
}
var fsids []string

for _, v := range clusterFSIDs {
fsids = append(fsids, v)
replicationId, err := utils.CreateUniqueReplicationId(clusterFSIDs)
if err != nil {
return err
}
// To ensure reliability of hash generation
sort.Strings(fsids)
replicationId := utils.CreateUniqueReplicationId(fsids)

if found.Labels[utils.CephClusterReplicationIdLabel] != replicationId {
klog.Infof("adding label %s/%s to cephcluster %s", utils.CephClusterReplicationIdLabel, replicationId, found.Name)
found.Labels[utils.CephClusterReplicationIdLabel] = replicationId
Expand Down
23 changes: 9 additions & 14 deletions controllers/drpolicy_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"context"
"encoding/json"
"fmt"
"sort"
"time"

"github.com/red-hat-storage/odf-multicluster-orchestrator/addons/setup"
Expand Down Expand Up @@ -166,16 +165,11 @@ func (r *DRPolicyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c

func (r *DRPolicyReconciler) createOrUpdateManifestWorkForVRC(ctx context.Context, mp *multiclusterv1alpha1.MirrorPeer, dp *ramenv1alpha1.DRPolicy, clusterFSIDs map[string]string) error {

var fsids []string
for _, v := range clusterFSIDs {
fsids = append(fsids, v)
replicationId, err := utils.CreateUniqueReplicationId(clusterFSIDs)
if err != nil {
return err
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returning an error will keep it in continous reconcilation and will keep printing the logs.
Do we want to log the info and reconcile at a later interval ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error loop is fine I guess, since we do not expect it to be for long. Also, better to error out that a manual restart.

}

// To ensure reliability of hash generation
sort.Strings(fsids)

replicationId := utils.CreateUniqueReplicationId(fsids)

for _, pr := range mp.Spec.Items {
manifestWorkName := fmt.Sprintf("vrc-%v", utils.FnvHash(dp.Name)) // Two ManifestWork per DRPolicy
found := &workv1.ManifestWork{
Expand Down Expand Up @@ -239,13 +233,14 @@ func (r *DRPolicyReconciler) createOrUpdateManifestWorkForVRC(ctx context.Contex
},
},
},
Spec: workv1.ManifestWorkSpec{
Workload: workv1.ManifestsTemplate{Manifests: []workv1.Manifest{
manifest,
}},
},
}
_, err = controllerutil.CreateOrUpdate(ctx, r.HubClient, &mw, func() error {
mw.Spec = workv1.ManifestWorkSpec{
Workload: workv1.ManifestsTemplate{
Manifests: []workv1.Manifest{
manifest,
}},
}
return nil
})

Expand Down
32 changes: 30 additions & 2 deletions controllers/drpolicy_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ package controllers
import (
"context"
"fmt"
"testing"

ramenv1alpha1 "github.com/ramendr/ramen/api/v1alpha1"
multiclusterv1alpha1 "github.com/red-hat-storage/odf-multicluster-orchestrator/api/v1alpha1"
"github.com/red-hat-storage/odf-multicluster-orchestrator/controllers/utils"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
clusterv1 "open-cluster-management.io/api/cluster/v1"
workv1 "open-cluster-management.io/api/work/v1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"testing"
)

const (
Expand Down Expand Up @@ -101,7 +103,33 @@ func getFakeDRPolicyReconciler(drpolicy *ramenv1alpha1.DRPolicy, mp *multicluste
Name: cName2,
},
}
fakeClient := fake.NewClientBuilder().WithScheme(scheme).WithObjects(drpolicy, mp, ns1, ns2).Build()
mc1 := &clusterv1.ManagedCluster{
ObjectMeta: metav1.ObjectMeta{
Name: cName1,
},
Status: clusterv1.ManagedClusterStatus{
ClusterClaims: []clusterv1.ManagedClusterClaim{
{
Name: "cephfsid.odf.openshift.io",
Value: "db47dafb-1459-44ca-8a7a-b55ba2ec2d7c",
},
},
},
}
mc2 := &clusterv1.ManagedCluster{
ObjectMeta: metav1.ObjectMeta{
Name: cName2,
},
Status: clusterv1.ManagedClusterStatus{
ClusterClaims: []clusterv1.ManagedClusterClaim{
{
Name: "cephfsid.odf.openshift.io",
Value: "5b544f43-3ff9-4296-bc9f-051e60dcecdf",
},
},
},
}
fakeClient := fake.NewClientBuilder().WithScheme(scheme).WithObjects(drpolicy, mp, ns1, ns2, mc1, mc2).Build()

r := DRPolicyReconciler{
HubClient: fakeClient,
Expand Down
18 changes: 16 additions & 2 deletions controllers/utils/hash.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"crypto/sha512"
"fmt"
"hash/fnv"
"sort"
"strings"
)

Expand Down Expand Up @@ -34,6 +35,19 @@ func CreateUniqueSecretName(managedCluster, storageClusterNamespace, storageClus
return CreateUniqueName(managedCluster, storageClusterNamespace, storageClusterName)[0:39]
}

func CreateUniqueReplicationId(fsids []string) string {
return CreateUniqueName(fsids...)[0:39]
func CreateUniqueReplicationId(clusterFSIDs map[string]string) (string, error) {
var fsids []string
for _, v := range clusterFSIDs {
if v != "" {
fsids = append(fsids, v)
}
}

if len(fsids) < 2 {
return "", fmt.Errorf("replicationID can not be generated due to missing cluster FSID")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add which cluster ID we are actually missing. It should be present as the key in clusterFSIDs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There could be multiple and I didn't want to do a bunch of string manipulation. Since this is a very corner case, can we keep that as a follow up item?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

String manipulation may not be required if you add it in the above loop. We can check if something is empty and just log that this spoke cluster's fsid is nil.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or it can done in the place where we are fetching the clusterFSIDs. It should be easier and will make more sense to log that

}

// To ensure reliability of hash generation
sort.Strings(fsids)
return CreateUniqueName(fsids...)[0:39], nil
}
69 changes: 68 additions & 1 deletion controllers/utils/hash_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package utils

import "testing"
import (
"testing"
)

func TestFnvHashTest(t *testing.T) {
testCases := []struct {
Expand All @@ -19,3 +21,68 @@ func TestFnvHashTest(t *testing.T) {
}
}
}

func TestCreateUniqueReplicationId(t *testing.T) {
type args struct {
fsids map[string]string
}
tests := []struct {
name string
args args
want string
wantErr bool
}{
{
name: "Case 1: Both FSID available",
args: args{
fsids: map[string]string{
"c1": "7e252ee3-abd9-4c54-a4ff-a2fdce8931a0",
"c2": "aacfbd7e-5ced-42a5-bdc2-483fcbe5a29d",
},
},
want: "a99df9fc6c52c7ef44222ab38657a0b15628a14",
wantErr: false,
},
{
name: "Case 2: FSID for C1 is available",
args: args{
fsids: map[string]string{
"c1": "7e252ee3-abd9-4c54-a4ff-a2fdce8931a0",
"c2": "",
},
},
want: "",
wantErr: true,
},
{
name: "Case 3: FSID for C2 is available",
args: args{
fsids: map[string]string{
"c1": "",
"c2": "aacfbd7e-5ced-42a5-bdc2-483fcbe5a29d",
},
},
want: "",
wantErr: true,
},
{
name: "Case 4: Both FSID unavailable",
args: args{
fsids: map[string]string{
"c1": "",
"c2": "",
},
},
want: "",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := CreateUniqueReplicationId(tt.args.fsids)
if ((err != nil) != tt.wantErr) || got != tt.want {
t.Errorf("CreateUniqueReplicationId() = %v, want %v", got, tt.want)
}
})
}
}