From 96992dd5ae0bb0751a570345b6bc6692996ef530 Mon Sep 17 00:00:00 2001 From: Alessandro Costantini <alessandro.costantini@cnaf.infn.it> Date: Wed, 25 Nov 2015 16:20:33 +0100 Subject: [PATCH] Update ERADME.md --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 611dc73..9cdba8c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ This Puppet module allows deploying a highly-available installation of OpenStack The present module is part of the outcomes of the Open City Platform ([OCP](http://www.opencityplatform.eu/)) National Project. -The iaas module derives from the puppet-iaas module authored by Qunentin Machu (ADD LINK). +The iaas module derives from the [puppet-iaas](https://github.com/Quentin-M/puppet-iaas) module authored by Qunentin Machu. ## Module Description @@ -48,10 +48,20 @@ The present module supports multiple external networks. ## Usage -The nodes should be deployed in the following order(USARE ordered-list): Service nodes, Storage nodes, Controller nodes, Network nodes and then Compute nodes. +The nodes should be deployed in the following order(USARE ordered-list): +1. Service nodes +2. Storage nodes +3. Controller nodes +4. Network nodes +5. Compute node(s) ### Hiera Configuration -Before using the module you need to collect all the inforamtion regarding your infrastructure: (unordered list) - hostnames, networks (admin, management, data..etc), ... +Before using the module you need to collect all the information regarding your infrastructure: +* hostnames +* networks (admin, management, data, etc.) +* Network devices +* other specific settings + The first step in using the iaas module is to configure Hiera with the specific settings of your infrastructure. You can find in the `examples/` directory a sample 'common.yaml' file with all of the settings required by the module. These configuration options include Service settings, Storage settings, Network settings, OpenStack core settings and related passwords. @@ -59,17 +69,15 @@ If any of these settings are undefined or not properly set, your deployment may ### Site configuration The second step is to configure the manifest file with specific settings pointing to your installation. -In this module, the `examples` directory contains a sample 'site.pp' file that can be updated according to your deployment. +In this module, the `examples/` directory contains a sample 'site.pp' file that can be updated according to your deployment. The configuration options present in this file include Service variables and node-specific configuration settings. If any of these settings are undefined or not properly set, your deployment may fail. ### Nodes balancing - In order to balance requests across the different nodes, HAproxy and Keepalived have to be configured properly. Make sure also that nodes hostnames con be easily resolved to the corresponding IPs, both direct and reverse. ## References - In order to develop and test the module and its components, the following official guides and web-pages have been considered: * [OpenStack installation guide (Ubuntu 14.04)](http://docs.openstack.org/juno/install-guide/install/apt/content/) * [OpenStack High Availability Guide](http://docs.openstack.org/ha-guide/) -- GitLab