diff --git a/contrib/block-box/README.CVOL-LVM.md b/contrib/block-box/README.CVOL-LVM.md index 40ebf2daf..9b8b74752 100644 --- a/contrib/block-box/README.CVOL-LVM.md +++ b/contrib/block-box/README.CVOL-LVM.md @@ -2,7 +2,7 @@ You'll need to modify how you're doing things to get to the iscsi Target. Specifically, using a Docker network hoses everything because the IP of the target is the internal containers IP NOT the IP of the host. -Setting `network_mode: host` solves this.. but that creates a new problem. +Setting `network_mode: host` solves this, but that creates a new problem. Can't use `link` when using network_mode: host. Sigh... so; docker run has "add-host=host:IP" that we should be able to find diff --git a/contrib/block-box/README.md b/contrib/block-box/README.md index 88ff8da35..960db99d7 100644 --- a/contrib/block-box/README.md +++ b/contrib/block-box/README.md @@ -3,7 +3,7 @@ Standalone Cinder Containerized using Docker Compose ## Cinder Provides Block Storage as a service as part of the OpenStack Project. -This project deployes Cinder in containers using docker-compose and +This project deploys Cinder in containers using docker-compose and also enabled the use of Cinder's noauth option which eliminates the need for keystone. One could also easily add keystone into the compose file along with an init script to set up endpoints. @@ -20,14 +20,14 @@ flexibility to add a Keystone service if desired. Start by building the required images. This repo includes a Makefile to enable building of openstack/loci images of Cinder. The Makefile includes variables to select between platform (debian, ubuntu or -centos) and also allows what branch of each project to biuld the image from. +centos) and also allows which branch of each project to build the image from. This includes master, stable/xyz as well as patch versions. Additional variables are provided and can be passed to make using the `-e` option to control things like naming and image tags. See the Makefile for more info. If you're going to utilize an external storage device (ie not using LVM), all -you need to build is the base Cinder image. Set the varialbe in the Makefile -to choose the Cinder Branch you'd like to use and Platforma then simply run: +you need to build is the base Cinder image. Set the variable in the Makefile +to choose the Cinder Branch you'd like to use and Platform then simply run: ```make base``` @@ -40,30 +40,30 @@ checked out into a container and includes test-requirements. ```make base``` -For more information and options, check out the openstack/loci page on github: -https://github.com/openstack/loci. +For more information and options, check out the openstack/loci page +on [github](https://github.com/openstack/loci). **NOTE** The loci project is moving fairly quickly, and it may or may not -continue to be a straight forward light weight method of building conatiner +continue to be a straight forward light weight method of building container Images. The build has been known to now work at times, and if it becomes -bloated or burdonsome it's easy to swap in another image builder (or write your +bloated or burdensome it's easy to swap in another image builder (or write your own even). -This will result in some base images that we'lluse: - cinder (openstack/loci image) - cinder-lvm (special cinder image with LVM config) - cinder-devenv (provides a Cinder development env container) +This will result in some base images that we'll use: + +1. cinder (openstack/loci image) +2. cinder-lvm (special cinder image with LVM config) +3. cinder-devenv (provides a Cinder development env container) ### cinder Creates a base image with cinder installed via source. This base image is -enough to run all of the services including api, scheudler and Volume with +enough to run all of the services including api, scheduler and volume with the exception of cinder-volume with the LVM driver which needs some extra packages installed like LVM2 and iSCSI target driver. Each Cinder service has an executable entrypoint at /usr/local/bin. -NOTE -If you choose to build images from something other than the default Debian +**NOTE** If you choose to build images from something other than the default Debian base, you'll need to modify the Dockerfile for this image as well. ### cinder-lvm @@ -76,7 +76,7 @@ some of your Cinder development. You can run this container which has all of the current development packages and python test-requirements for Cinder. You can pass in your current source directory from your local machine using -v -in your run command, here's a trival example that generates a sample config +in your run command, here's a trivial example that generates a sample config file. Note we don't use tox because we're already in an isolated environment. ```shell @@ -93,7 +93,7 @@ instance the result would be a newly generated cinder.conf.sample file in ## Accessing via cinderclient You can of course build a cinderclient container with a `cinder` entrypoint and -use that for acces, but in order to take advantage of things like the +use that for access, but in order to take advantage of things like the local-attach extension, you'll need to install the client tools on the host. The current release version in pypi doesn't include noauth @@ -114,7 +114,7 @@ sudo. To preserve your env variables don't forget to use `sudo -E cinder xxxxx` ## To run docker-compose up -d -Don't forget to modify the etc-cinder/cinder.conf file as needed for your +Don't forget to modify the `etc-cinder/cinder.conf` file as needed for your specific driver. We'll be adding support for the LVM driver and LIO Tgts shortly, but for now you won't have much luck without using an external device (no worries, there are over 80 to choose from).