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.

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

chore(docs): update README and quick.md files #154

Merged
merged 2 commits into from
Aug 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 10 additions & 3 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(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
prateekpandey14 marked this conversation as resolved.
Show resolved Hide resolved
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 All @@ -79,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
Expand Down
16 changes: 11 additions & 5 deletions docs/quick.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Quickstart

### Prerequisites
Prerequisites
--------------

Before setting up cStor operators make sure your Kubernetes Cluster
meets the following prerequisites:
Expand All @@ -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 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
Expand Down Expand Up @@ -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
14 changes: 7 additions & 7 deletions docs/tutorial/cspc/tuning/tune.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ metadata:
spec:
resources:
requests:
memory: "64Mi"
memory: "2Gi"
cpu: "250m"
limits:
memory: "128Mi"
memory: "4Gi"
cpu: "500m"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure do we need to specify the show CPU limits?


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
Expand Down Expand Up @@ -307,4 +307,4 @@ spec:
dataRaidGroupType: mirror

roThresholdLimit : 70
```
```
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.