* * * README * * *

* * * VERITAS INFOSCALE VOLUME DRIVER TRIALWARE PLUGIN FOR DOCKER * * *

This document provides the following information:
* ABOUT VERITAS INFOSCALE VOLUME DRIVER TRIALWARE PLUGIN
* SYSTEM REQUIREMENTS
* OVERALL USAGE FLOW
* PREREQUISITE : CFS CONFIGURATION
* RUNNING DOCKER CONTAINER


ABOUT VERITAS INFOSCALE VOLUME DRIVER TRIALWARE PLUGIN
------------------------------------------------------
Veritas InfoScale volume driver plugin for Docker extends the capability of Docker daemon to handle storage related operations like creation of volume/file system, mount/unmount file system, remove volumes etc. With this plugin, docker containers can be started with storage attached to them automatically. This helps in ease of deployment of Docker containers. By using Veritas InfoScale storage, you can use all capabilities/features of Veritas InfoScale products.

You need the root permission to install and use Veritas volume plugin for docker.


SYSTEM REQUIREMENTS
-------------------
The Veritas InfoScale Volume Driver Plugin is supported on the following platforms:

Linux:		RHEL 7 or later

InfoScale Storage/Enterprise:	7.0 or later

Docker:		1.9 or later


OVERALL USAGE FLOW
------------------
Step 1: Configure Veritas InfoScale Storage 7.0 or later
Step 2: Install Docker version 1.9 or later
Step 3: Install VRTSdocker-plugin rpm
Step 3: Create dockerdg pool for Storage as mentioned below in the prerequisite section
Step 4: Deploy Containers using Persistent Storage (run docker volume commands with required arguments)


PREREQUISITE : CFS CONFIGURATION
--------------------------------
For shared storage environment,
Create a shared disk group with name 'dockerdg' using below command:
	# /usr/sbin/vxdg -s init dockerdg <disk_1> <disk_2> <disk_3> .. <disk_n>
						OR
For non-shared storage environment,
Create a shared disk group with name 'dockerdg' using below command:
	# /usr/sbin/vxdg -s -o fss init dockerdg <disk_1> <disk_2> <disk_3> .. <disk_n>

Note that, diskgroup 'dockerdg' spans across multiple hosts (either shared or non-shared storage) to allow container migration.

For more information on how to create a VxVM shared disk group refer following links for vxdg manual page -
   https://sort.symantec.com/public/documents/vie/7.1/linux/manualpages/html/man/volume_manager/html/contents.html
   https://sort.symantec.com/public/documents/vie/7.1/linux/manualpages/html/man/


RUNNING DOCKER CONTAINER
------------------------
Suppose you want to run Docker container with Veritas InfoScale plugin as a volume driver, with say volume name as 'demovol' then you may follow the steps given below:

1. Create a volume using the Docker volume create command:
	# docker volume create -d veritas --name demovol

You can also specify size and/or layout options using -o option, as shown below:
	# docker volume create -d veritas --name demovol -o size=500m -o layout=mirror

If options are not provided while creating a volume, then it uses default values for size and layout, stored in the /etc/vx/docker/vxinfoscale-default.conf file. If layout=auto is mentioned, then InfoScale automatically chooses the best layout for the environment.

2. Launch docker container:
	# docker run --name <container_name> -it -v demovol:/vol --volume-driver veritas <docker_image> <command>

Here, VxVM volume 'demovol' will be created with the desired size/layout and it will get automatically attached to the docker container.

Verify that container is running and accessible using following command, this should start 'bash' inside container.
	# docker exec <container_name> bash