feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase #5270

tobiasehlert · 2023-03-08T09:53:35Z

Description

This PR adds documentation of ignore_uri_case parameter in the cache-proxy plugin added with PR Kong/kong#10453.

Testing instructions

Netlify link: https://deploy-preview-5270--kongdocs.netlify.app

Checklist

Review label added
PR pointed to correct branch (release/gateway-3.3)

netlify · 2023-03-08T09:53:40Z

✅ Deploy Preview for kongdocs ready!

Name	Link
🔨 Latest commit	`4e2add8`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdocs/deploys/64134a55fbcac90008766a43
😎 Deploy Preview	https://deploy-preview-5270--kongdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

cloudjumpercat

Thanks for making these changes! I made a small suggestion for wording if you want to see if that's accurate. I also added a label "blocked by kong", so we'll wait until your kong repo PR is merged before we merge this one.

app/_hub/kong-inc/proxy-cache-advanced/_index.md

app/_hub/kong-inc/proxy-cache/_index.md

Co-authored-by: Diana <[email protected]>

tobiasehlert · 2023-03-15T12:22:07Z

@cloudjumpercat now Kong/kong#10453 got merged :)

Something to change on this PR like switching from main to some other branch?
This is probably coming with Kong release 3.3.0

cloudjumpercat · 2023-03-15T16:55:22Z

@tobiasehlert Thanks for letting me know!

@samugi Do you know if Kong/kong#10453 will be going out with Gateway 3.3? I didn't see any labels on the PR, so I wasn't sure.

app/_hub/kong-inc/proxy-cache-advanced/_index.md

app/_hub/kong-inc/proxy-cache/_index.md

samugi · 2023-03-15T18:27:24Z

@tobiasehlert Thanks for letting me know!

@samugi Do you know if Kong/kong#10453 will be going out with Gateway 3.3? I didn't see any labels on the PR, so I wasn't sure.

@cloudjumpercat yep, 3.3

Co-authored-by: Samuele Illuminati <[email protected]>

cloudjumpercat · 2023-03-16T13:50:34Z

@tobiasehlert Could you change the base branch of this PR to release/gateway-3.3? Then we can get it merged and it'll be published with the Gateway 3.3 release.

tobiasehlert · 2023-03-16T13:53:06Z

@tobiasehlert Could you change the base branch of this PR to release/gateway-3.3? Then we can get it merged and it'll be published with the Gateway 3.3 release.

@cloudjumpercat, done :)

cloudjumpercat · 2023-03-16T16:27:53Z

@tobiasehlert Thanks for doing that! Sorry for not catching this sooner, but it looks like the only thing remaining to do before this can be merged is to add ignore_uri_case to the dictionary file for Vale. Looks like that's what's causing the Vale check failures.

To do that, all you'd have to do is add ignore_uri_case to this file: https://github.com/Kong/docs.konghq.com/blob/main/.github/styles/kongplugins/plugin-ignore.txt

tobiasehlert · 2023-03-16T17:19:49Z

@cloudjumpercat done! Now all checks are green 🥳

cloudjumpercat

LGTM! Thanks for making these updates!

…o be handled as lowercase (#5270) * feat(proxy-cache): add cache_lowercase_uri param * renaming parameter to ignore_uri_case * feat(proxy-cache): apply suggestions from code review Co-authored-by: Diana <[email protected]> * feat(proxy-cache): removed in proxy-cache-advanced * feat(proxy-cache): apply suggestions from code review Co-authored-by: Samuele Illuminati <[email protected]> * feat(proxy-cache): add param to plugin-ignore --------- Co-authored-by: Diana <[email protected]> Co-authored-by: Samuele Illuminati <[email protected]>

* gateway 3.3 metadata * feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase (#5270) * feat(proxy-cache): add cache_lowercase_uri param * renaming parameter to ignore_uri_case * feat(proxy-cache): apply suggestions from code review Co-authored-by: Diana <[email protected]> * feat(proxy-cache): removed in proxy-cache-advanced * feat(proxy-cache): apply suggestions from code review Co-authored-by: Samuele Illuminati <[email protected]> * feat(proxy-cache): add param to plugin-ignore --------- Co-authored-by: Diana <[email protected]> Co-authored-by: Samuele Illuminati <[email protected]> * docs(acme): add account_key for acme plugin (#5222) * docs(acme): add account_key for acme plugin * docs(acme): add keys/keyset configuration for acme plugin * Update app/_hub/kong-inc/acme/_index.md Co-authored-by: lena-larionova <[email protected]> * Update app/_hub/kong-inc/acme/_index.md Co-authored-by: lena-larionova <[email protected]> * Update app/_hub/kong-inc/acme/_index.md Co-authored-by: lena-larionova <[email protected]> * Update app/_hub/kong-inc/acme/_index.md Co-authored-by: lena-larionova <[email protected]> --------- Co-authored-by: lena-larionova <[email protected]> * feat(logging): add workspace name in the logging payload (#5251) Co-authored-by: lena.larionova <[email protected]> * docs(http-log): plugin schema update for 3.3 (#5326) * feat(plugins): added second available content-type option to http-log plugin * add version tags and a changelog entry --------- Co-authored-by: lena-larionova <[email protected]> * docs(proxy-cache-advanced): add ignore_uri_case (#5458) * docs(proxy-cache-advanced): add ignore_uri_case add ignore_uri_case parameter to proxy-cache-advanced docs * Update app/_hub/kong-inc/proxy-cache-advanced/_index.md Co-authored-by: lena-larionova <[email protected]> * Set minimum version on param --------- Co-authored-by: lena-larionova <[email protected]> * docs(request-transformer): untrusted_lua (#5499) add changelog for untrusted lua to request transformer and request transformer advanced plugins * docs(aws-lambda): add new disable_https field (#5486) * docs(aws-lambda): add new disable_https field * add changelog entry * phrasing adjustment for changelog --------- Co-authored-by: lena-larionova <[email protected]> * docs(3.3) remove references to 'default tracing_sampling_rate' (#5517) * docs(acme): support redis namespace (#5366) * docs(acme): support redis namespace correspond to [Kong/kong#10562](Kong/kong#10562) `namespace` will be treated as a prefix of key and is default to empty string `""` for backward compatibility. `namespace` must not be prefixed with any of the reserved words. [KAG-615](https://konghq.atlassian.net/browse/KAG-615) * update * Fix Vale errors Signed-off-by: Diana <[email protected]> * Apply suggestions from code review --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Diana <[email protected]> * feat(proxy-cache): add wildcard and parameter match support for content_type (#5420) * feat(proxy-cache): add wildcard and parameter match support for content_type * Apply suggestions from code review Co-authored-by: Michael Heap <[email protected]> * set version tags for 3.3; add missing changelog entry for proxy cache --------- Co-authored-by: lena-larionova <[email protected]> Co-authored-by: Michael Heap <[email protected]> Co-authored-by: lena.larionova <[email protected]> * datadog: now host is referenceable (#5353) * datadog: now host is referenceable * Update app/_hub/kong-inc/datadog/_index.md Co-authored-by: lena-larionova <[email protected]> * kubernetes section * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> * Update app/_hub/kong-inc/datadog/_index.md Co-authored-by: Harry <[email protected]> * - fix indents - add changelog entry - adjust phrasing for intro to kubernetes section and add navtabs - set version tags --------- Co-authored-by: lena-larionova <[email protected]> Co-authored-by: Victor Yu <[email protected]> Co-authored-by: Harry <[email protected]> Co-authored-by: lena.larionova <[email protected]> * [DOCU-3216] Status Endpoint link (#5541) * add status endpoint * add absolute_url * Fix description of routing priorities with multiple paths (#5533) * Fix description of routing priorities with multiple paths * Apply suggestions from code review --------- Co-authored-by: Diana <[email protected]> * Revert "feat(logging): add workspace name in the logging payload (#52… (#5547) Revert "feat(logging): add workspace name in the logging payload (#5251)" This reverts commit 37df8eb. * fix(oauth2): add a changelog entry (#5548) * fix(oauth2): add a changelog entry * rephrase for clarity --------- Co-authored-by: lena-larionova <[email protected]> * [DOCU-2921] Status endpoint + Kong health check (#5419) * Create health-check.md New page + tutorial tempalte for KAG-76 * docs: health check * Update health-check.md * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Chrono <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Chrono <[email protected]> * Update health-check.md * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Chrono <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Update app/_src/gateway/production/monitoring/health-check.md Co-authored-by: Datong Sun <[email protected]> * Change some phrasing These are all small adjustments. * Update status_listen enablement step * s/configured/enabled/ to match other updates * Add response examples to usage instructions * Fixup code blocks * Add health check link to navbar * Fixup response code/messages * Use the correct link syntax * Add reference to monitoring index/overview * Inline port number comment in yaml block * Prettify JSON for readability * Update app/_src/gateway/production/monitoring/index.md Co-authored-by: Vinicius Mignot <[email protected]> * readiness instead of health * Apply suggestions from code review Co-authored-by: Vinicius Mignot <[email protected]> * s/ready to work/ready to accept requests/ * add control_plane explanation * apply review suggestions * more review comments addressing * Update app/_src/gateway/production/monitoring/readiness-check.md Co-authored-by: Harry <[email protected]> * Revert "Update app/_src/gateway/production/monitoring/readiness-check.md" This reverts commit d68d904. * wording and formatting * Copy edit * link --------- Co-authored-by: pluveto <[email protected]> Co-authored-by: Zijing Zhang <[email protected]> Co-authored-by: Chrono <[email protected]> Co-authored-by: Datong Sun <[email protected]> Co-authored-by: Michael Martin <[email protected]> Co-authored-by: Michael Martin <[email protected]> Co-authored-by: Chrono <[email protected]> Co-authored-by: Vinicius Mignot <[email protected]> Co-authored-by: Harry <[email protected]> Co-authored-by: Angel <[email protected]> * Reworked plugin queues (#5088) * Reworked plugin queues documentation * Add queueing parameters to relevant plugin docs * Mention queues in sizing guidelines * Add batch queue overview and reference * Remove consumer batching section, add results sentence to why queues are needed Signed-off-by: Diana <[email protected]> * Apply copy edits Co-authored-by: Hans Hübner <[email protected]> * Rework how queue parameters are included in plugin docs * Can't include paramters * Quote queue parameter names * remove comment * remove comment * Change batch queue to queue, fix links, add link to Zipkin to about plugin queues Signed-off-by: Diana <[email protected]> * Fix links to queue reference Signed-off-by: Diana <[email protected]> * Apply conditional rendering to queue content * Add conditional rendering to queue parameters * Fix minimum_version spacing Signed-off-by: Diana <[email protected]> * Fix queue param spacing in http log plugin doc Signed-off-by: Diana <[email protected]> * Apply suggestions from code review Co-authored-by: Diana <[email protected]> Co-authored-by: Angel <[email protected]> * Update app/_src/gateway/production/sizing-guidelines.md Co-authored-by: Angel <[email protected]> * Fix link and add conditional rendering to sizing guidelines page --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Diana <[email protected]> Co-authored-by: Angel <[email protected]> * [DOCU-3051] Auto docs 3.3 (#5549) * autodocs * Apply suggestions from code review * config.md add EE info * Update app/_src/gateway/reference/configuration.md Co-authored-by: lena-larionova <[email protected]> --------- Co-authored-by: lena-larionova <[email protected]> * Timeout support for dynamic log levels (#5550) * Timeout support for dynamic log levels KAG-5 DOCU-2903 * Update app/_src/gateway/production/logging/update-log-level-dynamically.md * Update app/_src/gateway/production/logging/update-log-level-dynamically.md --------- Co-authored-by: Angel <[email protected]> * Spec links (#5553) add links to specs * chore: update 3.3 nav to include all updates in 3.2 * [DOCU-3065] Data plane labels in konnect (#5554) * document using custom dp labels in konnect * Update app/konnect/runtime-manager/runtime-instances/custom-dp-labels.md --------- Co-authored-by: Angel <[email protected]> * [DOCU-3167] Add Amazon Linux 2023 to support page (#5536) * Add Amazon Linux 2023 to support page Signed-off-by: Diana <[email protected]> * Add Amazon Linux 2023 tab to install instructions Signed-off-by: Diana <[email protected]> * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> * Add 3.3 to browser and third-party support, add AL2023 Yum repo tab Signed-off-by: Diana <[email protected]> * Update app/_data/tables/support/gateway/versions/33.yml Co-authored-by: lena-larionova <[email protected]> * Add Amazon Graviton note to install pages Signed-off-by: Diana <[email protected]> * Remove mentions of Graviton Signed-off-by: Diana <[email protected]> * Fix EOL date for 3.3 Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: lena-larionova <[email protected]> * Revert "[DOCU-3167] Add Amazon Linux 2023 to support page" (#5559) Revert "[DOCU-3167] Add Amazon Linux 2023 to support page (#5536)" This reverts commit 9c64603. * Fixes to log level doc (#5570) fixes * Support page updates for 3.3 (#5569) * update support pages for 3.3 * update one more version Co-authored-by: Angel <[email protected]> --------- Co-authored-by: Angel <[email protected]> * Fix errors after rebase * feat: add aws iam authentication to rds feature document (#5503) * feat: add aws iam authentication to rds feature document * refine doc * add more tips * ssl maximum version is limited by rds * add mentioning cluster resource id syntax for aurora * adjust a bit about IAM role assignment and add the case of running kong locally * make onboarding smoother by providing ways to connect to rds using psql; refine the wording on read/write and read/only mode description * mention tlsv1.3 not supported one more time in the limitations; refine wording of the highlight of this feature * Edit title, introduction, and start of prereqs section Signed-off-by: Diana <[email protected]> * Finish copy edits Signed-off-by: Diana <[email protected]> * Apply tech review feedback Signed-off-by: Diana <[email protected]> * Fix some grammar errors and spelling Signed-off-by: Diana <[email protected]> * Apply suggestions from code review Co-authored-by: Qirui(Keery) Nie <[email protected]> * Update app/_src/gateway/kong-enterprise/aws-iam-auth-to-rds-database.md Co-authored-by: Qirui(Keery) Nie <[email protected]> * Fix limitations descriptions based on tech review feedback Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Diana <[email protected]> * Plugin queuing diagrams (#5583) * Add plugin queue diagrams Signed-off-by: Diana <[email protected]> * Fix Figure number on second one Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> * add 3.3 compatibility table updates (#5573) add 3.3 compatability issues Adds compatability issues for release 3.3. * Remove centos from 3.3 support table * [DOCU-3169] Changelog for gateway 3.3.0.0 (#5562) * changelog for gateway 3.3.0.0 * added reminders about deprecations and links to API specs * set release date * [DOCU-3215] 3.3 upgrade guide (#5590) * Add upgrade table for 3.3 Signed-off-by: Diana <[email protected]> * Fix rolling upgrades column for 3.1.x releases * Add info about plugin queue breaking changes to upgrade doc Signed-off-by: Diana <[email protected]> * Add traditional_compat and Plugins to breaking changes section Signed-off-by: Diana <[email protected]> * Fix changelog link Signed-off-by: Diana <[email protected]> * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: lena-larionova <[email protected]> * [docu-3186] SOBM page (#5558) * add page * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> * rename --------- Co-authored-by: lena-larionova <[email protected]> * [fix] 3.2.2 changelog (#5605) * fix 3.2.2 changelog * move content into the right places --------- Co-authored-by: lena.larionova <[email protected]> * Add known issues to 3.3 changelog (#5599) * lmdb known issue * adding more known issues * spacing * Apply suggestions from code review Co-authored-by: Datong Sun <[email protected]> --------- Co-authored-by: Angel <[email protected]> Co-authored-by: Datong Sun <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Tobias Lindberg <[email protected]> Co-authored-by: Diana <[email protected]> Co-authored-by: Samuele Illuminati <[email protected]> Co-authored-by: Steve Zesch <[email protected]> Co-authored-by: Xiaoyan Rao <[email protected]> Co-authored-by: Jack Tysoe <[email protected]> Co-authored-by: Qirui(Keery) Nie <[email protected]> Co-authored-by: Enrique García Cota <[email protected]> Co-authored-by: Zhefeng C <[email protected]> Co-authored-by: Yusheng Li <[email protected]> Co-authored-by: Michael Heap <[email protected]> Co-authored-by: Xumin <[email protected]> Co-authored-by: Victor Yu <[email protected]> Co-authored-by: Harry <[email protected]> Co-authored-by: Angel <[email protected]> Co-authored-by: Hans Hübner <[email protected]> Co-authored-by: Amy Goldsmith <[email protected]> Co-authored-by: pluveto <[email protected]> Co-authored-by: Zijing Zhang <[email protected]> Co-authored-by: Chrono <[email protected]> Co-authored-by: Datong Sun <[email protected]> Co-authored-by: Michael Martin <[email protected]> Co-authored-by: Michael Martin <[email protected]> Co-authored-by: Chrono <[email protected]> Co-authored-by: Vinicius Mignot <[email protected]> Co-authored-by: Murillo <[email protected]> Co-authored-by: Fabian Rodriguez <[email protected]> Co-authored-by: Alex Gaesser <[email protected]>

feat(proxy-cache): add cache_lowercase_uri param

9f8ff27

tobiasehlert requested a review from a team as a code owner March 8, 2023 09:53

tobiasehlert mentioned this pull request Mar 8, 2023

feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase Kong/kong#10453

Merged

3 tasks

renaming parameter to ignore_uri_case

16e7c2d

tobiasehlert changed the title ~~feat(proxy-cache): add cache_lowercase_uri to configuring cache-key uri to be handled as lowercase~~ feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase Mar 10, 2023

cloudjumpercat added blocked:kong Issues/PRs waiting on Kong PRs to merge before it can be solved review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? labels Mar 10, 2023

cloudjumpercat reviewed Mar 10, 2023

View reviewed changes

app/_hub/kong-inc/proxy-cache-advanced/_index.md Outdated Show resolved Hide resolved

app/_hub/kong-inc/proxy-cache/_index.md Outdated Show resolved Hide resolved

cloudjumpercat added the do not merge Issues/ PRs whose changes should not be merged at this time label Mar 10, 2023

feat(proxy-cache): apply suggestions from code review

1e09b5d

Co-authored-by: Diana <[email protected]>

samugi requested changes Mar 15, 2023

View reviewed changes

app/_hub/kong-inc/proxy-cache-advanced/_index.md Outdated Show resolved Hide resolved

app/_hub/kong-inc/proxy-cache/_index.md Outdated Show resolved Hide resolved

tobiasehlert and others added 2 commits March 15, 2023 19:42

feat(proxy-cache): removed in proxy-cache-advanced

d03e05e

feat(proxy-cache): apply suggestions from code review

1e83161

Co-authored-by: Samuele Illuminati <[email protected]>

tobiasehlert requested a review from samugi March 15, 2023 18:45

samugi approved these changes Mar 15, 2023

View reviewed changes

tobiasehlert changed the base branch from main to release/gateway-3.3 March 16, 2023 13:52

cloudjumpercat self-assigned this Mar 16, 2023

feat(proxy-cache): add param to plugin-ignore

4e2add8

cloudjumpercat approved these changes Mar 16, 2023

View reviewed changes

cloudjumpercat merged commit 1d6d6e2 into Kong:release/gateway-3.3 Mar 16, 2023

cloudjumpercat added this to the Gateway 3.3 milestone Mar 16, 2023

tobiasehlert deleted the add-cache-key-uri-lowercase-parameter branch March 16, 2023 18:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase #5270

feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase #5270

tobiasehlert commented Mar 8, 2023 •

edited

Loading

netlify bot commented Mar 8, 2023 •

edited

Loading

cloudjumpercat left a comment

tobiasehlert commented Mar 15, 2023

cloudjumpercat commented Mar 15, 2023

samugi commented Mar 15, 2023 •

edited

Loading

cloudjumpercat commented Mar 16, 2023

tobiasehlert commented Mar 16, 2023 •

edited

Loading

cloudjumpercat commented Mar 16, 2023

tobiasehlert commented Mar 16, 2023

cloudjumpercat left a comment

feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase #5270

feat(proxy-cache): add ignore_uri_case to configuring cache-key uri to be handled as lowercase #5270

Conversation

tobiasehlert commented Mar 8, 2023 • edited Loading

Description

Testing instructions

Checklist

netlify bot commented Mar 8, 2023 • edited Loading

✅ Deploy Preview for kongdocs ready!

cloudjumpercat left a comment

Choose a reason for hiding this comment

tobiasehlert commented Mar 15, 2023

cloudjumpercat commented Mar 15, 2023

samugi commented Mar 15, 2023 • edited Loading

cloudjumpercat commented Mar 16, 2023

tobiasehlert commented Mar 16, 2023 • edited Loading

cloudjumpercat commented Mar 16, 2023

tobiasehlert commented Mar 16, 2023

cloudjumpercat left a comment

Choose a reason for hiding this comment

tobiasehlert commented Mar 8, 2023 •

edited

Loading

netlify bot commented Mar 8, 2023 •

edited

Loading

samugi commented Mar 15, 2023 •

edited

Loading

tobiasehlert commented Mar 16, 2023 •

edited

Loading