vSphere Flocker driver
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


VMware vSphere now supports Native Docker Volumes. Download latest vSphere Docker Volume Driver from here

VMware vSphere® Flocker Driver

![vSphere Flocker Integration] (https://cloud.githubusercontent.com/assets/4852973/9564639/7e529746-4e62-11e5-9d61-3bc2ea4228fd.png)

ClusterHQ's Flocker provides an efficient and easy way to connect persistent storage with Docker containers. This project provides a plugin to provision persistent data volumes on VMware's vSphere storage datastores (VMFS, NFS, VSAN, VVOL).



  • Setup a shared datastore on your VC.
  • Let the name of the datastore be say: vsphereDatastore
  • Create directory with name "FLOCKER" on this datastore. Flocker volumes will reside in this path. [vsphereDatastore] FLOCKER
  • VMware pyVmomi 6.0.0 (python 2.7.9+) or 5.5-2014.1.1 (python 2.7.6)


  • Deploy Ubuntu VMs (which you will use as Flocker nodes) on ESXi hosts with vsphereDatastore as the shared datastore.

    • Power off these VMs and enable disk uuid on these VMs by adding following to the vmx files.
    disk.EnableUUID​ = "TRUE"
    • Power on these VMs and install VMware Tools, scsitools and sg3-utils
      • Ubuntu
      sudo apt-get install -y open-vm-tools scsitools sg3-utils
    • One of these VMs should have Flocker control service installed.
      • Follow the Ubuntu specific steps on this guide for installing Flocker.
  • Steps to install vsphere-flocker-driver:

    /opt/flocker/bin/pip install git+https://github.com/vmware/vsphere-flocker-driver.git

Usage Instructions

To start the plugin on a node, a configuration file must exist on the node at /etc/flocker/agent.yml. This should be as follows:

version: 1
  hostname: "{IP/Hostname of Flocker-Control Service}"
  backend: "vsphere_flocker_plugin"
  vc_ip: "{VC_IP}"                        # VC IP address
  username: "{VC_Username}"               # VC privileged user
  password: "{VC_Password}"               # VC privileged user password
  datacenter_name: "Datacenter"           # VC datacenter name
  datastore_name: "vsphereDatastore"      # VC datastore name as above  
  ssl_verify_cert: no                     # VC SSL cert verification
  ssl_key_file: ""                        #    SSL keyfile path
  ssl_cert_file: ""                       #    SSL certfile path
  ssl_thumbprint: ""                      #    SSL host thumbprint

Please see configuration examples in the config directory.


Copyright © 2015 VMware, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, without warranties or conditions of any kind, EITHER EXPRESS OR IMPLIED. See the License for the specific language governing permissions and limitations under the License.