Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jrokeach committed May 15, 2024
1 parent 42ec518 commit 9017f4c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<filepath>
```
Note that `<filepath>` 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 <node> <label1>=<value> <label2>=<value>
```
5. Apply your configuration:
6. Apply your configuration:
```bash
kubectl [-n namespace] apply -f <file1>
kubectl [-n namespace] apply -f <file2>
Expand Down
2 changes: 1 addition & 1 deletion examples/2regions-hrr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/load-balanced-route-servers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
preferred;
}
# MetalLB Anycast Peer
address 192.168.255.0/32/32;
address 192.168.255.0/32;
}
}
}
Expand Down

0 comments on commit 9017f4c

Please sign in to comment.