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

Jump to bottom

Make SetVolumeID function support cross-project scenario. #150

Merged
merged 1 commit into from
Jul 27, 2023
Merged

Make SetVolumeID function support cross-project scenario. #150

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
2 changes: 1 addition & 1 deletion examples/backup_at_b_restore_at_a.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These steps are heavily inspired by the [gcp documentation](https://cloud.google
Assume the following...

- Project A [project-a]: GCP project we want to restore TO
- Project B [project-b]: GCP Project we want to restore FROM
- Project B [project-b]: GCP Project we want to backup FROM

The steps below assume that you have not setup Velero yet. So make sure to skip any steps you've already completed.

Expand Down
2 changes: 1 addition & 1 deletion examples/velero_at_a_br_at_other.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Assume the following...

- Project A [project-a]: The project where the Velero's service account is located, and the Velero service account is granted to have enough permission to do backup and restore in the other projects.
- Project B [project-b]: The GCP project we want to restore TO.
- Project C [project-c]: The GCP project we want to restore FROM.
- Project C [project-c]: The GCP project we want to backup FROM.

## Set up Velero with permission in projects
* In **project-a**
Expand Down
19 changes: 19 additions & 0 deletions velero-plugin-for-gcp/volume_snapshotter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,10 @@ func (b *VolumeSnapshotter) SetVolumeID(unstructuredPV runtime.Unstructured, vol
return nil, fmt.Errorf("invalid volumeHandle for restore with CSI driver:%s, expected projects/{project}/zones/{zone}/disks/{name}, got %s",
driver, handle)
}
if b.IsVolumeCreatedCrossProjects(handle) == true {
projectRE := regexp.MustCompile(`projects\/[^\/]+\/`)
handle = projectRE.ReplaceAllString(handle, "projects/"+b.volumeProject+"/")
}
pv.Spec.CSI.VolumeHandle = handle[:strings.LastIndex(handle, "/")+1] + volumeID
} else {
return nil, fmt.Errorf("unable to handle CSI driver: %s", driver)
Expand All @@ -457,3 +461,18 @@ func (b *VolumeSnapshotter) SetVolumeID(unstructuredPV runtime.Unstructured, vol

return &unstructured.Unstructured{Object: res}, nil
}

func (b *VolumeSnapshotter) IsVolumeCreatedCrossProjects(volumeHandle string) bool {
// Get project ID from volume handle
parsedStr := strings.Split(volumeHandle, "/")
if len(parsedStr) < 2 {
return false
}
projectID := parsedStr[1]

if projectID != b.volumeProject {
return true
}

return false
}
114 changes: 88 additions & 26 deletions velero-plugin-for-gcp/volume_snapshotter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package main
import (
"encoding/json"
"os"
"strings"
"testing"

"github.com/pkg/errors"
Expand Down Expand Up @@ -179,15 +178,13 @@ func TestSetVolumeID(t *testing.T) {
}

func TestSetVolumeIDForCSI(t *testing.T) {
b := &VolumeSnapshotter{
log: logrus.New(),
}

cases := []struct {
name string
csiJSON string
volumeID string
wantErr bool
name string
csiJSON string
volumeID string
wantErr bool
volumeProject string
wantedVolumeID string
}{
{
name: "set ID to CSI with GKE pd CSI driver",
Expand All @@ -196,8 +193,10 @@ func TestSetVolumeIDForCSI(t *testing.T) {
"fsType": "ext4",
"volumeHandle": "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: false,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: false,
volumeProject: "velero-gcp",
wantedVolumeID: "projects/velero-gcp/zones/us-central1-f/disks/restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
},
{
name: "set ID to CSI with GKE pd CSI driver, but the volumeHandle is invalid",
Expand All @@ -206,8 +205,9 @@ func TestSetVolumeIDForCSI(t *testing.T) {
"fsType": "ext4",
"volumeHandle": "pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeProject: "velero-gcp",
},
{
name: "set ID to CSI with Constellation pd CSI driver",
Expand All @@ -216,8 +216,10 @@ func TestSetVolumeIDForCSI(t *testing.T) {
"fsType": "ext4",
"volumeHandle": "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: false,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: false,
volumeProject: "velero-gcp",
wantedVolumeID: "projects/velero-gcp/zones/us-central1-f/disks/restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
},
{
name: "set ID to CSI with Constellation pd CSI driver, but the volumeHandle is invalid",
Expand All @@ -226,22 +228,41 @@ func TestSetVolumeIDForCSI(t *testing.T) {
"fsType": "ext4",
"volumeHandle": "pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeProject: "velero-gcp",
},
{
name: "set ID to CSI with unknown driver",
csiJSON: `"{
csiJSON: `{
"driver": "xxx.csi.storage.gke.io",
"fsType": "ext4",
"volumeHandle": "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: true,
volumeProject: "velero-gcp",
},
{
name: "volume project is different from original handle project",
csiJSON: `{
"driver": "pd.csi.storage.gke.io",
"fsType": "ext4",
"volumeHandle": "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d"
}`,
volumeID: "restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
wantErr: false,
volumeProject: "velero-gcp-2",
wantedVolumeID: "projects/velero-gcp-2/zones/us-central1-f/disks/restore-fd9729b5-868b-4544-9568-1c5d9121dabc",
},
}
for _, tt := range cases {
t.Run(tt.name, func(t *testing.T) {
b := &VolumeSnapshotter{
log: logrus.New(),
volumeProject: tt.volumeProject,
}

res := &unstructured.Unstructured{
Object: map[string]interface{}{},
}
Expand All @@ -250,17 +271,16 @@ func TestSetVolumeIDForCSI(t *testing.T) {
res.Object["spec"] = map[string]interface{}{
"csi": csi,
}
originalVolHanle, _ := csi["volumeHandle"].(string)
newRes, err := b.SetVolumeID(res, tt.volumeID)
if tt.wantErr {
assert.Error(t, err)
require.Error(t, err)
} else {
assert.NoError(t, err)
require.NoError(t, err)
newPV := new(v1.PersistentVolume)
require.NoError(t, runtime.DefaultUnstructuredConverter.FromUnstructured(newRes.UnstructuredContent(), newPV))
ind := strings.LastIndex(newPV.Spec.CSI.VolumeHandle, "/")
assert.Equal(t, tt.volumeID, newPV.Spec.CSI.VolumeHandle[ind+1:])
assert.Equal(t, originalVolHanle[:ind], newPV.Spec.CSI.VolumeHandle[:ind])
if tt.wantedVolumeID != "" {
require.Equal(t, tt.wantedVolumeID, newPV.Spec.CSI.VolumeHandle)
}
}
})
}
Expand Down Expand Up @@ -464,3 +484,45 @@ func TestInit(t *testing.T) {
err = os.Remove(default_credential_file_name)
require.NoError(t, err)
}

func TestIsVolumeCreatedCrossProjects(t *testing.T) {
tests := []struct {
name string
volumeSnapshotter VolumeSnapshotter
volumeHandle string
expectedResult bool
}{
{
name: "Invalid Volume handle",
volumeSnapshotter: VolumeSnapshotter{
log: logrus.New(),
},
volumeHandle: "InvalidHandle",
expectedResult: false,
},
{
name: "Volume is created cross-project",
volumeSnapshotter: VolumeSnapshotter{
log: logrus.New(),
volumeProject: "velero-gcp-2",
},
volumeHandle: "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d",
expectedResult: true,
},
{
name: "Volume is not created cross-project",
volumeSnapshotter: VolumeSnapshotter{
log: logrus.New(),
volumeProject: "velero-gcp",
},
volumeHandle: "projects/velero-gcp/zones/us-central1-f/disks/pvc-a970184f-6cc1-4769-85ad-61dcaf8bf51d",
expectedResult: false,
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
require.Equal(t, test.expectedResult, test.volumeSnapshotter.IsVolumeCreatedCrossProjects(test.volumeHandle))
})
}
}
Loading