votequorum_overview.8 3.8 KB

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