Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Commit

Permalink
Repo rename (Part#4) [SKIP CI]
Browse files Browse the repository at this point in the history
1. Update for README.md, CONTRIBUTING.md etc
2. Update in customer facing document
3. vDVS ===> VDVS (as we can't use small v)
  • Loading branch information
shuklanirdesh82 committed Dec 15, 2017
1 parent ee64c1a commit 56e5a01
Show file tree
Hide file tree
Showing 45 changed files with 166 additions and 290 deletions.
4 changes: 2 additions & 2 deletions .drone.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ build:
- GOVC_PASSWORD=$GOVC_PASSWORD_ESX
- if [ "$TAG" != "" ]; then export PKG_VERSION=$TAG; fi
- #
- echo "=> Building and pushing vDVS managed plugin" `date` > /dev/null
- echo "=> Building and pushing VDVS managed plugin" `date` > /dev/null
- #
- export GOVC_URL=$GOVC_URL_6_5
- export VM1=`$GOVC_GET_IP photon.vmfs`
Expand Down Expand Up @@ -133,7 +133,7 @@ build:
- #
- ./misc/drone-scripts/deploy-and-test-wrapper.sh runtests $GOVC_URL_6_5 $VM1 $VM2 $$BUILD_NUMBER < /dev/null
- #
- echo "=> Building and running tests for Windows vDVS plugin on VMFS" `date` > /dev/null
- echo "=> Building and running tests for Windows VDVS plugin on VMFS" `date` > /dev/null
- #
- export WIN_VM1=`$GOVC_GET_IP windows`
- ./misc/drone-scripts/deploy-and-test-wrapper.sh winplugin $GOVC_URL_6_5 < /dev/null
Expand Down
43 changes: 22 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
## Table of Contents
* [Dev Setup and debugging help](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#pull-requests)
* [Bug filing guidelines](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#bug-filing-guidelines)
* [Typical Developer Workflow](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#typical-developer-workflow)
* [Photon VM specific configuration](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#photon-vm-specific-configuration)
* [Testing configuration](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#testing-configuration)
* [Windows plugin contribution guidelines](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#windows-plugin-contribution-guidelines)
* [Managing GO Dependencies](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#managing-go-dependencies)
* [Capturing ESX Code Coverage](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#capturing-esx-code-coverage)
* [CI/CD System](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#cicd-system)
* [Release naming convention](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#release-naming-convention)
* [Guidelines for cutting a new release](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#guidelines-for-cutting-a-new-release)
* [Documentation](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md#documentation)
* [Dev Setup and debugging help](#pull-requests)
* [Bug filing guidelines](#bug-filing-guidelines)
* [Typical Developer Workflow](#typical-developer-workflow)
* [Photon VM specific configuration](#photon-vm-specific-configuration)
* [Testing configuration](#testing-configuration)
* [Windows plugin contribution guidelines](#windows-plugin-contribution-guidelines)
* [Managing GO Dependencies](#managing-go-dependencies)
* [Capturing ESX Code Coverage](#capturing-esx-code-coverage)
* [CI/CD System](#cicd-system)
* [Release naming convention](#release-naming-convention)
* [Guidelines for cutting a new release](#guidelines-for-cutting-a-new-release)
* [Documentation](#documentation)


## Code Contribution guidelines
### Dev Setup and debugging help
Read the [FAQ on the Wiki](https://github.com/vmware/docker-volume-vsphere/wiki#faq)
### Pull Requests
* Create a fork or branch (if you can) and make your changes
* Branch should be suffixed with github user id: `(branch name).(github user id)` Example: `mydevbranch.kerneltime`
Expand Down Expand Up @@ -239,7 +237,7 @@ This is done to make sure CI still passes.

## Windows plugin contribution guidelines

Use following information to setup Windows VM in order to contribute towards vDVS plugin for Windows.
Use following information to setup Windows VM in order to contribute towards VDVS plugin for Windows.

### To configure a Windows VM
1. Create/Deploy Windows 2016 Server or Windows 10 OS VM.
Expand Down Expand Up @@ -291,7 +289,7 @@ Add a multi-string key named Environment and add the following lines to it.
# deploy the plugin:
make deploy-windows-plugin
# run the tests:
make test-e2e-windows
Expand All @@ -300,19 +298,22 @@ Add a multi-string key named Environment and add the following lines to it.
## Managing GO Dependencies

Use [gvt](https://github.com/FiloSottile/gvt) and check in the dependency.

Example:
```
make gvt # Start docker image used to build which includes gvt
# Use this command to install gvt if not already installed on your system
go get -u github.com/FiloSottile/gvt
gvt fetch github.com/docker/go-plugins-helpers/volume
git add vendor
git commit -m "Added new dependency go-plugins-helpers"
exit
```

## Capturing ESX Code Coverage
Coverage is captured using make coverage target (On CI it is called using drone script).
Coverage is captured using `make coverage` target (On CI it is called using drone script).
User can configure the setup and use this target to see the coverage.
### Setup ESX box to install python coverage package
* Install https://coverage.readthedocs.io/en/coverage-4.4.1/ on your machine using pip <br />
Expand Down Expand Up @@ -398,18 +399,18 @@ Head to GitHub and author a new release add the changelog for the tag created.
**Note**: Update [vDVS_bulletin.xml](https://github.com/vmware/docker-volume-vsphere/blob/master/docs/misc/vDVS_bulletin.xml#L19) to keep it current with the release and check changes to `[vmware/master]/docs/misc/vDVS_bulletin.xml` (see below to update the content per release)

```
<id>vDVS_driver-0.15</id> (0.15 refers to version)
<id>VDVS_driver-0.15</id> (0.15 refers to version)
<releaseDate>2017-06-30T18:47:36.688572+00:00</releaseDate> (release date where time is optional)
<vibID>vmware-esx-vmdkops-0.15.b93c186</vibID> (vmware-esx-vmdkops-<release_version>.<commit's SHA hash>)
```

4. After the vib signing has successfully finished, you will receive a confirmation email. Go to the deliverables link
mentioned in the email and download the signed offline bundle. Offline bundle will be a zip file something like ```vDVS_driver-0.18-offline_bundle-7032243.zip```. From the offline bundle, extract the signed VIB.
5. Head to [Bintray](https://bintray.com/vmware/product/vDVS/view) to publish signed VIB as well as offline bundle
6. Push vDVS & vFile managed plugin to docker store and windows plugin to bintray
6. Push VDVS & vFile managed plugin to docker store and windows plugin to bintray
7. Add ```Downloads``` section with direct links; take [Release 0.13](https://github.com/vmware/docker-volume-vsphere/releases/tag/0.13) as the reference

### Publish vDVS managed plugin to Docker Store
### Publish VDVS managed plugin to Docker Store
**Note**: not automated as of 04/04/17

To push plugin image
Expand All @@ -434,7 +435,7 @@ Windows plugin needs to be built on a windows environment
### Upload files to bintray
Two files need to be uploaded to bintray at https://bintray.com/vmware/vDVS/vDVS_Windows

Following are their paths (with respect to vDVS root working directory)
Following are their paths (with respect to VDVS root working directory)
1. install-vdvs.ps1
2. /build/windows/docker-volume-vsphere_windows_<release_tag>.zip

Expand Down
2 changes: 1 addition & 1 deletion Commonvars.mk
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

# This Makefile's purpose is to hold common variables to reuse across
# Makefiles for vDVS.
# Makefiles for VDVS.

# Exporting all variables to reuse
export
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
[![VIB_Download](https://api.bintray.com/packages/vmware/vDVS/VIB/images/download.svg)](https://bintray.com/vmware/vDVS/VIB/_latestVersion)
[![Windows Plugin](https://img.shields.io/badge/Windows%20Plugin-latest-blue.svg)](https://bintray.com/vmware/vDVS/vDVS_Windows/_latestVersion)

# vSphere Docker Volume Service
# vSphere Storage for Docker

vSphere Docker Volume Service (vDVS) enables customers to address persistent storage requirements for Docker containers in vSphere environments. This service is integrated with [Docker Volume Plugin framework](https://docs.docker.com/engine/extend/). Docker users can now consume vSphere Storage (vSAN, VMFS, NFS) to stateful containers using Docker.
vSphere Storage for Docker enables customers to address persistent storage requirements for Docker containers in vSphere environments. This service is integrated with [Docker Volume Plugin framework](https://docs.docker.com/engine/extend/). Docker users can now consume vSphere Storage (vSAN, VMFS, NFS, VVol) to stateful containers using Docker.

[<img src="https://github.com/vmware/docker-volume-vsphere/blob/master/docs/misc/Docker%20Certified.png" width="180" align="right">](https://store.docker.com/plugins/vsphere-docker-volume-service?tab=description)vDVS is Docker Certified to use with Docker Enterprise Edition and available in [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).
[<img src="https://github.com/vmware/docker-volume-vsphere/blob/master/docs/misc/Docker%20Certified.png" width="180" align="right">](https://store.docker.com/plugins/vsphere-docker-volume-service?tab=description)vSphere Storage for Docker is Docker Certified to use with Docker Enterprise Edition and available in [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).

If you would like to contribute then please check out
[CONTRIBUTING.md](https://github.com/vmware/docker-volume-vsphere/blob/master/CONTRIBUTING.md)
Expand All @@ -24,10 +24,10 @@ Detailed documentation can be found on our [GitHub Documentation Page](http://vm

The download consists of 2 parts:

1. VIB (vDVS driver): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
2. Managed plugin (vDVS plugin): Plugin is available on [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).
1. VIB (VDVS driver): The ESX code is packaged as [a vib or an offline depot](http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.install.doc/GUID-29491174-238E-4708-A78F-8FE95156D6A3.html#GUID-29491174-238E-4708-A78F-8FE95156D6A3)
2. Managed plugin (VDVS plugin): Plugin is available on [Docker store](https://store.docker.com/plugins/e15dc9d5-e20e-4fb8-8876-9615e6e6e852?tab=description).

Please check [vDVS Installation User Guide](http://vmware.github.io/docker-volume-vsphere/documentation/install.html) to get started. To ensure compatibility, make sure to use the same version of vDVS driver (on ESX) and managed plugin (on Docker host VM).
Please check [VDVS Installation User Guide](http://vmware.github.io/docker-volume-vsphere/documentation/install.html) to get started. To ensure compatibility, make sure to use the same version of driver (on ESX) and managed plugin (on Docker host VM) for vSphere Storage for Docker.

## Supported Platforms

Expand All @@ -47,7 +47,7 @@ The relevant logging for debugging consists of the following:
journalctl -fu docker.service # Journalctl/Systemd
```

**vDVS Plugin logs**
**VDVS Plugin logs**

* Log location (Linux): `/var/log/docker-volume-vsphere.log`
* Log location (Windows): `C:\Windows\System32\config\systemprofile\AppData\Local\docker-volume-vsphere\logs\docker-volume-vsphere.log`
Expand All @@ -74,14 +74,14 @@ journalctl -fu docker.service # Journalctl/Systemd
docker plugin install --grant-all-permissions --alias vsphere vmware/docker-volume-vsphere:latest VDVS_LOG_LEVEL=debug VDVS_SOCKET_GID=<group name>
```

**vDVS Driver logs**
**VDVS Driver logs**

* Log location: `/var/log/vmware/vmdk_ops.log`
* Config file location: `/etc/vmware/vmdkops/log_config.json` See Python
logging config format for content details.
* **Turning on debug logging**: replace all 'INFO' with 'DEBUG' in config file, restart the service

Please refer [vDVS configuration page](http://vmware.github.io/docker-volume-vsphere/documentation/configuration.html) for detailed steps.
Please refer [VDVS configuration page](http://vmware.github.io/docker-volume-vsphere/documentation/configuration.html) for detailed steps.

## Tested on

Expand All @@ -102,8 +102,8 @@ Please refer [vDVS configuration page](http://vmware.github.io/docker-volume-vsp

## References

* **Known Issues**: Please check [vDVS known issue page](http://vmware.github.io/docker-volume-vsphere/documentation/known-issues.html) to find out about known issues.
* **Known Issues**: Please check [VDVS known issue page](http://vmware.github.io/docker-volume-vsphere/documentation/known-issues.html) to find out about known issues.

* **Contact us**: Please [click here](http://vmware.github.io/docker-volume-vsphere/documentation/contactus.html) for requesting any feature or reporting a product issue.

* **Blogs**: Please check our [vDVS blog page](http://vmware.github.io/docker-volume-vsphere/documentation/blogs.html).
* **Blogs**: Please check our [VDVS blog page](http://vmware.github.io/docker-volume-vsphere/documentation/blogs.html).
4 changes: 2 additions & 2 deletions build.bat
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ del %winBuildDir%\vdvs.exe
echo Clean up complete.

:: ---- Build ----
echo Building vDVS...
echo Building VDVS...

:: Compile vmci_client.dll.
echo Entering the MSVC Build Tools environment.
Expand Down Expand Up @@ -100,5 +100,5 @@ powershell Compress-Archive -Path %winBuildDir%\* -DestinationPath %winBuildDir%
echo Successfully moved binaries to the build directory.

cd %projectRoot%
echo vDVS build complete.
echo VDVS build complete.
echo Binaries are available under %winBuildDir%.
8 changes: 4 additions & 4 deletions client_plugin/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ PLUGIN_BIN = $(BIN)/$(PLUGNAME)
VFILE_PLUGIN_BIN = $(BIN)/$(VFILE_PLUGNAME)

# all binaries for VMs - plugin and tests
# PLUGIN_BIN - vDVS plugin binary
# PLUGIN_BIN - VDVS plugin binary
# $(BIN)/$(VMDKOPS_TEST_MODULE).test - Running mock esx test
# $(BIN)/$(PLUGNAME).test - Running sanity test
# $(BIN)/$(INSTRUMENTED_PLUGIN_BIN) - Instrumented vDVS plugin binary for capturing code coverage
# $(BIN)/$(INSTRUMENTED_PLUGIN_BIN) - Instrumented VDVS plugin binary for capturing code coverage
VM_BINS = $(PLUGIN_BIN) $(BIN)/$(VMDKOPS_TEST_MODULE).test $(BIN)/$(PLUGNAME).test $(BIN)/$(INSTRUMENTED_PLUGIN_BIN)
VFILE_VM_BINS = $(VFILE_PLUGIN_BIN)

Expand Down Expand Up @@ -171,7 +171,7 @@ $(VFILE_PLUGIN_BIN): $(COMMON_SRC) $(VFILE_PLUGIN_SRC)
@-mkdir -p $(BIN) && chmod a+w $(BIN)
$(GO) build --ldflags '-extldflags "-static"' -o $(VFILE_PLUGIN_BIN) $(PLUGIN)/vfile_plugin

# vDVS binary to capture code coverage
# VDVS binary to capture code coverage
$(BIN)/$(INSTRUMENTED_PLUGIN_BIN): $(COMMON_SRC) $(VMDKOPS_MODULE_SRC) $(VMDK_PLUGIN_TEST_SRC)
$(GO) test -coverprofile=/tmp/cover.out -coverpkg=$(PLUGIN)/... -c -o $@ $(PLUGIN)/vmdk_plugin -tags testmain -covermode count

Expand Down Expand Up @@ -401,7 +401,7 @@ test-esx:
testremote: test-esx test-vm
test-all: test test-e2e testremote

# capture coverage of vDVS driver code.
# capture coverage of VDVS driver code.
coverage:
$(log_target)
$(MAKE) --directory=$(ESX_SRC) $@
Expand Down
2 changes: 1 addition & 1 deletion client_plugin/vmdk_plugin/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func main() {
startDaemon()
}

// startPluginServer starts vDVS plugin server.
// startPluginServer starts VDVS plugin server.
// Parses flags, initializes and mounts refcounters and finally initializes the server.
func startPluginServer() {
var driver volume.Driver
Expand Down
2 changes: 1 addition & 1 deletion client_plugin/vmdk_plugin/main_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// A VMDK Docker Data Volume plugin for Linux
package main

// startDaemon starts vDVS plugin daemon on Linux
// startDaemon starts VDVS plugin daemon on Linux
func startDaemon() {
startPluginServer()
}
2 changes: 1 addition & 1 deletion client_plugin/vmdk_plugin/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.\

// A sample test to run vDVS in a test mode to collect coverage data from
// A sample test to run VDVS in a test mode to collect coverage data from
// an instrumented binary.

// +build testmain
Expand Down
4 changes: 2 additions & 2 deletions client_plugin/vmdk_plugin/main_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"github.com/kardianos/service"
)

// pluginService is a wrapper for vDVS plugin server so that the plugin can
// pluginService is a wrapper for VDVS plugin server so that the plugin can
// be run as a service on Windows. Windows controls services by setting up
// callbacks that is non-trivial. This wrapper utilizes a vendor library to
// handle this.
Expand All @@ -42,7 +42,7 @@ func (p *pluginService) Stop(s service.Service) error {
return nil
}

// startDaemon starts vDVS plugin daemon on Windows
// startDaemon starts VDVS plugin daemon on Windows
func startDaemon() {
svcConfig := &service.Config{
Name: "vdvs",
Expand Down
3 changes: 0 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Documentation

The documentation for the next release goes here.
Please refer
[mkdocs.yml](https://github.com/vmware/docker-volume-vsphere/blob/master/mkdocs.yml)
for the layout of the documentation. Only files covered in [index.md](https://github.com/vmware/docker-volume-vsphere/blob/master/mkdocs.yml) will get published.

Documentation intended for publishing should go into the misc folder.

Expand Down
14 changes: 8 additions & 6 deletions docs/external/Interop.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Interop with vSphere features
---
title: Interop with vSphere features
---

The vDVS plugin works well with all vSphere features and deviations if any are as documented below:
The VDVS plugin works well with all vSphere features and deviations if any are as documented below:

**SvMotion/XvMotion**

SvMotion/XvMotion is not supported for VMs that use vDVS volumes.
SvMotion/XvMotion is not supported for VMs that use VDVS volumes.

- SvMotion/XvMotion causes vDVS volumes to be migrated out of the datastore location and hence causing the plugin to lose access to the volume. [#1618](https://github.com/vmware/docker-volume-vsphere/issues/1618)
- SvMotion/XvMotion causes VDVS volumes to be migrated out of the datastore location and hence causing the plugin to lose access to the volume. [#1618](https://github.com/vmware/docker-volume-vsphere/issues/1618)

**Storage DRS**

Storage DRS is not supported for VMs that use vDVS volumes.
Storage DRS is not supported for VMs that use VDVS volumes.

- Volume creation succeeds on a datastore which is in maintenance mode. Datastore maintenance mode is a VC feature and ESX is not aware of if any datastore is put in maintenance mode. [#1651](https://github.com/vmware/docker-volume-vsphere/issues/1651)
- Specifying "Datastore Cluster" name during volume creation is not supported. Datastore clusters (as a part of Storage DRS) is a VC feature and not available on an individual ESX. [#556](https://github.com/vmware/docker-volume-vsphere/issues/556)
Expand All @@ -30,4 +32,4 @@ User created vmgroup is not supported with SRM.

**Virtual Volumes(VVol)**

- All features of vDVS are supported with Virtual Volumes(VVol) except clone volume. Cloning a volume to create a new volume on a VVol datastore is not supported currently. [#1998] (https://github.com/vmware/docker-volume-vsphere/issues/1998)
- All features of VDVS are supported with Virtual Volumes(VVol) except clone volume. Cloning a volume to create a new volume on a VVol datastore is not supported currently. [#1998] (https://github.com/vmware/docker-volume-vsphere/issues/1998)
4 changes: 2 additions & 2 deletions docs/external/admin-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Available Namespaces:
vmgroup Administer and monitor volume access control
config Init and manage Config DB to enable quotas and access control [EXPERIMENTAL]
policy Configure and display storage policy information
volume Manage vDVS volumes
volume Manage VDVS volumes
Available Commands:
status Status of vdvs service
Expand Down Expand Up @@ -337,7 +337,7 @@ Note: If the VMs have volumes attached (containers running), their membership ch
they belong is not permitted. Make sure no volumes are attached.
To do so:
1. Get the list of containers running. (docker ps)
2. If the container has any vDVS volume mounted (docker inspect container_name), stop the container.
2. If the container has any VDVS volume mounted (docker inspect container_name), stop the container.
3. Ensure that the dvs volumes have status detached (docker volume inspect)

#### Help
Expand Down
Loading

0 comments on commit 56e5a01

Please sign in to comment.