Add hash_on cookie load balancing docs #726
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tieske
requested changes
May 30, 2018
app/docs/0.14.x/admin-api.md
Outdated
| `hash_on`<br>*optional* | What to use as hashing input: `none`, `consumer`, `ip`, or `header` (defaults to `none` resulting in a weighted-round-robin scheme). | ||
| `hash_fallback`<br>*optional* | What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no consumer identified): `none`, `consumer`, `ip`, or `header` (defaults to `none`). | ||
| `hash_on`<br>*optional* | What to use as hashing input: `none`, `consumer`, `ip`, `header`, or `cookie` (defaults to `none` resulting in a weighted-round-robin scheme). | ||
| `hash_fallback`<br>*optional* | What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no consumer identified). Not availble if `hash_on` is `cookie`. One of: `none`, `consumer`, `ip`, `header`, or `cookie` (defaults to `none`). |
There was a problem hiding this comment.
I'd turn the clauses around (and a typo in available)
One of:
none,consumer,ip,header, orcookie(defaults tonone, not available ifhash_onis set tocookie).
app/docs/0.14.x/admin-api.md
Outdated
| `hash_on_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_on` is set to `header`). | ||
| `hash_fallback_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_fallback` is set to `header`). | ||
| `hash_on_cookie`<br>*semi-optional* | The cookie name to take the value from as hash input (only required when `hash_on` is set to `cookie`) If the specified cookie is not in the request, the response will set a value. |
There was a problem hiding this comment.
add hash fallback (and add a dot)
when either
hash_onorhash_on_fallbackis set to `cookie.
last part is a bit awkward
If the specified cookie is not in the request, a value will be generated and set in the response.
app/docs/0.14.x/admin-api.md
Outdated
| `hash_on_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_on` is set to `header`). | ||
| `hash_fallback_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_fallback` is set to `header`). | ||
| `hash_on_cookie`<br>*semi-optional* | The cookie name to take the value from as hash input (only required when `hash_on` is set to `cookie`) If the specified cookie is not in the request, the response will set a value. | ||
| `hash_on_cookie_path`<br>*semi-optional* | The cookie path to set in the response headers (only required when `hash_on` is set to `cookie`, defaults to `"/"`) |
app/docs/0.14.x/loadbalancing.md
Outdated
| `hash_fallback_cookie` field) with a specified path (in the `hash_on_cookie_path` | ||
| field, default `"/"`) as input for the hash. If the cookie is not present in the | ||
| request, it will be set by the response, hence the `hash_on_fallback` setting is | ||
| invalid if `cookie` is the primary hashing mechanism. |
There was a problem hiding this comment.
hash_fallback_cookie field no longer exists
jtschulz
force-pushed
the
release/ce-0.14.0
branch
from
f423dbf to
318b14c
Compare
|
Thanks @Tieske . Fixed those (and tweaked phrasing in a few other places). |
See Kong/kong#3416 Signed-off-by: Thibault Charbonnier <[email protected]>
Both versions were deprecated in 0.12.0. See Kong/kong#3490 From Kong#724 Signed-off-by: Thibault Charbonnier <[email protected]>
thibaultcha
force-pushed
the
release/ce-0.14.0
branch
from
8bc7e44 to
df215cf
Compare
All references to the API entity must be sent to the 0.13.x version of the Admin API reference. Signed-off-by: Thibault Charbonnier <[email protected]>
Tieske
requested changes
May 31, 2018
app/docs/0.14.x/admin-api.md
Outdated
| `hash_on_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_on` is set to `header`). | ||
| `hash_fallback_header`<br>*semi-optional* | The header name to take the value from as hash input (only required when `hash_fallback` is set to `header`). | ||
| `hash_on_cookie`<br>*semi-optional* | The cookie name to take the value from as hash input (only required when `hash_on` or `hash_fallback` is set to `cookie`). If the specified cookie is not in the request, Kong will generate a value and set in the response. |
There was a problem hiding this comment.
and set in the response.
not proper?
|
seems it also needs some conflicts to be resolved |
jtschulz
force-pushed
the
release/ce-0.14.0
branch
from
784c0fa to
c918932
Compare
|
I had tried to resolve the conflicts in the github UI, but the merge looked funny. Cleaned the commit history up and addressed that last comment. |
Tieske
approved these changes
Jun 1, 2018
|
@hishamhm @thibaultcha either of you want to review and merge? |
|
I will take a look, always; there is no rush since this is scheduled for 0.14 which we will be picking a date for. |
thibaultcha
force-pushed
the
release/ce-0.14.0
branch
4 times, most recently
from
9619ca5 to
51808cc
Compare
thibaultcha
pushed a commit
that referenced
this pull request
Jun 28, 2018
|
Manually merged, thank you @PepperTeasdale! |
ukiahsmith
pushed a commit
that referenced
this pull request
Jul 2, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add documentation for new feature in kong admin API