From 40c751cab44375d1b463220e7805286a8484a461 Mon Sep 17 00:00:00 2001 From: Francis Dupont Date: Wed, 7 Aug 2019 16:53:04 +0200 Subject: [PATCH] [804-cb-doc-never-says-clearly-how-to-configure-server-tag-on-a-server] First attempt to deocument server-tag --- doc/examples/kea4/config-backend.json | 3 +++ doc/examples/kea6/config-backend.json | 3 +++ doc/sphinx/arm/config-backend.rst | 1 + doc/sphinx/arm/dhcp4-srv.rst | 1 + doc/sphinx/arm/dhcp6-srv.rst | 1 + 5 files changed, 9 insertions(+) diff --git a/doc/examples/kea4/config-backend.json b/doc/examples/kea4/config-backend.json index 637ad8433e..8ea41f4990 100644 --- a/doc/examples/kea4/config-backend.json +++ b/doc/examples/kea4/config-backend.json @@ -6,6 +6,9 @@ { "Dhcp4": { + // Set the server tag for the configuration backend. + "server-tag": "my DHCPv4 server", + // Kea is told to listen on ethX interface only. "interfaces-config": { "interfaces": [ "ethX" ] diff --git a/doc/examples/kea6/config-backend.json b/doc/examples/kea6/config-backend.json index 8956462d3f..082013e2b7 100644 --- a/doc/examples/kea6/config-backend.json +++ b/doc/examples/kea6/config-backend.json @@ -6,6 +6,9 @@ { "Dhcp6": { + // Set the server tag for the configuration backend. + "server-tag": "my DHCPv6 server", + // Kea is told to listen on ethX interface only. "interfaces-config": { "interfaces": [ "ethX" ] diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst index a689194fa2..0783f490a4 100644 --- a/doc/sphinx/arm/config-backend.rst +++ b/doc/sphinx/arm/config-backend.rst @@ -29,6 +29,7 @@ network grows, the usefulness of the CB becomes obvious. A good example of a use case for the CB is a pair of Kea DHCP servers which can be configured to support High Availability as described in :ref:`high-availability-library`. The configurations of both servers +(as known as the server tag: the value of the "server-tag" parameter) are almost exactly the same. They may differ by the server identifier and designation of the server as a primary or standby (or secondary). They may also differ by the interfaces configuration. Typically, the diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 95a0c0f8bf..07b96eb8e9 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -5681,6 +5681,7 @@ Consider the following configuration snippet: :: "Dhcp4": { + "server-tag": "my DHCPv4 server", "config-control": { "config-databases": [{ "type": "mysql", diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index 8a013a1520..72479f286f 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -5731,6 +5731,7 @@ Configuration Backend for the DHCPv6 server: { "Dhcp6": { + "server-tag": "my DHCPv6 server", "config-control": { "config-databases": [ { -- 2.47.2