Pacemaker Remote Quick Start #
This document guides you through the setup of a High Availability cluster with a remote
node or a guest node, managed by Pacemaker and pacemaker_remote
. Remote in the pacemaker_remote
term
does not mean physical distance, but “non-membership” of a cluster.
Copyright © 2006–2024 SUSE LLC and contributors. All rights reserved.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled “GNU Free Documentation License”.
For SUSE trademarks, see https://www.suse.com/company/legal/. All third-party trademarks are the property of their respective owners. Trademark symbols (®, ™ etc.) denote trademarks of SUSE and its affiliates. Asterisks (*) denote third-party trademarks.
All information found in this book has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither SUSE LLC, its affiliates, the authors nor the translators shall be held liable for possible errors or the consequences thereof.
1 Conceptual Overview and Terminology #
A regular cluster may contain up to 32 nodes. With the pacemaker_remote
service,
High Availability clusters can be extended to include additional nodes beyond this
limit.
The pacemaker_remote
service can be operated as a physical node (called remote
node) or as a virtual node (called guest node).
Unlike normal cluster nodes, both remote and guest nodes are managed by
the cluster as resources.
As such, they are not bound to the 32 node limitation of the cluster
stack. However, from the resource management point of view, they behave
as regular cluster nodes.
Remote nodes do not need to have the full cluster stack installed, as
they only run the pacemaker_remote
service. The service acts as a proxy,
allowing the cluster stack on the “regular” cluster nodes
to connect to the service.
Thus, the node that runs the pacemaker_remote
service is
effectively integrated into the cluster as a remote node (see Terminology).
- Cluster Node
A node that runs the complete cluster stack, see Figure 1, “Regular Cluster Stack (Two-Node Cluster)”.
Figure 1: Regular Cluster Stack (Two-Node Cluster) #A regular cluster node may perform the following tasks:
Run cluster resources.
Run all command line tools, such as
crm
,crm_mon
.Execute fencing actions.
Count toward cluster quorum.
Serve as the cluster's designated coordinator (DC).
- Pacemaker Remote (
systemd
service:pacemaker_remote
) A service daemon that makes it possible to use a node as a Pacemaker node without deploying the full cluster stack. Note that
pacemaker_remote
is the name of the systemd service. However, the name of the daemon is pacemaker_remoted (with a trailing d after its name).- Remote Node
A physical machine that runs the
pacemaker_remote
daemon. A special resource (ocf:pacemaker:remote
) needs to run on one of the cluster nodes to manage communication between the cluster node and the remote node (see Section 3, “Use Case 1: Setting Up a Cluster with Remote Nodes”).- Guest Node
A virtual machine that runs the
pacemaker_remote
daemon. A guest node is created using a resource agent such asocf:pacemaker:VirtualDomain
with theremote-node
meta attribute (see Section 4, “Use Case 2: Setting Up a Cluster with Guest Nodes”).For a physical machine that contains several guest nodes, the process is as follows:
On the cluster node, virtual machines are launched by Pacemaker.
The cluster connects to the
pacemaker_remote
service of the virtual machines.The virtual machines are integrated into the cluster by
pacemaker_remote
.
It is important to distinguish between several roles that a virtual machine can take in the High Availability cluster:
A virtual machine can run a full cluster stack. In this case, the virtual machine is a regular cluster node and is not itself managed by the cluster.
A virtual machine can be managed by the cluster as a resource, without the cluster being aware of the services that run inside the virtual machine. In this case, the virtual machine is opaque to the cluster.
A virtual machine can be a cluster resource and run
pacemaker_remote
, which allows the cluster to manage services inside the virtual machine. In this case, the virtual machine is a guest node and is transparent to the cluster.
Remote nodes and guest nodes can run cluster resources and most command line tools. However, they have the following limitations:
They cannot execute fencing actions.
They do not affect quorum.
They cannot serve as Designated Coordinator (DC).
2 Usage Scenario #
The procedures in this document describe the process of setting up a minimal cluster with the following characteristics:
Two cluster nodes running SUSE Linux Enterprise High Availability 12 GA or higher. In this guide, their host names are
alice
andbob
.Depending on the setup you choose, your cluster will end up with one of the following nodes:
One remote node running
pacemaker_remote
(the remote node is namedcharlie
in this document).Or:
One guest node running
pacemaker_remote
(the guest node is nameddoro
in this document).
Pacemaker to manage guest nodes and remote nodes.
Failover of resources from one node to the other if the active host breaks down (active/passive setup).
3 Use Case 1: Setting Up a Cluster with Remote Nodes #
In the following example setup, a remote node
charlie
is used.
3.1 Preparing the Cluster Nodes and the Remote Node #
To prepare the cluster nodes and remote node, proceed as follows:
Install and set up a basic two-node cluster as described in the Article “Installation and Setup Quick Start”. This will lead to a two-node cluster with two physical hosts,
alice
andbob
.On a physical host (
charlie
) that you want to use as remote node, install SUSE Linux Enterprise Server 12 SP5 and add SUSE Linux Enterprise High Availability 12 SP5 as extension. However, do not install the High Availability installation pattern, because the remote node needs only individual packages (see Section 3.3).On all cluster nodes, check
/etc/hosts
and add an entry forcharlie
.
3.2 Configuring an Authentication Key #
On the cluster node alice
proceed as follows:
Create a specific authentication key for the
pacemaker_remote
service:#
mkdir
-p --mode=0755 /etc/pacemaker#
dd
if=/dev/urandom of=/etc/pacemaker/authkey bs=4k count=1The key for the
pacemaker_remote
service is different from the cluster authentication key that you create in the YaST cluster module.Synchronize the authentication key among all cluster nodes and your future remote node with
scp
:#
scp
-r -p /etc/pacemaker/ bob:/etc#
scp
-r -p /etc/pacemaker/ charlie:/etcThe key needs to be kept synchronized all the time.
3.3 Configuring the Remote Node #
The following procedure configures the physical host charlie
as a remote node:
On
charlie
, proceed as follows:In the firewall settings, open the TCP port 3121 for
pacemaker_remote
.Install the pacemaker-remote and crmsh packages:
#
zypper
in pacemaker-remote crmshEnable and start the
pacemaker_remote
service oncharlie
:#
systemctl
enable pacemaker_remote#
systemctl
start pacemaker_remote
On
alice
orbob
, verify the host connection to the remote node by usingssh
:#
ssh
-p 3121 charlieThis SSH connection will fail, but how it fails shows if the setup is working:
- Working Setup
ssh_exhange_identification: read: Connection reset by peer.
- Broken Setup
ssh: connect to host charlie port 3121: No route to host ssh: connect to host charlie port 3121: Connection refused
If you see either of those two messages, the setup does not work. Use the
-v
option forssh
and execute the command again to see debugging messages. This can be helpful to find connection, authentication, or configuration problems. Multiple-v
options increase the verbosity.
If needed, add more remote nodes and configure them as described above.
3.4 Integrating the Remote Node into the Cluster #
To integrate the remote node into the cluster, proceed as follows:
Log in to each cluster node and make sure Pacemaker service is already started:
#
systemctl
start pacemakerOn node
alice
, create aocf:pacemaker:remote
primitive:#
crm
configurecrm(live)configure#
primitive
charlie ocf:pacemaker:remote \ params server=charlie reconnect_interval=15m \ op monitor interval=30scrm(live)configure#
commit
crm(live)configure#
exit
Check the status of the cluster with the command
crm status
. It should contain a running cluster with nodes that are all accessible:#
crm
status [...] Online: [ alice bob ] RemoteOnline: [ charlie ] Full list of resources: charlie (ocf:pacemaker:remote): Started alice [...]
3.5 Starting Resources on the Remote Node #
After the remote node is integrated into the cluster, you can start resources on the remote node in the same way as on any cluster node.
Never involve a remote node connection resource in a resource group, colocation constraint, or order constraint. This may lead to unexpected behavior on cluster transitions.
Fencing Remote Nodes. Remote nodes are fenced in the same way as cluster nodes. Configure fencing resources for use with remote nodes in the same way as with cluster nodes.
Remote nodes do not take part in initiating a fencing action. Only cluster nodes can execute a fencing operation against another node.
4 Use Case 2: Setting Up a Cluster with Guest Nodes #
In the following example setup, KVM is used for setting up the virtual
guest node (doro
).
4.1 Preparing the Cluster Nodes and the Guest Node #
To prepare the cluster nodes and guest node, proceed as follows:
Install and set up a basic two-node cluster as described in the Article “Installation and Setup Quick Start”. This will lead to a two-node cluster with two physical hosts,
alice
andbob
.Create a KVM guest on
alice
. For details refer to https://documentation.suse.com/sles-12/html/SLES-all/cha-kvm-inst.html.On the KVM guest (
doro
) that you want to use as guest node, install SUSE Linux Enterprise Server 12 SP5 and add SUSE Linux Enterprise High Availability 12 SP5 as extension. However, do not install the High Availability installation pattern, because the remote node needs only individual packages (see Section 4.3).On all cluster nodes, check
/etc/hosts
and add an entry fordoro
.
4.2 Configuring an Authentication Key #
On the cluster node alice
proceed as follows:
Create a specific authentication key for the
pacemaker_remote
service:#
mkdir
-p --mode=0755 /etc/pacemaker#
dd
if=/dev/urandom of=/etc/pacemaker/authkey bs=4k count=1The key for the
pacemaker_remote
service is different from the cluster authentication key that you create in the YaST cluster module.Synchronize the authentication key among all cluster nodes and your guest node with
scp
:#
scp
-r -p /etc/pacemaker/ bob:/etc#
scp
-p /etc/pacemaker/ doro:/etcThe key needs to be kept synchronized all the time.
4.3 Configuring the Guest Node #
The following procedure configures doro
as a guest node on your cluster node
alice
:
On
doro
, proceed as follows:In the firewall settings, open the TCP port 3121 for
pacemaker_remote
.Install the pacemaker-remote and crmsh packages:
#
zypper
in pacemaker-remote crmshEnable and start the
pacemaker_remote
service onalice
:#
systemctl
enable pacemaker_remote#
systemctl
start pacemaker_remote
On
alice
orbob
, verify the host connection to the guest by runningssh
:#
ssh
-p 3121 doroThis SSH connection will fail, but how it fails shows if the setup is working:
- Working Setup
ssh_exhange_identification: read: Connection reset by peer.
- Broken Setup
ssh: connect to host doro port 3121: No route to host ssh: connect to host doro port 3121: Connection refused
If you see either of those two messages, the setup does not work. Use the
-v
option forssh
and execute the command again to see debugging messages. This can be helpful to find connection, authentication, or configuration problems. Multiple-v
options increase the verbosity.
If needed, add more guest nodes and configure them as described above.
Shut down the guest node and proceed with Section 4.4, “Integrating a Guest Node into the Cluster”.
4.4 Integrating a Guest Node into the Cluster #
To integrate the guest node into the cluster, proceed as follows:
Log in to each cluster node and make sure Pacemaker service is already started:
#
systemctl
start pacemakerDump the XML configuration of the KVM guest(s) that you need in the next step:
#
virsh
list --all Id Name State ----------------------------------- - doro shut off#
virsh
dumpxml doro > /etc/pacemaker/doro.xmlOn node
alice
, create aVirtualDomain
resource to launch the virtual machine. Use the dumped configuration from Step 2:#
crm
configurecrm(live)configure#
primitive
vm-doro ocf:heartbeat:VirtualDomain \ params hypervisor="qemu:///system" \ config="/etc/pacemaker/doro.xml" \ meta remote-node=doroPacemaker will automatically monitor pacemaker_remote connections for failure, so it is not necessary to create a recurring monitor on the
VirtualDomain
resource.Tip: Enabling live migrationTo enable live migration of the resource, set the meta attribute
allow-migrate
totrue
. The default isfalse
.Check the status of the cluster with the command
crm status
. It should contain a running cluster with nodes that are all accessible.
4.5 Testing the Setup #
To demonstrate how resources are executed, use a dummy resource. It serves for testing purposes only.
Create a dummy resource:
#
crm
configure primitive fake1 ocf:pacemaker:DummyCheck the cluster status with the
crm status
command. You should see something like the following:#
crm
status [...] Online: [ alice bob ] GuestOnline: [ doro@alice ] Full list of resources: vm-doro (ocf:heartbeat:VirtualDomain): Started alice fake1 (ocf:pacemaker:Dummy): Started bobTo move the Dummy primitive to the guest node (
doro
), use the following command:#
crm
resource move fake1 doroThe status will change to this:
#
crm
status [...] Online: [ alice bob ] GuestOnline: [ doro@alice ] Full list of resources: vm-doro (ocf:heartbeat:VirtualDomain): Started alice fake1 (ocf:pacemaker:Dummy): Started doroTo test whether fencing works, kill the
pacemaker_remoted
daemon ondoro
:#
kill
-9 $(pidof pacemaker_remoted)After a few seconds, check the status of the cluster again. It should look like this:
#
crm
status [...] Online: [ alice bob ] Full list of resources: vm-doro (ocf::heartbeat:VirtualDomain): Started alice fake1 (ocf:pacemaker:Dummy): Stopped Failed Actions: * doro_monitor_30000 on alice 'unknown error' (1): call=8, status=Error, exitreason='none', last-rc-change='Tue Jul 18 13:11:51 2017', queued=0ms, exec=0ms
5 Upgrading the Cluster and Pacemaker_remote Nodes #
Upgrade all pacemaker_remote nodes to SUSE Linux Enterprise 12 SP5 one by one and make sure
SUSE Linux Enterprise High Availability 12 SP5 has been added as extension. Update the
packages pacemaker-remote
and
crmsh
including their
dependencies. For details, see Book “Administration Guide”, Chapter 24 “Upgrading Your Cluster and Updating Software Packages”, Section 24.3 “Updating Software Packages on Cluster Nodes”.
It also lists different scenarios and supported upgrade paths in chapter Upgrading Your Cluster and Updating Software Packages.
A GNU licenses #
This appendix contains the GNU Free Documentation License version 1.2.
GNU Free Documentation License #
Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
0. PREAMBLE #
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or non-commercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS #
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING #
You may copy and distribute the Document in any medium, either commercially or non-commercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY #
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS #
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS #
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS #
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS #
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION #
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
9. TERMINATION #
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE #
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents #
Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.