소스 검색

Add Managed Routes example to controller readme.

Travis LaDuke 5 년 전
부모
커밋
e744c95c5b
1개의 변경된 파일20개의 추가작업 그리고 0개의 파일을 삭제
  1. 20 0
      controller/README.md

+ 20 - 0
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`.