README.md

VMware has ended active development of this project, this repository will no longer be updated.

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

vSphere Storage for Docker is Docker Certified to use with Docker Enterprise Edition and available in Docker store.

If you would like to contribute then please check out CONTRIBUTING.md & FAQ on the project site.

Documentation

Detailed documentation can be found on our GitHub Documentation Page.

Downloads

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 driver (on ESX) and managed plugin (on Docker host VM) for vSphere Storage for Docker.

Supported Platforms

ESXi: 6.0U2 and above
Docker (Linux): 17.06.1 and above to use managed plugin
Docker (Windows): 17.06 and above (Windows containers mode only)
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 6.9 or higher (64 bit)
• Windows Server 2016 (64 bit)
• Photon 1.0, Revision 2 (v4.4.51 or later), Photon 2.0
  

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

 {"MaxLogAgeDays": 28,
 "MaxLogFiles": 10,
 "MaxLogSizeMb": 10,
 "LogPath": "/var/log/vsphere-storage-for-docker.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.

  • Managed plugin user: Set the group ID to use for the plugin socket file via the VDVS_SOCKET_GID env. variable.

    e.g.

    docker plugin install --grant-all-permissions --alias vsphere vmware/vsphere-storage-for-docker:latest VDVS_LOG_LEVEL=debug VDVS_SOCKET_GID=<group name>
    

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.

References

• 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.