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

update-readme for 1.3 #51

Merged
merged 2 commits into from
Sep 6, 2023
Merged

update-readme for 1.3 #51

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2accaae
update-readme for 1.3
JacobGros Sep 6, 2023
9825718
feedback
JacobGros Sep 6, 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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For documentation, please visit [Container Storage Modules documentation](https:
* [Troubleshooting](#troubleshooting)

## Supported CSI Drivers
Currently, CSM Volume Group Snapshotter provides support to create and delete volume group snapshots for PowerFlex array.
Currently, CSM Volume Group Snapshotter provides support to create and delete volume group snapshots on Dell PowerFlex and Dell PowerStore storage platforms.
Additional array support in CSM Volume Group Snapshotter is planned for the near future.

## Build
Expand All @@ -54,8 +54,9 @@ This project relies on the following tools which have to be installed in order t
To install the external-snapshotter, please see the [GitHub repository](https://github.com/kubernetes-csi/external-snapshotter/tree/v4.1.1). If you have already installed the correct version of the external-snapshotter with the CSI driver, you don't need to do it again.

### Binaries
To build an image for docker, run `make docker-build`
To build an image for podman, run `make podman-build`
To build an image, run `make docker`
Image will be built with Podman if it is avaialble; otherwise, Docker will be used.
> Note: Buildah is needed to build the image

## Installation
To install and use the Volume Group Snapshotter, you need to install pre-requisites in your cluster, then install the CRD in your cluster and deploy it with the driver.
Expand Down Expand Up @@ -101,7 +102,7 @@ vgsnapshotter:
```
To deploy CSM Volume Group Snapshotter with the driver, the following changes are required:
1. Enable CSM Volume Group Snapshotter by changing the vgsnapshotter.enabled boolean to true.
2. In the vgsnapshotter.image field, put the location of the image you created following the steps in the build section, or link to one already built (such as the one on DockerHub, `dellemc/csi-volumegroup-snapshotter:v1.0.0`).
2. In the vgsnapshotter.image field, put the location of the image you created following the steps in the build section, or link to one already built (such as the one on DockerHub, `dellemc/csi-volumegroup-snapshotter:v1.3.0`).
3. Install/upgrade the driver normally. You should now have VGS successfully deployed with the driver!

## Volume Group Snapshot CRD Create
Expand Down