Skip to content

Commit

Permalink
Updating website
Browse files Browse the repository at this point in the history
  • Loading branch information
shlokc9 committed Aug 21, 2024
1 parent 7cf4252 commit f14b1bd
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,19 @@ Kubestr can assist in the following ways-
- Run `./kubestr csicheck -s <storage class> -v <volume snapshot class>`

### To view the contents of a PersistentVolumeClaim in a graphical filesystem browser -
- Run `./kubestr browse <pvc name> -n <namespace> -v <volume snapshot class>`
- Run `./kubestr browse pvc <pvc name> -n <namespace> -v <volume snapshot class>`
- Additional flag `--show-tree` can be specified to view contents on CLI.

### To view the contents of a VolumeSnapshot in a graphical filesystem browser -
- Run `./kubestr browse snapshot <snapshot name> -n <namespace> -s <storage class>`
- Additional flag `--show-tree` can be specified to view contents on CLI.

### To restore files from a VolumeSnapshot to a PersistentVolumeClaim using graphical filesystem browser -
- Run `./kubestr file-restore --fromSnapshot <snapshot name> --toPVC <pvc name> -n <namespace>`
### To restore files from a VolumeSnapshot using graphical filesystem browser -
- Run `./kubestr file-restore --fromSnapshot <snapshot name> -n <namespace>`
- Additional option `--path` can be specified to restore a file from given path using CLI.
<br> This restores to a PersistentVolumeClaim specified by the VolumeSnapshot.
- Optionally, run `./kubestr file-restore --fromSnapshot <snapshot name> -n <namespace> [--toPVC <pvc name>]`
<br> to restore to a specified PersistentVolumeClaim.
- Additionally, an option `--path` can be specified to restore a file from given path using CLI.

## Roadmap
- For future work please refer to our GitHub issues [page](https://github.com/kastenhq/kubestr/issues).
Expand Down

0 comments on commit f14b1bd

Please sign in to comment.