From 7e3e29594cce76e82af1a1037c7e82d6eae0af4f Mon Sep 17 00:00:00 2001 From: Doina Cristina Aiftimiei <cristina.aiftimiei@cnaf.infn.it> Date: Wed, 25 Nov 2015 15:59:51 +0100 Subject: [PATCH] New Update Readme.md --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 77dd1f3..b8ef5a2 100644 --- a/README.md +++ b/README.md @@ -18,45 +18,47 @@ This Puppet module allows deploying a highly-available installation of OpenStack Juno on commodity servers supporting multiple networks architecture. -The present modlue is part of the outcomes of the Open City Paltform ([OCP](http://www.opencityplatform.eu/)) National Project. +The present module is part of the outcomes of the Open City Platform ([OCP](http://www.opencityplatform.eu/)) National Project. -The iaas module derive fron the puppet-iaas module authored by Qunentin Machu. +The iaas module derives from the puppet-iaas module authored by Qunentin Machu (ADD LINK). ## Module Description -Different types of nodes are created by the deployment : +By using the present module, different types of nodes can be deployed: * Service nodes hosting databases, message queues and load balancers [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/Keepalived_HAProxy_MySQLPercona_e_RabbitMQ_in_HA_su_testbed_Puppet) -* Storage nodes hosting volumes, image storage using CEPH [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/CEPHPuppetIAAS) +* Storage nodes hosting volumes and images using CEPH [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/CEPHPuppetIAAS) * Controller nodes hosting API services and OpenStack core services [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/OnlyControllerPuppetIAAS) * Network nodes hosting L2/L3 (Open vSwitch) routing and DHCP services [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/NetworkPuppetIAAS) -* Compute nodes to run guest operating systems [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/ComputePuppetIAAS) +* Compute nodes to host guest operating systems [installation guide](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/ComputePuppetIAAS) ## Setup ### Setup Requirements This module assumes nodes running Ubuntu 14.04 (Trusty) with either Puppet Enterprise or Puppet. -More information related to the setup requirement are available in the present guide [Setup requirements](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/TestbedPuppet) +More information related to the setup requirements are available in the following guide - [Setup requirements](https://support.ba.infn.it/redmine/projects/automaticocp/wiki/TestbedPuppet) This module depends on Hiera. ### Beginning with iaas module -To ensure high availability, three Service nodes, three Storage nodes, two Controller nodes and two Network nodes must be deployed, be sure to have ten available servers. In addition, a number of Compute nodes are also to be available for the deployment. +To ensure high availability of the infrastructure, three Service nodes, three Storage nodes, two Controller nodes and two Network nodes must be deployed. Please make sure you have available at least ten servers. +In addition, a number of Compute nodes must also to be available for the deployment. The present module supports multiple external networks. ## Usage -The nodes should be deployed in the following order : Service nodes, Storage nodes, Controller nodes, Network nodes and then Compute nodes. +The nodes should be deployed in the following order(USARE ordered-list): Service nodes, Storage nodes, Controller nodes, Network nodes and then Compute nodes. ### Hiera Configuration -The first step to using the iaas module is to configure hiera with specific settings pointing to your installation. -In this module, the `examples` directory contains sample 'common.yaml' file with all of the settings required by this module. +Before using the module you need to collect all the inforamtion regarding your infrastructure: (unordered list) - hostnames, networks (admin, management, data..etc), ... +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. If any of these settings are undefined or not properly set, your deployment may fail. ### Site configuration -The second step to using the iaas module is to configure manifest file with specific settings pointing to your installation. +The second step is to configure the manifest file with specific settings pointing to your installation. In this module, the `examples` directory contains sample 'site.pp' file according to your deployment. These configuration options include Service variables and node-specific configuration settings. If any of these settings are undefined or not properly set, your deployment may fail. -- GitLab