votequorum_overview.8 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. .\"/*
  2. .\" * Copyright (c) 2008 Red Hat, Inc.
  3. .\" *
  4. .\" * All rights reserved.
  5. .\" *
  6. .\" * Author: Christine Caulfield <ccaulfie@redhat.com>
  7. .\" *
  8. .\" * This software licensed under BSD license, the text of which follows:
  9. .\" *
  10. .\" * Redistribution and use in source and binary forms, with or without
  11. .\" * modification, are permitted provided that the following conditions are met:
  12. .\" *
  13. .\" * - Redistributions of source code must retain the above copyright notice,
  14. .\" * this list of conditions and the following disclaimer.
  15. .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16. .\" * this list of conditions and the following disclaimer in the documentation
  17. .\" * and/or other materials provided with the distribution.
  18. .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19. .\" * contributors may be used to endorse or promote products derived from this
  20. .\" * software without specific prior written permission.
  21. .\" *
  22. .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25. .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26. .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29. .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30. .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31. .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32. .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33. .\" */
  34. .TH VOTEQUORUM_OVERVIEW 8 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
  35. .SH OVERVIEW
  36. The votequuorum library is delivered with the corosync project. It is the external interface to
  37. the vote-based quorum service. This service is optionally loaded into all ndes in a corosync cluster
  38. to avoid split-brain situations. It does this by having a number of votes assigned to each system
  39. in the cluster and ensuring that only when a majority of the votes are present, cluster operations are
  40. allowed to proceed.
  41. .PP
  42. The library provides a mechanism to:
  43. * Query the quorum status
  44. .PP
  45. * Get a list of nodes known to the quorum service
  46. .PP
  47. * Receive notifications of quorum state changes
  48. .PP
  49. * Change the number of votes assigned to a node
  50. .PP
  51. * Change the number of expected votes for a cluster to be quorate
  52. .PP
  53. * Connect an additional quorum device to allow small clusters to remain quorate during node outages.
  54. .PP
  55. .B votequorum
  56. reads its configuration from the objdb. The following keys are read when it starts up:
  57. .PP
  58. * quorum.expected_votes
  59. .br
  60. * quorum.votes
  61. .br
  62. * quorum.quorumdev_poll
  63. .br
  64. * quorum.disallowed
  65. .br
  66. * quorum.two_node
  67. .PP
  68. Most of those values can be changed while corosync is running with the following exceptions:
  69. .B quorum.disallowed
  70. cannot be changed, and
  71. .B two_node
  72. cannot be set on-the-fly, though it can be cleared. ie you can start with two nodes in the cluster
  73. and add a third without rebooting all the nodes.
  74. .PP
  75. .SH BUGS
  76. This software is not yet production, so there may still be some bugs.
  77. .SH "SEE ALSO"
  78. .BR votequorum_initialize (3),
  79. .BR votequorum_finalize (3),
  80. .BR votequorum_fd_get (3),
  81. .BR votequorum_dispatch (3),
  82. .PP