Adding "./kubestr file-restore" command #287

shlokc9 · 2024-08-09T23:13:28Z

This PR adds a new command ./kubestr file-restore which would allow the users to browse through the contents of a VolumeSnapshot along with it's source PVC using Filebrowser UI and enable copying file(s) from snapshot to PVC. Users can also copy a file from snapshot to PVC without the Filebrowser UI by simply mentioning the path of the file with --path flag.

Unit-tested these code changes with new fake tests and mock objects.
Tested these code changes by executing the command on a GKE cluster. Please find the output below;

> ./kubestr file-restore --fromSnapshot test-snapshot --toPVC test-pvc1 -n file-level-restore
Fetching the snapshot.
Fetching the source PVC.
Creating the restored PVC & browser Pod.
Forwarding the port.
Port forwarding is ready to get traffic. visit https://localhost:8080/
^C
Stopping port forward.
Cleaning up browser pod & restored PVC.

> ./kubestr file-restore --fromSnapshot test-snapshot -n file-level-restore
Fetching the snapshot.
Fetching the source PVC from snapshot.
Creating the restored PVC & browser Pod.
Forwarding the port.
Port forwarding is ready to get traffic. visit https://localhost:8080/
^C
Stopping port forward.
Cleaning up browser pod & restored PVC.

> ./kubestr file-restore --fromSnapshot test-snapshot -n application --path /time.txt
Fetching the snapshot.
Creating the restored PVC & browser Pod.
Restoring the file /time.txt
File restored from VolumeSnapshot test-snapshot to Source PVC test-pvc1.
Cleaning up browser pod & restored PVC.

During cleanup, we clean the restore PVC created from the VolumeSnapshot along with the Filebrowser pod.

Closes #286

…t for backward compatibility.

… command.

…astenhq#272) Bumps the github-actions group with 1 update: [github/codeql-action](https://github.com/github/codeql-action). Updates `github/codeql-action` from 3.25.12 to 3.25.13 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@4fa2a79...2d79040) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…nhq#273) Bumps the docker group with 1 update: [docker/build-push-action](https://github.com/docker/build-push-action). Updates `docker/build-push-action` from 6.3.0 to 6.4.1 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](docker/build-push-action@1a16264...1ca370b) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…in the mount path

…reateInspectorApplicationForPVC

…onForSnapshot

…ecause we made those persistent

…rowse snapshot" commands (kastenhq#278) * Adding the kubestr browse pvc command. Handling kubestr browse support for backward compatibility. * Adding browse snapshot command. Updating browse command to browse pvc command. * chore(deps): bump github/codeql-action in the github-actions group (kastenhq#272) Bumps the github-actions group with 1 update: [github/codeql-action](https://github.com/github/codeql-action). Updates `github/codeql-action` from 3.25.12 to 3.25.13 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@4fa2a79...2d79040) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump docker/build-push-action in the docker group (kastenhq#273) Bumps the docker group with 1 update: [docker/build-push-action](https://github.com/docker/build-push-action). Updates `docker/build-push-action` from 6.3.0 to 6.4.1 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](docker/build-push-action@1a16264...1ca370b) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Adding --show-tree flag for browse snapshot & browse pvc commands * Removing unused snapshot function parameter in cleanup * Adding KubeExecutor Exec helper function to execute tree command * Adding --show-tree logic in pvc_inspector.go * Adding --show-tree logic in snapshot_inspector.go * Printing out the tree structure for --show-tree * Updating mock tests for new code changes * Updating mount path in container args for creating a browse pod * Updating the CSITestSuite.TestCreateInspectorApplication for changes in the mount path * Adding Deprecated msg to the 'browse' command * Adding mock tests for SnapshotBrowserStepper * Adding fake tests for snapshot_inspector.go * Renamed testcase CSITestSuite.TestCreateInspectorApplication to TestCreateInspectorApplicationForPVC * Adding snapshot_inspector_steps_test.go * Updating mock tests for new code changes * Updating the mount paths in CSITestSuite.TestCreateInspectorApplicationForSnapshot * Updating Deprecated msg for 'browse' command * Making namespace, runAsUser & localport flags persistent * Removing namespace, runAsUser & localport flags for browse snapshot because we made those persistent * Adding --show-tree flag for browse snapshot & browse pvc commands * Updating namespace flag usage for better understanding * Removing storage class flag * Adding --show-tree logic in snapshot_inspector.go * Updating mock objects for SnapshotBrowserStepper * Adding --show-tree flag for browse snapshot & browse pvc commands * Removing storage class flag * Adding --show-tree flag for browse snapshot & browse pvc commands * Adding --show-tree logic in snapshot_inspector.go * Passing showTree var as function argument * Making --show-tree a persistent flag * Removing ShowTree dummy condition * Removing duplicate browseSnapshotCmd * Adding --show-tree flag for browse snapshot & browse pvc commands * Making --show-tree a persistent flag * Adding --show-tree flag for browse snapshot & browse pvc commands * Making --show-tree a persistent flag --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…updates (kastenhq#282) Bumps the github-actions group with 2 updates in the / directory: [github/codeql-action](https://github.com/github/codeql-action) and [actions/upload-artifact](https://github.com/actions/upload-artifact). Updates `github/codeql-action` from 3.25.13 to 3.25.15 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@2d79040...afb54ba) Updates `actions/upload-artifact` from 4.3.4 to 4.3.5 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@0b2256b...89ef406) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…astenhq#283) Bumps the docker group with 4 updates in the / directory: [docker/setup-qemu-action](https://github.com/docker/setup-qemu-action), [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action), [docker/login-action](https://github.com/docker/login-action) and [docker/build-push-action](https://github.com/docker/build-push-action). Updates `docker/setup-qemu-action` from 3.1.0 to 3.2.0 - [Release notes](https://github.com/docker/setup-qemu-action/releases) - [Commits](docker/setup-qemu-action@5927c83...49b3bc8) Updates `docker/setup-buildx-action` from 3.4.0 to 3.6.1 - [Release notes](https://github.com/docker/setup-buildx-action/releases) - [Commits](docker/setup-buildx-action@4fd8129...988b5a0) Updates `docker/login-action` from 3.2.0 to 3.3.0 - [Release notes](https://github.com/docker/login-action/releases) - [Commits](docker/login-action@0d4c9c5...9780b0c) Updates `docker/build-push-action` from 6.4.1 to 6.5.0 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](docker/build-push-action@1ca370b...5176d81) --- updated-dependencies: - dependency-name: docker/setup-qemu-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker - dependency-name: docker/setup-buildx-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker - dependency-name: docker/login-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docker ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…#281) Bumps [ossf/scorecard-action](https://github.com/ossf/scorecard-action) from 2.3.3 to 2.4.0. - [Release notes](https://github.com/ossf/scorecard-action/releases) - [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md) - [Commits](ossf/scorecard-action@dc50aa9...62b2cac) --- updated-dependencies: - dependency-name: ossf/scorecard-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…astenhq#274) * fix function definition for Create and CreateFromSource * update go mod * update go mod * update fakesnapshotter * update create and createFromSource method * change snapshot and content meta struct type * sync kanister dependency * Renamed struct * Sync kanister dependency * Sync kanister dependency * Sync kanister dependency * Sync kanister dependency to merge master commit

…ad of string (kastenhq#285) * Updating the PVCName, MountPath, DevicePath signature in CreatePodArgs * Refactoring PVCName, MountPath, DevicePath variables into a single PVCMap with path definitions * Removing unused PVCName variable from CreatePodArgs * Updating DevicePath and MountPath error messages

…source PVC

…ssmodes check

cmd/rootCmd.go

bathina2

Adjust the CLI help a bit, otherwise looks good.

Co-authored-by: Sirish Bathina <[email protected]>

shlokc9 and others added 30 commits July 24, 2024 14:42

Adding the kubestr browse pvc command. Handling kubestr browse suppor…

36882b5

…t for backward compatibility.

Adding browse snapshot command. Updating browse command to browse pvc…

0927b25

… command.

Merge branch 'kastenhq:master' into browse-pvc-snapshot

32cecd0

Adding --show-tree flag for browse snapshot & browse pvc commands

a6ac177

Removing unused snapshot function parameter in cleanup

e2aa023

Adding KubeExecutor Exec helper function to execute tree command

1f10988

Adding --show-tree logic in pvc_inspector.go

34744f6

Adding --show-tree logic in snapshot_inspector.go

cbed58b

Printing out the tree structure for --show-tree

2f8e255

Updating mock tests for new code changes

9098f94

Updating mount path in container args for creating a browse pod

a0c97b9

Updating the CSITestSuite.TestCreateInspectorApplication for changes …

16e29c4

…in the mount path

Adding Deprecated msg to the 'browse' command

8b44243

Adding mock tests for SnapshotBrowserStepper

0bb5fd5

Adding fake tests for snapshot_inspector.go

778b71c

Renamed testcase CSITestSuite.TestCreateInspectorApplication to TestC…

b17344a

…reateInspectorApplicationForPVC

Adding snapshot_inspector_steps_test.go

f848045

Updating mock tests for new code changes

78d4981

Updating the mount paths in CSITestSuite.TestCreateInspectorApplicati…

74bd34d

…onForSnapshot

Updating Deprecated msg for 'browse' command

4e160b1

Making namespace, runAsUser & localport flags persistent

62af178

Removing namespace, runAsUser & localport flags for browse snapshot b…

dc4a65e

…ecause we made those persistent

Adding --show-tree flag for browse snapshot & browse pvc commands

2d419ec

Updating namespace flag usage for better understanding

0314b8e

Removing storage class flag

f63aebf

Adding --show-tree logic in snapshot_inspector.go

e0f5dcf

Updating mock objects for SnapshotBrowserStepper

d7b492c

Adding --show-tree flag for browse snapshot & browse pvc commands

938e625

shlokc9 and others added 13 commits August 2, 2024 17:01

Removing dummy ShowTree arg test

f1c2578

Removing placeholder test for browse snapshot and browse pvc

dbbb0f9

Removing unused snapshotFetchOps from snapshotBrowserSteps

d6d359b

Adding File restore command

f94e6e0

Adding mock objects and fake tests for file restore command

a0eb8e8

Renaming file_restore_inspector.go

d0dc63e

shlokc9 added enhancement New feature or request go Pull requests that update Go code labels Aug 9, 2024

shlokc9 requested review from bathina2 and kidgilson August 9, 2024 23:13

shlokc9 self-assigned this Aug 9, 2024

shlokc9 and others added 7 commits August 9, 2024 18:16

Merge branch 'master' into file-restore

c206c79

Removing unused SnapshotFetcher interface

21aada5

Adding check for source PVC in Snapshot and supported accessModes in …

d498389

…source PVC

Adding --toPVC flag

6ba5cd7

Fixing seg fault occurred because of the invalid error thrown in acce…

a025986

…ssmodes check

Removing check for ReadWriteOnce accessmode

487ad81

Merge branch 'master' into file-restore

b3dcb80

bathina2 reviewed Aug 19, 2024

View reviewed changes

cmd/rootCmd.go Outdated Show resolved Hide resolved

bathina2 approved these changes Aug 19, 2024

View reviewed changes

Update cmd/rootCmd.go

dab6718

Co-authored-by: Sirish Bathina <[email protected]>

shlokc9 merged commit 0d37899 into kastenhq:master Aug 20, 2024
4 checks passed

shlokc9 deleted the file-restore branch August 20, 2024 20:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding "./kubestr file-restore" command #287

Adding "./kubestr file-restore" command #287

shlokc9 commented Aug 9, 2024 •

edited

Loading

bathina2 left a comment

Adding "./kubestr file-restore" command #287

Adding "./kubestr file-restore" command #287

Conversation

shlokc9 commented Aug 9, 2024 • edited Loading

bathina2 left a comment

Choose a reason for hiding this comment

shlokc9 commented Aug 9, 2024 •

edited

Loading