vShared plugin: userguide [SKIP CI] #1793
Conversation
|
@pdhamdhere |
docs/user-guide/vshared-plugin.md
Outdated
| Detailed documentation can be found on our [GitHub Documentation Page](http://vmware.github.io/docker-volume-vsphere/documentation/). | ||
|
|
||
| ## Prerequisites | ||
| * Docker version 1.30/17.06.0 is required. |
There was a problem hiding this comment.
What is 1.30? Docker engine API version?
docs/user-guide/vshared-plugin.md
Outdated
|
|
||
| ## Prerequisites | ||
| * Docker version 1.30/17.06.0 is required. | ||
| * To use vShared plugin, hosts must be Docker Swarm mode. |
There was a problem hiding this comment.
"hosts must be Docker Swarm mode." -> "hosts must be running in Swarm mode."
docs/user-guide/vshared-plugin.md
Outdated
| #### Creating a persistent volume from vShared plugin | ||
| ``` | ||
| $ docker volume create --driver=vshared --name=SharedVol -o size=10gb | ||
| $ docker volume ls |
There was a problem hiding this comment.
Do we want to show the output of the command here?
docs/user-guide/vshared-plugin.md
Outdated
| $ docker volume inspect SharedVol | ||
| ``` | ||
| Options for creation will be the same for the base volume plugin. | ||
| Please refer to the base volume plugin for proper options. |
There was a problem hiding this comment.
Not all the options in base volume plugin are supported, for example "fstype" is not supported.
There was a problem hiding this comment.
+1
Also, Please refer to the base volume plugin for more options.
docs/user-guide/vshared-plugin.md
Outdated
| * Docker version 1.30/17.06.0 is required. | ||
| * To use vShared plugin, hosts must be Docker Swarm mode. | ||
| [How to create a swarm](https://docs.docker.com/engine/swarm/swarm-tutorial/create-swarm/) | ||
| [How to add nodes to the swarm](https://docs.docker.com/engine/swarm/swarm-tutorial/add-nodes/) |
There was a problem hiding this comment.
Can we get a line break here? And also before the previous link.
docs/user-guide/vshared-plugin.md
Outdated
|
|
||
| #### Creating a persistent volume from vShared plugin | ||
| ``` | ||
| $ docker volume create --driver=vshared --name=SharedVol -o size=10gb |
There was a problem hiding this comment.
Replace all vshared with vFile
docs/user-guide/vshared-plugin.md
Outdated
| # ssh to node1 | ||
| $ docker run --rm -it -v SharedVol:/mnt/myvol --name busybox-on-node1 busybox | ||
| / # cd /mnt/myvol | ||
| # write data into mounted shared volume |
There was a problem hiding this comment.
Change to read/write data. This might give an impression that we can either read or write from one container. Same for line 53.
docs/user-guide/vshared-plugin.md
Outdated
| $ docker volume rm SharedVol | ||
| ``` | ||
|
|
||
| ## Installing |
There was a problem hiding this comment.
Should Installing be above usage examples?
|
resolves #1796 |
Userguide for vShared plugin