summaryrefslogtreecommitdiff
path: root/controller/README.md
diff options
context:
space:
mode:
authorTravis LaDuke <[email protected]>2019-11-15 10:27:48 -0800
committerTravis LaDuke <[email protected]>2019-11-15 10:29:39 -0800
commite744c95c5bd5bc63900d04bc2d2a5f5c313d0b7e (patch)
tree59e58f6c620f2f8134527743265abbaff0431d76 /controller/README.md
parenta725d1a29a694ba741e3d64f98779d4f3f5d79fc (diff)
Add Managed Routes example to controller readme.
Diffstat (limited to 'controller/README.md')
-rw-r--r--controller/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/controller/README.md b/controller/README.md
index 368613a6..0a76ebbc 100644
--- a/controller/README.md
+++ b/controller/README.md
@@ -134,6 +134,26 @@ IPv6 ranges work just like IPv4 ranges and look like this:
That defines a range within network `fd00:feed:feed:beef::/64` that contains up to 2^64 addresses. If an IPv6 range is large enough, the controller will assign addresses by placing each member's device ID into the address in a manner similar to the RFC4193 and 6PLANE modes. Otherwise it will assign addresses at random.
+**Managed Route object format:**
+
+| Field | Type | Description |
+| --------------------- | ------------- | ------------------------------------------------- |
+| target | string | Subnet in CIDR notation |
+| via | string/null | Next hop router IP address |
+
+Managed Route objects look like this:
+
+ {
+ "target": "10.147.20.0/24"
+ }
+
+or
+
+ {
+ "target": "192.168.168.0/24",
+ "via": "10.147.20.1"
+ }
+
**Rule object format:**
Each rule is actually a sequence of zero or more `MATCH_` entries in the rule array followed by an `ACTION_` entry that describes what to do if all the preceding entries match. An `ACTION_` without any preceding `MATCH_` entries is always taken, so setting a single `ACTION_ACCEPT` rule yields a network that allows all traffic. If no rules are present the default action is `ACTION_DROP`.