2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 05:55:28 +00:00

[#810,!471] Changed title levels in hooks-*.rst files

- mostly --- to ~~~
This commit is contained in:
Tomek Mrugalski
2019-08-16 19:58:41 +02:00
parent e90577743e
commit f1ae84186b
7 changed files with 39 additions and 36 deletions

View File

@@ -22,7 +22,7 @@ support contract.
``kea-dhcp6`` process.
Commands Structure
------------------
~~~~~~~~~~~~~~~~~~
There are 5 types of commands supported by this library:
@@ -78,7 +78,7 @@ the configuration of the server receiving the command.
.. _cb-cmds-dhcp:
Control Commands for DHCP Servers
---------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes and gives some examples of the control commands
implemented by the ``cb_cmds`` hooks library, to manage the

View File

@@ -20,7 +20,7 @@ customers with a paid support contract.
.. _command-class-add:
The class-add Command
---------------------
~~~~~~~~~~~~~~~~~~~~~
The ``class-add`` command adds a new client class to the DHCP server
configuration. This class is appended at the end of the list of classes
@@ -62,7 +62,7 @@ Here is the response to the ``class-add`` command in our example:
.. _command-class-update:
The class-update Command
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
The ``class-update`` command updates an existing client class in the
DHCP server configuration. If the client class with the given name
@@ -111,7 +111,8 @@ the new name will be added at the end of the list of configured classes.
.. _command-class-del:
The class-del Command
---------------------
~~~~~~~~~~~~~~~~~~~~~
The ``class-del`` command is used to remove a particular class from the server
configuration. The class to be removed is identified by name. The class
@@ -146,7 +147,8 @@ If the class does not exist, the result of 3 is returned.
.. _command-class-list:
The class-list Command
----------------------
~~~~~~~~~~~~~~~~~~~~~~
``class-list`` is used to retrieve a list of all client classes. This
command includes no arguments:
@@ -184,7 +186,8 @@ merely class names. To retrieve full class information, the
.. _command-class-get:
The class-get Command
---------------------
~~~~~~~~~~~~~~~~~~~~~
``class-get`` is used to retrieve detailed information about a specified
class. The command structure is very simple:

View File

@@ -41,7 +41,7 @@ The following sections describe the configuration and operation of the
Kea HA hook library.
Supported Configurations
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
The Kea HA hook library supports two configurations, also known as HA
modes: load-balancing and hot-standby. In the load-balancing mode, two
@@ -92,7 +92,7 @@ responses, because not only do active servers send lease updates to each
other, but also to the backup servers.
Clocks on Active Servers
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
Synchronized clocks are essential for the HA setup to operate reliably.
The servers share lease information via lease updates and during
@@ -128,7 +128,7 @@ clocks and restart the servers.
.. _ha-server-states:
Server States
-------------
~~~~~~~~~~~~~
.. _command-ha-heartbeat:
@@ -303,7 +303,7 @@ for more details).
.. _ha-scope-transition:
Scope Transition in a Partner-Down Case
---------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When one of the servers finds that its partner is unavailable, it starts
serving clients from both its own scope and the scope of the unavailable
@@ -334,7 +334,7 @@ back to the correct server via the rebinding mechanism.
.. _ha-load-balancing-config:
Load-Balancing Configuration
----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following is the configuration snippet to enable high availability
on the primary server within the load-balancing configuration. The same
@@ -515,7 +515,7 @@ available, ``server1`` will allocate the lease from the pool of
.. _ha-load-balancing-advanced-config:
Load Balancing with Advanced Classification
-------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the previous section, we provided an example of a load-balancing
configuration with client classification limited to the ``HA_server1``
@@ -622,7 +622,7 @@ expression and class dependencies.
.. _ha-hot-standby-config:
Hot-Standby Configuration
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~
The following is an example configuration of the primary server in the
hot-standby configuration:
@@ -703,7 +703,7 @@ hot-standby and load-balancing modes of operation.
.. _ha-sharing-lease-info:
Lease Information Sharing
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~
An HA-enabled server informs its active partner about allocated or
renewed leases by sending appropriate control commands, and the partner
@@ -784,7 +784,7 @@ designed to maximize flexibility of administration.
.. _ha-syncing-page-limit:
Controlling Lease-Page Size Limit
---------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An HA-enabled server initiates synchronization of the lease database
after downtime or upon receiving the ``ha-sync`` command. The server
@@ -807,7 +807,7 @@ less than 10000 lines.
.. _ha-syncing-timeouts:
Timeouts
--------
~~~~~~~~
In deployments with a large number of clients connected to the network,
lease-database synchronization after a server failure may be a
@@ -885,7 +885,7 @@ the Kea source at: ``src/lib/config/timeouts.h``.
.. _ha-pause-state-machine:
Pausing the HA State Machine
----------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The high-availability state machine includes many different states
described in detail in :ref:`ha-server-states`. The server
@@ -1063,7 +1063,7 @@ states anyway.
.. _ha-ctrl-agent-config:
Control Agent Configuration
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~
:ref:`kea-ctrl-agent` describes in detail the Kea daemon, which
provides a RESTful interface to control the Kea servers. The same
@@ -1102,7 +1102,7 @@ load-balancing and the hot-standby cases presented in previous sections.
.. _ha-control-commands:
Control Commands for High Availability
--------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Even though the HA hook library is designed to automatically resolve
issues with DHCP service interruptions by redirecting the DHCP traffic
@@ -1124,7 +1124,7 @@ library which are available for the administrator.
.. _command-ha-sync:
The ha-sync Command
~~~~~~~~~~~~~~~~~~~
-------------------
The ``ha-sync`` command instructs the server to synchronize its local
lease database with the selected peer. The server fetches all leases
@@ -1172,7 +1172,7 @@ database inconsistencies.
.. _command-ha-scopes:
The ha-scopes Command
~~~~~~~~~~~~~~~~~~~~~
---------------------
This command allows modification of the HA scopes that the server is
serving. Consult :ref:`ha-load-balancing-config` and
@@ -1207,7 +1207,7 @@ specify an empty list:
.. _command-ha-continue:
The ha-continue Command
~~~~~~~~~~~~~~~~~~~~~~~
-----------------------
This command is used to resume the operation of the paused HA state
machine, as described in :ref:`ha-pause-state-machine`. It takes no arguments, so the

View File

@@ -54,7 +54,7 @@ available.
.. _command-cache-flush:
The cache-flush Command
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
This command allows removal of a specified number of cached host
entries. It takes one parameter, which defines the number of hosts to be
@@ -74,7 +74,7 @@ hosts, please use cache-clear instead. The hosts are stored in FIFO
.. _command-cache-clear:
The cache-clear Command
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
This command allows removal of all cached host entries. An example usage
looks as follows:
@@ -91,7 +91,7 @@ number of cached hosts, please use cache-flush instead.
.. _command-cache-size:
The cache-size Command
----------------------
~~~~~~~~~~~~~~~~~~~~~~
This command returns the number of host entries. An example usage looks
as follows:
@@ -105,7 +105,7 @@ as follows:
.. _command-cache-write:
The cache-write Command
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
In general, the cache content is considered a runtime state and the
server can be shut down or restarted as usual; the cache will then be
@@ -135,7 +135,7 @@ processed by any other tool that is able to understand JSON format.
.. _command-cache-load:
The cache-load Command
----------------------
~~~~~~~~~~~~~~~~~~~~~~
See the previous section for a discussion of use cases where it may be
useful to write and load contents of the host cache to disk.
@@ -158,7 +158,7 @@ processed by any other tool that is able to understand JSON format.
.. _command-cache-get:
The cache-get Command
---------------------
~~~~~~~~~~~~~~~~~~~~~
This command is similar to cache-write, but instead of writing the cache
contents to disk, it returns the contents to whoever sent the command.
@@ -179,7 +179,7 @@ may be large.
.. _command-cache-get-by-id:
The cache-get-by-id Command
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~
This command is similar to cache-get, but instead of returning the whole
content it returns only the entries matching the given identifier.
@@ -202,7 +202,7 @@ address.
.. _command-cache-insert:
The cache-insert Command
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
This command may be used to manually insert a host into the cache; there
are very few use cases when this command might be useful. This command
@@ -263,7 +263,7 @@ looks as follows:
.. _command-cache-remove:
The cache-remove Command
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
Sometimes it is useful to remove a single entry from the host cache. A
good use case is a situation where the device is up, Kea has already

View File

@@ -100,7 +100,7 @@ servers.
.. _command-lease6-add:
The lease4-add, lease6-add Commands
-----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``lease4-add`` and ``lease6-add`` commands allow for the creation of
a new lease. Typically Kea creates a lease when it first sees a new

View File

@@ -44,7 +44,7 @@ specified for a particular class.
.. _hooks-radius-install:
Compilation and Installation of the RADIUS Hook
-----------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following section describes how to compile and install the software
on CentOS 7.0. Other systems may differ slightly.
@@ -289,7 +289,7 @@ option is recommended to speed up the build.
.. _hooks-radius-config:
RADIUS Hook Configuration
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~
The RADIUS hook is a library that has to be loaded by either DHCPv4 or
DHCPv6 Kea servers. Unlike some other available hooks libraries, this one

View File

@@ -62,7 +62,7 @@ configuration, Kea will not retrieve statistics for it.
.. _command-stat-lease6-get:
The stat-lease4-get, stat-lease6-get Commands
---------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``stat-lease4-get`` and ``stat-lease6-get`` commands fetch lease
statistics for a range of known subnets. The range of subnets is