x/valence
Code Issues Proposed changes

Wrap the lines in README.rst

Browse Source 
Some the lines in README are over 80 characters. We should wrap them.

Change-Id: I686b98343abd3c1a1f85dc32fba2ccc934cd3ac9
Closes-bug: #1643754
This commit is contained in:
Shuquan Huang 2016-11-22 11:56:16 +08:00
parent 8144b0c98b
commit c8ca1f7073
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.rst
View File

@ -2,7 +2,9 @@
Openstack Valence Project Openstack Valence Project
========================= =========================
Valence is a service for lifecycle management of pooled bare-metal hardware infrastructure such as Intel(R) Rack Scale architecture which uses Redfish(TM) as one of the management protocols. Valence is a service for lifecycle management of pooled bare-metal hardware
infrastructure such as Intel(R) Rack Scale architecture which uses Redfish(TM)
as one of the management protocols.
:Free software: Apache license :Free software: Apache license
:Wiki: https://wiki.openstack.org/wiki/Valence :Wiki: https://wiki.openstack.org/wiki/Valence
@ -14,7 +16,8 @@ Valence is a service for lifecycle management of pooled bare-metal hardware infr
Download and Installation Download and Installation
=========================== ===========================
The following steps capture how to install valence. All installation steps require super user permissions. The following steps capture how to install valence. All installation steps
require super user permissions.
******************************************* *******************************************
Valence installation Valence installation
@ -29,7 +32,8 @@ Valence installation
``$ git clone https://git.openstack.org/openstack/rsc`` ``$ git clone https://git.openstack.org/openstack/rsc``
3. Execute the 'install_valence.sh' file present in the Valence root directory. 3. Execute the 'install_valence.sh' file present in the Valence root directory.
The install script will automatically install the dependencies listed in the requirements.txt file. The install script will automatically install the dependencies listed in the
requirements.txt file.
``$ sudo bash install_valence.sh`` ``$ sudo bash install_valence.sh``
@ -55,15 +59,18 @@ Please refer to the installation steps in the ui/README file.
Components Components
********** **********
Valence follows the typical OpenStack project setup. The components are listed below: Valence follows the typical OpenStack project setup. The components are listed
below:
valence-api valence-api
----------- -----------
A pecan based daemon to expose Valence REST APIs. The api service communicates to the controller through AMQP. A pecan based daemon to expose Valence REST APIs. The api service communicates
to the controller through AMQP.
valence-controller valence-controller
-------------- --------------
The controller implements all the handlers for Plasma-api. It reads requests from the AMQP queue, process it and send the reponse back to the caller. The controller implements all the handlers for Plasma-api. It reads requests
from the AMQP queue, process it and send the reponse back to the caller.
valence-ui valence-ui
-------- --------
@ -74,5 +81,3 @@ Features
========== ==========
Please refer the Valence blueprints for supported and in-the-pipeline features. Please refer the Valence blueprints for supported and in-the-pipeline features.
``https://blueprints.launchpad.net/openstack-valence`` ``https://blueprints.launchpad.net/openstack-valence``