vSphere Storage for Docker
Python Go Shell JavaScript C Makefile Other
Clone or download
govint and ashahi1 Fix KV files on clone. (#2077)
* Fix KV files on clone.Z
Latest commit 8b7dc30 Mar 27, 2018
Permalink
Failed to load latest commit information.
.settings Updated gitignore and eclipse config Mar 3, 2016
client_plugin Change the base image of vfile smb to PhotonOS (#2059) Feb 1, 2018
docs [SKIP CI] Describe fix for installation on CoreOS (#2076) Mar 14, 2018
esx_service Fix KV files on clone. (#2077) Mar 27, 2018
misc Script to setup swarm cluster for vFile [SKIP CI] (#2028) Jan 17, 2018
plugin_dockerbuild Change the base image of vfile smb to PhotonOS (#2059) Feb 1, 2018
tests Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
ui Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
vendor Add docker version check for vFile plugin. (#2014) Dec 2, 2017
.drone.sec Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
.drone.yml Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
.gitignore Adds npipe server impl for windows (#1488) Jun 28, 2017
.project Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
.pydevproject Initial commit of Go "vmware/vmdkops" module, related ESX vmdkops ser… Jan 29, 2016
CI.md Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
CONTRIBUTING.md rename "vFile" to "vSphere Shared Storage for Docker" or "VSSD" in do… Jan 31, 2018
Commonvars.mk Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
Jenkinsfile Updates Jenkinsfile semantics and aesthetics (#2072) Feb 20, 2018
LICENSE Add the missing LICENSE and NOTICE. This was part of pull/245 but got… Apr 15, 2016
Makefile More code and script change to enable vFile CI (#1886) Oct 25, 2017
NOTICE Add the missing LICENSE and NOTICE. This was part of pull/245 but got… Apr 15, 2016
README.md Release 0.20 doc update [SKIP CI] (#2047) Dec 21, 2017
build.bat Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017
install-vdvs.ps1 Repo rename: Project repo name is updated to vsphere-storage-for-dock… Dec 15, 2017

README.md

Build Status Go Report Card Docker Pulls VIB_Download Windows Plugin

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:

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