diff --git a/doc/sphinx/Clusters_from_Scratch/images/Console.png b/doc/sphinx/Clusters_from_Scratch/images/Console.png deleted file mode 100644 index 27529de0bb..0000000000 Binary files a/doc/sphinx/Clusters_from_Scratch/images/Console.png and /dev/null differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/ConsolePrompt.png b/doc/sphinx/Clusters_from_Scratch/images/ConsolePrompt.png new file mode 100644 index 0000000000..606280b967 Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/ConsolePrompt.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/Editing-eth0.png b/doc/sphinx/Clusters_from_Scratch/images/Editing-eth0.png deleted file mode 100644 index d9ba68ebeb..0000000000 Binary files a/doc/sphinx/Clusters_from_Scratch/images/Editing-eth0.png and /dev/null differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/InstallationSummary.png b/doc/sphinx/Clusters_from_Scratch/images/InstallationSummary.png new file mode 100644 index 0000000000..01bf8625a8 Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/InstallationSummary.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/Installer.png b/doc/sphinx/Clusters_from_Scratch/images/Installer.png deleted file mode 100644 index fb35f1c849..0000000000 Binary files a/doc/sphinx/Clusters_from_Scratch/images/Installer.png and /dev/null differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/ManualPartitioning.png b/doc/sphinx/Clusters_from_Scratch/images/ManualPartitioning.png new file mode 100644 index 0000000000..83a8b9485a Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/ManualPartitioning.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/NetworkAndHostName.png b/doc/sphinx/Clusters_from_Scratch/images/NetworkAndHostName.png new file mode 100644 index 0000000000..16245efb69 Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/NetworkAndHostName.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/Partitioning.png b/doc/sphinx/Clusters_from_Scratch/images/Partitioning.png deleted file mode 100644 index e379aa6b01..0000000000 Binary files a/doc/sphinx/Clusters_from_Scratch/images/Partitioning.png and /dev/null differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/RootPassword.png b/doc/sphinx/Clusters_from_Scratch/images/RootPassword.png new file mode 100644 index 0000000000..83ebb5b3eb Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/RootPassword.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/SoftwareSelection.png b/doc/sphinx/Clusters_from_Scratch/images/SoftwareSelection.png new file mode 100644 index 0000000000..26ae1bc038 Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/SoftwareSelection.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/Welcome.png b/doc/sphinx/Clusters_from_Scratch/images/Welcome.png deleted file mode 100644 index f44ba434d3..0000000000 Binary files a/doc/sphinx/Clusters_from_Scratch/images/Welcome.png and /dev/null differ diff --git a/doc/sphinx/Clusters_from_Scratch/images/WelcomeToCentos.png b/doc/sphinx/Clusters_from_Scratch/images/WelcomeToCentos.png new file mode 100644 index 0000000000..ae9879c740 Binary files /dev/null and b/doc/sphinx/Clusters_from_Scratch/images/WelcomeToCentos.png differ diff --git a/doc/sphinx/Clusters_from_Scratch/installation.rst b/doc/sphinx/Clusters_from_Scratch/installation.rst index f5dcc7d1e8..595f8a7bbc 100644 --- a/doc/sphinx/Clusters_from_Scratch/installation.rst +++ b/doc/sphinx/Clusters_from_Scratch/installation.rst @@ -1,408 +1,433 @@ Installation ------------ Install |CFS_DISTRO| |CFS_DISTRO_VER| ################################################################################################ Boot the Install Image ______________________ -Download the 4GB |CFS_DISTRO| |CFS_DISTRO_VER| `DVD ISO `_. +Download the 8.9GB |CFS_DISTRO| |CFS_DISTRO_VER| `DVD ISO `_. Use the image to boot a virtual machine, or burn it to a DVD or USB drive and boot a physical server from that. After starting the installation, select your language and keyboard layout at the welcome screen. -.. figure:: images/Welcome.png +.. figure:: images/WelcomeToCentos.png :scale: 80% :width: 1024 :height: 800 :align: center :alt: Installation Welcome Screen |CFS_DISTRO| |CFS_DISTRO_VER| Installation Welcome Screen Installation Options ____________________ At this point, you get a chance to tweak the default installation options. -.. figure:: images/Installer.png +.. figure:: images/InstallationSummary.png :scale: 80% :width: 1024 :height: 800 :align: center :alt: Installation Summary Screen |CFS_DISTRO| |CFS_DISTRO_VER| Installation Summary Screen -Ignore the **SOFTWARE SELECTION** section (try saying that 10 times quickly). The -**Infrastructure Server** environment does have add-ons with much of the software -we need, but we will leave it as a **Minimal Install** here, so that we can see -exactly what software is required later. +Click on the **SOFTWARE SELECTION** section (try saying that 10 times quickly). The +default environment, **Server with GUI**, does have add-ons with much of the software +we need, but we will change the environment to a **Minimal Install** here, so that we +can see exactly what software is required later, and press **Done**. + +.. figure:: images/SoftwareSelection.png + :scale: 80% + :width: 1024 + :height: 800 + :align: center + :alt: Software Selection Screen + + |CFS_DISTRO| |CFS_DISTRO_VER| Software Selection Screen Configure Network _________________ In the **NETWORK & HOSTNAME** section: - Edit **Host Name:** as desired. For this example, we will use - **pcmk-1.localdomain**. -- Select your network device, press **Configure...**, and manually assign a fixed - IP address. For this example, we'll use 192.168.122.101 under **IPv4 Settings** - (with an appropriate netmask, gateway and DNS server). + **pcmk-1.localdomain** and then press **Apply**. +- Select your network device, press **Configure...**, and use the **Manual** method to + assign a fixed IP address. For this example, we'll use 192.168.122.101 under + **IPv4 Settings** (with an appropriate netmask, gateway and DNS server). +- Press **Save**. - Flip the switch to turn your network device on, and press **Done**. -.. figure:: images/Editing-eth0.png +.. figure:: images/NetworkAndHostName.png :scale: 80% :width: 1024 :height: 800 :align: center - :alt: Editing eth0 + :alt: Editing enp0s3 |CFS_DISTRO| |CFS_DISTRO_VER| Network Interface Screen .. IMPORTANT:: Do not accept the default network settings. Cluster machines should never obtain an IP address via DHCP, because DHCP's periodic address renewal will interfere with corosync. Configure Disk ______________ By default, the installer's automatic partitioning will use LVM (which allows us to dynamically change the amount of space allocated to a given partition). However, it allocates all free space to the ``/`` (aka. **root**) partition, which cannot be reduced in size later (dynamic increases are fine). In order to follow the DRBD and GFS2 portions of this guide, we need to reserve space on each machine for a replicated volume. Enter the **INSTALLATION DESTINATION** section, ensure the hard drive you want to -install to is selected, select **I will configure partitioning**, and press **Done**. +install to is selected, select **Custom** to be the **Storage Configuration**, and +press **Done**. In the **MANUAL PARTITIONING** screen that comes next, click the option to create mountpoints automatically. Select the ``/`` mountpoint, and reduce the desired -capacity by 1GiB or so. Select **Modify...** by the volume group name, and change +capacity by 3GiB or so. Select **Modify...** by the volume group name, and change the **Size policy:** to **As large as possible**, to make the reclaimed space available inside the LVM volume group. We'll add the additional volume later. -.. figure:: images/Partitioning.png +.. figure:: images/ManualPartitioning.png :scale: 80% :width: 1024 :height: 800 :align: center :alt: Manual Partitioning Screen |CFS_DISTRO| |CFS_DISTRO_VER| Manual Partitioning Screen Press **Done**, then **Accept changes**. Configure Time Synchronization ______________________________ It is highly recommended to enable NTP on your cluster nodes. Doing so ensures all nodes agree on the current time and makes reading log files significantly easier. |CFS_DISTRO| will enable NTP automatically. If you want to change any time-related settings (such as time zone or NTP server), you can do this in the **TIME & DATE** section. +Root Password +______________________________ + +In order to continue to the next step, a **Root Password** must be set. + +.. figure:: images/RootPassword.png + :scale: 80% + :width: 1024 + :height: 800 + :align: center + :alt: Root Password Screen + + |CFS_DISTRO| |CFS_DISTRO_VER| Root Password Screen + +Press **Done** (depending on the password you chose, you may need to do so twice). + Finish Install ______________ -Select **Begin Installation**. Once it completes, set a root password, and reboot -as instructed. For the purposes of this document, it is not necessary to create -any additional users. After the node reboots, you'll see a login prompt on +Select **Begin Installation**. Once it completes, **Reboot System** +as instructed. After the node reboots, you'll see a login prompt on the console. Login using **root** and the password you created earlier. -.. figure:: images/Console.png +.. figure:: images/ConsolePrompt.png :scale: 80% :width: 1024 :height: 768 :align: center :alt: Console Prompt |CFS_DISTRO| |CFS_DISTRO_VER| Console Prompt .. NOTE:: From here on, we're going to be working exclusively from the terminal. Configure the OS ################ Verify Networking _________________ Ensure that the machine has the static IP address you configured earlier. .. code-block:: none - [root@pcmk-1 ~]# ip addr 1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 - link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 - inet 127.0.0.1/8 scope host lo - valid_lft forever preferred_lft forever - inet6 ::1/128 scope host - valid_lft forever preferred_lft forever - 2: eth0: mtu 1500 qdisc pfifo_fast state UP group default qlen 1000 - link/ether 52:54:00:8e:eb:41 brd ff:ff:ff:ff:ff:ff - inet 192.168.122.101/24 brd 192.168.122.255 scope global noprefixroute eth0 - valid_lft forever preferred_lft forever - inet6 fe80::e45:c99b:34c0:c657/64 scope link noprefixroute - valid_lft forever preferred_lft forever + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host + valid_lft forever preferred_lft forever + 2: enp1s0: mtu 1500 qdisc fq_codel state UP group default qlen 1000 + link/ether 52:54:00:32:cf:a9 brd ff:ff:ff:ff:ff:ff + inet 192.168.122.101/24 brd 192.168.122.255 scope global noprefixroute enp1s0 + valid_lft forever preferred_lft forever + inet6 fe80::c3e1:3ba:959:fa96/64 scope link noprefixroute + valid_lft forever preferred_lft forever .. NOTE:: If you ever need to change the node's IP address from the command line, follow these instructions, replacing **${device}** with the name of your network device: .. code-block:: none [root@pcmk-1 ~]# vi /etc/sysconfig/network-scripts/ifcfg-${device} # manually edit as desired [root@pcmk-1 ~]# nmcli dev disconnect ${device} [root@pcmk-1 ~]# nmcli con reload ${device} [root@pcmk-1 ~]# nmcli con up ${device} This makes **NetworkManager** aware that a change was made on the config file. Next, ensure that the routes are as expected: .. code-block:: none [root@pcmk-1 ~]# ip route - default via 192.168.122.1 dev eth0 proto static metric 100 - 192.168.122.0/24 dev eth0 proto kernel scope link src 192.168.122.101 metric 100 + default via 192.168.122.1 dev enp1s0 proto static metric 100 + 192.168.122.0/24 dev enp1s0 proto kernel scope link src 192.168.122.101 metric 100 If there is no line beginning with **default via**, then you may need to add a line such as ``GATEWAY="192.168.122.1"`` to the device configuration using the same process as described above for changing the IP address. Now, check for connectivity to the outside world. Start small by testing whether we can reach the gateway we configured. .. code-block:: none [root@pcmk-1 ~]# ping -c 1 192.168.122.1 PING 192.168.122.1 (192.168.122.1) 56(84) bytes of data. - 64 bytes from 192.168.122.1: icmp_seq=1 ttl=64 time=0.254 ms - + 64 bytes from 192.168.122.1: icmp_seq=1 ttl=64 time=0.492 ms + --- 192.168.122.1 ping statistics --- 1 packets transmitted, 1 received, 0% packet loss, time 0ms - rtt min/avg/max/mdev = 0.254/0.254/0.254/0.000 ms + rtt min/avg/max/mdev = 0.492/0.492/0.492/0.000 ms Now try something external; choose a location you know should be available. .. code-block:: none [root@pcmk-1 ~]# ping -c 1 www.clusterlabs.org - PING oss-uk-1.clusterlabs.org (109.74.197.241) 56(84) bytes of data. - 64 bytes from oss-uk-1.clusterlabs.org (109.74.197.241): icmp_seq=1 ttl=49 time=333 ms - - --- oss-uk-1.clusterlabs.org ping statistics --- + PING mx1.clusterlabs.org (95.217.104.78) 56(84) bytes of data. + 64 bytes from mx1.clusterlabs.org (95.217.104.78): icmp_seq=1 ttl=54 time=134 ms + + --- mx1.clusterlabs.org ping statistics --- 1 packets transmitted, 1 received, 0% packet loss, time 0ms - rtt min/avg/max/mdev = 333.204/333.204/333.204/0.000 ms + rtt min/avg/max/mdev = 133.987/133.987/133.987/0.000 ms Login Remotely ______________ The console isn't a very friendly place to work from, so we will now switch to accessing the machine remotely via SSH where we can use copy and paste, etc. From another host, check whether we can see the new host at all: .. code-block:: none - beekhof@f16 ~ # ping -c 1 192.168.122.101 + [gchin@gchin ~]$ ping -c 1 192.168.122.101 PING 192.168.122.101 (192.168.122.101) 56(84) bytes of data. - 64 bytes from 192.168.122.101: icmp_req=1 ttl=64 time=1.01 ms - + 64 bytes from 192.168.122.101: icmp_seq=1 ttl=64 time=0.344 ms + --- 192.168.122.101 ping statistics --- 1 packets transmitted, 1 received, 0% packet loss, time 0ms - rtt min/avg/max/mdev = 1.012/1.012/1.012/0.000 ms - + rtt min/avg/max/mdev = 0.344/0.344/0.344/0.000 ms + Next, login as root via SSH. .. code-block:: none - beekhof@f16 ~ # ssh -l root 192.168.122.101 + [gchin@gchin ~]$ ssh root@192.168.122.101 The authenticity of host '192.168.122.101 (192.168.122.101)' can't be established. - ECDSA key fingerprint is 6e:b7:8f:e2:4c:94:43:54:a8:53:cc:20:0f:29:a4:e0. - Are you sure you want to continue connecting (yes/no)? yes + ECDSA key fingerprint is SHA256:NBvcRrPDLIt39Rf0Tz4/f2Rd/FA5wUiDOd9bZ9QWWjo. + Are you sure you want to continue connecting (yes/no/[fingerprint])? yes Warning: Permanently added '192.168.122.101' (ECDSA) to the list of known hosts. - root@192.168.122.101's password: - Last login: Tue Aug 11 13:14:39 2015 - [root@pcmk-1 ~]# + root@192.168.122.101's password: + Last login: Tue Jan 10 20:46:30 2021 + [root@pcmk-1 ~]# Apply Updates _____________ Apply any package updates released since your installation image was created: .. code-block:: none [root@pcmk-1 ~]# yum update .. index:: single: node; short name Use Short Node Names ____________________ During installation, we filled in the machine's fully qualified domain name (FQDN), which can be rather long when it appears in cluster logs and status output. See for yourself how the machine identifies itself: .. code-block:: none [root@pcmk-1 ~]# uname -n pcmk-1.localdomain We can use the `hostnamectl` tool to strip off the domain name: .. code-block:: none [root@pcmk-1 ~]# hostnamectl set-hostname $(uname -n | sed s/\\..*//) Now, check that the machine is using the correct name: .. code-block:: none [root@pcmk-1 ~]# uname -n pcmk-1 You may want to reboot to ensure all updates take effect. Repeat for Second Node ###################### Repeat the Installation steps so far, so that you have two nodes ready to have the cluster software installed. For the purposes of this document, the additional node is called pcmk-2 with address 192.168.122.102. Configure Communication Between Nodes ##################################### Configure Host Name Resolution ______________________________ Confirm that you can communicate between the two new nodes: .. code-block:: none [root@pcmk-1 ~]# ping -c 3 192.168.122.102 PING 192.168.122.102 (192.168.122.102) 56(84) bytes of data. - 64 bytes from 192.168.122.102: icmp_seq=1 ttl=64 time=0.343 ms - 64 bytes from 192.168.122.102: icmp_seq=2 ttl=64 time=0.402 ms - 64 bytes from 192.168.122.102: icmp_seq=3 ttl=64 time=0.558 ms - + 64 bytes from 192.168.122.102: icmp_seq=1 ttl=64 time=1.22 ms + 64 bytes from 192.168.122.102: icmp_seq=2 ttl=64 time=0.795 ms + 64 bytes from 192.168.122.102: icmp_seq=3 ttl=64 time=0.751 ms + --- 192.168.122.102 ping statistics --- - 3 packets transmitted, 3 received, 0% packet loss, time 2000ms - rtt min/avg/max/mdev = 0.343/0.434/0.558/0.092 ms + 3 packets transmitted, 3 received, 0% packet loss, time 2054ms + rtt min/avg/max/mdev = 0.751/0.923/1.224/0.214 ms Now we need to make sure we can communicate with the machines by their name. If you have a DNS server, add additional entries for the two machines. Otherwise, you'll need to add the machines to ``/etc/hosts`` on both nodes. Below are the entries for my cluster nodes: .. code-block:: none [root@pcmk-1 ~]# grep pcmk /etc/hosts 192.168.122.101 pcmk-1.clusterlabs.org pcmk-1 192.168.122.102 pcmk-2.clusterlabs.org pcmk-2 We can now verify the setup by again using ping: .. code-block:: none [root@pcmk-1 ~]# ping -c 3 pcmk-2 - PING pcmk-2.clusterlabs.org (192.168.122.101) 56(84) bytes of data. - 64 bytes from pcmk-1.clusterlabs.org (192.168.122.101): icmp_seq=1 ttl=64 time=0.164 ms - 64 bytes from pcmk-1.clusterlabs.org (192.168.122.101): icmp_seq=2 ttl=64 time=0.475 ms - 64 bytes from pcmk-1.clusterlabs.org (192.168.122.101): icmp_seq=3 ttl=64 time=0.186 ms - + PING pcmk-2.clusterlabs.org (192.168.122.102) 56(84) bytes of data. + 64 bytes from pcmk-2.clusterlabs.org (192.168.122.102): icmp_seq=1 ttl=64 time=0.295 ms + 64 bytes from pcmk-2.clusterlabs.org (192.168.122.102): icmp_seq=2 ttl=64 time=0.616 ms + 64 bytes from pcmk-2.clusterlabs.org (192.168.122.102): icmp_seq=3 ttl=64 time=0.809 ms + --- pcmk-2.clusterlabs.org ping statistics --- - 3 packets transmitted, 3 received, 0% packet loss, time 2001ms - rtt min/avg/max/mdev = 0.164/0.275/0.475/0.141 ms - + 3 packets transmitted, 3 received, 0% packet loss, time 2043ms + rtt min/avg/max/mdev = 0.295/0.573/0.809/0.212 ms .. index:: SSH Configure SSH _____________ SSH is a convenient and secure way to copy files and perform commands remotely. For the purposes of this guide, we will create a key without a password (using the -N option) so that we can perform remote actions without being prompted. .. WARNING:: Unprotected SSH keys (those without a password) are not recommended for servers exposed to the outside world. We use them here only to simplify the demo. Create a new key and allow anyone with that key to log in: .. index:: single: SSH; key .Creating and Activating a new SSH Key .. code-block:: none [root@pcmk-1 ~]# ssh-keygen -t dsa -f ~/.ssh/id_dsa -N "" Generating public/private dsa key pair. + Created directory '/root/.ssh'. Your identification has been saved in /root/.ssh/id_dsa. Your public key has been saved in /root/.ssh/id_dsa.pub. The key fingerprint is: - 91:09:5c:82:5a:6a:50:08:4e:b2:0c:62:de:cc:74:44 root@pcmk-1.clusterlabs.org + SHA256:ehR595AVLAVpvFgqYXiayds2qx8emkvnHmfQZMTZ4jM root@pcmk-1 The key's randomart image is: - +--[ DSA 1024]----+ - |==.ooEo.. | - |X O + .o o | - | * A + | - | + . | - | . S | - | | - | | - | | - | | - +-----------------+ + +---[DSA 1024]----+ + | . ..+.=+. | + | . +o+ Bo. | + | . *oo+*+o | + | = .*E..o | + | oS..o . | + | .o+. | + | o.*oo | + | . B.* | + | === | + +----[SHA256]-----+ [root@pcmk-1 ~]# cp ~/.ssh/id_dsa.pub ~/.ssh/authorized_keys Install the key on the other node: .. code-block:: none [root@pcmk-1 ~]# scp -r ~/.ssh pcmk-2: The authenticity of host 'pcmk-2 (192.168.122.102)' can't be established. - ECDSA key fingerprint is SHA256:63xNPkPYq98rYznf3T9QYJAzlaGiAsSgFVNHOZjPWqc. - ECDSA key fingerprint is MD5:d9:bf:6e:32:88:be:47:3d:96:f1:96:27:65:05:0b:c3. - Are you sure you want to continue connecting (yes/no)? yes + ECDSA key fingerprint is SHA256:FQ4sVubTiHdQ6IetbN96fixoTVx/LuQUV8qoyiywnfs. + Are you sure you want to continue connecting (yes/no/[fingerprint])? yes Warning: Permanently added 'pcmk-2,192.168.122.102' (ECDSA) to the list of known hosts. - root@pcmk-2's password: - id_dsa - id_dsa.pub - authorized_keys - known_hosts + root@pcmk-2's password: + id_dsa 100% 1385 1.6MB/s 00:00 + id_dsa.pub 100% 601 1.0MB/s 00:00 + authorized_keys 100% 601 1.3MB/s 00:00 + known_hosts 100% 184 389.2KB/s 00:00 Test that you can now run commands remotely, without being prompted: .. code-block:: none [root@pcmk-1 ~]# ssh pcmk-2 -- uname -n + root@pcmk-2's password: pcmk-2 diff --git a/doc/sphinx/conf.py.in b/doc/sphinx/conf.py.in index 04924e1d27..0c2615a1cb 100644 --- a/doc/sphinx/conf.py.in +++ b/doc/sphinx/conf.py.in @@ -1,314 +1,314 @@ """ Sphinx configuration for Pacemaker documentation """ __copyright__ = "Copyright 2020 the Pacemaker project contributors" __license__ = "GNU General Public License version 2 or later (GPLv2+) WITHOUT ANY WARRANTY" # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import datetime import os import sys # Variables that can be used later in this file authors = "the Pacemaker project contributors" year = datetime.datetime.now().year doc_license = "Creative Commons Attribution-ShareAlike International Public License" doc_license += " version 4.0 or later (CC-BY-SA v4.0+)" # rST markup to insert at beginning of every document; mainly used for # # .. || replace:: # # where occurrences of || in the rST will be substituted with rst_prolog=""" -.. |CFS_DISTRO| replace:: CentOS -.. |CFS_DISTRO_VER| replace:: 7.5 +.. |CFS_DISTRO| replace:: CentOS Stream +.. |CFS_DISTRO_VER| replace:: 8 .. |REMOTE_DISTRO| replace:: CentOS .. |REMOTE_DISTRO_VER| replace:: 7.4 """ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = '%BOOK_ID%' copyright = "2009-%s %s. Released under the terms of the %s" % (year, authors, doc_license) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The full version, including alpha/beta/rc tags. release = '%VERSION%' # The short X.Y version. version = release.rsplit('.', 1)[0] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'vs' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'pyramid' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] html_style = 'pacemaker.css' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = "%BOOK_TITLE%" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [ '%SRC_DIR%/_static' ] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Pacemakerdoc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', '%BOOK_ID%.tex', '%BOOK_TITLE%', authors, 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', '%BOOK_ID%', 'Part of the Pacemaker documentation set', [authors], 8) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', '%BOOK_ID%', '%BOOK_TITLE%', authors, '%BOOK_TITLE%', 'Pacemaker is an advanced, scalable high-availability cluster resource manager.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. epub_title = '%BOOK_TITLE%' epub_author = authors epub_publisher = 'ClusterLabs.org' epub_copyright = copyright # The language of the text. It defaults to the language option # or en if the language is not set. #epub_language = '' # The scheme of the identifier. Typical schemes are ISBN or URL. epub_scheme = 'URL' # The unique identifier of the text. This can be a ISBN number # or the project homepage. epub_identifier = 'http://www.clusterlabs.org/pacemaker/doc/2.0/%BOOK_ID%/epub/%BOOK_ID%.epub' # A unique identification for the text. epub_uid = 'ClusterLabs.org-Pacemaker-%BOOK_ID%' # A tuple containing the cover image and cover page html template filenames. #epub_cover = () # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_pre_files = [] # HTML files that should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = [ '_static/doctools.js', '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js', '_static/basic.css', '_static/websupport.js', 'search.html', ] # The depth of the table of contents in toc.ncx. #epub_tocdepth = 3 # Allow duplicate toc entries. #epub_tocdup = True