From aedb9d89f4d08721cac3ea27c7c62b0ac49c0b04 Mon Sep 17 00:00:00 2001 From: Szymon Banka Date: Thu, 19 Feb 2015 22:51:42 +0100 Subject: [PATCH] add README.md Change-Id: I0bfc41607138c19dc967680c5fc47959c421e5c5 --- README.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..91ffc59 --- /dev/null +++ b/README.md @@ -0,0 +1,101 @@ +EMC VNX Plugin for Fuel +======================= + +EMC VNX plugin +-------------- + +EMC VNX plugin for Fuel extends Mirantis OpenStack functionality by adding +support for EMC VNX arrays in Cinder using iSCSI protocol. It replaces Cinder +LVM driver which is the default volume backend that uses local volumes +managed by LVM. + +Requirements +------------ + +| Requirement | Version/Comment | +|:---------------------------------|:----------------| +| Mirantis OpenStack compatibility | >= 6.1 | + +Limitations +----------- + +Since only one storage network is available in Fuel 6.x on OpenStack nodes, +multipath will bind all storage paths from EMC on one network interface. +In case this NIC fails, the communication with storage is lost. + +Installation Guide +================== + + +EMC VNX configuration +--------------------- + +Before starting a deployment you have to preconfigure EMC VNX array and connect +it properly to the environment. Both EMC SP IPs and all iSCSI ports should be +available over storage interface from OpenStack nodes. To learn more about +EMC VNX configuration, see +[the official EMC VNX series documentation](https://mydocuments.emc.com/DynDispatcher?prod=VNX&page=ConfigGroups_VNX) + +EMC VNX configuration checklist: +1. create username/password +2. create at least one storage pool +3. configure network for A and B Service Processors +4. configure network for all iSCSI ports + +EMC VNX plugin installation +--------------------------- + +To install EMC VNX plugin, follow these steps: + +1. Download the plugin from + [Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins) + +2. Copy the plugin on already installed Fuel Master node; ssh can be used for + that. If you do not have the Fuel Master node yet, see + [Quick Start Guide](https://software.mirantis.com/quick-start/): + + # scp emc_vnx-1.0-1.0.0-0.noarch.rpm root@:/tmp + +3. Log into the Fuel Master node. Install the plugin: + + # cd /tmp + # fuel plugins --install emc_vnx-1.0-1.0.0-0.noarch.rpm + +4. Check if the plugin was installed successfully: + + # fuel plugins + id | name | version | package_version + ---|---------|---------|---------------- + 1 | emc_vnx | 1.0.0 | 2.0.0 + +EMC VNX plugin configuration +---------------------------- + +1. Create an environment with the default backend for Cinder. +2. Enable the plugin on the Settings tab of the Fuel web UI and fill in form + fields: + * username/password - access credentials configured on EMC VNX + * SP A/B IP - IP addresses of the EMC VNX Service Processors + * pool name (optional) - a name of the EMC VNX storage pool on which all + Cinder volumes will be created. Provided storage pool must be available on + EMC VNX. If pool name is not provided then EMC VNX driver will use a random + storage pool available on EMC VNX. You can also use a Volume Type OpenStack + feature to create a volume on a specific storage pool. + For more information, see + [Multiple pools support](https://github.com/emc-openstack/vnx-direct-driver + /blob/master/README_ISCSI.md#multiple-pools-support) +3. Deploy the environment without a Cinder node. All required Cinder services + are run on Controller nodes. + +Release Notes +------------- + +This is the first release of the plugin. + +Contributors +------------ + +Dmitry Klenov (PM) +Szymon Bańka (developer) +Piotr Misiak (developer) +Dmitry Kalashnik (QA engineer)