Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
88 lines (60 sloc) 5.03 KB
title: Adding Volume Services to Your Deployment
owner: Diego Persistence
This topic describes how Cloud Foundry (CF) operators can deploy volume services.
##<a id="overview"></a> Overview
A volume service gives apps access to a remote filesystem, such as NFS. To provide a volume service for CF developers to use with their apps, you must deploy a driver and broker pair.
For current versions of CF that have been been deployed with cf-deployment, deploying brokers and drivers is typically accomplished using operations files as outlined below in [Example: Deploy NFS to CF](#example).
### Additional Information
For more information about volume services and the drivers and brokers available to CF, see the following links:
* [Volume Services Google Doc](
* [NFS volume release repository](
* [CIFS/SMB volume release repository](
* [EFS volume release repository](
* [CEPHFS release repository](
<p class="note"><strong>Note</strong>: For test purposes, you can deploy the <a href="">Local Volume Release</a> if running a single Diego Cell CF deployment. This is not intended for production deployments.</p>
### Contact
If you have any questions, you can contact the team that develops volume services for CF on the **#persi** channel in the [Cloud Foundry (Open Source)]( Slack organization.
##<a id="example"></a> Example: Deploy NFS Volume Service to CF
The following procedure provides an example of how to deploy the NFS broker and corresponding driver to an existing CF deployment.
###<a id="pre"></a>Prerequisites
This procedure requires the following:
* A current version of Cloud Foundry deployed [as described here](/deploying/index.html).
* A BOSH v2 CLI.
* An NFS Server. If you require it, a test server can be deployed following the instructions [below](#server).
###<a id="redeploy"></a>Redeploy CF with NFS enabled
1. Clone the cf-deployment repository from git, if you do not already have it:
<pre class="terminal">
$ cd ~/workspace
$ git clone https<span>:</span>//
$ cd ~/workspace/cf-deployment</pre>
1. Redeploy your cf-deployment while including the nfs ops file:
<pre class="terminal">
$ bosh -e my-env -d cf deploy cf.yml -v deployment-vars.yml \
-o operations/enable-nfs-volume-service.yml</pre>
<p class="note"><strong>Note</strong>: The above command is an example, but your deployment command should match the one you used to deploy CF initially, with the addition of a <code>-o operations/enable-nfs-volume-service.yml</code> option.</p>
Your CF deployment now has a running service broker and volume drivers and is ready to mount nfs volumes. BOSH generates a variable for your nfsbroker password, unless you have explicitly defined one. You can find the broker registration password with the `bosh interpolate` command:
<pre class="terminal">
$ bosh int deployment-vars.yml --path /nfs-broker-password</pre>
####<a id="server"></a>Deploying the NFS Test Server
To deploy the NFS test server, you can fetch the operations file from the [persi-ci github repository]( and include that operation with a `-o` flag. This creates a separate VM with nfs exports you can use to experiment with volume mounts.
<p class="note"><strong>Note</strong>: By default, the nfs test server expects that your CF deployment is deployed to a 10.x.x.x subnet. If you are deploying to a subnet that is not 10.x.x.x (e.g. 192.168.x.x) then you will need to override the "export_cidr" property.<br/>
Edit the operations file, and replace this line:<br/>
<span style="font-family:monospace"> nfstestserver: {}</span><br/>
with something like this:<br/>
<span style="font-family:monospace"> nfstestserver: {export_cidr:}</span>
###<a id="broker"></a>Register the NFS Broker
1. Register the broker using the credentials specified in the `creds.yml` stub.
<pre class="terminal">
$ cf create-service-broker nfsbroker nfs-broker BROKER-PASSWORD \
1. Grant access to the service of the broker.
<pre class="terminal">
$ cf enable-service-access nfs
CF Developers can now create an NFS service and bind instances to their apps as outlined in the [Using an External File System (Volume Services)](../devguide/services/using-vol-services.html) topic.
###<a id="ldap"></a>(Optional) LDAP Support
For better security, it is recommended to configure your deployment of nfs-volume-release to connect to an external LDAP server to resolve user credentials into uids. See [this note]( for more details.