|
1 | 1 | # Pacemaker |
2 | 2 |
|
3 | 3 | ## What is Pacemaker? |
4 | | -Pacemaker is an advanced, scalable High-Availability cluster resource |
5 | | -manager for Linux-HA (Heartbeat) and/or Corosync. |
6 | 4 |
|
7 | | -It supports "n-node" clusters with significant capabilities for |
| 5 | +Pacemaker is an advanced, scalable high-availability cluster resource manager. |
| 6 | +It runs on top of a cluster communication layer, either Corosync or |
| 7 | +Linux-HA's Heartbeat. |
| 8 | + |
| 9 | +It supports "N-node" clusters with significant capabilities for |
8 | 10 | managing resources and dependencies. |
9 | 11 |
|
10 | 12 | It will run scripts at initialization, when machines go up or down, |
11 | 13 | when related resources fail and can be configured to periodically check |
12 | 14 | resource health. |
13 | 15 |
|
14 | | -## For more information look at: |
15 | | -* [Website](http://www.clusterlabs.org) |
16 | | -* [Issues/Bugs](http://bugs.clusterlabs.org) |
17 | | -* Mailing lists per audience: [users](http://oss.clusterlabs.org/mailman/listinfo/users), [developers](http://oss.clusterlabs.org/mailman/listinfo/developers), or possibly [the original one](http://oss.clusterlabs.org/mailman/listinfo/pacemaker) ([deprecated](http://oss.clusterlabs.org/pipermail/pacemaker/2015-February/023521.html)) |
18 | | -* [Documentation](http://www.clusterlabs.org/doc) |
| 16 | +## Who is Pacemaker? |
| 17 | + |
| 18 | +Pacemaker is distributed by [ClusterLabs](http://www.clusterlabs.org). |
| 19 | + |
| 20 | +Pacemaker was initially created by main architect and lead developer |
| 21 | +Andrew Beekhof <[email protected]>, with the aid of |
| 22 | +project catalyst and advocate Lars Marowsky-Brée <[email protected]>. |
| 23 | + |
| 24 | +Many, many developers have contributed significantly to the project since. |
| 25 | +The git log is the definitive record of their greatly appreciated |
| 26 | +contributions. |
| 27 | + |
| 28 | +The wider community of Pacemaker users is another essential aspect of the |
| 29 | +project's existence, especially the many users who participate in the mailing |
| 30 | +lists, blog about HA clustering, and otherwise actively make the project more |
| 31 | +useful. |
| 32 | + |
| 33 | +## How do I install Pacemaker? |
| 34 | + |
| 35 | +See [INSTALL.md](https://github.com/ClusterLabs/pacemaker/blob/master/INSTALL.md). |
19 | 36 |
|
20 | | -## User interfaces / shells |
| 37 | +## What higher-level interfaces to Pacemaker are available? |
21 | 38 |
|
22 | | -There are multiple user interfaces for Pacemaker, both command line |
23 | | -tools, graphical user interfaces and web frontends. The _crm shell_ |
| 39 | +There are multiple user interfaces for Pacemaker, including command-line |
| 40 | +tools, graphical user interfaces and web frontends. The crm shell |
24 | 41 | used to be included in the Pacemaker source tree, but is now |
25 | | -maintained as a separate project. |
26 | | - |
27 | | -This is not meant to be an exhaustive list: |
28 | | - |
29 | | -* _crmsh_: https://crmsh.github.io/ |
30 | | -* _pcs_: https://github.com/ClusterLabs/pcs |
31 | | -* _LCMC_: http://lcmc.sourceforge.net/ |
32 | | -* _hawk_: https://github.com/ClusterLabs/hawk |
33 | | - |
34 | | -## Build Dependencies |
35 | | -* automake |
36 | | -* autoconf |
37 | | -* libtool-ltdl-devel |
38 | | -* libuuid-devel |
39 | | -* pkgconfig |
40 | | -* python (or python-devel if that's preferred as a build dependency) |
41 | | -* glib2-devel |
42 | | -* libxml2-devel |
43 | | -* libxslt-devel |
44 | | -* bzip2-devel |
45 | | -* gnutls-devel |
46 | | -* pam-devel |
47 | | -* libqb-devel |
48 | | - |
49 | | -## Cluster Stack Dependencies (Pick at least one) |
50 | | -* clusterlib-devel (CMAN) |
51 | | -* corosynclib-devel (Corosync) |
52 | | -* heartbeat-devel (Heartbeat) |
53 | | - |
54 | | -## Optional Build Dependencies |
55 | | -* ncurses-devel |
56 | | -* openssl-devel |
57 | | -* libselinux-devel |
58 | | -* systemd-devel |
59 | | -* dbus-devel |
60 | | -* cluster-glue-libs-devel (LHA style fencing agents) |
61 | | -* libesmtp-devel (Email alerts) |
62 | | -* lm_sensors-devel (SNMP alerts) |
63 | | -* net-snmp-devel (SNMP alerts) |
64 | | -* asciidoc (documentation) |
65 | | -* help2man (documentation) |
66 | | -* publican (documentation) |
67 | | -* inkscape (documentation) |
68 | | -* docbook-style-xsl (documentation) |
69 | | - |
70 | | -## Optional testing dependencies |
71 | | -* valgrind (if running CTS valgrind tests) |
72 | | -* systemd-python (if using CTS on cluster nodes running systemd) |
73 | | -* rsync (if running CTS container tests) |
74 | | -* libvirt-daemon-driver-lxc (if running CTS container tests) |
75 | | -* libvirt-daemon-lxc (if running CTS container tests) |
76 | | -* libvirt-login-shell (if running CTS container tests) |
77 | | - |
78 | | -## Source Control (GIT) |
79 | | - |
80 | | - git clone git://github.com/ClusterLabs/pacemaker.git |
81 | | - |
82 | | -[See Github](https://github.com/ClusterLabs/pacemaker) |
83 | | - |
84 | | -## Installing from source |
85 | | - |
86 | | - $ ./autogen.sh |
87 | | - $ ./configure |
88 | | - $ make |
89 | | - $ sudo make install |
90 | | - |
91 | | -## How you can help |
92 | | -If you find this project useful, you may want to consider supporting its future development. |
93 | | -There are a number of ways to support the project. |
94 | | - |
95 | | -* Test and report issues. |
96 | | -* Tick something off our [todo list](https://github.com/ClusterLabs/pacemaker/blob/master/TODO.markdown). |
97 | | -* Help others on the [mailing list](http://oss.clusterlabs.org/mailman/listinfo/users). |
98 | | -* Contribute documentation, examples and test cases. |
99 | | -* Contribute patches. |
100 | | -* Spread the word. |
| 42 | +a separate project. |
| 43 | + |
| 44 | +This is not an exhaustive list: |
| 45 | + |
| 46 | +* crmsh: https://github.com/ClusterLabs/crmsh |
| 47 | +* pcs: https://github.com/ClusterLabs/pcs |
| 48 | +* LCMC: http://lcmc.sourceforge.net/ |
| 49 | +* hawk: https://github.com/ClusterLabs/hawk |
| 50 | +* Pacemaker-mgmt: https://github.com/ClusterLabs/pacemaker-mgmt |
| 51 | +* Striker: https://github.com/ClusterLabs/striker |
| 52 | + |
| 53 | +## How can I help? |
| 54 | + |
| 55 | +See [CONTRIBUTING.md](https://github.com/ClusterLabs/pacemaker/blob/master/CONTRIBUTING.md). |
| 56 | + |
| 57 | +## Where can I find more information about Pacemaker? |
| 58 | + |
| 59 | +* [ClusterLabs website](http://www.clusterlabs.org/) |
| 60 | +* [Documentation](http://www.clusterlabs.org/doc/) |
| 61 | +* [Issues/Bugs](http://bugs.clusterlabs.org/) |
| 62 | +* Mailing lists for [users](http://oss.clusterlabs.org/mailman/listinfo/users) and [developers](http://oss.clusterlabs.org/mailman/listinfo/developers) |
| 63 | +* #clusterlabs IRC channel on [freenode](http://freenode.net/) |
0 commit comments