Write a real README.rst
OpenStack generally prefers reStructuredText for READMEs, so replace the stub README.md with more useful information in reST format. Change-Id: Ief8908e3c19a0b996c070e8122ba4dbbf2c4dfc9 Signed-off-by: Adam Spiers <aspiers@suse.com>
This commit is contained in:
parent
8048540577
commit
c5b7ea4bd0
@ -1,4 +0,0 @@
|
|||||||
openstack-resource-agents
|
|
||||||
=========================
|
|
||||||
|
|
||||||
Pacemaker High Availability resource agents for OpenStack
|
|
42
README.rst
Normal file
42
README.rst
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
Pacemaker High Availability resource agents for OpenStack
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
This repository contains a collection of Pacemaker_ `resource agents`_
|
||||||
|
(RAs) which can be used to provide highly available OpenStack services
|
||||||
|
managed within Pacemaker_ clusters.
|
||||||
|
|
||||||
|
.. _Pacemaker: http://clusterlabs.org/
|
||||||
|
.. _resource agents: http://www.linux-ha.org/wiki/Resource_agents
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
Please see the `OpenStack High Availability Guide`__ for usage
|
||||||
|
instructions. It is a bit out of date, but most of the information is
|
||||||
|
still accurate; hopefully we can update it soon.
|
||||||
|
|
||||||
|
__ http://docs.openstack.org/high-availability-guide/content/
|
||||||
|
|
||||||
|
Development
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Bugs can be viewed and reported via
|
||||||
|
<https://launchpad.net/openstack-resource-agents>.
|
||||||
|
|
||||||
|
Suggestions for improvements are very welcome; changes can be
|
||||||
|
submitted for review via `the normal OpenStack development process`__.
|
||||||
|
|
||||||
|
__ http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
|
||||||
|
History
|
||||||
|
-------
|
||||||
|
|
||||||
|
Martin Loschwitz started this repository in 2012, hosted at
|
||||||
|
<https://github.com/madkiss/openstack-resource-agents>,
|
||||||
|
and together with Sébastien Han and Emilien Macchi contributed
|
||||||
|
the majority of resource agents.
|
||||||
|
|
||||||
|
Martin eventually stepped down from maintainership, and
|
||||||
|
`in October 2015 the project was moved to StackForge`__.
|
||||||
|
|
||||||
|
__ http://lists.openstack.org/pipermail/openstack-dev/2015-October/077601.html
|
Loading…
Reference in New Issue
Block a user