Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(canary) fix omissions in Canary plugin docs #1868

Merged
merged 2 commits into from
Mar 22, 2020
Merged

fix(canary) fix omissions in Canary plugin docs #1868

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
846bc66
fix(canary) fix omissions in Canary plugin docs
Tieske Mar 19, 2020
7acf0cf
Canary plugin added periods
GayleNeumann Mar 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions app/_hub/kong-inc/canary/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ kong_version_compatibility:

params:
name: canary
api_id: true
service_id: true
route_id: true
consumer_id: true
consumer_id: false
config:
- name: start
required:
Expand Down Expand Up @@ -86,7 +85,14 @@ params:
default: consumer
value_in_examples:
description: |
Entity to be used for hashing. Options: consumer, ip, or none. Please make sure when not using none, to properly set the settings for `trusted_ips` (see settings `trusted_ips` and `real_ip_header` in the Kong config file)
Entity to be used for hashing. Options: `consumer`, `ip`, `whitelist`, `blacklist`, or `none`. Please make sure when using `consumer` or `ip`, to properly set the settings for trusted ips (see settings `trusted_ips` and `real_ip_header` in the Kong config file)
- name: groups
required:
default:
value_in_examples:
description: |
An array (of strings) with the groupnames that are white/blacklisted. Set `hash` to either `whitelist` (the listed groups
go into the canary) or `blacklist` (the listed groups will NOT go into the canary)

---

Expand Down