Inicialização Rápida do Geo Clustering #
O Geo Clustering protege as cargas de trabalho nos data centers distribuídos globalmente. Este documento orienta você na configuração básica de um cluster Geográfico usando os scripts de boot Geo incluídos no crm shell.
Copyright © 2006-2024 SUSE LLC e colaboradores. Todos os direitos reservados.
Permissão concedida para copiar, distribuir e/ou modificar este documento sob os termos da Licença GNU de Documentação Livre, Versão 1.2 ou (por sua opção) versão 1.3; com a Seção Invariante sendo estas informações de copyright e a licença. Uma cópia da versão 1.2 da licença está incluída na seção intitulada “GNU Free Documentation License” (Licença GNU de Documentação Livre).
Para ver as marcas registradas da SUSE, visite https://www.suse.com/company/legal/. Todas as marcas registradas de terceiros pertencem aos seus respectivos proprietários. Os símbolos de marca registrada (®, ™ etc.) indicam marcas registradas da SUSE e de suas afiliadas. Os asteriscos (*) indicam marcas registradas de terceiros.
Todas as informações deste manual foram compiladas com a maior atenção possível aos detalhes. Entretanto, isso não garante uma precisão absoluta. A SUSE LLC, suas afiliadas, os autores ou tradutores não serão responsáveis por possíveis erros nem pelas consequências resultantes de tais erros.
1 Visão geral conceitual #
Os clusters Geográficos baseados no SUSE® Linux Enterprise High Availability podem ser considerados clusters “sobrepostos”, em que cada site do cluster corresponde a um nó em um cluster tradicional. O cluster sobreposto é administrado pelo gerenciador de tickets de cluster de booth (mencionado a seguir como booth). Cada uma das partes envolvidas em um cluster Geográfico executa um serviço, o boothd
. Ele se conecta aos daemons de booth executados em outros sites e troca detalhes de conectividade. Para tornar os recursos de cluster altamente disponíveis em todos os sites, o booth usa como base objetos do cluster denominados tickets. Um ticket concede o direito de executar determinados recursos em um site de cluster específico. O booth garante que cada ticket seja concedido a, no máximo, um site por vez.
Se a comunicação entre duas instâncias de booth falhar, talvez seja por causa de uma queda na rede entre os sites do cluster ou uma interrupção de um site do cluster. Neste caso, é necessária uma instância adicional (um terceiro site do cluster ou um arbitrator
) para chegar a um consenso sobre as decisões (por exemplo, failover de recursos em todos os sites). Arbitradores são máquinas únicas (fora dos clusters) que executam uma instância de booth em um modo especial. Cada cluster Geográfico pode ter um ou vários arbitradores.
É possível também executar um cluster Geográfico de dois sites sem um arbitrador. Nesse caso, um administrador de cluster Geográfico precisa gerenciar manualmente os tickets. Se for necessário conceder um ticket a mais de um site ao mesmo tempo, o booth exibirá um aviso.
Para obter mais detalhes sobre o conceito, os componentes e o gerenciamento de tickets usados para clusters Geográficos, consulte o Book “Administration Guide”.
2 Cenário de uso #
Os procedimentos neste documento orientam em relação a um cluster Geográfico básico com dois sites e um arbitrador:
Vamos supor que os nomes dos sites do cluster são
amsterdam
eberlin
.Imagine que cada site tenha dois nós. Os nós
alice
ebob
pertencem ao clusteramsterdam
. Os nóscharlie
edoro
pertencem ao clusterberlin
.O site
amsterdam
tem o seguinte endereço IP virtual:192.168.201.100
.O site
berlin
tem o seguinte endereço IP virtual:192.168.202.100
.Suponha que o arbitrador tenha o seguinte endereço IP:
192.168.203.100
.
Antes de prosseguir, verifique se os seguintes requisitos foram atendidos:
- Dois clusters existentes
Você tem pelo menos dois clusters existentes que deseja combinar em um cluster Geográfico (se você precisar configurar dois clusters primeiro, siga as instruções no Article “Inicialização Rápida de Instalação e Configuração”).
- Nomes de cluster significativos
Cada cluster tem um nome significativo que reflete sua localização, por exemplo:
amsterdam
eberlin
. Os nomes de cluster são definidos em/etc/corosync/corosync.conf
.- Arbitrador
Você instalou uma terceira máquina que não faz parte de nenhum cluster existente e deve ser usada como arbitrador.
Para obter os requisitos detalhados de cada item, consulte também a Seção 3, “Requisitos”.
3 Requisitos #
Todas as máquinas (nós do cluster e arbitradores) precisam, no mínimo, dos seguintes módulos e extensões:
Módulo Basesystem 15 SP6
Módulo Server Applications 15 SP6
SUSE Linux Enterprise High Availability 15 SP6
Ao instalar as máquinas, selecione HA GEO Node
como a system role
. Esse procedimento leva à instalação de um sistema mínimo em que os pacotes do padrão Geo Clustering
for High Availability (ha_geo)
são instalados por padrão.
Os IPs virtuais a serem usados para cada site do cluster devem estar acessíveis no cluster Geográfico.
Os sites devem ser acessíveis em uma porta UDP e TCP por instância de booth. Isso significa que qualquer firewall ou túnel IPsec intermediário deve ser configurado adequadamente.
Outras decisões de configuração podem exigir a abertura de mais portas (por exemplo, para replicação de banco de dados ou do DRBD).
Todos os nós do cluster em todos os sites devem ser sincronizados com um servidor NTP fora do cluster. Para obter mais informações, consulte o Administration Guide for SUSE Linux Enterprise Server 15 SP6.
Se os nós não estiverem sincronizados, será muito difícil de analisar os arquivos de registro e os relatórios do cluster.
Use um número ímpar de sites no cluster Geográfico. Em caso de falha na conexão de rede, esse procedimento garante que ainda exista a maioria dos sites (para evitar um cenário split-brain). Se você tem um número par de sites de cluster, use um arbitrador para processar o failover automático dos tickets. Se você não usar um arbitrador, precisará gerenciar o failover dos tickets manualmente.
O cluster em cada site tem um nome significativo, por exemplo:
amsterdam
eberlin
.Os nomes dos clusters para cada site são definidos nos respectivos arquivos
/etc/corosync/corosync.conf
:totem { [...] cluster_name: amsterdam }
Mude o nome com o seguinte comando crmsh:
#
crm cluster rename NEW_NAME
Pare e inicie os serviços do cluster para as mudanças entrarem em vigor:
#
crm cluster restart
Não há suporte para arquiteturas mistas em um cluster. No entanto, cada membro do cluster Geográfico pode ter uma arquitetura diferente, seja um site de cluster ou um arbitrador. Por exemplo, você pode executar um cluster Geo com três membros (dois sites de cluster e um arbitrador), em que um site de cluster é executado no IBM Z, o outro site de cluster é executado em x86 e o arbitrador é executado no POWER.
4 Visão geral dos scripts de boot Geo #
Com o
crm cluster geo_init
, transforme um cluster no primeiro site de um cluster Geográfico. O script usa parâmetros, como os nomes dos clusters, o arbitrador e um ou vários tickets, e cria o arquivo/etc/booth/booth.conf
com base neles. Ele copia a configuração de booth para todos os nós no site do cluster atual. Ele também configura os recursos de cluster necessários para o booth no site do cluster atual.Para obter os detalhes, consulte a Seção 6, “Configurando o primeiro site de um cluster Geográfico”.
Com o
crm cluster geo_join
, adicione o cluster atual a um cluster Geográfico existente. O script copia a configuração de booth de um site do cluster existente e grava-a no/etc/booth/booth.conf
em todos os nós no site do cluster atual. Ele também configura os recursos de cluster necessários para o booth no site do cluster atual.Para obter os detalhes, consulte a Seção 7, “Adicionando outro site a um cluster Geográfico”.
Com o
crm cluster geo_init_arbitrator
, transforme a máquina atual em um arbitrador para o cluster Geográfico. O script copia a configuração de booth de um site do cluster existente e grava-a no/etc/booth/booth.conf
.Para obter os detalhes, consulte a Seção 8, “Adicionando o arbitrador”.
Todos os scripts de boot são registrados em /var/log/crmsh/crmsh.log
. Consulte o arquivo de registro para obter todos os detalhes do processo de boot. Quaisquer opções definidas durante o processo de boot podem ser modificadas posteriormente (modificando configurações de booth, recursos, etc). Para obter os detalhes, consulte o Book “Administration Guide”.
5 Instalando os pacotes de High Availability e Geo Clustering #
Os pacotes para configurar e gerenciar um cluster Geográfico estão incluídos nos padrões de instalação High Availability
e Geo Clustering for High Availability
. Esses padrões estarão disponíveis somente após a instalação do SUSE Linux Enterprise High Availability.
Você pode se registrar no SUSE Customer Center e instalar o SUSE Linux Enterprise High Availability durante ou após a instalação do SUSE Linux Enterprise Server. Para obter mais informações, consulte o Deployment Guide para SUSE Linux Enterprise Server.
Instale os padrões High Availability e Geo Clustering pela linha de comando:
#
zypper install -t pattern ha_sles ha_geo
Instale os padrões High Availability e Geo Clustering em todas as máquinas que farão parte do cluster.
Nota: Instalando pacotes de software em todos os nósPara uma instalação automatizada do SUSE Linux Enterprise Server 15 SP6 e do SUSE Linux Enterprise High Availability 15 SP6, use o AutoYaST para clonar os nós existentes. Para obter mais informações, consulte o Book “Administration Guide”, Chapter 3 “Installing SUSE Linux Enterprise High Availability”, Section 3.2 “Mass installation and deployment with AutoYaST”.
6 Configurando o primeiro site de um cluster Geográfico #
Use o comando crm cluster geo_init
para transformar um cluster existente no primeiro site de um cluster Geográfico.
amsterdam
) com crm cluster geo_init
#Defina um IP virtual por site do cluster que pode ser usado para acessar o site. Consideramos que
192.168.201.100
e192.168.202.100
são usados para esta finalidade. Você ainda não precisa configurar os IPs virtuais como recursos de cluster. Isso é feito pelos scripts de boot.Defina o nome de pelo menos um ticket que concede o direito de executar determinados recursos em um site do cluster. Use um nome significativo que corresponda aos recursos que dependem do ticket (por exemplo,
ticket-nfs
). Os scripts de boot precisam apenas do nome do ticket. Você pode definir os detalhes restantes (dependências de ticket dos recursos) posteriormente, conforme descrito na Seção 10, “Próximas etapas”.Efetue login no nó de um cluster existente (por exemplo, no nó
alice
do clusteramsterdam
).Executar
crm cluster geo_init
. Por exemplo, use as seguintes opções:#
crm cluster geo_init \ --clusters "amsterdam=192.168.201.100 berlin=192.168.202.100" \
1--tickets ticket-nfs \
2--arbitrator 192.168.203.100
3Os nomes dos sites do cluster (conforme definido em
/etc/corosync/corosync.conf
) e os endereços IP virtuais que você deseja usar para cada site do cluster. Neste caso, temos dois sites do cluster (amsterdam
eberlin
), cada um com um endereço IP virtual.O nome de um ou vários tickets.
O nome de host ou endereço IP de uma máquina fora dos clusters.
O script de boot cria o arquivo de configuração de booth e o sincroniza com os sites do cluster. Ele também cria os recursos de cluster básicos necessários para o booth. A Passo 4 do Procedimento 2 resulta na seguinte configuração de booth e recursos de cluster:
crm cluster geo_init
## The booth configuration file is "/etc/booth/booth.conf". You need to # prepare the same booth configuration file on each arbitrator and # each node in the cluster sites where the booth daemon can be launched. # "transport" means which transport layer booth daemon will use. # Currently only "UDP" is supported. transport="UDP" port="9929" arbitrator="192.168.203.100" site="192.168.201.100" site="192.168.202.100" authfile="/etc/booth/authkey" ticket="ticket-nfs" expire="600"
crm cluster geo_init
#primitive1 booth-ip IPaddr2 \ params rule #cluster-name eq amsterdam ip=192.168.201.100 \ params rule #cluster-name eq berlin ip=192.168.202.100 \ primitive2 booth-site ocf:pacemaker:booth-site \ meta resource-stickiness=INFINITY \ params config=booth \ op monitor interval=10s group3 g-booth booth-ip booth-site \ meta target-role=Stopped4
Um endereço IP virtual para cada site do cluster. Os daemons de booth exigem essa informação, pois precisam de um endereço IP persistente em cada site do cluster. | |
Um recurso primitivo para o daemon de booth. Ele se comunica com os daemons de booth nos outros sites do cluster. O daemon pode ser iniciado em qualquer nó do site. Para fazer com que o recurso permaneça no mesmo nó, se possível, resource-stickiness foi definido como | |
Um grupo de recursos de cluster para ambos os primitivos. Com essa configuração, cada daemon de booth está disponível em seu endereço IP individual, independentemente do nó em que o daemon é executado. | |
O grupo de recursos de cluster não é iniciado por padrão. Depois de verificar a configuração de recursos de cluster (e adicionar os recursos necessários para concluir a configuração), você precisará iniciar o grupo de recursos. Consulte Etapas necessárias para concluir a configuração do cluster Geográfico para obter os detalhes. |
7 Adicionando outro site a um cluster Geográfico #
Depois de inicializar o primeiro site do cluster Geográfico, adicione o segundo cluster com crm cluster geo_join
, conforme descrito no Procedimento 3. O script precisa de acesso SSH a um site do cluster já configurado e adiciona o cluster atual ao cluster Geográfico.
berlin
) com crm cluster geo_join
#Efetue login no nó do site do cluster que você deseja adicionar (por exemplo, no nó
charlie
do clusterberlin
).Execute o comando
crm cluster geo_join
. Por exemplo:#
crm cluster geo_join \ --cluster-node 192.168.201.100\
1--clusters "amsterdam=192.168.201.100 berlin=192.168.202.100"
2Especifica de onde copiar a configuração de booth. Use o nome de host ou endereço IP de um nó em um site do cluster Geográfico já configurado. Você também pode usar o endereço IP virtual de um site do cluster existente (como neste exemplo). Como alternativa, use o nome de host ou endereço IP de um arbitrador já configurado para o cluster Geográfico.
Os nomes dos sites do cluster (conforme definido em
/etc/corosync/corosync.conf
) e os endereços IP virtuais que você deseja usar para cada site do cluster. Neste caso, temos dois sites do cluster (amsterdam
eberlin
), cada um com um endereço IP virtual.
O comando crm cluster geo_join
copia a configuração de booth de 1. Consulte o Exemplo 1. Além disso, ele cria os recursos de cluster necessários para o booth (consulte o Exemplo 2).
8 Adicionando o arbitrador #
Após configurar todos os sites do cluster Geográfico com crm cluster geo_init
e crm cluster geo_join
, configure o arbitrador com crm cluster geo_init_arbitrator
.
crm cluster geo_init_arbitrator
#Efetue login na máquina que você deseja usar como arbitrador.
Execute o seguinte comando. Por exemplo:
#
crm cluster geo_init_arbitrator --cluster-node 192.168.201.100
1Especifica de onde copiar a configuração de booth. Use o nome de host ou endereço IP de um nó em um site do cluster Geográfico já configurado. Se preferir, use o endereço IP virtual de um site do cluster existente (como neste exemplo).
O script crm cluster geo_init_arbitrator
copia a configuração de booth de 1. Consulte o Exemplo 1. Ele também habilita e inicia o serviço de booth no arbitrador. Dessa forma, o arbitrador está pronto para se comunicar com as instâncias de booth nos sites do cluster quando os serviços de booth também são executados neles.
9 Monitorando os sites do cluster #
Para ver os dois sites do cluster com os recursos e o ticket que você criou durante o processo de boot, use o Hawk2. A interface da Web do Hawk2 permite monitorar e gerenciar vários clusters (não relacionados) e clusters Geo.
Todos os clusters que serão monitorados do
do Hawk2 devem executar o SUSE Linux Enterprise High Availability 15 SP6.Se você ainda não substituiu o certificado autoassinado do Hawk2 em cada nó do cluster pelo seu próprio certificado (ou um certificado assinado por uma Autoridade de Certificação oficial), faça o seguinte: efetue login no Hawk2 em cada nó em cada cluster pelo menos uma vez. Verifique o certificado (ou adicione uma exceção ao browser para ignorar o aviso). Do contrário, o Hawk2 não poderá se conectar ao cluster.
Inicie um browser da Web e insira o IP virtual do seu primeiro site do cluster,
amsterdam
:https://192.168.201.100:7630/
Se preferir, use o nome de host ou endereço IP de
alice
oubob
. Se você configurou ambos os nós com os scripts de boot, o serviçohawk
deve ser executado em ambos os nós.Efetue login na interface da Web do Hawk2.
Na barra de navegação esquerda, selecione
.O Hawk2 mostra uma visão geral dos recursos e nós no site do cluster atual. Ele também mostra quaisquer
que foram configurados para o cluster Geográfico. Se você precisar de informações sobre os ícones usados nesta tela, clique em .Figura 2: Painel de controle do Hawk2 com um site do cluster (amsterdam
) #Para adicionar um painel de controle para o segundo site do cluster, clique em
.Insira o
para identificá-lo no . Neste caso,berlin
.Insira o nome completo do host de um dos nós do cluster (neste caso,
charlie
oudoro
).Clique em
. O Hawk2 exibe uma segunda guia para o site do cluster recém-adicionado com uma visão geral de seus nós e recursos.Figura 3: Painel de controle do Hawk2 com os dois sites do cluster #
Para ver mais detalhes para um site do cluster ou para gerenciá-lo, alterne para a guia do site e clique no ícone de corrente.
O Hawk2 abre a tela
referente a esse site em uma nova janela ou guia do browser. Neste local, você pode administrar esta parte do cluster Geográfico.
10 Próximas etapas #
Os scripts de boot de cluster Geográfico são um meio rápido para configurar um cluster Geográfico básico que pode ser usado para fins de teste. No entanto, para mover o cluster Geográfico resultante para um cluster Geográfico funcional que possa ser usado em ambientes de produção, mais etapas são necessárias.
- Iniciando os serviços de booth nos sites do cluster
Após o processo de boot, o serviço de booth do arbitrador ainda não poderá se comunicar com os serviços de booth nos sites do cluster, porque eles não são iniciados por padrão.
O serviço de booth para cada site do cluster é gerenciado pelo grupo de recursos de booth
g-booth
(consulte o Exemplo 2, “Recursos de cluster criados porcrm cluster geo_init
”). Para iniciar uma instância do serviço de booth por site, inicie o respectivo grupo de recursos de booth em cada site do cluster. Isso permite que todas as instâncias de booth se comuniquem umas com as outras.- Configurando dependências de ticket e restrições de pedidos
Para tornar os recursos dependentes do ticket que você criou durante o processo de boot do cluster Geográfico, configure restrições. Para cada restrição, defina uma
loss-policy
, que define o que deverá acontecer com os respectivos recursos se o ticket for revogado de um site do cluster.Para obter os detalhes, consulte o Book “Geo Clustering Guide”, Chapter 6 “Configuring cluster resources and constraints”.
- Concedendo inicialmente um ticket a um site
Antes que o booth possa gerenciar determinado ticket no cluster Geográfico, você precisa concedê-lo a um site manualmente. Você pode usar a ferramenta de linha de comando do cliente de booth ou o Hawk2 para conceder um ticket.
Para obter detalhes, leia o Book “Geo Clustering Guide”, Chapter 8 “Managing Geo clusters”.
Os scripts de boot criam os mesmos recursos de booth em ambos os sites do cluster, e os mesmos arquivos de configuração de booth em todos os sites, incluindo o arbitrador. Se você estender a configuração do cluster Geo (para mover para um ambiente de produção), provavelmente ajustará a configuração de booth e também mudará a configuração dos recursos de cluster relacionados ao booth. Depois disso, será necessário sincronizar as mudanças com os outros sites do cluster Geográfico para entrarem em vigor.
Para sincronizar as alterações na configuração de booth com todos os sites do cluster (incluindo o arbitrador), use o Csync2. Encontre mais informações no Book “Geo Clustering Guide”, Chapter 5 “Synchronizing configuration files across all sites and arbitrators”.
O CIB (Cluster Information Database) não é sincronizado automaticamente com todos os sites de um cluster Geográfico. Isso significa que quaisquer mudanças na configuração de recursos necessárias em todos os sites do cluster precisam ser transferidas para os outros sites manualmente. Para isso, marque os respectivos recursos, exporte-os do CIB atual e importe-os para o CIB nos outros sites do cluster. Para obter os detalhes, consulte o Book “Geo Clustering Guide”, Chapter 6 “Configuring cluster resources and constraints”, Section 6.4 “Transferring the resource configuration to other cluster sites”.
11 Para obter mais informações #
Há mais documentação para este produto disponível em https://documentation.suse.com/sle-ha/. Para ver outras tarefas de configuração e de administração, consulte o Geo Clustering Guide completo.
Encontre informações sobre replicação de dados nos clusters Geográficos pelo DRBD no seguinte SUSE Best Practices document.
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.