From 37cc61fd382113409b66fc6d9945510b02098949 Mon Sep 17 00:00:00 2001 From: prateekpandey14 Date: Tue, 11 Aug 2020 21:04:30 +0530 Subject: [PATCH 1/2] chore(docs): update README and quick.md files Signed-off-by: prateekpandey14 --- README.md | 11 +++++++++-- docs/quick.md | 16 +++++++++++----- docs/tutorial/cspc/tuning/tune.md | 14 +++++++------- docs/tutorial/intro.md | 5 +++-- 4 files changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4c369e20..ea747c83 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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]. diff --git a/docs/quick.md b/docs/quick.md index 66abf84c..13374727 100644 --- a/docs/quick.md +++ b/docs/quick.md @@ -1,6 +1,7 @@ # Quickstart -### Prerequisites +Prerequisites +-------------- Before setting up cStor operators make sure your Kubernetes Cluster meets the following prerequisites: @@ -19,7 +20,15 @@ meets the following prerequisites: 3. You have access to install RBAC components into kube-system namespace. 4. You have disks attached to nodes to provision storage. -### Insallation +Installation: +------------- + +Note: +------ + +It's always a better idea to install latest tag [release](https://github.com/openebs/cstor-operators/releases) yamls, unless we build the images locally. The latest release specific yamls of cstor-operators, +csi-operators and ndm-operators, can be fetched and apply directly from [release pages](https://github.com/openebs/charts/tree/gh-pages). +Since below mentioned resources are already created as part of release yamls, we can skip 1-7 steps and continue from step 8 onwards. 1. Clone the repository. ```bash @@ -301,6 +310,3 @@ meets the following prerequisites: $ kubectl exec -it busybox -- cat /mnt/openebs-csi/date.txt Wed Jul 12 07:00:26 UTC 2020 ``` - -[1]: /deploy/csi-operator.yaml -[2]: /deploy/csi-operator-ubuntu-18.04.yaml diff --git a/docs/tutorial/cspc/tuning/tune.md b/docs/tutorial/cspc/tuning/tune.md index 8498b716..1f2a2e2f 100644 --- a/docs/tutorial/cspc/tuning/tune.md +++ b/docs/tutorial/cspc/tuning/tune.md @@ -26,19 +26,19 @@ metadata: spec: resources: requests: - memory: "64Mi" + memory: "2Gi" cpu: "250m" limits: - memory: "128Mi" + memory: "4Gi" cpu: "500m" auxResources: requests: - memory: "50Mi" - cpu: "400m" + memory: "500Mi" + cpu: "100m" limits: - memory: "100Mi" - cpu: "400m" + memory: "1Gi" + cpu: "200m" pools: - nodeSelector: kubernetes.io/hostname: worker-node-1 @@ -307,4 +307,4 @@ spec: dataRaidGroupType: mirror roThresholdLimit : 70 -``` \ No newline at end of file +``` diff --git a/docs/tutorial/intro.md b/docs/tutorial/intro.md index a5bdce6c..3c7c8d1c 100644 --- a/docs/tutorial/intro.md +++ b/docs/tutorial/intro.md @@ -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. From e3007a35c62fae7ea96f4cc971103d0cc513bc8c Mon Sep 17 00:00:00 2001 From: prateekpandey14 Date: Thu, 13 Aug 2020 10:11:23 +0530 Subject: [PATCH 2/2] re-phrase the sentences based on suggestions Signed-off-by: prateekpandey14 --- README.md | 4 ++-- docs/quick.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ea747c83..94dd9bbc 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ 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 +Once the CStor pool(s) get provisioned successfully after creating CSPC, 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). @@ -86,7 +86,7 @@ Please read the contributing guidelines [here](./CONTRIBUTING.md). ## Code of conduct -Pleae read the community code of conduct [here](./CODE_OF_CONDUCT.md). +Please read the community code of conduct [here](./CODE_OF_CONDUCT.md). [Docker environment]: https://docs.docker.com/engine [Go environment]: https://golang.org/doc/install diff --git a/docs/quick.md b/docs/quick.md index 13374727..8779f136 100644 --- a/docs/quick.md +++ b/docs/quick.md @@ -27,8 +27,8 @@ Note: ------ It's always a better idea to install latest tag [release](https://github.com/openebs/cstor-operators/releases) yamls, unless we build the images locally. The latest release specific yamls of cstor-operators, -csi-operators and ndm-operators, can be fetched and apply directly from [release pages](https://github.com/openebs/charts/tree/gh-pages). -Since below mentioned resources are already created as part of release yamls, we can skip 1-7 steps and continue from step 8 onwards. +csi-operators and ndm-operators, can be fetched and applied directly from [release pages](https://github.com/openebs/charts/tree/gh-pages). +Since the below mentioned resources are already created as part of release yamls, we can skip 1-7 steps and continue from step 8 onwards. 1. Clone the repository. ```bash