doc(balancer) drop the orderlist property (#511)

pr #511, goes with Kong/kong#2748
Kong · Jan 16, 2018 · 8795478 · 8795478
1 parent 0b68318
commit 8795478
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 78 deletions.
diff --git a/app/docs/0.12.x/admin-api.md b/app/docs/0.12.x/admin-api.md
@@ -42,7 +42,6 @@ upstream_body: |
     ---:| ---
     `name` | This is a hostname like name that can be referenced in an `upstream_url` field of an `api`.
     `slots`<br>*optional* | The number of slots in the loadbalancer algorithm (`10`-`65536`, defaults to `1000`).
-    `orderlist`<br>*optional* | A list of sequential, but randomly ordered, integer numbers that determine the distribution of the slots in the balancer. If omitted it will be generated. If given, it must have exactly `slots` number of entries.
 
 certificate_body: |
     Attributes | Description
@@ -1414,18 +1413,6 @@ Requests for this API would be proxied to the targets defined within the upstrea
 ```json
 {
     "name": "service.v1.xyz",
-    "orderlist": [
-        1,
-        2,
-        7,
-        9,
-        6,
-        4,
-        5,
-        10,
-        3,
-        8
-    ],
     "slots": 10
 }
 ```
@@ -1452,18 +1439,6 @@ HTTP 201 Created
 {
     "id": "13611da7-703f-44f8-b790-fc1e7bf51b3e",
     "name": "service.v1.xyz",
-    "orderlist": [
-        1,
-        2,
-        7,
-        9,
-        6,
-        4,
-        5,
-        10,
-        3,
-        8
-    ],
     "slots": 10,
     "created_at": 1485521710265
 }
@@ -1491,18 +1466,6 @@ HTTP 200 OK
 {
     "id": "13611da7-703f-44f8-b790-fc1e7bf51b3e",
     "name": "service.v1.xyz",
-    "orderlist": [
-        1,
-        2,
-        7,
-        9,
-        6,
-        4,
-        5,
-        10,
-        3,
-        8
-    ],
     "slots": 10,
     "created_at": 1485521710265
 }
@@ -1540,36 +1503,12 @@ HTTP 200 OK
             "created_at": 1485521710265,
             "id": "13611da7-703f-44f8-b790-fc1e7bf51b3e",
             "name": "service.v1.xyz",
-            "orderlist": [
-                1,
-                2,
-                7,
-                9,
-                6,
-                4,
-                5,
-                10,
-                3,
-                8
-            ],
             "slots": 10
         },
         {
             "created_at": 1485522651185,
             "id": "07131005-ba30-4204-a29f-0927d53257b4",
             "name": "service.v2.xyz",
-            "orderlist": [
-                5,
-                3,
-                6,
-                1,
-                2,
-                10,
-                8,
-                7,
-                4,
-                9
-            ],
             "slots": 10
         }
     ],
@@ -1604,18 +1543,6 @@ HTTP 200 OK
 {
     "id": "4d924084-1adb-40a5-c042-63b19db421d1",
     "name": "service.v1.xyz",
-    "orderlist": [
-        1,
-        2,
-        7,
-        9,
-        6,
-        4,
-        5,
-        10,
-        3,
-        8
-    ],
     "slots": 10,
     "created_at": 1422386534
 }

diff --git a/app/docs/0.12.x/loadbalancing.md b/app/docs/0.12.x/loadbalancing.md
@@ -133,11 +133,8 @@ number of slots change for example.
 The only occurrence where the balancer will be rebuilt automatically is when 
 the target history is cleaned; other than that, it will only rebuild upon changes.
 
-Within the balancer there are the positions (from 1 to `slots`) on the ring,
-which each get a 'slot' assigned 1-on-1. Hence there are also `slots` number of slots, but
-they are __randomly distributed__ over the ring positions. This randomness can be
-set by using the `orderlist`, but we strongly advice against doing that.
-
+Within the balancer there are the positions (from 1 to `slots`),
+which are __randomly distributed__ on the ring.
 The randomness is required to make invoking the ring-balancer cheap at 
 runtime. A simple round-robin over the wheel (the positions) will do to 
 provide a well distributed weighted round-robin over the `targets`, whilst