vSphere Docker Volume Service

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. Docker users can now consume vSphere Storage (vSAN, VMFS, NFS) to stateful containers using Docker.

vDVS is Docker Certified to use with Docker Enterprise Edition and available in Docker store.

To read more about code development and testing please read CONTRIBUTING.md as well as the FAQ on the project site.

Detailed documentation

Detailed documentation can be found on our GitHub Documentation Page.

Download

** Download releases from Github releases page**

The download consists of 2 parts:

1. VIB (vDVS driver): The ESX code is packaged as a vib or an offline depot
2. Managed plugin (vDVS plugin): Plugin is available on Docker store.

Please check vDVS Installation User Guide 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).

Supported Platform

ESXi: 6.0 and above
Docker (Linux): 1.12 and higher (Recommended 1.13/17.03 and above to use managed plugin)
Docker (Windows): 1.13/17.03 and above (Windows containers mode only)

Logging

The relevant logging for debugging consists of the following:

• Docker Logs
• Plugin logs - VM (docker-side)
• Plugin logs - ESX (server-side)

Docker logs: see https://docs.docker.com/engine/admin/logging/overview/

/var/log/upstart/docker.log # Upstart
journalctl -fu docker.service # Journalctl/Systemd

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
• Config file location (Linux): /etc/docker-volume-vsphere.conf.
• Config file location (Windows): C:\ProgramData\docker-volume-vsphere\docker-volume-vsphere.conf.
• This JSON-formatted file controls logs retention, size for rotation and log location. Example:

 {"MaxLogAgeDays": 28,
 "MaxLogSizeMb": 100,
 "LogPath": "/var/log/docker-volume-vsphere.log"}

• Turning on debug logging:

  • Package user (DEB/RPM installation): Stop the service and manually run with --log_level=debug flag

  • Managed plugin user: You can change the log level by passing VDVS_LOG_LEVEL key to docker plugin install.

    e.g.

    docker plugin install --grant-all-permissions --alias vsphere vmware/docker-volume-vsphere:latest VDVS_LOG_LEVEL=debug
    

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 for detailed steps.

Tested on

VMware ESXi:

• 6.0, 6.0U1, 6.0U2
• 6.5

Guest Operating System:

• Ubuntu 14.04 or higher (64 bit)
  • Needs Upstart or systemctl to start and stop the service
  • Needs open vm tools or VMware Tools installed sudo apt-get install open-vm-tools
• RedHat and CentOS
• Windows Server 2016 (64 bit)
• Photon 1.0, Revision 2 (v4.4.51 or later)

Docker (Linux): 1.12 and higher (Recommended 1.13/17.03 and above to use managed plugin) Docker (Windows): 1.13/17.03

Reference

• Known Issues: Please check vDVS known issue page to find out about known issues.

• Contact us: Please click here for requesting any feature or reporting a product issue.

• Blogs: Please check our vDVS blog page.