Skip to content

Commit

Permalink
Minor docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
jrokeach committed Oct 23, 2023
1 parent f78a332 commit 4fddeb5
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ At this time and in the project's raw form, *meshrr* should not be considered fo
- [Introduction](#introduction)
- [Instructions](#instructions)
- [Prerequisites](#prerequisites)
- [Quickstart](#quickstart)
- [Usage](#usage)
- [Environment Variables](#environment-variables)
- [Methodology](#methodology)
- [Containers](#containers)
- [BGP Group Types](#bgp-group-types)
- [Examples](#examples)

## Instructions
Expand Down Expand Up @@ -53,7 +54,7 @@ At this time and in the project's raw form, *meshrr* should not be considered fo
| Variable | Required for | Optional for | Description |
| -------------- | ------------------- | ------------ | ------------------------------------------------------------ |
| LICENSE_KEY | meshrr-init | | Range to allow. Currently, this accepts only one CIDR block. Format: `network/mask-length` |
| LICENSE_KEY | meshrr-init | | License key to be used for the cRPD container; expected to be a single line. |
| POD_IP | meshrr-init, meshrr | | The pod's IP address. Must be set by Kubernetes manifest in all pod templates for all meshrr containers. This does not need to be set for the cRPD containers. (`valueFrom: fieldRef: fieldPath: status.podIP`) |
| UPDATE_SECONDS | | meshrr | Frequency in seconds that `meshrr` container will attempt to update `crpd` container with changes to peers. (Default: 30) |
Expand Down

0 comments on commit 4fddeb5

Please sign in to comment.