Skip to content

Commit

Permalink
chore(docs): update README with volume specific info
Browse files Browse the repository at this point in the history
Signed-off-by: prateekpandey14 <[email protected]>
  • Loading branch information
prateekpandey14 committed Aug 11, 2020
1 parent 5ad1994 commit c99f25b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ We are actively working on the following additional tasks for the beta release:
Table of contents:
==================
- [Quickly deploy it on K8s and get started](docs/quick.md)
- [Pool Operations Tutorial](docs/tutorial/intro.md)
- [Pool and Volume Operations Tutorial](docs/tutorial/intro.md)
- [High level overview](#overview)
- [CStor Resource Organisation](docs/developer-guide/cstor-pool.md)
- [CStorPool Resource Organisation](docs/developer-guide/cstor-pool.md)
- [CStorVolume Resource Organisation](docs/developer-guide/cstor-volume.md)
- [Issues and PRs](#issues-and-prs)
- [FAQ and Troubleshooting](docs/troubleshooting/troubleshooting.md)
- [Contributing](#contributing)
Expand Down Expand Up @@ -63,6 +64,12 @@ perform pool operations e.g pool provisioning.
**Note:** It is not recommended to modify the CSPI CR and pool-manager in the running cluster unless you know what you are
trying to do. CSPC should be the only point of interaction.

Once the CStor pool get provisioned successfully, admin/user can create PVC to provision csi CStor volumes, when a user
creates PVC, CStor CSI driver creates CStorVolumeConfig(CVC) resource, managed and reconcile by the **cvc-controller** which creates
different volume specific resources for each persistent volume, later managed by their respective controllers, more info
can be found [here](docs/developer-guide/cstor-volume.md).


## Issues And PRs
We consider issues also as a part of contribution to the project.
If you want to raise any issue for cstor-operators please do that at [openebs/openebs].
Expand Down
5 changes: 3 additions & 2 deletions docs/tutorial/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ On a high level, this tutorial covers following:
1. This [link](./volumes/volume.md) explains the volume related operations.
2. This [link](./volumes/snapshot.md) explains the volume snapshot related operations.
3. This [link](./volumes/resize.md) explains the volume resize related operations.
4. This [link](./volumes/migration.md) explains the volume migration related operations across k8s nodes.
5. This [link](./volumes/block_volume.md) explains how to use cstor raw block volume.
4. This [link](./volumes/policy.md) explains the volume policy related operations.
5. This [link](./volumes/migration.md) explains the volume migration related operations across k8s nodes.
6. This [link](./volumes/block_volume.md) explains how to use cstor raw block volume.

0 comments on commit c99f25b

Please sign in to comment.