From: Marcin Siodelski Date: Thu, 24 May 2018 16:16:02 +0000 (+0200) Subject: [5632] HA class prefix is now upper case in the docs. X-Git-Tag: trac5382a_base~2^2~6 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=73ed3f7abaaa887e9933e01d74a6ca7f7d736edb;p=thirdparty%2Fkea.git [5632] HA class prefix is now upper case in the docs. --- diff --git a/doc/examples/kea4/ha-load-balancing-primary.json b/doc/examples/kea4/ha-load-balancing-primary.json index 4430c5b509..25caa6951f 100644 --- a/doc/examples/kea4/ha-load-balancing-primary.json +++ b/doc/examples/kea4/ha-load-balancing-primary.json @@ -43,12 +43,12 @@ // This class corresponds with a scope of the server1. // It must be always declared. { - "name": "ha_server1" + "name": "HA_server1" }, // This class corresponds with a scope of the server2. // It must be always declared. { - "name": "ha_server2" + "name": "HA_server2" }, // phones class { @@ -60,27 +60,27 @@ "name": "laptops", "test": "not member('phones')" }, - // Some phones will be handled by server1. Whether the ha_server1 - // or ha_server2 is assigned for the client is a matter of load + // Some phones will be handled by server1. Whether the HA_server1 + // or HA_server2 is assigned for the client is a matter of load // balancing performed by the HA hooks library. { "name": "phones_server1", - "test": "member('phones') and member('ha_server1')" + "test": "member('phones') and member('HA_server1')" }, // Some phones will be handled by server2. { "name": "phones_server2", - "test": "member('phones') and member('ha_server2')" + "test": "member('phones') and member('HA_server2')" }, // Some laptops will be handled by server1. { "name": "laptops_server1", - "test": "member('laptops') and member('ha_server1')" + "test": "member('laptops') and member('HA_server1')" }, // Some laptops will be handled by server2. { "name": "laptops_server2", - "test": "member('laptops') and member('ha_server2')" + "test": "member('laptops') and member('HA_server2')" } ], diff --git a/doc/guide/hooks-ha.xml b/doc/guide/hooks-ha.xml index 0b0a52df74..702483c628 100644 --- a/doc/guide/hooks-ha.xml +++ b/doc/guide/hooks-ha.xml @@ -281,13 +281,13 @@ hot-standby primary or standby (hot standby mode) enabled - ha_server1 if primary, none otherwise + HA_server1 if primary, none otherwise load-balancing primary or secondary (load balancing mode) enabled - ha_server1 or ha_server2 + HA_server1 or HA_server2 partner-down @@ -333,16 +333,16 @@ any names can be used as long as they remain unique. In the load balancing mode there are two scopes named after - the active servers: ha_server1 and - ha_server2. The DHCP queries load balanced to the - server1 belong to the ha_server1 + the active servers: HA_server1 and + HA_server2. The DHCP queries load balanced to the + server1 belong to the HA_server1 scope and the queries load balanced to the server2 - belong to the ha_server2 scope. If any of the + belong to the HA_server2 scope. If any of the servers is in the partner-down state, it is responsible for serving both scopes. In the hot standby mode, there is only one scope - ha_server1 because only the server1 + HA_server1 because only the server1 is responding to the DHCP queries. If that server becomes unavailable, the server2 becomes responsible for this scope. @@ -453,11 +453,11 @@ "pools": [ { "pool": "192.0.3.100 - 192.0.3.150", - "client-class": "ha_server1" + "client-class": "HA_server1" }, { "pool": "192.0.3.200 - 192.0.3.250", - "client-class": "ha_server2" + "client-class": "HA_server2" } ], @@ -635,7 +635,7 @@ Load Balancing with Advanced Classification In the previous section we have provided an example which demonstrated the load balancing configuration with the client classification limited - to the use of ha_server1 and ha_server2 + to the use of HA_server1 and HA_server2 classes, which are dynamically assigned to the received DHCP queries. In many cases it will be required to use HA in deployments which already use some client classification. @@ -648,8 +648,8 @@ is expected to result in further split of each of those pools, so as each of the servers can allocate leases for some part of the phones and part of the laptops. This requires that each of the existing pools - should be split between the ha_server1 and - ha_server2, so we end up with the following classes: + should be split between the HA_server1 and + HA_server2, so we end up with the following classes: phones_server1 @@ -670,12 +670,12 @@ { // No test expression for this class. Incoming packets will be // assigned to that class dynamically by the HA Hook library. - "name": "ha_server1" + "name": "HA_server1" }, { // No test expression for this class. Incoming packets will be // assigned to that class dynamically by the HA Hook library. - "name": "ha_server2" + "name": "HA_server2" }, { "name": "phones", @@ -687,19 +687,19 @@ }, { "name": "phones_server1", - "test": "member('phones') and member('ha_server1')" + "test": "member('phones') and member('HA_server1')" }, { "name": "phones_server2", - "test": "member('phones') and member('ha_server2')" + "test": "member('phones') and member('HA_server2')" }, { "name": "laptops_server1", - "test": "member('laptops') and member('ha_server1')" + "test": "member('laptops') and member('HA_server1')" }, { "name": "laptops_server2", - "test": "member('laptops') and member('ha_server2')" + "test": "member('laptops') and member('HA_server2')" } ], @@ -765,15 +765,15 @@ four pools. Two pools are dedicated to server1 and two are dedicated for server2. Each server can assign leases to both phones and laptops. Both groups of devices are assigned addresses from different pools. - Note that definition of classes ha_server1 and - ha_server2 is required because other classes + Note that definition of classes HA_server1 and + HA_server2 is required because other classes refer to them via member expression. These classes do not include test parameter because they are not evaluated with other classes. They are assigned dynamically by the HA hook library as a result of load balancing algorithm. The phones_* and laptop_* evaluate to "true" when the query belongs to a given combination - of other classes, e.g. ha_server1 and + of other classes, e.g. HA_server1 and phones. The pool will be selected accordingly as a result of such evaluation. @@ -839,7 +839,7 @@ "pools": [ { "pool": "192.0.3.100 - 192.0.3.250", - "client-class": "ha_server1" + "client-class": "HA_server1" } ], @@ -878,7 +878,7 @@ active server is set to. Finally, because there is always one server responding to the - DHCP queries, there is only one scope ha_server1 + DHCP queries, there is only one scope HA_server1 in use within pools definitions. In fact, the client-class parameter could be removed from this configuration without harm, because there are no conflicts in lease allocations by different @@ -1083,14 +1083,14 @@ "command": "ha-scopes", "service": [ "dhcp4 "], "arguments": { - "scopes": [ "ha_server1", "ha_server2" ] + "scopes": [ "HA_server1", "HA_server2" ] } } This command configures the server to handle traffic from - both ha_server1 and ha_server2 + both HA_server1 and HA_server2 scopes. In order to disable all scopes specify an empty list: