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.

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

Add wasm filter config schema document #6459

Merged
merged 6 commits into from
Nov 7, 2023

Conversation

flrgh
Copy link
Contributor

@flrgh flrgh commented Nov 6, 2023

Description

This adds documentation for the filter config schema feature added in 3.5: link.

In doing so, I have also slightly updated the navbar/organization for Proxy-Wasm topics in the gateway docs.

Testing instructions

Links:

Checklist

  • Review label added
  • PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

Ref: KAG-2727

@flrgh flrgh added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. labels Nov 6, 2023
@flrgh flrgh requested a review from a team as a code owner November 6, 2023 00:51
Copy link

netlify bot commented Nov 6, 2023

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit a8bbaff
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/654a7bfc1a797a00076b14e6
😎 Deploy Preview https://deploy-preview-6459--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 92 (🟢 up 2 from production)
Accessibility: 80 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 90 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@flrgh flrgh added this to the Gateway 3.5 milestone Nov 6, 2023
@flrgh flrgh force-pushed the gateway/wasm-filter-meta branch 2 times, most recently from 889ad5d to cd9b6f8 Compare November 6, 2023 01:01
@flrgh
Copy link
Contributor Author

flrgh commented Nov 6, 2023

🤔 the build error is a little cryptic. Anyone know what's up with that?

@lena-larionova lena-larionova self-assigned this Nov 6, 2023
@lena-larionova
Copy link
Contributor

lena-larionova commented Nov 6, 2023

the build error is a little cryptic. Anyone know what's up with that?

took me a bit of guessing here, but turns out the new topic was missing a chapter attribute, since all the PDK guide docs are part of a "book".

Only hint for that was that the book generator failed:

/home/runner/work/docs.konghq.com/docs.konghq.com/app/_plugins/generators/book.rb:18:in `sort!': comparison of Jekyll::GeneratorSingleSource::SingleSourcePage with Jekyll::GeneratorSingleSource::SingleSourcePage failed (ArgumentError)

@flrgh flrgh force-pushed the gateway/wasm-filter-meta branch from 7a58dae to a3e91b9 Compare November 7, 2023 17:30
@flrgh flrgh force-pushed the gateway/wasm-filter-meta branch from a3e91b9 to a8bbaff Compare November 7, 2023 18:03
@flrgh flrgh requested a review from lena-larionova November 7, 2023 18:03
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@lena-larionova lena-larionova merged commit 77c51b6 into release/gateway-3.5 Nov 7, 2023
@lena-larionova lena-larionova deleted the gateway/wasm-filter-meta branch November 7, 2023 18:32
Guaris added a commit that referenced this pull request Nov 8, 2023
* create 3.5 pages and bump version

* feat(opentelemetry): propagate GCP trace header (#5829)

feat(opentelemetry): propagate GCP header

* feat(request-id): introduce Request ID (#6163)

* feat(request-id): introduce Request ID

Docs for Kong/kong#11624 where the Request ID is
introduced.

Few minor changes to the log serializer as well to make mapping between
IDs easier.

* fix if statement

* fix if statement in other plugin

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* update submodule for 3.5 placeholders

* feat(labels): add on premise dp labels (#6173)

* Update plugin submodule to Lena's placeholder branch

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat(oidc): certificate bound access tokens (#6284)

* feat(oidc): certificate bound access tokens

Docs for: Kong/kong-ee#6446

* Apply copyedits and some minor formatting

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* GW 3.5 Self-hosted Portal and Vitals Sustaining Mode  (#6341)

* test

* more deprecation

* spelling on redirects

* shot scraper

* shot scraper

* Feat: Add /schemas/vaults/:name endpoint [skip-ci] (#6347)

Add 3.5 specs and schema vault endpoint

* docs(vaults): add docs for Azure Key Vault support in Kong Gateway (#6215)

* docs(vaults): add docs for Azure Key Vault support in Kong Gateway

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* fixes

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* nav bar

* copy edits

* style

---------

Signed-off-by: Joshua Schmid <jaiks@posteo.de>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Angel <angel.guarisma@konghq.com>

* feat: kong gateway's aws vault backend now supports automatic IAM credential fetch and role assuming (#6181)

* feat: kong gateway's aws vault backend now supports automatic IAM credential fetch and role assuming

* apply suggestions

* update docs

Co-authored-by: Hans Hübner <hans.huebner@gmail.com>

* copy edit

---------

Co-authored-by: Hans Hübner <hans.huebner@gmail.com>
Co-authored-by: Angel <angel.guarisma@konghq.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* fix: cert bound access token conditional rendering (#6349)

Add conditional rendering for cert-bound access tokens, fix note formatting

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat: Kong Manager forced workspace deletion (#6327)

* Update workspace deletion instructions, add changelog entry about forced KM workspace deletion

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Consolidate delete workspace sections, fix changelog formatting

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add missing API option to auto delete entities

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix kong-plugin submodule sha

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Fix step formatting, clarify what entities are deleted

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add conditional rendering

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Conditionally render the delete workspace section, remove Portal CLI from 3.5 instructions

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Feat: Rename Kong Enterprise to Kong Gateway Enterprise (#6372)

* kong enterprise rename

* update product name and use variables wherever possible

* feature tables alignment with longer name

* add some missing enterprise badges; use correct variables on gateway overview

* appease vale

* remove broken links

* update the admin_gui_auth_conf of the OIDC (#6331)

* update the admin_gui_auth_conf of the OIDC

* fix vale error

* Update app/_src/gateway/kong-manager/auth/oidc/configure.md

Co-authored-by: Makito <sumimakito@hotmail.com>

* Update app/_src/gateway/kong-manager/auth/oidc/configure.md

Co-authored-by: Makito <sumimakito@hotmail.com>

* Add conditional rendering, revise the table, make copy edits

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Makito <sumimakito@hotmail.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat: aws lambda plugin now supports more IAM-based authentication scenarios (#6002)

* feat: aws lambda plugin now supports more IAM-based authentication scenarios

* Add to vale dictionary, fix conditional rendering, copyedits

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat(license_report): update description of licensing report (#6307)

* feat(license_report): update description of licensing report

* version the source file

* comment out 3.4 source file until 3.4 patch goes out

---------

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* feat: dedicated config processing (#6442)

* feat: dedicated config processing

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* minor formatting edits

* remove backticks from around hybrid

---------

Signed-off-by: Joshua Schmid <jaiks@posteo.de>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* feat(openid-connect): cert-bound tokens doc edits (#6441)

feat(openid-connect): cert-bound tokens typos

few typos and rewording of the openid-connect certificate-bound tokens
feature

* chore: Update Gateway config reference for 3.5 (#6445)

update config reference for 3.5

* chore: Remove performance testing framework from 3.5 (#6452)

remove performance testing framework from 3.5

* chore: Copy over nav changes from 3.4 to 3.5 (#6455)

* copy over nav changes from 3.4 to 3.5

* use better url for consumer groups

* Gateway 3.5 Autodocs (#6419)

* Autodocs

* update spec

* Chore: Support matrix updates for Gateway 3.5 (#6470)

add EOL date for 3.5; update PG supported versions

* chore: Replace mockbin with httpbin/httpbun (#6453)

* replace mockbin with httpbin/httpbun

* Update app/_src/gateway/get-started/proxy-caching.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

---------

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* chore: add compatibility updates for Gateway 3.5 release (#6474)

* chore: add compatibility updates for Gateway 3.5 release
Adds version compatibility issues for gateway v3.5.
Rewords "data plane" -> "data plane node".

* fix: formatting and names

* change single quote to backtick

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* docs(plugins): add docs about `plugin:configure` handler (#6463)

* docs(plugins): add docs about `plugin:configure` handler

### Summary

In Kong 3.5 we added `plugin:configure` as an additional handler that is
called each time there is a change in Kong plugin iterator.

This commit adds documentation for it.

Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com>

* if_version + cleanup

---------

Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com>
Co-authored-by: Angel <angel.guarisma@konghq.com>

* Add wasm filter config schema document (#6459)

* Add wasm filter config schema document

* fix indents & add missing chapter metadata

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* revert some unintentional whitespace changes

* relocate draft-4 disclaimer

* rework request/response format

---------

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* chore: Dev Portal broken links (#6484)

* fix redirects

* re-add deleted redirects

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Release 3.5 Changelog (#6471)

* save

* changelog

* formatting and cleanup; rephrase the Dev Portal and Vitals entry + add to breaking changes

* copyedit changelog and add plugin changelog entries to plugin changelogs

* add fix entry for oidc plugin in 3.5

* backport missing plugin changelog entries to 3.4

* add a couple of entries to breaking changes

* add links to docs

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* add some more links; apply reviewer feedback

---------

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Chore: update upgrade paths for Gateway 3.5 (#6482)

* Add 3.5 upgrade path to table, remove duplicate links to general upgrade instructions

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update based on LTS versions

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat: Request Debug Header docs for Kong Gateway 3.5 (#6475)

* Add request debug header page to 3.5 as well as changelog

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Remove changelog entry

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Move debug request to logging section

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Move debug request doc to logging folder, reformat json examples

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Move debug request file to stop test from failing

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Joshua Schmid <jaiks@posteo.de>
Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: Jon Ruskin <jon.ruskin@gmail.com>
Co-authored-by: Samuele <samuele@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Joshua Schmid <joshua.schmid@konghq.com>
Co-authored-by: Qirui(Keery) Nie <windmgc@gmail.com>
Co-authored-by: Hans Hübner <hans.huebner@gmail.com>
Co-authored-by: Xiaoyan Rao <270668624@qq.com>
Co-authored-by: Makito <sumimakito@hotmail.com>
Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Yufu Zhao <ms2008vip@gmail.com>
Co-authored-by: Alex Gaesser <alex.gaesser@konghq.com>
Co-authored-by: Aapo Talvensaari <aapo.talvensaari@gmail.com>
Co-authored-by: Michael Martin <flrgh@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants