Volume Services

Page last updated:

Introduction

Cloud Foundry application developers may want their applications to mount one or more volumes in order to write to a reliable, non-ephemeral file system. By integrating with service brokers and the Cloud Foundry runtime, providers can offer these services to developers through an automated, self-service, and on-demand user experience.

Schema

Service Broker Bind Response

Field Type Description
volume_mounts* volume_mount[] An array of volume_mount JSON objects

volume_mount

A volume_mount represents a remote storage device to be attached and mounted into the app container filesystem via a Volume Driver.

Field Type Description
driver string Name of the volume driver plugin which manages the device
container_dir string The directory to mount inside the application container
mode string “r” to mount the volume read-only, or “rw” to mount it read-write
device_type string A string specifying the type of device to mount. Currently only “shared” devices are supported.
device device-object Device object containing device_type specific details. Currently only shared_device devices are supported.

shared_device

A shared_device is a subtype of a device. It represents a distributed file system which can be mounted on all app instances simultaneously.

Field Type Description
volume_id string ID of the shared volume to mount on every app instance
mount_config object Configuration object to be passed to the driver when the volume is mounted (optional)

Example

{
  ...
  "volume_mounts": [
    {
      "driver": "cephdriver",
      "container_dir": "/data/images",
      "mode": "r",
      "device_type": "shared",
      "device": {
        "volume_id": "bc2c1eab-05b9-482d-b0cf-750ee07de311",
        "mount_config": {
          "key": "value"
        }
      }
    }
  ]
}
Create a pull request or raise an issue on the source for this page in GitHub