diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..4342875 --- /dev/null +++ b/README.markdown @@ -0,0 +1,76 @@ +# Pacemaker + +## What is Pacemaker? + +Pacemaker is an advanced, scalable high-availability cluster resource manager. + +It supports "N-node" clusters with significant capabilities for +managing resources and dependencies. + +It will run scripts at initialization, when machines go up or down, +when related resources fail and can be configured to periodically check +resource health. + +## Who is Pacemaker? + +Pacemaker is distributed by [ClusterLabs](https://www.clusterlabs.org/). + +Pacemaker was initially created by main architect and lead developer +Andrew Beekhof <andrew@beekhof.net>, with the aid of +project catalyst and advocate Lars Marowsky-Brée <lmb@suse.de>. + +Many, many developers have contributed significantly to the project since. +The git log is the definitive record of their greatly appreciated +contributions. + +The wider community of Pacemaker users is another essential aspect of the +project's existence, especially the many users who participate in the mailing +lists, blog about HA clustering, and otherwise actively make the project more +useful. + +## Where do I get Pacemaker? + +Pacemaker source code is distributed via +[Github](https://github.com/ClusterLabs/pacemaker). + +From there, you can clone or download the repository to get the latest +development code, or download one of the official +[releases](https://github.com/ClusterLabs/pacemaker/releases). + +## How do I install Pacemaker? + +See [INSTALL.md](https://github.com/ClusterLabs/pacemaker/blob/main/INSTALL.md). + +## What higher-level interfaces to Pacemaker are available? + +There are multiple user interfaces for Pacemaker, including command-line +tools, graphical user interfaces and web frontends. The crm shell +used to be included in the Pacemaker source tree, but is now +a separate project. + +This is not an exhaustive list: + +* crmsh: https://github.com/ClusterLabs/crmsh +* pcs: https://github.com/ClusterLabs/pcs +* LCMC: http://lcmc.sourceforge.net/ +* hawk: https://github.com/ClusterLabs/hawk +* Striker: https://github.com/ClusterLabs/striker + +### Can I convert some other cluster configuration to Pacemaker? + +[clufter](https://github.com/jnpkrn/clufter) is a general-purpose tool +for converting one cluster representation format to another. Among other +possibilities, it can convert from a cluster based on rgmanager with CMAN to +a one based on pacemaker with corosync. See its documentation for details. + +## How can I help? + +See [CONTRIBUTING.md](https://github.com/ClusterLabs/pacemaker/blob/main/CONTRIBUTING.md). + +## Where can I find more information about Pacemaker? + +* [ClusterLabs website](https://www.clusterlabs.org/) +* [Documentation](https://www.clusterlabs.org/pacemaker/doc/) +* [Issues/Bugs](https://bugs.clusterlabs.org/) +* [Mailing lists](https://wiki.clusterlabs.org/wiki/Mailing_lists) for users and developers +* [ClusterLabs IRC channel](https://wiki.clusterlabs.org/wiki/ClusterLabs_IRC_channel) |