aboutsummaryrefslogtreecommitdiff
path: root/docs/block-storage-guide.md
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-07-31 18:53:30 +0000
committerGerrit Code Review <review@openstack.org>2015-07-31 18:53:30 +0000
commitf41e1a4a2771c229f77f1b9ea41f1c18631a585e (patch)
tree3a8da82012dd136b7dbebfe7e42efa17e40e90e7 /docs/block-storage-guide.md
parent2dfc88dcac763f94e837b9e16857301ee486c040 (diff)
parentd9a3afbfe067613942b6dd43287ea53598604942 (diff)
downloadkolla-f41e1a4a2771c229f77f1b9ea41f1c18631a585e.tar.gz
kolla-f41e1a4a2771c229f77f1b9ea41f1c18631a585e.zip
Merge "Fix some spelling and formatting errors in the Cinder doc"
Diffstat (limited to 'docs/block-storage-guide.md')
-rw-r--r--docs/block-storage-guide.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/block-storage-guide.md b/docs/block-storage-guide.md
new file mode 100644
index 000000000..aa7f3d5b7
--- /dev/null
+++ b/docs/block-storage-guide.md
@@ -0,0 +1,54 @@
+# Storage Guide
+
+This is a overview of how Cinder is implemented in Kolla so that it is easier
+to understand how to use it. Keep in mind, this is the first iteration for
+Cinder as support for Ceph and physical devices will follow.
+
+## Overview
+
+Kolla's setup for Cinder uses tgtd as the default iSCSI helper to implement
+persistent targets. By default, we use a loop back file that is defined by
+CINDER_LVM_LO_VOLUME_SIZE to create the cinder-volumes volume group.
+
+## Configure Cinder
+
+Listed below are the default configurations for Cinder. For more info on what
+each variable does look at the [integration guide.](https://github.com/stackforge/kolla/blob/master/docs/integration-guide.md):
+
+ # Cinder Volume
+ CINDER_ENABLED_BACKEND=lvm57
+ CINDER_LVM_LO_VOLUME_SIZE=4G
+ CINDER_VOLUME_API_LISTEN=$HOST_IP
+ CINDER_VOLUME_BACKEND_NAME=LVM_iSCSI57
+ CINDER_VOLUME_DRIVER=cinder.volume.drivers.lvm.LVMISCSIDriver
+ CINDER_VOLUME_GROUP=cinder-volumes
+ ISCSI_HELPER=tgtadm
+ ISCSI_IP_ADDRESS=$HOST_IP
+
+## Using Cinder
+
+After you've started all your containers, you should be able to interact
+with Cinder.
+
+ cinder list
+
+Next, you will want to create a volume and attach it to a running instance.
+
+ cinder create 1
+ nova volume-attach <instance_id> <volume_id>
+
+## Debugging and deleting volumes
+
+The cinder-volumes volume group can't be seen from the host. In order to
+interact with an existing volume, you need to jump into the Cinder Volume
+container.
+
+ sudo docker exec -it <cinder_volume_container> /bin/bash
+ vgs
+
+Running 'vgs' will list the volumes groups. From there, you can look
+specific volumes to make sure volume creation succeeded.
+
+To delete the cinder-volumes volume group from within the container run:
+
+ vgs remove cinder-volumes