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 docs for setup & quickstart #130

Merged
merged 1 commit into from
Jul 16, 2020
Merged

Update docs for setup & quickstart #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 8 additions & 10 deletions docs/developer-guide/devel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,17 @@

### Clone fork to local host

Place openebs/cstor-operators' code on your `GOPATH` using the following cloning procedure.
Place openebs/cstor-operators' code on your local machine using the following cloning procedure.
Create your clone:

```sh

mkdir -p $GOPATH/src/github.com/openebs
cd $GOPATH/src/github.com/openebs
Move to the directory where you want to place the clone.

```sh
# Note: Here $user is your GitHub profile name
git clone https://github.com/$user/cstor-operators.git

# Configure remote upstream
cd $GOPATH/src/github.com/openebs/cstor-operators
cd cstor-operators
git remote add upstream https://github.com/openebs/cstor-operators.git

# Never push to upstream master
Expand All @@ -43,7 +41,7 @@ git remote -v
Open a terminal on your local host. Change directory to the cstor-operators-fork root.

```sh
$ cd $GOPATH/src/github.com/openebs/cstor-operators
$ cd cstor-operators
```

Checkout the master branch.
Expand Down Expand Up @@ -133,16 +131,16 @@ $ cd $GOPATH/src/github.com/openebs/cstor-operators
### Test your changes
After you are done with your changes, run the unit tests.
```sh
cd $GOPATH/src/github.com/openebs/cstor-operators
cd cstor-operators

# Run every unit test
make test
```

### Build the images
You can build amd64 images by following command.
You can build amd64 images by following command.
```sh
cd $GOPATH/src/github.com/openebs/cstor-operators
cd cstor-operators
make all.amd64
```

Expand Down
6 changes: 3 additions & 3 deletions docs/developer-guide/start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ OpenEBS uses the standard GitHub pull requests process to review and accept cont
* If you are a first-time contributor, please see [Steps to Contribute](#steps-to-contribute).
* If you have documentation improvement ideas, go ahead and create a pull request. See [Pull Request checklist](#pull-request-checklist).
* If you would like to make code contributions, please start with [Setting up the Development Environment](#setting-up-your-development-environment).
* If you would like to work on something more involved, please connect with the OpenEBS Contributors. ( See [communicate](#communicate) )
* If you would like to work on something more involved, please connect with the OpenEBS Contributors. ( See [communicate](#communicate) )

## Steps to Contribute

Expand Down Expand Up @@ -67,8 +67,8 @@ For setting up a Development environment on your local host, see the detailed in
## Communicate

Reach out to OpenEBS [slack] to communicate with contributors.
Also feel free to reach out to @sonasingh46 @mittachaitu @prateekpandey14
Also feel free to reach out to @sonasingh46 @mittachaitu @prateekpandey14
who are the owners for cstor-operators repository.


[slack]: https://openebs-community.slack.com
[slack]: (https://kubernetes.slack.com/messages/openebs/)
37 changes: 25 additions & 12 deletions docs/quick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ meets the following prerequisites:
```bash
$ git clone https://github.com/openebs/cstor-operators.git
```

2. Make sure you are at the root directory of the cloned repository.
```bash
$ cd cstor-operators
Expand Down Expand Up @@ -50,7 +50,7 @@ meets the following prerequisites:
blockdevice-3ec130dc1aa932eb4c5af1db4d73ea1b worker2 21474836480 Unclaimed Active 2m12s
```

NOTE:
NOTE:
1. It can take little while for blockdevices to appear when the application is warming up.
2. For a blockdevice to appear, you must have disks attached to node.

Expand All @@ -77,7 +77,18 @@ meets the following prerequisites:
openebs-ndm-xztkj 1/1 Running 0 6m5s
```

7. Install CStor CSI driver.
7. Install CStor CSI driver. Apply the file that corresponds to your OS.

| Operating System | csi-operator.yaml |
|--------------------------------|--------------------------------------------|
| Ubuntu 16.04, CentOS 7 & 8 | [deploy/csi-operator.yaml](1) |
| Ubuntu 18.04+ | [deploy/csi-operator-ubuntu-18.04.yaml](2) |

**Known Limitations**
* The CSI-Operators are currently unavailable for CoreOS

*Note*: These operators **may** work for other operating systems, we look forward to your feedback & contribution
in testing and doccumenting the same.

```bash
$ kubectl create -f deploy/csi-operator.yaml
Expand All @@ -91,17 +102,16 @@ meets the following prerequisites:
openebs-cstor-csi-node-86mx9 2/2 Running 0 5m22s
```


8. Provision a cStor pool. For simplicity, this guide will provision a
8. Provision a cStor pool. For simplicity, this guide will provision a
stripe pool on one node.
Use the CSPC file from examples/cspc/cspc-single.yaml and modify by performing
Use the CSPC file from [examples/cspc/cspc-single.yaml](/examples/cspc/cspc-single.yaml) and modify by performing
follwing steps:

i) Modify CSPC to add your node selector for the node where you want to provision the pool.
List the nodes with labels:

```bash
kubectl get node --show labels
kubectl get node --show-labels

```
```bash
Expand All @@ -118,7 +128,7 @@ meets the following prerequisites:
In this guide, worker1 is picked. Modify the CSPC yaml to use this worker.
(Note: Use the value from labels kubernetes.io/hostname=worker1 as this label value and node name could be different in some platforms)

```bash
```yml
kubernetes.io/hostname: "worker1"
```

Expand All @@ -132,7 +142,7 @@ meets the following prerequisites:
blockdevice-10ad9f484c299597ed1e126d7b857967 worker1 21474836480 Unclaimed Active 2m17s
blockdevice-3ec130dc1aa932eb4c5af1db4d73ea1b worker2 21474836480 Unclaimed Active 2m12s
```
```bash
```yml
- blockDeviceName: "blockdevice-10ad9f484c299597ed1e126d7b857967"
```
Finally the CSPC YAML looks like the following :
Expand All @@ -148,7 +158,7 @@ meets the following prerequisites:
kubernetes.io/hostname: "worker1"
dataRaidGroups:
- blockDevices:
- blockDeviceName: "blockdevice-10ad9f484c299597ed1e126d7b857967"
- blockDeviceName: "blockdevice-10ad9f484c299597ed1e126d7b857967"
poolConfig:
dataRaidGroupType: "stripe"
```
Expand All @@ -158,11 +168,11 @@ meets the following prerequisites:
kubectl apply -f examples/cspc/cspc-single.yaml
```
10. Check if the pool has came online.

```bash
kubectl get cspc -n openebs
```

```bash
NAME HEALTHYINSTANCES PROVISIONEDINSTANCES DESIREDINSTANCES AGE
cspc-stripe 1 1 1 2m2s
Expand Down Expand Up @@ -293,3 +303,6 @@ 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