From 9017f4c48b12df6411ca37775badf31444202392 Mon Sep 17 00:00:00 2001 From: "Jason R. Rokeach" Date: Wed, 15 May 2024 11:44:44 -0400 Subject: [PATCH] Minor documentation fixes --- README.md | 6 +++--- examples/2regions-hrr/README.md | 2 +- examples/load-balanced-route-servers/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 39f9c6f..122bb5c 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,12 @@ At this time and in the project's raw form, *meshrr* should not be considered fo kubectl create secret generic crpd-license --from-file=crpd-license= ``` Note that `` must point to a file that contains the singular license line and not an entire license file. - 4. (If required) Custom configuration Jinja2 templates loaded into ConfigMaps and mapped as volumes. See [Examples](#Examples). -4. (If required - e.g., for [2regions-hrr](examples/2regions-hrr/) where only certain nodes should host certain clusters of RRs) Apply appropriate labels to the nodes: +4. (If required) Custom configuration Jinja2 templates loaded into ConfigMaps and mapped as volumes. See [Examples](#Examples). +5. (If required - e.g., for [2regions-hrr](examples/2regions-hrr/) where only certain nodes should host certain clusters of RRs) Apply appropriate labels to the nodes: ```bash kubectl label nodes = = ``` -5. Apply your configuration: +6. Apply your configuration: ```bash kubectl [-n namespace] apply -f kubectl [-n namespace] apply -f diff --git a/examples/2regions-hrr/README.md b/examples/2regions-hrr/README.md index 30b3090..9276107 100644 --- a/examples/2regions-hrr/README.md +++ b/examples/2regions-hrr/README.md @@ -5,7 +5,7 @@ ## Description * This topology has two regions, `mirkwood` and `lothlorian`, and a `core` region. * Within a region, all cRPDs are fully meshed via iBGP to provide maximum visibility within the region. -* All cRPDs in a region other than `core` have BGP peerings with up to 2 `core` cRPDs. The `core` cRPDs serve as route reflectors for the non-core regions. (The limit of 2 is hard coded on upstream peer groups.) +* All cRPDs in a region other than `core` have BGP peerings with up to 2 `core` cRPDs as dictated by the `max_peers` setting. The `core` cRPDs serve as route reflectors for the non-core regions. * **Redundancy groups and anycast addressing:** * Each node is assigned to redundancy group `a` or `b`. (In a production environment, two separate Kubernetes clusters may be desirable.) * For each region with neighbors outside the cluster, separate DaemonSets are created for `a` and `b`, each with a unique IP address for that [meshrr_region:redundancy_group] combination. This IP address is used for iBGP peering with neighbors outside the cluster. diff --git a/examples/load-balanced-route-servers/README.md b/examples/load-balanced-route-servers/README.md index 340c129..80e31f0 100644 --- a/examples/load-balanced-route-servers/README.md +++ b/examples/load-balanced-route-servers/README.md @@ -45,7 +45,7 @@ preferred; } # MetalLB Anycast Peer - address 192.168.255.0/32/32; + address 192.168.255.0/32; } } }