Skip to content
This repository has been archived by the owner on Mar 16, 2021. It is now read-only.

Commit

Permalink
Markdown linter corrections.
Browse files Browse the repository at this point in the history
Signed-off-by: Humble Chirammal <[email protected]>
  • Loading branch information
humblec committed Jan 11, 2019
1 parent 830137d commit fd0edec
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 50 deletions.
27 changes: 19 additions & 8 deletions pkg/flexadapter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,45 @@
## Usage:

### Start Flexvolume adapter for simple nfs flexvolume driver
```

```bash

$ sudo ./_output/flexadapter --endpoint tcp://127.0.0.1:10000 --drivername simplenfs --driverpath ./pkg/flexadapter/examples/simplenfs-flexdriver/driver/nfs --nodeid CSINode -v=5

```

### Test using csc
Get ```csc``` tool from https://github.com/rexray/gocsi/tree/master/csc

Get ```csc``` tool from <https://github.com/rexray/gocsi/tree/master/csc>

#### Get plugin info
```

```bash

$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"simplenfs" "0.1.0"
"simplenfs" "0.1.0"

```

#### NodePublish a volume
```

```bash

$ csc node publish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/nfs --attrib server=a.b.c.d --attrib share=nfs_share nfstestvol
nfstestvol

```

#### NodeUnpublish a volume
```

```bash
$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/nfs nfstestvol
nfstestvol
```

#### Get NodeID
```

```bash
$ csc node get-id --endpoint tcp://127.0.0.1:10000
CSINode
```

36 changes: 23 additions & 13 deletions pkg/hostpath/README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,68 @@
# CSI Hostpath driver

## Usage:
## Usage

### Build hostpathplugin
```
$ make hostpath

```bash
make hostpath
```

### Start Hostpath driver
```
$ sudo ./_output/hostpathplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINode -v=5

```bash
sudo ./_output/hostpathplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINode -v=5
```

### Test using csc
Get ```csc``` tool from https://github.com/rexray/gocsi/tree/master/csc

Get ```csc``` tool from <https://github.com/rexray/gocsi/tree/master/csc>

#### Get plugin info
```

```bash
$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"csi-hostpath" "0.1.0"
```

#### Create a volume
```

```bash
$ csc controller new --endpoint tcp://127.0.0.1:10000 --cap 1,block CSIVolumeName
CSIVolumeID
```

#### Delete a volume
```

```bash
$ csc controller del --endpoint tcp://127.0.0.1:10000 CSIVolumeID
CSIVolumeID
```

#### Validate volume capabilities
```

```bash
$ csc controller validate-volume-capabilities --endpoint tcp://127.0.0.1:10000 --cap 1,block CSIVolumeID
CSIVolumeID true
```

#### NodePublish a volume
```

```bash
$ csc node publish --endpoint tcp://127.0.0.1:10000 --cap 1,block --target-path /mnt/hostpath CSIVolumeID
CSIVolumeID
```

#### NodeUnpublish a volume
```

```bash
$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/hostpath CSIVolumeID
CSIVolumeID
```

#### Get NodeID
```

```bash
$ csc node get-id --endpoint tcp://127.0.0.1:10000
CSINode
```
37 changes: 22 additions & 15 deletions pkg/iscsi/README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
# CSI ISCSI driver

## Usage:
## Usage

### Start ISCSI driver
```
$ sudo ./_output/iscsidriver --endpoint tcp://127.0.0.1:10000 --nodeid CSINode

```bash
sudo ./_output/iscsidriver --endpoint tcp://127.0.0.1:10000 --nodeid CSINode
```

### Test using csc
Get ```csc``` tool from https://github.com/rexray/gocsi/tree/master/csc

Get ```csc``` tool from <https://github.com/rexray/gocsi/tree/master/csc>

#### Get plugin info
```
$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"ISCSI" "0.1.0"

```bash
csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"ISCSI""0.1.0"
```

#### NodePublish a volume
```
$ export ISCSI_TARGET="iSCSI Target Server IP (Ex: 10.10.10.10)"
$ export IQN="Target IQN"
$ csc node publish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/iscsi --attrib targetPortal=$ISCSI_TARGET --attrib iqn=$IQN --attrib lun=<lun-id> iscsitestvol

```bash

export ISCSI_TARGET="iSCSI Target Server IP (Ex: 10.10.10.10)"
export IQN="Target IQN"
csc node publish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/iscsi --attrib targetPortal=$ISCSI_TARGET --attrib iqn=$IQN --attrib lun=<lun-id> iscsitestvol
iscsitestvol
```

#### NodeUnpublish a volume
```
$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/iscsi iscsitestvol

```bash
csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/iscsi iscsitestvol
iscsitestvol
```

#### Get NodeID
```
$ csc node get-id --endpoint tcp://127.0.0.1:10000

```bash
csc node get-id --endpoint tcp://127.0.0.1:10000
CSINode
```
54 changes: 40 additions & 14 deletions pkg/nfs/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# CSI NFS driver


## Kubernetes

### Requirements

The folllowing feature gates and runtime config have to be enabled to deploy the driver

```
```bash

FEATURE_GATES=CSIPersistentVolume=true,MountPropagation=true
RUNTIME_CONFIG="storage.k8s.io/v1alpha1=true"

```

Mountprogpation requries support for privileged containers. So, make sure privileged containers are enabled in the cluster.
Expand All @@ -22,48 +24,72 @@ Mountprogpation requries support for privileged containers. So, make sure privil
```kubectl -f deploy/kubernetes create```

### Example Nginx application

Please update the NFS Server & share information in nginx.yaml file.

```kubectl -f examples/kubernetes/nginx.yaml create```

## Using CSC tool

### Build nfsplugin
```
$ make nfs

```bash

make nfs

```


### Start NFS driver


```bash

sudo ./_output/nfsplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINode -v=5

```
$ sudo ./_output/nfsplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINode -v=5
```


## Test
Get ```csc``` tool from https://github.com/rexray/gocsi/tree/master/csc

#### Get plugin info
```
Get ```csc``` tool from <https://github.com/rexray/gocsi/tree/master/csc>

### Get plugin info

```bash

$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"NFS" "0.1.0"
"NFS""0.1.0"

```


#### NodePublish a volume
```

```bash

$ export NFS_SERVER="Your Server IP (Ex: 10.10.10.10)"
$ export NFS_SHARE="Your NFS share"
$ csc node publish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/nfs --attrib server=$NFS_SERVER --attrib share=$NFS_SHARE nfstestvol
nfstestvol

```

#### NodeUnpublish a volume
```

```bash

$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/nfs nfstestvol
nfstestvol

```


#### Get NodeID
```

```bash

$ csc node get-id --endpoint tcp://127.0.0.1:10000
CSINode
```

```

0 comments on commit fd0edec

Please sign in to comment.