Riferimento rapido per l'installazione e la configurazione #
SUSE Linux Enterprise High Availability Extension 15 SP2
Questo documento guida l'utente attraverso la procedura di configurazione di un modello base di cluster a due nodi mediante gli script di bootstrap forniti insieme al pacchetto ha-cluster-bootstrap
. È prevista la configurazione di un indirizzo IP virtuale come risorsa cluster e l'uso di SBD nell'archiviazione condivisa come meccanismo di isolamento dei nodi.
1 Scenario di utilizzo #
Le procedure descritte in questo documento prevedono una configurazione minima di un cluster a due nodi con le seguenti proprietà:
Due nodi:
alice
(IP:192.168.1.1
) ebob
(IP:192.168.1.2
), connessi l'uno all'altro tramite rete.Un indirizzo IP virtuale mobile (
192.168.2.1
) che consente ai client di connettersi al servizio indipendentemente dal nodo fisico sul quale è in esecuzione.Un dispositivo di archiviazione condiviso, utilizzato come meccanismo di isolamento SBD. In questo modo si evitano situazioni di split brain.
Failover di risorse da un nodo all'altro in caso di mancato funzionamento dell'host attivo (configurazione attiva/passiva).
Dopo aver configurato il cluster con gli script di bootstrap, il cluster verrà monitorato con Hawk2 grafico. Questo è uno degli strumenti di gestione dei cluster inclusi in SUSE® Linux Enterprise High Availability Extension. Per verificare se il failover delle risorse funziona, uno dei nodi verrà impostato in modalità standby controllando che l'indirizzo IP virtuale venga migrato al secondo nodo.
È possibile utilizzare il cluster a due nodi a scopo di prova o come configurazione minima del cluster con la possibilità di estenderla in un secondo momento. Prima di utilizzare il cluster in un ambiente di produzione, modificarlo secondo i propri requisiti.
2 Requisiti di sistema #
In questa sezione vengono descritti i requisiti di sistema fondamentali per lo scenario descritto nella Sezione 1. Per regolare il cluster per l'uso in un ambiente di produzione, fare riferimento all'elenco completo nel Book “Administration Guide”, Chapter 2 “System Requirements and Recommendations”.
2.1 Requisiti hardware #
- Server
Due server con software secondo quanto specificato nella Sezione 2.2, «Requisiti del software».
I server possono essere bare metal o macchine virtuali. Non sono necessari gli stessi requisiti hardware (memoria, spazio su disco ecc.), ma devono avere la stessa architettura. I cluster multipiattaforma non sono supportati.
- Canali di comunicazione
Almeno due moduli di comunicazione TCP/IP per nodo cluster. Le apparecchiature di rete devono supportare i mezzi di comunicazione che si desidera utilizzare per la comunicazione cluster: multicast o unicast. I moduli di comunicazione devono supportare una velocità dati di 100 Mbit/s o superiore. Per la configurazione di un cluster supportato, sono necessari almeno due percorsi di comunicazione ridondanti. La configurazione può essere eseguita tramite:
Associazione dei dispositivi di rete (preferita).
Un secondo canale di comunicazione in Corosync.
- Isolamento dei nodi/STONITH
Per evitare una situazione di «split brain», i cluster richiedono un meccanismo di isolamento dei nodi. In una situazione split brain, i nodi del cluster sono divisi in due o più gruppi, ciascuno dei quali non è al corrente della presenza degli altri (a causa di un guasto hardware o software o di un'interruzione della rete). Un meccanismo di isolamento isola il nodo in questione (generalmente eseguendo il reset del nodo o spegnendolo). Tale meccanismo prende anche il nome di STONITH («Shoot the other node in the head»). Un meccanismo di isolamento dei nodi può essere un dispositivo fisico (un interruttore di alimentazione) o un meccanismo come SBD (STONITH by disk) abbinato a un watchdog. L'utilizzo di SBD richiede l'archiviazione condivisa.
2.2 Requisiti del software #
Tutti i nodi che fanno parte del cluster richiedono almeno i seguenti moduli ed estensioni:
Base System Module 15 SP2
Server Applications Module 15 SP2
SUSE Linux Enterprise High Availability Extension 15 SP2
2.3 Altri requisiti e raccomandazioni #
- Sincronizzazione dell'orario
I nodi del cluster devono sincronizzarsi a un server NTP al di fuori del cluster. A partire da SUSE Linux Enterprise High Availability Extension 15, chrony è l'implementazione di default di NTP. Per ulteriori informazioni, vedere l' Administration Guide for SUSE Linux Enterprise Server 15 SP2 (Guida all'amministrazione di SUSE Linux Enterprise Server 15 SP2).
Se i nodi non sono sincronizzati, il cluster potrebbe non funzionare correttamente. Inoltre, i file di registro e i report dei cluster sono particolarmente difficili da analizzare in assenza di sincronizzazione. Se si utilizzano gli script di bootstrap, l'utente verrà avvisato nel caso in cui l'NTP non fosse ancora stato configurato.
- Nome host e indirizzo IP
Utilizzare indirizzi IP statici.
Elencare tutti i nodi del cluster nel file
/etc/hosts
con il relativo nome host completo e breve. È fondamentale che i membri del cluster possano cercarsi per nome. Se i nomi non sono disponibili, non sarà possibile garantire la comunicazione interna al cluster.
- SSH
Tutti nodi del cluster devono essere in grado di accedere agli altri tramite SSH. Strumenti quali
report crm
(per la risoluzione dei problemi) e Hawk2's richiedono l'accesso SSH senza password tra i nodi, altrimenti possono solo raccogliere dati dal nodo corrente.Se per configurare il cluster si utilizzano gli script di bootstrap, le chiavi SSH verranno create e copiate automaticamente.
3 Panoramica degli script di bootstrap #
Tutti i comandi del pacchetto ha-cluster-bootstrap eseguono script di bootstrap che richiedono tempi e interventi manuali ridotti al minimo.
Con
ha-cluster-init
, è possibile definire i parametri fondamentali necessari per la comunicazione del cluster. In questo modo all'utente rimane un cluster a un nodo in esecuzione.Con
ha-cluster-join
, è possibile aggiungere più nodi al proprio cluster.Con
ha-cluster-remove
, è possibile rimuovere nodi dal proprio cluster.
Tutti gli script di bootstrap effettuano l'accesso a /var/log/ha-cluster-bootstrap.log
. Consultare questo file per eventuali dettagli sul processo di bootstrap. Tutte le opzioni impostate durante il processo di bootstrap possono essere modificate in un secondo momento con il modulo cluster YaST. Per ulteriori informazioni, vedere Book “Administration Guide”, Chapter 4 “Using the YaST Cluster Module”.
Ogni script è dotato di una documentazione completa di tutte le funzioni, le opzioni di script e una panoramica dei file che è possibile creare e modificare con lo script.
Lo script di bootstrap ha-cluster-init
controlla e configura i seguenti componenti:
- NTP
Se NTP non è stato configurato per essere avviato al momento del riavvio, viene visualizzato un messaggio. A partire da SUSE Linux Enterprise High Availability Extension 15, chrony è l'implementazione di default di NTP.
- SSH
Crea chiavi SSH per l'accesso senza password tra nodi del cluster.
- Csync2
Configura Csync2 per replicare file di configurazione attraverso tutti i nodi in un cluster.
- Corosync
Configura il sistema di comunicazione del cluster.
- SBD/Watchdog
Verifica che sia presente un watchdog e chiede all'utente se configurare SBD come meccanismo di isolamento dei nodi.
- IP virtuale mobile
Chiede all'utente se configurare un indirizzo IP virtuale per l'amministrazione del cluster con Hawk2.
- Firewall
Apre le porte nel firewall che sono necessarie per la comunicazione del cluster.
- Nome cluster
Definisce un nome per il cluster, per default
hacluster
. Facoltativo e utile per i cluster Geo. Di solito, il nome del cluster riflette l'ubicazione e semplifica la distinzione di un sito all'interno di un cluster Geo.
4 Installazione di SUSE Linux Enterprise High Availability Extension #
I pacchetti per la configurazione e la gestione di un cluster con High Availability Extension sono inclusi nel modello di installazione High Availability
(denominato sles_ha
sulla riga di comando). Questo schema è disponibile solo dopo aver installato SUSE Linux Enterprise High Availability Extension come estensione di SUSE® Linux Enterprise Server.
Per informazioni su come installare le estensioni, vedere la Deployment Guide for SUSE Linux Enterprise Server 15 SP2 (Guida alla distribuzione di SUSE Linux Enterprise Server 15 SP2).
High Availability
#Se il pattern non è ancora installato, attenersi alla seguente procedura:
Installarlo dalla riga di comando utilizzando il comando Zypper:
root #
zypper
install -t pattern ha_slesInstallare il pattern Alta disponibilità su tutte le macchine che faranno parte del cluster.
Nota: installazione dei pacchetti software su tutte le entitàPer un'installazione automatizzata di SUSE Linux Enterprise Server 15 SP2 e SUSE Linux Enterprise High Availability Extension 15 SP2, utilizzare AutoYaST per clonare i nodi esistenti. Per ulteriori informazioni, vedere Book “Administration Guide”, Chapter 3 “Installing SUSE Linux Enterprise High Availability”, Section 3.2 “Mass Installation and Deployment with AutoYaST”.
Registrare le macchine nel SUSE Customer Center. Ulteriori informazioni sono disponibili nella Upgrade Guide for SUSE Linux Enterprise Server 15 SP2 (Guida all'upgrade di SUSE Linux Enterprise Server 15 SP2).
5 Utilizzo di SBD come meccanismo di isolamento #
Se si è condiviso lo storage, ad esempi una SAN (Storage Area Network), è possibile utilizzarlo per evitare scenari split- brain. A tal fine, configurare SBD come meccanismo di isolamento dei nodi. SBD utilizza il supporto watchdog e l'agente della risorsa STONITH external/sbd
.
5.1 Requisiti per SBD #
Durante la configurazione del primo nodo con ha-cluster-init
, è possibile decidere se utilizzare SBD. In tal caso, è necessario inserire il percorso al dispositivo di archiviazione condivisa. Per impostazione predefinita, ha-cluster-init
creerà automaticamente una piccola partizione sul dispositivo da utilizzare per SBD.
Per utilizzare SBD, è necessario soddisfare i seguenti requisiti:
Il percorso al dispositivo di archiviazione condivisa deve essere persistente e coerente attraverso tutti i nodi nel cluster. Utilizzare nomi di dispositivi stabili come
/dev/disk/by-id/dm-uuid-part1-mpath-abcedf12345
.Il dispositivo SBD non deve utilizzare RAID basati su host, LVM2, né risiedere su un'istanza DRBD*.
Per maggiori dettagli su come configurare un'archiviazione condivisa, consultare la Storage Administration Guide for SUSE Linux Enterprise Server 15 SP2 (Guida all'amministrazione dello storage di SUSE Linux Enterprise Server 15 SP2).
5.2 Abilitazione della sorveglianza Softdog per SBD #
In SUSE Linux Enterprise Server, il supporto watchdog nel kernel è abilitato di default: viene garantito con numerosi moduli kernel che forniscono driver watchdog specifici all'hardware. High Availability Extension utilizza il daemon SBD come componente software che «alimenta» il watchdog.
La procedura descritta di seguito utilizza il watchdog softdog
.
Il driver softdog suppone che almeno una CPU sia ancora in esecuzione. Se tutte le CPU sono bloccate, il codice nel driver softdog che dovrebbe riavviare il sistema non viene mai eseguito. Al contrario, i watchdog hardware continuano a funzionare anche se tutte le CPU sono bloccate.
Prima di utilizzare il cluster in un ambiente di produzione, si consiglia di sostituire il modulo softdog
con il rispettivo modulo hardware più adatto all'hardware in uso.
Tuttavia, se nessun watchdog corrisponde all'hardware in uso, è possibile utilizzare softdog
come modulo watchdog del kernel.
Creare un'archiviazione condivisa persistente, come descritto nella Sezione 5.1, «Requisiti per SBD».
Abilitare il watchdog softdog:
root #
echo
softdog > /etc/modules-load.d/watchdog.confroot #
systemctl
restart systemd-modules-loadControllare che il modulo softdog sia caricato correttamente:
root #
lsmod
| grep dog softdog 16384 1
Si consiglia vivamente di testare il meccanismo di isolamento SBD per impedire uno scenario split. Tale verifica può essere effettuata bloccando la comunicazione del cluster Corosync.
6 Configurazione del primo nodo #
Configurare il primo nodo con lo script ha-cluster-init
. Il tempo e l'intervento manuale necessari sono ridotti al minimo.
alice
) con ha-cluster-init
#Accedere come
root
alla macchina fisica o virtuale da utilizzare come nodo cluster.Avviare lo script di bootstrap eseguendo:
root #
ha-cluster-init
--name CLUSTERNAMESostituire il segnaposto CLUSTERNAME con un nome significativo, come la posizione geografica del cluster (ad esempio,
amsterdam
). Questo risulta particolarmente utile per creare in seguito un cluster Geo, in quanto semplifica l'identificazione di un sito.Se per la comunicazione cluster occorre unicast invece di multicast (predefinito), utilizzare l'opzione
-u
. Dopo l'installazione, individuare il valoreudpu
nel file/etc/corosync/corosync.conf
. Seha-cluster-init
rileva un nodo in esecuzione su Amazon Web Services (AWS), lo script utilizza unicast automaticamente come predefinito per la comunicazione del cluster.Lo script verifica la configurazione NTP e un servizio di watchdog hardware. Genera le chiavi SSH pubbliche e private utilizzate per l'accesso SSH e la sincronizzazione Csync2 e avvia i rispettivi servizi.
Configurare il livello di comunicazione del cluster (Corosync):
Immettere un indirizzo di rete al quale collegarlo. Per default, lo script proporrà l'indirizzo di rete di
eth0
. In alternativa, immettere un altro indirizzo di rete, ad esempio l'indirizzo dibond0
.Immettere un indirizzo multicast. Lo script propone un accesso casuale da utilizzare come default. Naturalmente, l'indirizzo multicast deve essere supportato dalla propria rete.
Immettere una porta multicast. Lo script propone
5405
come default.
Configurare SBD come meccanismo di isolamento dei nodi:
Confermare con
s
che si desidera utilizzare SBD.Immettere un percorso persistente nella partizione del proprio dispositivo di blocco che si desidera utilizzare per SBD, vedere Sezione 5, «Utilizzo di SBD come meccanismo di isolamento». Il percorso deve essere coerente attraverso tutti i nodi nel cluster.
Configurare un indirizzo IP virtuale per l'amministrazione del cluster con Hawk2 (Questa risorsa IP virtuale verrà utilizzata più avanti per verificare il corretto completamento del failover).
Confermare con
s
che si desidera configurare un indirizzo IP virtuale.Immettere un indirizzo IP inutilizzato da utilizzare come IP di amministrazione per Hawk2:
192.168.2.1
Anziché accedere a un singolo nodo del cluster con Hawk2, è possibile connettersi all'indirizzo IP virtuale.
Infine, lo script avvierà il servizio Pacemaker per portare il cluster online e abilitare Hawk2. L'URL da utilizzare per Hawk2 viene visualizzato sullo schermo.
A questo punto è in esecuzione un cluster a un nodo. Per visualizzarne lo stato, attenersi alla seguente procedura:
Su un computer, avviare un browser Web e assicurarsi che JavaScript e i cookie siano abilitati.
Come URL, immettere l'indirizzo IP o il nome host di un nodo del cluster sul quale è in esecuzione il servizio Web di Hawk. In alternativa, immettere l'indirizzo dell'indirizzo IP virtuale configurato nel Passo 5 della Procedura 2, «Configurazione del primo nodo (
alice
) conha-cluster-init
»:https://HAWKSERVER:7630/
Nota: avviso certificatoSe quando si tenta di accedere all'URL per la prima volta, viene visualizzato un avviso certificato significa che è in uso un certificato firmato da se stessi. I certificati firmati da se stessi non sono considerati attendibili per default.
Chiedere i dettagli del certificato all'operatore del cluster per verificare il certificato.
Per continuare ignorando l'avviso, è possibile aggiungere un'eccezione nel browser.
Nella schermata di accesso Hawk2, immettere il
e la dell'utente che è stato creato durante la procedura di bootstrap (utentehacluster
, passwordlinux
).Importante: password di protezioneSostituire la password di default con una di protezione non appena possibile:
root #
passwd
haclusterFare clic su
. Dopo il login, l'interfaccia Web di Hawk2 mostra di default la schermata Stato, visualizzando rapidamente lo stato corrente del cluster:Figura 1: Stato del cluster a un nodo in Hawk2 #
7 Aggiunta del secondo nodo #
Se un cluster a un nodo è installato e in funzione, aggiungere il secondo nodo del cluster con lo script di bootstrap ha-cluster-join
, come descritto nella Procedura 4. Lo script deve accedere solo a un nodo del cluster esistente e completerà automaticamente la configurazione di base nel computer corrente. Per informazioni più dettagliate, vedere la documentazione ha-cluster-join
.
Gli script di bootstrap si occupano delle modifiche alla configurazione specifiche a un cluster a due nodi, ad esempio, SBD e Corosync.
bob
) con ha-cluster-join
#Accedere come
root
alla macchina virtuale o fisica che si prevede di aggiungere al cluster.Avviare lo script di bootstrap eseguendo:
root #
ha-cluster-join
Se NTP non è stato configurato per essere avviato al momento del riavvio, viene visualizzato un messaggio. Lo script verifica inoltre l'eventuale presenza di un dispositivo di sorveglianza hardware (importante se si desidera configurare SBD). Se non è presente alcun dispositivo l'utente viene avvisato.
Se si decide di continuare comunque, verrà richiesto l'indirizzo IP di un nodo esistente. Immettere l'indirizzo IP del primo nodo (
alice
,192.168.1.1
).Se non è già stato configurato un accesso SSH senza password tra entrambe le macchine, verrà richiesta la password
root
del nodo esistente.Una volta effettuato l'accesso al nodo specificato, lo script copierà la configurazione Corosync, configurerà SSH e Csync2 e porterà la macchina corrente online come nuovo nodo del cluster. Oltre a quello, avvierà il servizio necessario per Hawk2.
Controllare lo stato del cluster in Hawk2. In Figura 2, «Stato del cluster a due nodi»).
› si dovrebbero vedere due nodi con uno stato di colore verde (vedere8 Test del cluster #
Sezione 8.1, «Test del failover delle risorse» è un semplice test per verificare se il cluster sposta l'indirizzo IP virtuale nell'altro nodo nel caso in cui il nodo sul quale è attualmente in esecuzione la risorsa è impostato su standby
.
Tuttavia, un test realistico implica casi e scenari di utilizzo specifici, incluso il test del proprio meccanismo di isolamento per evitare una situazione di split brain. Se il meccanismo di isolamento non è stato configurato correttamente, il cluster non funzionerà adeguatamente.
Prima di utilizzare il cluster in un ambiente di produzione, testarloSono presenti risorse avviate, in base ai casi d'uso o servendosi dello script ha-cluster-preflight-check
.
8.1 Test del failover delle risorse #
La procedura seguente è un test rapido per la verifica del failover delle risorse:
Aprire un terminale ed effettuare il ping del proprio indirizzo IP virtuale,
192.168.2.1
:root #
ping
192.168.2.1Accedere al proprio cluster come descritto nella Procedura 3, «Accesso all'interfaccia Web di Hawk2».
In Hawk2
› , verificare su quale nodo è in esecuzione l'indirizzo IP virtuale (risorsaadmin_addr
). Si presume che la risorsa sia in esecuzione sualice
.Impostare
alice
in modalità (vedere Figura 3, «Nodoalice
in modalità Standby»).Figura 3: Nodoalice
in modalità Standby #Fare clic su
› . La risorsaadmin_addr
è stata migrata inbob
.
Durante la migrazione, si dovrebbe vedere un flusso ininterrotto di ping verso l'indirizzo IP virtuale indicante che la configurazione del cluster e l'indirizzo IP mobile funzionano correttamente. Annullare il comando ping
con Ctrl– C.
8.2 Come effettuare il test con il comando ha-cluster-preflight-check #
Il comando ha-cluster-preflight-check
consente di eseguire dei test standardizzati su un cluster. Provoca errori nel cluster e verifica la configurazione al fine di individuare eventuali problemi. Prima di utilizzare il cluster nell'ambiente di produzione, si consiglia di utilizzare questo comando per assicurarsi che tutto funzioni come previsto.
Il comando supporta i controlli seguenti:
Controllo dell'ambiente
-e
/--env-check
. Questo test consente di controllare quanto segue:I nomi host sono risolvibili?
Il servizio orario è stato abilitato e avviato?
La sorveglianza è stata configurata per il nodo corrente?
Il servizio
firewall
è stato avviato e le porte relative al cluster sono aperte?
Controllo dello stato del cluster
-c
/--cluster-check
. Consente di controllare i diversi stati e servizi del cluster. Questo test consente di controllare quanto segue:I servizi del cluster (Pacemaker/Corosync) sono abilitati e in esecuzione?
STONITH è abilitato? Consente di controllare inoltre se le risorse relative a STONITH sono state configurate e avviate. Se SBD è stato configurato, il relativo servizio è stato avviato?
Il cluster dispone di un quorum? Mostra i nodi DC correnti e quelli online, offline e non corretti.
Sono presenti risorse avviate, interrotte o con errori?
Controllo split-brain
--split-brain-iptables
. Simula uno scenario split-brain tramite il blocco della porta Corosync. Consente di controllare se è possibile applicare una recinzione a un nodo come previsto.Termina i daemon per SBD, Corosync e Pacemaker
-kill-sbd
/-kill-corosync
/-kill-pacemakerd
. In seguito all'esecuzione di questo test, in/var/lib/ha-cluster-preflight-check
è possibile trovare un rapporto con la descrizione del caso di prova, la registrazione delle operazioni e la spiegazione dei risultati possibili.Controllo del nodo con recinzione
--fence-node
. Consente di applicare una recinzione a un nodo specifico trasmesso dalla riga di comando.
Ad esempio, per testare l'ambiente, eseguire:
root #
crm_mon -1
Stack: corosync Current DC: alice (version ...) - partition with quorum Last updated: Fri Mar 03 14:40:21 2020 Last change: Fri Mar 03 14:35:07 2020 by root via cibadmin on alice 2 nodes configured 1 resource configured Online: [ alice bob ] Active resources: stonith-sbd (stonith:external/sbd): Started aliceroot #
ha-cluster-preflight-check
-e [2020/03/20 14:40:45]INFO: Checking hostname resolvable [Pass] [2020/03/20 14:40:45]INFO: Checking time service [Fail] INFO: chronyd.service is available WARNING: chronyd.service is disabled WARNING: chronyd.service is not active [2020/03/20 14:40:45]INFO: Checking watchdog [Pass] [2020/03/20 14:40:45]INFO: Checking firewall [Fail] INFO: firewalld.service is available WARNING: firewalld.service is not active
È possibile esaminare il risultato in /var/log/ha-cluster-preflight-check.log
.
9 Ulteriori informazioni #
Maggiore documentazione per questo prodotto è disponibile su https://documentation.suse.com/sle-ha/15-SP2. Per altre attività di configurazione e amministrazione, vedere la Guida all'amministrazione completa.
10 Note legali #
Copyright © 2006– 2023 SUSE LLC e collaboratori. Tutti i diritti riservati.
L'autorizzazione per la copia, la distribuzione e/o la modifica di questo documento è soggetta ai termini indicati nella licenza GFDL (GNU Free Documentation License), versione 1.2 oppure, a scelta, 1.3, di cui la presente licenza e le presenti informazioni sul copyright rappresentano la sezione non variabile. Una copia della licenza versione 1.2 è inclusa nella sezione intitolata «GNU Free Documentation License».
Per i marchi di fabbrica SUSE vedere http://www.suse.com/company/legal/. Tutti gli altri marchi di fabbrica di terze parti sono proprietà dei rispettivi titolari. I simboli di marchio di fabbrica (®, ™ e così via) indicano i marchi di fabbrica appartenenti a SUSE e alle rispettive affiliate. Gli asterischi (*) indicano i marchi di fabbrica di terze parti.
Tutte le informazioni nella presente pubblicazione sono state compilate con la massima attenzione ai dettagli. Ciò, tuttavia, non garantisce una precisione assoluta. SUSE LLC, le rispettive affiliate, gli autori e i traduttori non potranno essere ritenuti responsabili di eventuali errori o delle relative conseguenze.
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 http://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.