v1

File shares

Create a file share in a space

This endpoint creates a new file share in a space (corresponding IBM Containers command: cf ic volume fs-create FSNAME FSSIZE FSIOPS).

A file share is a persistent NFS-based (Network File System) storage system that hosts Docker volumes in a Bluemix space and allows a user to store and access container and app-related files. To store files in a file share, you must create a container volume and save the data into this volume.

As soon as you create your first volume in a space with the cf ic volume create VOLNAME command or the POST /volumes/create API endpoint, a default file share with 20 GB at 4 IOPS (Input Output operations Per Second) is created at no cost.

The organization manager can create file shares with specific storage size and IOPS to meet the storage needs of the space. File shares can be provisioned in sizes from 20 GB to 12 TB and at IOPS per GB of 0.25, 2 or 4. Run cf ic volume fs-flavor-list or call the GET /volumes/fs/flavors/json API endpoint to retrieve a list of available file share sizes. The file share size in relation to the number of IOPS impacts the speed that data can be read and written from and to the container volume.

post/volumes/fs/create

Headers

X-Auth-Tokenstring required

The Bluemix JSON web token that you receive when logging into Bluemix. Run cf oauth-token to retrieve your access token.

X-Auth-Project-Idstring required

The unique ID of your organization space where you want to create or work with your containers. Run cf space <space_name> --guid, where <space_name> is the name of your space, to retrieve your space ID.

Request body

fsIOPSnumber double required

The number of input/output transactions per second. Available values are 0.25, 2 or 4.

fsNamestring required

The name of the new file share that you want to create. The name can contain uppercase letters, lowercase letters, numbers, underscores (_), and hyphens (-).

fsSizeinteger required

The size of the file share in gigabyte. Run cf ic volume fs-flavor-list or call the GET /volumes/fs/flavors/json API endpoint to retrieve a list of available file share sizes.

Response

Accepted. A new fileshare has been created.