No OneTemporary
Actions

Size

37 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
	index d3c3889310..e48e19a780 100644
	--- a/doc/sphinx/Makefile.am
	+++ b/doc/sphinx/Makefile.am
	@@ -1,214 +1,222 @@
	#
	# Copyright 2003-2023 the Pacemaker project contributors
	#
	# The version control history for this file may have further details.
	#
	# This source code is licensed under the GNU General Public License version 2
	# or later (GPLv2+) WITHOUT ANY WARRANTY.
	#
	include $(top_srcdir)/mk/common.mk

	# Define release-related variables
	include $(top_srcdir)/mk/release.mk

	# Things you might want to override on the command line

	# Books to generate
	BOOKS ?= Clusters_from_Scratch \
	Pacemaker_Administration \
	Pacemaker_Development \
	Pacemaker_Explained \
	Pacemaker_Python_API \
	Pacemaker_Remote

	# Output formats to generate. Possible values:
	# html (multiple HTML files)
	# dirhtml (HTML files named index.html in multiple directories)
	# singlehtml (a single large HTML file)
	# text
	# pdf
	# epub
	# latex
	# linkcheck (not actually a format; check validity of external links)
	#
	# The results will end up in <book>/_build/<format>
	BOOK_FORMATS ?= singlehtml

	# Set to "a4paper" or "letterpaper" if building latex format
	PAPER ?= letterpaper

	# Additional options for sphinx-build
	SPHINXFLAGS ?=

	# toplevel rsync destination for www targets (without trailing slash)
	RSYNC_DEST ?= root@www.clusterlabs.org:/var/www/html

	# End of useful overrides


	# Example scheduler transition graphs
	# @TODO The original CIB XML for these is long lost. Ideally, we would recreate
	# something similar and keep those here instead of the DOTs (or use a couple of
	# scheduler regression test inputs instead), then regenerate the SVG
	# equivalents using crm_simulate and dot when making a release.
	DOTS = $(wildcard shared/images/*.dot)

	# Vector sources for generated PNGs (including SVG equivalents of DOTS, created
	# manually using dot)
	SVGS = $(wildcard shared/images/pcmk-*.svg) \
	$(DOTS:%.dot=%.svg)

	# PNG images generated from SVGS
	#
	# These will not be accessible in a VPATH build, which will generate warnings
	# when building the documentation, but the make will still succeed. It is
	# nontrivial to get them working for VPATH builds and not worth the effort.
	PNGS_GENERATED = $(SVGS:%.svg=%.png)

	# Original PNG image sources
	PNGS_Clusters_from_Scratch = $(wildcard Clusters_from_Scratch/images/*.png)
	PNGS_Pacemaker_Explained = $(wildcard Pacemaker_Explained/images/*.png)
	PNGS_Pacemaker_Remote = $(wildcard Pacemaker_Remote/images/*.png)

	STATIC_FILES = $(wildcard _static/*.css)

	EXTRA_DIST = $(wildcard /.rst) $(DOTS) $(SVGS) \
	$(PNGS_Clusters_from_Scratch) \
	$(PNGS_Pacemaker_Explained) \
	$(PNGS_Pacemaker_Remote) \
	$(wildcard Pacemaker_Python_API/_templates/*rst) \
	$(STATIC_FILES) \
	conf.py.in

	# recursive, preserve symlinks/permissions/times, verbose, compress,
	# don't cross filesystems, sparse, show progress
	RSYNC_OPTS = -rlptvzxS --progress

	PACKAGE_SERIES=$(shell echo "$VERSION" \| awk -F. '{ print $1"."$2 }')

	BOOK_RSYNC_DEST = $(RSYNC_DEST)/$(PACKAGE)/doc/$(PACKAGE_SERIES)

	BOOK = none

	DEPS_intro = shared/pacemaker-intro.rst \
	$(PNGS_GENERATED)

	DEPS_Clusters_from_Scratch = $(DEPS_intro) \
	$(PNGS_Clusters_from_Scratch)
	DEPS_Pacemaker_Administration = $(DEPS_intro)
	DEPS_Pacemaker_Development =
	DEPS_Pacemaker_Explained = $(DEPS_intro) \
	$(PNGS_Pacemaker_Explained)
	DEPS_Pacemaker_Python_API = ../../python
	DEPS_Pacemaker_Remote = $(PNGS_Pacemaker_Remote)

	if BUILD_SPHINX_DOCS

	INKSCAPE_CMD = $(INKSCAPE) --export-dpi=90 -C

	# Pattern rule to generate PNGs from SVGs
	# (--export-png works with Inkscape <1.0, --export-filename with >=1.0;
	# create the destination directory in case this is a VPATH build)
	%.png: %.svg
	$(AM_V_at)-$(MKDIR_P) "$(shell dirname "$@")"
	$(AM_V_GEN) { \
	$(INKSCAPE_CMD) --export-png="$@" "$<" 2>/dev/null \
	\|\| $(INKSCAPE_CMD) --export-filename="$@" "$<"; \
	} $(PCMK_quiet)

	# Create a book's Sphinx configuration.
	# Create the book directory in case this is a VPATH build.
	$(BOOKS:%=%/conf.py): conf.py.in
	$(AM_V_at)-$(MKDIR_P) "$(@:%/conf.py=%)"
	$(AM_V_GEN)sed \
	-e 's/%VERSION%/$(VERSION)/g' \
	-e 's/%BOOK_ID%/$(@:%/conf.py=%)/g' \
	-e 's/%BOOK_TITLE%/$(subst _, ,$(@:%/conf.py=%))/g' \
	-e 's#%SRC_DIR%#$(abs_srcdir)#g' \
	-e 's#%ABS_TOP_SRCDIR%#$(abs_top_srcdir)#g' \
	+ -e 's#%CONFIGDIR%#@CONFIGDIR@#g' \
	+ -e 's#%CRM_BLACKBOX_DIR%#@CRM_BLACKBOX_DIR@#g' \
	+ -e 's#%CRM_DAEMON_GROUP%#@CRM_DAEMON_GROUP@#g' \
	+ -e 's#%CRM_DAEMON_USER%#@CRM_DAEMON_USER@#g' \
	+ -e 's#%CRM_LOG_DIR%#@CRM_LOG_DIR@#g' \
	+ -e 's#%CRM_SCHEMA_DIRECTORY%#@CRM_SCHEMA_DIRECTORY@#g' \
	+ -e 's#%PACEMAKER_CONFIG_DIR%#@PACEMAKER_CONFIG_DIR@#g' \
	+ -e 's#%PCMK_GNUTLS_PRIORITIES%#@PCMK_GNUTLS_PRIORITIES@#g' \
	$(<) > "$@"

	$(BOOK)/_build: $(STATIC_FILES) $(BOOK)/conf.py $(DEPS_$(BOOK)) $(wildcard $(srcdir)/$(BOOK)/*.rst)
	@echo 'Building "$(subst _, ,$(BOOK))" because of $?' $(PCMK_quiet)
	$(AM_V_at)rm -rf "$@"
	$(AM_V_BOOK)for format in $(BOOK_FORMATS); do \
	echo -e "\n * Building $$format" $(PCMK_quiet); \
	doctrees="doctrees"; \
	real_format="$$format"; \
	case "$$format" in \
	pdf) real_format="latex" ;; \
	gettext) doctrees="gettext-doctrees" ;; \
	esac; \
	$(SPHINX) -b "$$real_format" -d "$@/$$doctrees" \
	-c "$(builddir)/$(BOOK)" \
	-D latex_elements.papersize=$(PAPER) \
	$(SPHINXFLAGS) \
	"$(srcdir)/$(BOOK)" "$@/$$format" \
	$(PCMK_quiet); \
	if [ "$$format" = "pdf" ]; then \
	$(MAKE) $(AM_MAKEFLAGS) -C "$@/$$format" \
	all-pdf; \
	fi; \
	done
	endif

	build-$(PACKAGE_SERIES).txt: all
	$(AM_V_GEN)echo "Generated on `date --utc` from version $(TAG)" > "$@"

	.PHONY: books-upload
	books-upload: all build-$(PACKAGE_SERIES).txt
	if BUILD_SPHINX_DOCS
	@echo "Uploading $(PACKAGE_SERIES) documentation set"
	@for book in $(BOOKS); do \
	echo " * $$book"; \
	rsync $(RSYNC_OPTS) $(BOOK_FORMATS:%=$$book/_build/%) \
	"$(BOOK_RSYNC_DEST)/$$book/"; \
	done
	@rsync $(RSYNC_OPTS) "$(builddir)/build-$(PACKAGE_SERIES).txt" \
	"$(RSYNC_DEST)/$(PACKAGE)/doc"
	endif

	.PHONY: all-local
	all-local:
	if BUILD_SPHINX_DOCS
	@for book in $(BOOKS); do \
	$(MAKE) $(AM_MAKEFLAGS) BOOK=$$book \
	PAPER="$(PAPER)" SPHINXFLAGS="$(SPHINXFLAGS)" \
	BOOK_FORMATS="$(BOOK_FORMATS)" $$book/_build; \
	done
	endif

	.PHONY: install-data-local
	install-data-local: all-local
	if BUILD_SPHINX_DOCS
	$(AM_V_at)for book in $(BOOKS); do \
	for format in $(BOOK_FORMATS); do \
	formatdir="$$book/_build/$$format"; \
	for f in `find "$$formatdir" -print`; do \
	dname="`echo $$f \| sed s:_build/::`"; \
	dloc="$(DESTDIR)/$(docdir)/$$dname"; \
	if [ -d "$$f" ]; then \
	$(INSTALL) -d -m 755 "$$dloc"; \
	else \
	$(INSTALL_DATA) "$$f" "$$dloc"; \
	fi \
	done; \
	done; \
	done
	endif

	.PHONY: uninstall-local
	uninstall-local:
	if BUILD_SPHINX_DOCS
	$(AM_V_at)for book in $(BOOKS); do \
	rm -rf "$(DESTDIR)/$(docdir)/$$book"; \
	done
	endif

	.PHONY: clean-local
	clean-local:
	$(AM_V_at)-rm -rf \
	$(BOOKS:%="$(builddir)/%/_build") \
	$(BOOKS:%="$(builddir)/%/conf.py") \
	$(BOOKS:%="$(builddir)/%/generated") \
	$(PNGS_GENERATED)
	diff --git a/doc/sphinx/Pacemaker_Explained/options.rst b/doc/sphinx/Pacemaker_Explained/cluster-options.rst
	similarity index 100%
	rename from doc/sphinx/Pacemaker_Explained/options.rst
	rename to doc/sphinx/Pacemaker_Explained/cluster-options.rst
	diff --git a/doc/sphinx/Pacemaker_Explained/index.rst b/doc/sphinx/Pacemaker_Explained/index.rst
	index e3b7e9e55e..63387f3421 100644
	--- a/doc/sphinx/Pacemaker_Explained/index.rst
	+++ b/doc/sphinx/Pacemaker_Explained/index.rst
	@@ -1,41 +1,42 @@
	Pacemaker Explained
	===================

	Configuring Pacemaker Clusters


	Abstract
	--------
	This document definitively explains Pacemaker's features and capabilities,
	particularly the XML syntax used in Pacemaker's Cluster Information Base (CIB).


	Table of Contents
	-----------------

	.. toctree::
	:maxdepth: 3
	:numbered:

	intro
	- options
	+ local-options
	+ cluster-options
	nodes
	resources
	operations
	constraints
	fencing
	alerts
	rules
	collective
	reusing-configuration
	utilization
	acls
	status
	multi-site-clusters
	ap-samples

	Index
	-----

	* :ref:`genindex`
	* :ref:`search`
	diff --git a/doc/sphinx/Pacemaker_Explained/local-options.rst b/doc/sphinx/Pacemaker_Explained/local-options.rst
	new file mode 100644
	index 0000000000..91eda6632d
	--- /dev/null
	+++ b/doc/sphinx/Pacemaker_Explained/local-options.rst
	@@ -0,0 +1,515 @@
	+Host-Local Configuration
	+------------------------
	+
	+.. index::
	+ pair: XML element; configuration
	+
	+.. note:: Directory and file paths below may differ on your system depending on
	+ your Pacemaker build settings. Check your Pacemaker configuration
	+ file to find the correct paths.
	+
	+Pacemaker supports several host-local configuration options. These options can
	+be configured on each node in the main Pacemaker configuration file
	+(\|PCMK_CONFIG_FILE\|) in the format ``<NAME>="<VALUE>"``. They work by setting
	+environment variables when Pacemaker daemons start up.
	+
	+.. list-table:: Local Options
	+ :class: longtable
	+ :widths: 2 2 2 5
	+ :header-rows: 1
	+
	+ * - Name
	+ - Type
	+ - Default
	+ - Description
	+ * - .. _pcmk_logfacility:
	+
	+ .. index::
	+ pair: node option; PCMK_logfacility
	+
	+ PCMK_logfacility
	+ - :ref:`enumeration <enumeration>`
	+ - daemon
	+ - Enable logging via the system log or journal, using the specified log
	+ facility. Messages sent here are of value to all Pacemaker
	+ administrators. This can be disabled using ``none``, but that is not
	+ recommended. Allowed values:
	+
	+ * ``none``
	+ * ``daemon``
	+ * ``user``
	+ * ``local0``
	+ * ``local1``
	+ * ``local2``
	+ * ``local3``
	+ * ``local4``
	+ * ``local5``
	+ * ``local6``
	+ * ``local7``
	+
	+ * - .. _pcmk_logpriority:
	+
	+ .. index::
	+ pair:: node option; PCMK_logpriority
	+
	+ PCMK_logpriority
	+ - :ref:`enumeration <enumeration>`
	+ - notice
	+ - Unless system logging is disabled using ``PCMK_logfacility=none``,
	+ messages of the specified log severity and higher will be sent to the
	+ system log. The default is appropriate for most installations. Allowed
	+ values:
	+
	+ * ``emerg``
	+ * ``alert``
	+ * ``crit``
	+ * ``error``
	+ * ``warning``
	+ * ``notice``
	+ * ``info``
	+ * ``debug``
	+
	+ * - .. _pcmk_logfile:
	+
	+ .. index::
	+ pair:: node option; PCMK_logfile
	+
	+ PCMK_logfile
	+ - :ref:`text <text>`
	+ - \|PCMK_LOG_FILE\|
	+ - Unless set to ``none``, more detailed log messages will be sent to the
	+ specified file (in addition to the system log, if enabled). These
	+ messages may have extended information, and will include messages of info
	+ severity. This log is of more use to developers and advanced system
	+ administrators, and when reporting problems.
	+
	+ * - .. _pcmk_logfile_mode:
	+
	+ .. index::
	+ pair:: node option; PCMK_logfile_mode
	+
	+ PCMK_logfile_mode
	+ - :ref:`text <text>`
	+ - 0660
	+ - Pacemaker will set the permissions on the detail log to this value (see
	+ ``chmod(1)``).
	+
	+ * - .. _pcmk_debug:
	+
	+ .. index::
	+ pair:: node option; PCMK_debug
	+
	+ PCMK_debug
	+ - :ref:`enumeration <enumeration>`
	+ - no
	+ - Whether to send debug severity messages to the detail log. This may be
	+ set for all subsystems (``yes`` or ``no``) or for specific (comma-
	+ separated) subsystems. Allowed subsystems are:
	+
	+ * ``pacemakerd``
	+ * ``pacemaker-attrd``
	+ * ``pacemaker-based``
	+ * ``pacemaker-controld``
	+ * ``pacemaker-execd``
	+ * ``pacemaker-fenced``
	+ * ``pacemaker-schedulerd``
	+
	+ Example: ``PCMK_debug="pacemakerd,pacemaker-execd"``
	+
	+ * - .. _pcmk_stderr:
	+
	+ .. index::
	+ pair:: node option; PCMK_stderr
	+
	+ PCMK_stderr
	+ - :ref:`boolean <boolean>`
	+ - no
	+ - Advanced Use Only: Whether to send daemon log messages to stderr. This
	+ would be useful only during troubleshooting, when starting Pacemaker
	+ manually on the command line.
	+
	+ Setting this option in the configuration file is pointless, since the
	+ file is not read when starting Pacemaker manually. However, it can be set
	+ directly as an environment variable on the command line.
	+
	+ * - .. _pcmk_trace_functions:
	+
	+ .. index::
	+ pair:: node option; PCMK_trace_functions
	+
	+ PCMK_trace_functions
	+ - :ref:`text <text>`
	+ -
	+ - Advanced Use Only: Send debug and trace severity messages from these
	+ (comma-separated) source code functions to the detail log.
	+
	+ Example:
	+ ``PCMK_trace_functions="func1,func2"``
	+
	+ * - .. _pcmk_trace_files:
	+
	+ .. index::
	+ pair:: node option; PCMK_trace_files
	+
	+ PCMK_trace_files
	+ - :ref:`text <text>`
	+ -
	+ - Advanced Use Only: Send debug and trace severity messages from all
	+ functions in these (comma-separated) source file names to the detail log.
	+
	+ Example: ``PCMK_trace_files="file1.c,file2.c"``
	+
	+ * - .. _pcmk_trace_formats:
	+
	+ .. index::
	+ pair:: node option; PCMK_trace_formats
	+
	+ PCMK_trace_formats
	+ - :ref:`text <text>`
	+ -
	+ - Advanced Use Only: Send trace severity messages that are generated by
	+ these (comma-separated) format strings in the source code to the detail
	+ log.
	+
	+ Example: ``PCMK_trace_formats="Error: %s (%d)"``
	+
	+ * - .. _pcmk_trace_tags:
	+
	+ .. index::
	+ pair:: node option; PCMK_trace_tags
	+
	+ PCMK_trace_tags
	+ - :ref:`text <text>`
	+ -
	+ - Advanced Use Only: Send debug and trace severity messages related to
	+ these (comma-separated) resource IDs to the detail log.
	+
	+ Example: ``PCMK_trace_tags="client-ip,dbfs"``
	+
	+ * - .. _pcmk_blackbox:
	+
	+ .. index::
	+ pair:: node option; PCMK_blackbox
	+
	+ PCMK_blackbox
	+ - :ref:`enumeration <enumeration>`
	+ - no
	+ - Advanced Use Only: Enable blackbox logging globally (``yes`` or ``no``)
	+ or by subsystem. A blackbox contains a rolling buffer of all logs (of all
	+ severities). Blackboxes are stored under \|CRM_BLACKBOX_DIR\| by default,
	+ by default, and their contents can be viewed using the ``qb-blackbox(8)``
	+ command.
	+
	+ The blackbox recorder can be enabled at start using this variable, or at
	+ runtime by sending a Pacemaker subsystem daemon process a ``SIGUSR1`` or
	+ ``SIGTRAP`` signal, and disabled by sending ``SIGUSR2`` (see
	+ ``kill(1)``). The blackbox will be written after a crash, assertion
	+ failure, or ``SIGTRAP`` signal.
	+
	+ See :ref:`PCMK_debug <pcmk_debug>` for allowed subsystems.
	+
	+ Example:
	+ ``PCMK_blackbox="pacemakerd,pacemaker-execd"``
	+
	+ * - .. _pcmk_trace_blackbox:
	+
	+ .. index::
	+ pair:: node option; PCMK_trace_blackbox
	+
	+ PCMK_trace_blackbox
	+ - :ref:`enumeration <enumeration>`
	+ -
	+ - Advanced Use Only: Write a blackbox whenever the message at the
	+ specified function and line is logged. Multiple entries may be comma-
	+ separated.
	+
	+ Example: ``PCMK_trace_blackbox="remote.c:144,remote.c:149"``
	+
	+ * - .. _pcmk_node_start_state:
	+
	+ .. index::
	+ pair:: node option; PCMK_node_start_state
	+
	+ PCMK_node_start_state
	+ - :ref:`enumeration <enumeration>`
	+ - default
	+ - By default, the local host will join the cluster in an online or standby
	+ state when Pacemaker first starts depending on whether it was previously
	+ put into standby mode. If this variable is set to ``standby`` or
	+ ``online``, it will force the local host to join in the specified state.
	+
	+ * - .. _pcmk_node_action_limit:
	+
	+ .. index::
	+ pair:: node option; PCMK_node_action_limit
	+
	+ PCMK_node_action_limit
	+ - :ref:`nonnegative integer <nonnegative_integer>`
	+ -
	+ - Specify the maximum number of jobs that can be scheduled on this node. If
	+ set, this overrides the ``node-action-limit`` cluster property for this
	+ node.
	+
	+ * - .. _pcmk_shutdown_delay:
	+
	+ .. index::
	+ pair:: node option; PCMK_shutdown_delay
	+
	+ PCMK_shutdown_delay
	+ - :ref:`timeout <timeout>`
	+ -
	+ - Specify a delay before shutting down ``pacemakerd`` after shutting down
	+ all other Pacemaker daemons.
	+
	+ * - .. _pcmk_fail_fast:
	+
	+ .. index::
	+ pair:: node option; PCMK_fail_fast
	+
	+ PCMK_fail_fast
	+ - :ref:`boolean <boolean>`
	+ - no
	+ - By default, if a Pacemaker subsystem crashes, the main ``pacemakerd``
	+ process will attempt to restart it. If this variable is set to ``yes``,
	+ ``pacemakerd`` will panic the local host instead.
	+
	+ * - .. _pcmk_panic_action:
	+
	+ .. index::
	+ pair:: node option; PCMK_panic_action
	+
	+ PCMK_panic_action
	+ - :ref:`enumeration <enumeration>`
	+ - reboot
	+ - Pacemaker will panic the local host under certain conditions. By default,
	+ this means rebooting the host. This variable can change that behavior: if
	+ ``crash``, trigger a kernel crash (useful if you want a kernel dump to
	+ investigate); if ``sync-reboot`` or ``sync-crash``, synchronize
	+ filesystems before rebooting the host or triggering a kernel crash. The
	+ sync values are more likely to preserve log messages, but with the risk
	+ that the host may be left active if the synchronization hangs.
	+
	+ * - .. _pcmk_authkey_location:
	+
	+ .. index::
	+ pair:: node option; PCMK_authkey_location
	+
	+ PCMK_authkey_location
	+ - :ref:`text <text>`
	+ - \|PCMK_AUTHKEY_FILE\|
	+ - Use the contents of this file as the authorization key to use with
	+ Pacemaker Remote connections. This file must be readable by Pacemaker
	+ daemons (that is, it must allow read permissions to either the
	+ \|CRM_DAEMON_USER\| user or the \|CRM_DAEMON_GROUP\| group), and its contents
	+ must be identical on all nodes.
	+
	+ * - .. _pcmk_remote_address:
	+
	+ .. index::
	+ pair:: node option; PCMK_remote_address
	+
	+ PCMK_remote_address
	+ - :ref:`text <text>`
	+ -
	+ - By default, if the Pacemaker Remote service is run on the local node, it
	+ will listen for connections on all IP addresses. This may be set to one
	+ address to listen on instead, as a resolvable hostname or as a numeric
	+ IPv4 or IPv6 address. When resolving names or listening on all addresses,
	+ IPv6 will be preferred if available. When listening on an IPv6 address,
	+ IPv4 clients will be supported via IPv4-mapped IPv6 addresses.
	+
	+ Example: ``PCMK_remote_address="192.0.2.1"``
	+
	+ * - .. _pcmk_remote_port:
	+
	+ .. index::
	+ pair:: node option; PCMK_remote_port
	+
	+ PCMK_remote_port
	+ - :ref:`port <port>`
	+ - 3121
	+ - Use this TCP port number for Pacemaker Remote node connections. This
	+ value must be the same on all nodes.
	+
	+ * - .. _pcmk_remote_pid1:
	+
	+ .. index::
	+ pair:: node option; PCMK_remote_pid1
	+
	+ PCMK_remote_pid1
	+ - :ref:`enumeration <enumeration>`
	+ - default
	+ - Advanced Use Only: When a bundle resource's ``run-command`` option is
	+ left to default, Pacemaker Remote runs as PID 1 in the bundle's
	+ containers. When it does so, it loads environment variables from the
	+ container's \|PCMK_INIT_ENV_FILE\| and performs the PID 1 responsibility of
	+ reaping dead subprocesses.
	+
	+ This option controls whether those actions are performed when Pacemaker
	+ Remote is not running as PID 1. It is intended primarily for developer
	+ testing but can be useful when ``run-command`` is set to a separate,
	+ custom PID 1 process that launches Pacemaker Remote.
	+
	+ * ``full``: Pacemaker Remote loads environment variables from
	+ \|PCMK_INIT_ENV_FILE\| and reaps dead subprocesses.
	+ * ``vars``: Pacemaker Remote loads environment variables from
	+ \|PCMK_INIT_ENV_FILE\| but does not reap dead subprocesses.
	+ * ``default``: Pacemaker Remote performs neither action.
	+
	+ If Pacemaker Remote is running as PID 1, this option is ignored, and the
	+ behavior is the same as for ``full``.
	+
	+ * - .. _pcmk_tls_priorities:
	+
	+ .. index::
	+ pair:: node option; PCMK_tls_priorities
	+
	+ PCMK_tls_priorities
	+ - :ref:`text <text>`
	+ - \|PCMK_GNUTLS_PRIORITIES\|
	+ - Advanced Use Only: These GnuTLS cipher priorities will be used for TLS
	+ connections (whether for Pacemaker Remote connections or remote CIB
	+ access, when enabled). See:
	+
	+ https://gnutls.org/manual/html_node/Priority-Strings.html
	+
	+ Pacemaker will append ``":+ANON-DH"`` for remote CIB access and
	+ ``":+DHE-PSK:+PSK"`` for Pacemaker Remote connections, as they are
	+ required for the respective functionality.
	+
	+ Example:
	+ ``PCMK_tls_priorities="SECURE128:+SECURE192"``
	+
	+ * - .. _pcmk_dh_min_bits:
	+
	+ .. index::
	+ pair:: node option; PCMK_dh_min_bits
	+
	+ PCMK_dh_min_bits
	+ - :ref:`nonnegative integer <nonnegative_integer>`
	+ - 0 (no minimum)
	+ - Advanced Use Only: Set a lower bound on the bit length of the prime
	+ number generated for Diffie-Hellman parameters needed by TLS connections.
	+ The default is no minimum.
	+
	+ The server (Pacemaker Remote daemon, or CIB manager configured to accept
	+ remote clients) will use this value to provide a floor for the value
	+ recommended by the GnuTLS library. The library will only accept a limited
	+ number of specific values, which vary by library version, so setting
	+ these is recommended only when required for compatibility with specific
	+ client versions.
	+
	+ Clients (connecting cluster nodes or remote CIB commands) will require
	+ that the server use a prime of at least this size. This is recommended
	+ only when the value must be lowered in order for the client's GnuTLS
	+ library to accept a connection to an older server.
	+
	+ * - .. _pcmk_dh_max_bits:
	+
	+ .. index::
	+ pair:: node option; PCMK_dh_max_bits
	+
	+ PCMK_dh_max_bits
	+ - :ref:`nonnegative integer <nonnegative_integer>`
	+ - 0 (no maximum)
	+ - Advanced Use Only: Set an upper bound on the bit length of the prime
	+ number generated for Diffie-Hellman parameters needed by TLS connections.
	+ The default is no maximum.
	+
	+ The server (Pacemaker Remote daemon, or CIB manager configured to accept
	+ remote clients) will use this value to provide a ceiling for the value
	+ recommended by the GnuTLS library. The library will only accept a limited
	+ number of specific values, which vary by library version, so setting
	+ these is recommended only when required for compatibility with specific
	+ client versions.
	+
	+ Clients do not use ``PCMK_dh_max_bits``.
	+
	+ * - .. _pcmk_ipc_type:
	+
	+ .. index::
	+ pair:: node option; PCMK_ipc_type
	+
	+ PCMK_ipc_type
	+ - :ref:`enumeration <enumeration>`
	+ - shared-mem
	+ - Advanced Use Only: Force use of a particular IPC method. Allowed values:
	+
	+ * ``shared-mem``
	+ * ``socket``
	+ * ``posix``
	+ * ``sysv``
	+
	+ * - .. _pcmk_ipc_buffer:
	+
	+ .. index::
	+ pair:: node option; PCMK_ipc_buffer
	+
	+ PCMK_ipc_buffer
	+ - :ref:`nonnegative integer <nonnegative_integer>`
	+ - 131072
	+ - Advanced Use Only: Specify an IPC buffer size in bytes. This can be
	+ useful when connecting to large clusters that result in messages
	+ exceeding the default size (which will also result in log messages
	+ referencing this variable).
	+
	+ * - .. _pcmk_cluster_type:
	+
	+ .. index::
	+ pair:: node option; PCMK_cluster_type
	+
	+ PCMK_cluster_type
	+ - :ref:`enumeration <enumeration>`
	+ - corosync
	+ - Advanced Use Only: Specify the cluster layer to be used. If unset,
	+ Pacemaker will detect and use a supported cluster layer, if available.
	+ Currently, ``"corosync"`` is the only supported cluster layer. If
	+ multiple layers are supported in the future, this will allow overriding
	+ Pacemaker's automatic detection to select a specific one.
	+
	+ * - .. _pcmk_schema_directory:
	+
	+ .. index::
	+ pair:: node option; PCMK_schema_directory
	+
	+ PCMK_schema_directory
	+ - :ref:`text <text>`
	+ - \|CRM_SCHEMA_DIRECTORY\|
	+ - Advanced Use Only: Specify an alternate location for RNG schemas and
	+ XSL transforms.
	+
	+ * - .. _pcmk_valgrind_enabled:
	+
	+ .. index::
	+ pair:: node option; PCMK_valgrind_enabled
	+
	+ PCMK_valgrind_enabled
	+ - :ref:`enumeration <enumeration>`
	+ - no
	+ - Advanced Use Only: Whether subsystem daemons should be run under
	+ ``valgrind``. Allowed values are the same as for ``PCMK_debug``.
	+
	+ * - .. _pcmk_callgrind_enabled:
	+
	+ .. index::
	+ pair:: node option; PCMK_callgrind_enabled
	+
	+ PCMK_callgrind_enabled
	+ - :ref:`enumeration <enumeration>`
	+ - no
	+ - Advanced Use Only: Whether subsystem daemons should be run under
	+ ``valgrind`` with the ``callgrind`` tool enabled. Allowed values are the
	+ same as for ``PCMK_debug``.
	+
	+ * - .. _valgrind_opts:
	+
	+ .. index::
	+ pair:: node option; VALGRIND_OPTS
	+
	+ VALGRIND_OPTS
	+ - :ref:`text <text>`
	+ -
	+ - Advanced Use Only: Pass these options to valgrind, when enabled (see
	+ ``valgrind(1)``). ``"--vgdb=no"`` should usually be specified because
	+ ``pacemaker-execd`` can lower privileges when executing commands, which
	+ would otherwise leave a bunch of unremovable files in ``/tmp``.
	diff --git a/doc/sphinx/conf.py.in b/doc/sphinx/conf.py.in
	index 7d843d82b7..7d74cbf05b 100644
	--- a/doc/sphinx/conf.py.in
	+++ b/doc/sphinx/conf.py.in
	@@ -1,319 +1,328 @@
	""" Sphinx configuration for Pacemaker documentation
	"""

	__copyright__ = "Copyright 2020-2023 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
	#
	# .. \|<abbr>\| replace:: <Full text>
	#
	# where occurrences of \|<abbr>\| in the rST will be substituted with <Full text>
	rst_prolog="""
	.. \|CFS_DISTRO\| replace:: AlmaLinux
	.. \|CFS_DISTRO_VER\| replace:: 9
	+.. \|CRM_BLACKBOX_DIR\| replace:: ``%CRM_BLACKBOX_DIR%``
	+.. \|CRM_DAEMON_GROUP\| replace:: ``%CRM_DAEMON_GROUP%``
	+.. \|CRM_DAEMON_USER\| replace:: ``%CRM_DAEMON_USER%``
	+.. \|CRM_SCHEMA_DIRECTORY\| replace:: %CRM_SCHEMA_DIRECTORY%
	+.. \|PCMK_AUTHKEY_FILE\| replace:: %PACEMAKER_CONFIG_DIR%/authkey
	+.. \|PCMK_CONFIG_FILE\| replace:: ``%CONFIGDIR%/pacemaker``
	+.. \|PCMK_INIT_ENV_FILE\| replace:: ``%PACEMAKER_CONFIG_DIR%/pcmk-init.env``
	+.. \|PCMK_LOG_FILE\| replace:: %CRM_LOG_DIR%/pacemaker.log
	+.. \|PCMK_GNUTLS_PRIORITIES\| replace:: %PCMK_GNUTLS_PRIORITIES%
	.. \|REMOTE_DISTRO\| replace:: AlmaLinux
	.. \|REMOTE_DISTRO_VER\| replace:: 9
	"""

	# 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('%ABS_TOP_SRCDIR%/python'))

	# -- 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 = ['sphinx.ext.autodoc',
	'sphinx.ext.autosummary']

	# 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
	# "<project> v<release> 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 <link> 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_engine = "xelatex"

	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 = 'https://www.clusterlabs.org/pacemaker/doc/2.1/%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

	autosummary_generate = True

File Metadata

Mime Type: text/x-diff
Expires: Mon, Apr 21, 6:16 PM (20 h, 5 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1665171
Default Alt Text: (37 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions