Changelog

May 5, 2025 · View on GitHub

Week 18

fix: Incorrect links in azure content safety docs (2025-04-29)

This PR fixes two incorrect links pointing to AI prompt decorator in the Azure content safety main doc.

Modified

Release: Gateway 3.4.3.18 (2025-04-29)

3.4.3.18 changelog and version bump.

Modified

Update geo.md (2025-04-28)

Added France Central to Azure regions

Modified

Week 17

Modified

Modified

chore: Mention that we don't support kafka 4.0 (2025-04-24)

Kafka 4.0 was released last month and users are running into problems because we don't explicitly say that we don't support it.

https://konghq.atlassian.net/browse/KAG-6911

Modified

update: Warn users about very high sync rates in RLA (2025-04-24)

Added a table and info about window size and sync rate interactions in RLA, and what strategy they should use.

Modified

Update transit-gateways.md (2025-04-23)

Added more details on AWS routing tables setup

Modified

update script for ai-rag (2025-04-24)

The script should be updated

Modified

update script for ai-rate-limiting plugin (2025-04-23)

update script

Modified

Update konnect-configuration.md (2025-04-23)

Updating the decK file to reflect PrivateLink updates

Modified

Added Section for making Konnect Admin API requests over PrivateLink

  1. https://konghq.atlassian.net/browse/CSRE-4181
  2. https://konghq.atlassian.net/browse/CSRE-3768

Modified

Week 16

Modified

fix(ai): update options-param templating documentation (2025-04-17)

Updated AI "templated options" example for a better sub-string sample configuration.

Modified

update ai-sanitizer doc (2025-04-17)

update ai-sanitizer doc

Modified

Update aws-privatelink.md (2025-04-17)

  • Added India endpoint to all regions
  • Added ap-southeast-1
  • Added us-west-2

https://konghq.aha.io/features/PLAT-2

Modified

fix: Add 3.10 to Konnect compatibility table (2025-04-16)

Added 3.10 to Konnect compatibility table

https://kongstrong.slack.com/archives/CDSTDSG9J/p1744771182817609

Modified

Feat: New Request Callout examples (2025-04-16)

Request Callout examples requested on Slack

Modified

docs(portal): snippets page header (2025-04-15)

Reference “Snippets” instead of “Pages” on the snippet page

Modified

Release: Gateway 2.8.4.14 (2025-04-14)

Changelog and version bump for gateway 2.8.4.14

Modified

Updated ai-rag-injector docs (2025-04-14)

An approach to update the content of ai-rag-injector plugin for Kong instances in hybrid mode or Konnect mode.

Modified

Release: Gateway 3.10.0.1 (2025-04-15)

Changelog and version bump for 3.10.0.1

Modified

[TDX-5270] Snippets docs (2025-04-14)

Added nav item & docs for Snippets, in preparation of releasing the feature

Added

Modified

Week 15

Release: Gateway 3.8.1.1 (2025-04-11)

Changelog and version bump for 3.8.1.1.

Modified

Release: Gateway 3.7.1.5 (2025-04-11)

Changelog and version bump for 3.7.1.5.

Modified

Update geo.md (2025-04-09)

Updated regions for Azure, added Google tab

Modified

Added a note in changelog for ai-rate-limiting-advanced plugin (2025-04-09)

A note is added to describe how to transform a deck yaml config that is exported from a previous version to the latest version where huggingface is supported as the llm_providers in ai-rate-limiting-advanced plugin

Modified

Update cluster_type (2025-04-09)

In the Konnect API CLUSTER_TYPE_HYBRID was deprecated some time ago and no longer exists (see Control Plane schema). The Terraform provider only still supports CLUSTER_TYPE_HYBRID to prevent state recreation. Moving forward CLUSTER_TYPE_CONTROL_PLANE should be used.

See also: https://kongstrong.slack.com/archives/C04RXLGNB6K/p1727707794692459

Modified

Modified

Fix: Consume plugins tiers (2025-04-08)

This is an enterprise plugin.

Modified

Fix: Update geos list for DCGWs (2025-04-08)

Updating the geos list to accurately reflect what's currently available.

Modified

Fix: Remove labels from konnect search query for teams (2025-04-07)

Teams don't support labels, so this sample query is invalid. Removing the labels portion leaves the example as a valid logical AND example.

Issue reported on slack.

Modified

Fix: Missing Auth Headers & Request Body in Token Creation API Call (2025-04-07)

Fix system account token creation process

  • Add required authentication header with bearer token
  • Include proper request body in the API call
  • Set correct content-type header

ref: https://docs.konghq.com/konnect/api/identity-management/latest/#/operations/post-system-accounts-id-access-tokens

Modified

Remove outdated Runtime groups parameter (2025-04-07)

CLUSTER_TYPE_COMPOSITE -> CLUSTER_TYPE_CONTROL_PLANE_GROUP

Modified

[AI RAG Injector] How to - Update title of step 2 (2025-04-07)

Fix misleading title for step 2

Modified

Week 14

Added the memory requirement for the PII service docker image (2025-04-03)

The memory requirement is added to the ai-sanitizer plugin's document page as a note, so users can successfully run the image

Modified

  • Fixed broken markdown link from templates](/hub/...) to [templates](/hub/...)

Modified

Service Catalog feedback (2025-04-02)

Modified

Fix: Priority load balancing example (2025-04-02)

Fix algorithm field in priority load balancing example for AI Proxy Advanced

Modified

Fix: spelling (2025-04-02)

Modified

Fix: Update config-store.md for decK tab steps (2025-04-02)

Added missing steps from the decK tab for creating and linking the config store to the vault before referencing it in the decK YAML config file.

This was creating confusion for customers wanting to use decK with the Konnect Config Store.

Modified

fix: Centralized consumers parameter descriptions (2025-04-04)

Improved consumer group (and eventually allowed control plane) descriptions and added links to API endpoints.

https://kongstrong.slack.com/archives/C074KG8NX1B/p1743518122340309

Modified

chore(custom-pages): add notice about the 1000000 char limit (2025-04-01)

I added a notice about the limitations of custom pages. Slack thread

Modified

Fix: Add note about private Docker image (2025-03-31)

Added note to tell users to reach out to support to get access to the private AI PII Service Docker image

https://kongstrong.slack.com/archives/C06GB3KM155/p1743148798458789

Modified

Add AI RAG Injector Admin api usage (2025-04-02)

Modified

kgo: add KGO 1.5 docs (2025-04-02)

Add KGO 1.5 docs

Depends on

Related:

  • #8560
  • #8576

Closes https://github.com/Kong/gateway-operator/issues/1202

Modified

Week 13

Fix: title AI RAG INJECTOR (2025-03-28)

Modified

docs(plugins/request-callout): warn about forward behavior (2025-03-27)

Warn about request-callout forward behavior.

Modified

docs(portal): additional idp configuration (2025-03-27)

Provide additional IdP configuration information specifically related to the new Dev Portal and Konnect Portal Editor experience.

Based on this internal doc: https://docs.google.com/document/d/1_h2rsg4x77EnedPaILYKV1ce93IHHTPcqIVALCFw9lU/edit?tab=t.0

Modified

Chore: Move Gateway 2.8 into sunset support (2025-03-26)

Gateway 2.8 moves into sunset support tomorrow (march 26).

We hadn't updated the 2.8 non-single-sourced support policy for a while (oversight), so making the tables match the latest version.

Modified

Fix: Expressions route limitation on mTLS and TLS Handshake Modifier (2025-03-27)

Add note about limitation on expressions routes to the mTLS and TLS handshake modifier plugins.

https://konghq.atlassian.net/browse/FTI-6227

Modified

feat: add ai-rag-injector plugin (2025-03-27)

Fixes https://konghq.atlassian.net/browse/DOCU-4196

Added

Chore: remove tiers (2025-03-27)

https://konghq.atlassian.net/browse/DOCU-4189

Modified

Release: Gateway 3.4.3.17 (2025-03-26)

Changelog and version bump for 3.4.3.17

Modified

Week 12

Add AI pricing disclaimer (2025-03-20)

Add a note that AI plugins require additional licensing

Modified

CSRE-3763 Added documentation for 2 new edge gateway regions (2025-03-20)

Added new AWS Private Link regions

https://konghq.atlassian.net/browse/CSRE-3763

Modified

Regexp used: /gateway/api/admin-ee/latest/#(/(?!operations)([^/]+)/)(.*)/? Replaced with: /gateway/api/admin-ee/latest/#/operations/$3

Modified

fix: s/consumer/consume/g (2025-03-19)

Followup of https://github.com/Kong/docs.konghq.com/pull/8506

Mainly fixes to plugin naming and some enumeration corrections

Modified

Release: Gateway 3.9.1.1 (2025-03-21)

Changelog and version bump for 3.9.1.1

Modified

Fix APIOps introduction (2025-03-19)

"X, Y and Z" was a placeholder that snuck through

Modified

docs(ai-semantic-cache): add note on cache control behaviour (2025-03-18)

Add clarification of the cache_control config and explain the behaviour if being set with common AI services.

Modified

docs(ai-proxy-advanced): add new feature description for ai-proxy-advanced in 3.10 (2025-03-20)

Add following features:

  • ai-proxy-advanced: new priority algorithm
  • ai-proxy-advanced: failover creteria
  • ai-proxy-advanced: cost as tokens_count_strategy (mention log_statistics must be on)

Fixes: https://konghq.atlassian.net/browse/DOCU-4194 https://konghq.atlassian.net/browse/DOCU-4193

Modified

JWE: Update supported algorithms (2025-03-18)

The JWE plugin now supports more algorithms: https://github.com/Kong/kong-ee/pull/11074

Found in changelog.

Modified

fix(konnect): update Azure SAML claim attributes (2025-03-17)

I'm modifying the referenced email claim for Azure SAML applications, updating from user.email to. user.mail.

I'm also including a note in the Azure navtab that states "ensure the Namespace value is empty".

Screenshots are attached for additional Azure/SAML context and verification.

  • Default claims: Screenshot 2025-03-17 at 15 14 31
  • Claim edit window (showing Namespace): Screenshot 2025-03-17 at 15 15 29

Modified

fix: Dynatrace deployment options (2025-03-20)

Setting network_config_opts: All as a temp solution to avoid the incorrect entries in this table: https://docs.konghq.com/hub/plugins/compatibility/#analytics-monitoring

Issue came up on Slack.

Modified

feat: AppDynamics agent ARM support (2025-03-18)

KAG-4034

Modified

AI RLA: Support for multiple limits and window sizes (2025-03-18)

Modified

Week 10

docs(portal): reserved paths (2025-03-07)

Document the new Dev Portal reserved paths.

Modified

Rename title in transit-gateways.md (2025-03-07)

Issue reported at https://github.com/Kong/docs.konghq.com/issues/8296

Change title from "How to configure Transit Gateway" to "How to configure AWS Transit Gateway", so it clearly states this is an AWS product.

In the "Configure AWS Transit Gateway" section, replace "Create Transit Gateway" with "Create transit gateway", in lowercase, as this is the term appearing in AWS.

Modified

Update index.md (2025-03-07)

Added Other limits for Serverless

Modified

fix(deck): docker on Windows (2025-03-05)

Modified

Link to all available deck file lint rules

Modified

Add v3 API Builder API, insomnia fixes for other portal v3 APIs (2025-03-04)

Added required files for docs portal to list new API Builder v3, and added YAML versions of specs to potentially fix Insomnia links.

Modified

Dev Portal v3 docs (2025-03-03)

Preview app for the internal teams. Do not merge.

Added

Week 9

Fix Konnect cluster and telemetry hostnames (2025-02-27)

Changed the existing cluster and telemetry hostnames to CONTROL_PLANE_DNS_PREFIX to match feedback I got here: https://kongstrong.slack.com/archives/C04RXLGNB6K/p1740607033227059

Modified

Fix: Loggly plugin description update (2025-02-26)

Remove unrelated description of Syslog in Loggly page.

Modified

docs(json-threat-protection): add a description for the supported HTTP methods (2025-02-28)

Please merge this PR after the PR https://github.com/Kong/kong-ee/pull/11437 is merged.

Modified

Fix: transit gateways (2025-02-24)

Updated steps to ensure a customer has Tgw attachment for their own VPCs also.

Modified

Release: Gateway 3.7.1.4 (2025-02-27)

Changelog and version bump for 3.7.1.4

Modified

Update request-transformer-advanced examples to include replace.uri (2025-02-25)

Update request-transformer-advanced examples to include replace.uri

  • Added examples for replace.uri using static values and capturing groups.
  • Improved documentation to clarify usage.

Modified

Feat: service catalog score cards (2025-02-28)

https://konghq.atlassian.net/browse/DOCU-4184

Added

Modified

docs(mesh): moved k8s section of kumactl configuration (2025-02-25)

The instruction is a bit confusing and might suggest that user can access Konnect cluster with kubectl. I tried to moved it to the tip.

Modified

Week 8

Fix: route priority info (2025-02-22)

Modified

Update diff.md (2025-02-20)

Minor fix in deck gateway diff documentation

Modified

Week 6

extra space between period (2025-02-05)

Modified

Update the Dynatrace integration description (2025-02-03)

Updating the description of our Dynatrace implementation to provide more context, per request.

Modified

Week 5

Update custom-dns.md (2025-01-31)

Updating Serverless for CAA instructions

Updated the Serverless custom domains doc to include instructions on adding CAA to prevent CAA errors with Serverless GWs.

Modified

Update custom-dns.md (2025-01-31)

Updated to include instructions for CAA Records

Modified

Fix: Add missing queue parameter to table (2025-01-31)

We missed documenting the concurrency_limit queue parameter in 3.8. Removed the link to kong.conf from the changelog; these params aren't in kong.conf, they're in plugins.

Fixes https://github.com/Kong/docs.konghq.com/issues/8291.

Modified

Fix SSO Instructions (2025-01-29)

Improved the SSO Instructions, specifically the Okta instructions to be correct and more helpful for onboarding users.

Modified

docs(opentelemetry): better description of OTel logs (2025-01-29)

this commit follows up to https://github.com/Kong/kong/issues/14068 and tries to make the OTel logs description more clear / less open for interpretation.

Modified

Feat: Dedicated Cloud Gateways logs (2025-01-31)

https://deploy-preview-8380--kongdocs.netlify.app/konnect/gateway-manager/dedicated-cloud-gateways/data-plane-logs/

Added

Modified

Feat: Empty states and new dimensions (2025-01-30)

For the release of Empty states in Explorer.

Modified

docs(kgo): update references for 1.4.x (2025-01-28)

Adjusts the CRD references after releasing KGO v1.4.2.

Modified

chore: Adjust messaging around Vitals sustaining mode (2025-01-29)

Vitals is supported indefinitely for existing customer that have purchased it in the past, same as Dev Portal. Adjusting the docs to reflect this.

Modified

Release: Gateway 3.9.0.1 (2025-01-29)

Changelog and version bump for 3.9.0.1

Modified

feat(ai): Community LLM libraries documentation and demonstrations (2025-01-30)

First phase of adding supported "LLM Library and Framework" tutorials, for our AI community to use, to demonstrate compatibility with Kong AI Gateway.

Added

Week 4

Feat: Secure back end traffic (2025-01-24)

Added

Modified

feat: Service Catalog GitLab integration (2025-01-24)

Added GitLab as the newest Service Catalog integration.

DOCU-4140

Added

Modified

Week 3

Fix: OIDC plugin params listed as strings instead of arrays (2025-01-17)

In the OIDC plugin, client_id, client_secret, and client_auth must be arrays. See the config schema to verify: https://docs.konghq.com/hub/kong-inc/openid-connect/configuration/

Fixes #8343

Modified

Release: Gateway 3.4.3.16 (2025-01-17)

Version bump and changelog for 3.4.3.16

Modified

Release: Gateway 3.4.3.15 (2025-01-13)

Changelog and version bump for Gateway 3.4.3.15.

Modified

Fix: Update decK compatible version with Konnect (2025-01-13)

Versions of decK before 1.4 have some inconsistency issues when used with Konnect. We need to tell our users to use 1.40 with Konnect at a minimum.

issue reported on slack: https://kongstrong.slack.com/archives/C03NRECFJPM/p1734711282132209

Modified

Week 2

fix: workspace collision (2025-01-10)

Modified

fix: we do not support uploading the custom schema via decK. (2025-01-08)

Clarify that when using decK with custom plugins, the schema must be uploaded to Konnect first. After that, custom plugins can be managed like any other entity. We do not support uploading the custom schema via decK.

(https://kongstrong.slack.com/archives/C04349E4KRC/p1736269545150239)

Modified

Fix: RHEL7 deprecation version (2025-01-07)

The deprecation notice for rhel7 mentions the wrong kong version. Checked all the other version entries (2.8 onward), all the rest are correct.

Issue reported on slack: https://kongstrong.slack.com/archives/CDSTDSG9J/p1736248819331859

Modified

docs: update the key calculation expression of proxy cache (2025-01-08)

In the description of Proxy Cache, it is explained that the cache key is calculated using the following expression.

key = md5(UUID | method | request)

However, in the source code of Proxy Cache (3.9.0), the cache key is calculated from the following five elements.

https://github.com/Kong/kong/blob/3.9.0/kong/plugins/proxy-cache/cache_key.lua#L111-L112

Because of that, I have updated the expression in the documentation to match it with the one of source code.

Modified

Update _index.md (2025-01-06)

Updating some issues with the text in this plugin description

Modified

Fix: typos in plugin development (2025-01-06)

Fixed several small typos in plugin development pages.

Modified

Week 50

Fix: clarify license propagation in Konnect (2024-12-13)

We were missing info about KIC licenses in Konnect, so adding that.

https://konghq.atlassian.net/browse/DOCU-4144

Modified

kic: drop 'beta' from feature gates toc heading (2024-12-13)

Drop 'beta' from feature gates toc heading

Modified

Fix: Consumer groups docs (2024-12-13)

Addressing feedback we’ve received on consumer groups docs, where some of the docs are outdated (kong manager), one is missing from the nav but findable via search (Konnect), and links for how-to guides go to the Rate Limiting plugin, which is only one of the plugins that supports consumer groups.

  • The Kong Manager topic is very short and doesn't need to exist, but doesn't hurt to leave it for now
  • The Konnect topic is a condensed version of upcoming how-to guides
  • As part of this, splitting out the Personal Access Token info into its own doc, as we link to it a bunch (I needed to from the consumer groups doc), but its buried in a decK page.

Fixes https://github.com/Kong/docs.konghq.com/issues/6465 and https://konghq.atlassian.net/browse/DOCU-3593

Modified

Add link to environment variable vault config options.

Issue reported on Slack.

Modified

chore: Changelog for Gateway 3.9 (2024-12-12)

Changelog and breaking changes page for 3.9.

https://konghq.atlassian.net/browse/DOCU-4164 https://konghq.atlassian.net/browse/DOCU-4154

Added

Modified

Automated submodule update (app/_src/.repos/kong-plugins) (2024-12-11)

Modified

Update performance-testing.md for 3.9 rc4 (2024-12-09)

The raw results could be found here

Modified

chore: Remove deprecated APIs (2024-12-09)

Clean out deprecated Konnect APIs in prep for migration.

https://konghq.atlassian.net/browse/DOCU-4176

Need to merge this before unpublishing specs in the Konnect Org + running the sync action to update the konnect_oas_data.json file properly.

Modified

feat: serverless custom domains docs (2024-12-09)

Add specific serverless docs for custom domains.

Added

Modified

feat: Datakit (2024-12-12)

Adds documentation about the Datakit feature for 3.9.

DOCU-4170

Added

Feat: Add Hugging Face as LLM provider (2024-12-09)

Add docs for AI Proxy and AI Proxy Advanced configuration with Hugging Face.

DOCU-4166

Added

Modified

Fix: Inaccurate OS support for AppD C SDK agent (2024-12-13)

Removed the mention of Alpine from AppD docs.

Although the AppD agent does support Alpine as of May 2022, Kong stopped supporting Alpine in 3.3.x, so the older versions get a mention of Alpine, while it's completely removed from the newest ones.

https://konghq.atlassian.net/browse/DOCU-4121

Modified

feat: Injection Protection plugin for 3.9 (2024-12-12)

Adding the new Injection Protection plugin docs.

DOCU-4148

Added

feat: Konnect IN geo (2024-12-13)

This PR splits the IN geo information into a separate PR (from the original #8126 , which will be edited to just contain ME info)

DOCU-4147

Modified

feat: Service Protection plugin (2024-12-09)

DOCU-4149

Added

Modified

docs(kic): fix ingress to gateway migration plugins conversion (2024-12-13)

Changed the conversion from konghq.com/plugins in the Ingress to the Gateway API migration. The conversion should be placed under httpRoute.spec.rules[*].filters in the HTTPRoute resource.

Following the ingress2gateway tool and the Gateway API documentation, the plugins annotation should be filters rather than headers.

Modified

feat: Dev Portal SAML SSO (2024-12-12)

SAML SSO is being added to Dev Portal. This PR adds instructions for it and creates SSO includes so that org SSO and Dev Portal SSO content can be shared.

This PR also fixes some outdated Okta SSO language, see DOCU-4120 for more information.

DOCU-4135

Added

Modified

Week 49

Update opentelemetry _changelog.md to include deprecation of config.endpoint in 3.8 (2024-12-05)

  • Update _changelog.md to include deprecation of config.endpoint
  • Fix typo in config.batch_flush_delay deprecation
2024/12/05 15:16:04 [warn] 2533#0: *1692 [kong] init.lua:910 OpenTelemetry: config.endpoint is deprecated, please use config.traces_endpoint instead (deprecated after 4.0), client: 172.19.0.1, server: kong_admin, request: "PUT /plugins/924e591e-5544-4ee8-8327-32625f0034f0 HTTP/1.1", host: "localhost:8001"

Modified

Feat: Redirect plugin (2024-12-06)

Docs for the new Redirect plugin in 3.9.

https://konghq.atlassian.net/browse/DOCU-4175

Added

Header Cert Auth plugin: cert format FAQ (2024-12-03)

Updated the FAQ to include a note about how the certificate should be passed. The docs were not entirely clear that base64 and url encoding require different data to be passed (one including the being/end certificate delimiters).

Modified

chore: Update 3.9 support tables (2024-12-03)

Add tabs for 3.9 support tables + add ubuntu 24.04 to the data file (it's already in 39.yml, was just missing from here).

Modified

Fix: missing changelog entry for dependency bump (2024-12-02)

Add missing dependency bump changelong entry to 3.8.1.0 (eng PR here) and add detail to capture the customer issue. Support was unable to find the fix in the changelog, since the initial issue wasn't mentioned.

Issue reported on slack: https://kongstrong.slack.com/archives/CDSTDSG9J/p1732724038244199

Modified

Update: Guardrail for Bedrock (2024-12-03)

Updated the AI Proxy and AI Proxy Advanced docs to add a request example with guardrails for Bedrock.

DOCU-4167

Modified

chore(gateway): add notice for unsupported AWS credential provider (2024-12-02)

Modified

Update config-store.md for referencing the secret in Konnect (2024-12-05)

Modified

Week 48

feat: Service Catalog Datadog integration (2024-12-01)

Adding Datadog as a new Service Catalog integration.

DOCU-4109

Added

Week 48

cleanup(mesh): remove old versions (2024-11-29)

The mesh docs experienced a lot of changes before 2.2.x Maintaining all this is very combursome and all these versions are now deprecated.

This simply removes old versions and makes the Mesh docs easier to manage

We will still need to remove some of the conditional rendering but I'll do this as a follow up PR

Part of https://github.com/kumahq/kuma-website/issues/2072 Replaces https://github.com/Kong/docs.konghq.com/pull/8195

Signed-off-by: Charly Molter charly.molter@konghq.com

chore(kgo): bump to 1.4.1 (2024-11-28)

Bump KGO to 1.4.1

OSS release: https://github.com/Kong/gateway-operator/releases/tag/v1.4.1 EE release https://github.com/Kong/gateway-operator-enterprise/releases/tag/v1.4.1

Modified

fix: step formatting in Secure Comms (2024-11-27)

Fixed the formatting of the certificate steps, it was messed up.

Modified

Release: Gateway 3.7.1.3 (2024-11-27)

Changelog and version bump for Gateway 3.7.1.3.

Also merge https://github.com/Kong/docs-plugin-toolkit/pull/74 when this goes in.

Modified

Update secure-communications.md (2024-11-27)

Updated documentation to reflect current behavior. Changes explain what is happening behind the scene so users can understand the flow and what the workflows accomplish

There is no jira. However there are discussions on slack. All are linked below

https://kongstrong.slack.com/archives/C03LRB400TC/p1730253689774879 https://kongstrong.slack.com/archives/C03LRB400TC/p1731604458601139?thread_ts=1730253689.774879&cid=C03LRB400TC https://kongstrong.slack.com/archives/C02KEASTTRC/p1731688031878609

Modified

feat: serverless provisioning clarification (2024-11-26)

Quick clarification change to ensure users know that Serverless Gateways may not be provisioned in their current Konnect region.

Modified

Add docs page for PrivateLink.

DOCU-3871 CSRE-2806

Replaces Kong/docs.konghq.com#7771

Added

feat: Konnect ME geos (2024-11-26)

DOCU-4147

Modified

fix: Request Validator incorrectly refers to Kong format schema (2024-11-25)

The doc says the the Kong format schema validation is supported, which is incorrect. JSON Schema format validation is actually what's supported.

Fixes https://konghq.atlassian.net/browse/FTI-6196.

Note to reviewers: I fixed the title of the section referring to the "Kong format schema" and some minor cleanup to the page, including removing unnecessary output examples. However, I couldn't actually get these examples to work as documented in the example. The last step, validation, always fails for me- though this is probably out of scope of this PR and is a separate issue.

Modified

Week 47

Fix: extra sentence (2024-11-21)

Modified

Fix: network requirements (2024-11-20)

the CONTROL_PLANE_ID.eu.cp0.konghq.com in the documentation is wrong, since it should actually be CONTROL_PLANE_DNS_PREFIX.eu.cp0.konghq.com

Modified

fix: correct config store queries (2024-11-20)

Correct config store queries and references.

Modified

Release: Gateway 3.8.1.0 (2024-11-18)

Changelog and version bump for gateway 3.8.1.0.

Modified

Week 45

Update title to Impart Security (2024-11-04)

Incorrectly labeled title as overview, corrected it to Impart Security. Link to page https://docs.konghq.com/hub/impart-security/kong-plugin-impart/

Screenshot 2024-10-31 at 1 11 52 PM

Modified

Mesh CVE policy (2024-11-05)

fixes #6156

Adds a CVE policy for Kong Mesh

Modified

Week 43

Fix: Konnect roles reference (2024-10-21)

Update the Konnect roles reference to the most recent actual state of Konnect. Includes the new serverless roles.

Entries pulled from UI text with very light editing. Eventually, I expect we'll be generating this, so we won't want to manually edit.

Issue reported on Slack.

Modified

Week 42

Update request-validator content-type validation (2024-10-16)

crated from Jira: https://konghq.atlassian.net/browse/FTI-6269?focusedCommentId=144703

Modified

Update: Rewrite AI Gateway Getting Started guide (2024-10-17)

We've gotten feedback that the AI getting started script is difficult to use as it obfuscates what's actually happening in the setup. This changes the getting started guide to set up a service, route, and plugin manually, then test that the plugin is working.

Tested this locally, still need to test the Konnect instructions.

I left the AI quickstart script in at the bottom of the page with a bit of info on how to use it, for those people that are still interested. This script is very useful for demos and testing and we don't want to lose it.

Modified

feat: serverless gateways (2024-10-17)

Relates to https://github.com/Kong/docs.konghq.com/pull/7947

Add initial docs for Serverless Gateways

Added

Modified

Release: Gateway 3.6.1.8 (2024-10-15)

Changelog and version bump for Gateway 3.6.1.8.

Modified

feat: swaggerhub integration (2024-10-18)

Service Catalog SwaggerHub integration doc.

I added a section on how to add/find the API specs tab to link specs to services, because it took me some poking around to find it. It's not standard for these integration pages yet, but I think it makes sense to add it here.

https://konghq.atlassian.net/browse/DOCU-4092

Added

Modified

chore: Archive Gateway 2.6 and 2.7 (2024-10-14)

Gateway versions 2.6 and 2.7 have reached the end of sunset support, so we are archiving the docs as no longer maintained.

PR for https://legacy-gateway--kongdocs.netlify.app/: https://github.com/Kong/docs.konghq.com/pull/8037

https://konghq.atlassian.net/browse/DOCU-4090

Modified

Update: AI proxy advanced load balancing (2024-10-17)

  • Added link to AI proxy advanced load balancing in navigation under AI Gateway
  • Updated AI proxy advanced overview to add missing load balancing algorithms and a section about retry/fallback
  • Removed the semantic routing section and included the info in the load balancer algorithms section
  • Added config example for each load balancer type

DOCU-4076

Added

Modified

Week 41

Fix: broken table in AI RLA plugin (2024-10-11)

Issue reported on slack.

Modified

fix: fix capitalization of GitHub (2024-10-11)

Fixes capitalization of GitHub.

Modified

fix: fix the quickstart help command (2024-10-09)

We have to pass the -s command to the bash script in order to pass additional arguments to the quickstart script.

The original help command gives the following error:

$ curl -Ls https://get.konghq.com/quickstart | bash -- -h
bash: -h: No such file or directory

Modified

Bug bash: Logging correlation IDs doc does not specify the nginx context (2024-10-07)

Fixes https://github.com/Kong/docs.konghq.com/issues/5123

Preview: https://deploy-preview-8006--kongdocs.netlify.app/hub/kong-inc/correlation-id/

Modified

Week 40

chore: update konnect compatibility (2024-10-04)

Modified

Adjust Request Transformer Advanced plugin link text (2024-10-03)

Adjusting the link text in the plugin overview to be more descriptive.

Fixes https://github.com/Kong/docs.konghq.com/issues/5593.

Modified

OAS Validation: headers (2024-10-04)

Adding a troubleshooting entry for the OAS Validation plugin about header validation. Fixes https://konghq.atlassian.net/browse/DOCU-4013

Modified

Change the demo app used in the mesh manager example (2024-10-02)

I updated our Mesh Manager tutorial so that it uses the same demo app as what they're using in the Kong Mesh docs.

I also verified that my changes worked by testing the full tutorial end-to-end.

Fixes #6625

Modified

fix: Change Gateway changelog dates to ISO 8601 format (2024-10-02)

Some dates weren't in the ISO 8601 format, this fixes that.

DOCU-3877

Modified

fix: Add notes about OpenAPI spec version compatibility (2024-10-02)

I updated our Dev Portal docs to state which versions of Swagger and OpenAPI are supported for uploaded API specs.

I tested this by trying to upload example OpenAPI specs created by ChatGPT:

  • 1.1 ❌
  • 2.0 ✅
  • 3.0 ✅
  • 3.2 ✅

DOCU-3594

Modified

ACME plugin storage types (2024-10-02)

  • Added a table comparing the types of storage, what they are (info from lua-resty-acme), and where they're available
  • Minor adjustments to the ACME overview page for better flow with the table
  • Tested the local storage guide and fixed it up to make it work + made the curl formatting consistent

Fixes https://github.com/Kong/docs.konghq.com/issues/7966 and https://konghq.atlassian.net/browse/DOCU-2910.

Modified

Fix: Protobuf structure issue (2024-10-02)

Issue reported through docs feedback

Modified

Fix: AI rate limiting advanced example (2024-10-04)

Fixes Issue #7867

Modified

Fix: Replace httpbin.org with httpbin.konghq.com (2024-10-02)

DOCU-4088

Modified

Fix: Broken link in Konnect KIC page (2024-10-04)

The link in the note on the Konnect KIC page redirects to the KIC landing page: https://docs.konghq.com/konnect/gateway-manager/kic/#kic-in-konnect-association

Replacing it with the latest real link.

Modified

Fix: update konnect predefined teams (2024-10-01)

The Data Plane Node Admin and Service Admin roles no longer exist. Looks like that's been the case for at least a year: https://github.com/Kong/kong-api-tests/blob/main/fixtures/kauth/kauth_teams.ts

Removed non-existent roles and added Control Plane Admin. Verified via UI and link above.

Issue reported on Slack.

Modified

fix(plugins): ai semantic prompt guard is EE-only (2024-09-30)

Modified

Week 39

Fix: Mention Azure in last table entry (2024-09-27)

Azure has now launched as a CGW region (see first row in the same table), so this note should say "other than AWS or Azure" instead of just AWS.

Modified

Chore: Move CGW docs (2024-09-23)

Moves Cloud Gateways docs into their own dedicated cloud gateways section

Modified

Release: Gateway 2.8.4.13 (2024-09-23)

Changelog and version bump for 2.8.4.13.

See https://kongstrong.slack.com/archives/C02GZ0CGJNT/p1726668953815289 for release status.

Modified

Fix: mention format keyword only supported in draft4 version (2024-09-27)

Modified

Feat: add introduction of --disable-consumer-sync in konnect KIC section (2024-09-26)

Add introduction of --disable-consumer-sync CLI argument to speedup KIC's synchronization of configurations to Konnect when there are a lot of consumers. Fixes https://github.com/Kong/kubernetes-ingress-controller/issues/6319.

Modified

Week 38

Fix: Logging plugins log format + descriptions (2024-09-20)

The log format example and descriptions were missing some changes from 3.6, and had incorrectly tagged versions. Tested this out via the File Log plugin and compared the output to any log serializer changelog entries.

"JSON object considerations" was also a strange title that didn't describe the contents, which are just descriptions of each log item, so updated that to be clearer.

Issue reported on Slack.

Modified

Fix: Add missing _APPD to env variables (2024-09-20)

Some of the newer parameters for the AppDynamics plugin are missing the _APPD section of the prefix. They should all be KONG_APPD_*.

Modified

fix: Convert to AI Semantic Cache LLM examples to plugin_example (2024-09-19)

Converting the LLM examples to use plugin_example instead for better consistency.

DOCU-4060

Modified

Fix: AppD plugin missing info + broken collapsible note (2024-09-16)

  • Documenting the ARM64 limitation for the C/C++ AppD SDK
  • Fixing the collapsible note

https://konghq.atlassian.net/browse/DOCU-4061

Collapsible note with broken styling: https://docs.konghq.com/hub/kong-inc/app-dynamics/

Screenshot 2024-09-12 at 1 35 15 PM

Modified

Week 37

Update: 3.8 known issue for JSON threat protection plugin (2024-09-13)

Document a known issue for the JSON threat protection plugin.

Issue reported in https://konghq.atlassian.net/browse/KAG-5398.

Modified

Fix: correct the Konnect compatibility of the JSON-Threat-Protection Plugin (2024-09-12)

The JSON-Threat-Protection IS compatible with Konnect, this PR is to fix it.

Modified

feat: Bedrock docs for AI Proxy and AI Proxy Advanced (2024-09-11)

DOCU-3863

Added

Fix: OTEL + dynatrace feedback (2024-09-11)

  • more accurate endpoints
  • blurb on metrics

Modified

Chore: Konnect changelog update (2024-09-11)

Update changelogs to new format, and announce that beamer is released.

Modified

Fix: Add missing prerequisites to AI semantic prompt guard plugin (2024-09-11)

Added Redis in the prerequisites since it is needed to use the plugin

Modified

Fix: Traceable overview title (2024-09-11)

Traceable overview page had "Overview" as title instead of "Traceable.io" because of the title element in the frontmatter.

Modified

Feat: Documentation for new deck command kong2tf (2024-09-13)

Reference documentation for the new deck command kong2tf expected to be release as part of deck 1.40.0.

Checklist

Modified

Update: Konnect plugin pricing tiers (2024-09-11)

Removing all instances of paid and premium plugin badges and categorization. Adding a "konnect compatible" badge instead.

https://konghq.atlassian.net/browse/DOCU-4018

Modified

feat: Service Catalog (2024-09-11)

Contains: https://github.com/Kong/docs.konghq.com/pull/7739 https://github.com/Kong/docs.konghq.com/pull/7849 https://github.com/Kong/docs.konghq.com/pull/7862

Previews:

https://deploy-preview-7889--kongdocs.netlify.app/konnect/service-catalog/ https://deploy-preview-7889--kongdocs.netlify.app/konnect/service-catalog/integrations/

Added

Modified

Update: Add info about Header Cert Auth size limits (2024-09-10)

Adding a section on how to increase the header size limit so that certs aren't blocked or truncated.

Info provided on Slack: https://kongstrong.slack.com/archives/CDSTDSG9J/p1725983347871329?thread_ts=1725973425.599459&cid=CDSTDSG9J

Modified

Feat: OTEL with Dynatrace + plugin doc refactor (2024-09-11)

New page for Dynatrace.

Also split the very long main page into multiple how-to guides.

❗ Note to reviewers: The dynatrace page is the only new page. I didn't edit or rewrite any of the other content, I only split it into pages. You can copyedit them if you have time, but that's not the priority here.

https://konghq.atlassian.net/browse/DOCU-3879

Added

Modified

Update: Konnect resource limits note (2024-09-09)

Add note about contacting support to increase resource limits.

Requested on Slack, as customers have run into these limits and didn't know what to do about them: https://kongstrong.slack.com/archives/C07JN2D8RAS/p1725722454208289?thread_ts=1725652540.259969&cid=C07JN2D8RAS

Modified

Feat: Azure Vnet peering for Cloud Gateways (2024-09-11)

https://konghq.atlassian.net/browse/DOCU-4041

Added

Update: Add docker copy command to move cert and key into container before restarting the gateway (2024-09-12)

added docker copy command to move cert and key ointo container before restarting the gateway

Modified

Feat: Advanced AI Analytics (2024-09-12)

https://konghq.atlassian.net/browse/DOCU-4055 https://konghq.atlassian.net/browse/DOCU-4050

Modified

feat: Gemini and Bedrock for AI Proxy (2024-09-11)

  • Added support for Gemini and Bedrock to tables
  • Added rough draft tutorials for Gemini and Bedrock

DOCU-3863

Added

Modified

Feat: AI proxy advanced (2024-09-11)

AI Proxy Advanced plugin.

Schema (config reference) and basic example added via https://github.com/Kong/docs-plugin-toolkit/pull/47.

https://konghq.atlassian.net/browse/DOCU-3884

Questions for @fffonion @AntoineJac:

  • How many of the currently existing AI Proxy docs, especially the LLM integration guides, do we want to reuse for this plugin? How many of them apply?
  • Is there somewhere that I can find info on the load balancing and semantic routing capabilities of this plugin?

Added

Modified

Feat: Upstream Oauth plugin (2024-09-10)

Upstream OAuth plugin.

To do:

  • Short "how to use this" - or is the "basic examples" page enough?
  • Is this plugin supported in DB-less, hybrid, and Konnect?

Config reference and example added via https://github.com/Kong/docs-plugin-toolkit/pull/53 https://konghq.atlassian.net/browse/DOCU-4024

Added

Feat: Standard Webhooks plugin (2024-09-10)

Standard webhooks plugin.

Schema and example added via https://github.com/Kong/docs-plugin-toolkit/pull/50.

https://konghq.atlassian.net/browse/DOCU-3844

Added

Feat: Header Cert Auth plugin (2024-09-09)

Doc for new Header Cert Auth plugin. https://konghq.atlassian.net/browse/DOCU-4005

Schema and basic example added in https://github.com/Kong/docs-plugin-toolkit/pull/46. Based on https://github.com/Kong/kong-ee/pull/9723.

Added

Feat: semantic prompt guard plugin (2024-09-11)

https://konghq.atlassian.net/browse/DOCU-4008

Base for documentation

https://deploy-preview-7770--kongdocs.netlify.app/hub/kong-inc/ai-semantic-prompt-guard/unreleased/

Added

Modified

Feat: add custom sts endpoint configuration field for various aws features in kong gateway (2024-09-09)

This is a new feature in kong gateway 3.8. The original PR is here: https://github.com/Kong/kong-ee/pull/9654

The feature covers the update for three parts of the AWS-related features inside Kong gateway: the aws-lambda plugin, the aws vault backend, and the IAM authentication for RDS database.

KAG-4599

Modified

Feat: add ai semantic caching plugin (2024-09-10)

Feat/add ai semantic caching plugin

DOCU-3852

Added

Modified

Week 36

Feat: AppD analytics_enable (2024-09-06)

Adding ANALYTICS_ENABLE env variable to the AppDynamics env variables table.

Discovered via changelog entry.

@oowl what kind of analytics get logged via this variable, and is it sending the data to AppD?

Modified

Fix: Add a third option to close your Plus or Enterprise account (2024-09-05)

Add a third option to close your Plus or Enterprise account

Modified

Fix: updates rbac's docs in DB-less mode. (2024-09-05)

Modified

Fix: AWS Lambda plugin changelog entry for base64_encode_body (2024-09-05)

Adding a missing changelog entry for base64_encode_body (tracked down via blame in https://github.com/Kong/kong/commit/5853f9d0c0bb6afce4b6d3165cacbd86bb46b8d2). Since we no longer have specific docs for version 2.5.x, we don't need to update the config reference.

Fixes https://github.com/Kong/docs.konghq.com/issues/5544.

Modified

Fix: Exit Transformer plugin handle_unknown description (2024-09-05)

Correcting the description of handle_unknown, which is currently misleading and doesn't provide enough context.

Fixes https://konghq.atlassian.net/browse/FTI-6080

Modified

Fix: Remove AI RLA plugin from traffic control category on plugin hub (2024-09-04)

The plugin currently appears twice because it's listed under two categories, and it should only be under AI:

Issue reported by on Slack by Marco.

Modified

The links on this page currently point to the on-prem EE Admin API, where they should be pointing to the Konnect Control Plane Config API.

Fixes https://github.com/Kong/docs.konghq.com/issues/7812.

Modified

Fix: HMAC signing string in plugin example (2024-09-04)

Fixes https://konghq.atlassian.net/browse/FTI-6211.

Modified

Fix: Errors in mTLS Auth examples (2024-09-03)

Fixing mTLS auth examples:

  • Incorrect URL in Konnect example
  • Split response out from Admin API example to reduce confusion

Modified

Fix: Konnect example in mtls plugin (2024-09-03)

The mTLS plugin doc contains an example of using the Konnect API with a generated cookie, which hasn't been possible for a long time. Fixing the example to reference a PAT instead.

Modified

Feat: add docs for new confluent plugin (2024-09-04)

This is a DRAFT PR that needs fill-in from @silvolu.

Added

Feat: add docs for json-threat-protection plugin (2024-09-03)

Added

Week 35

Fix: Add timeout config, specify konnect compatibility, add kong versions (2024-08-26)

  • Add timeout config for latest version of our plugin
  • Specify konnect compatibility
  • Add kong support versions

Modified

Week 34

Fix: Add changelog entry for deprecated OTEL parameters in 3.7 (2024-08-23)

Issue reported on slack: certain parameters in the OTEL plugin are marked deprecated, but there is no changelog entry noting when the deprecation happened.

Modified

Feat: add ai metrics docs (2024-08-23)

Doc on AI metrics and Prometheus

Modified

Week 33

Feat: Document shared variables (2024-08-13)

Update the template documentation to add details for using shared variables: https://docs.konghq.com/gateway/latest/plugin-development/pdk/kong.ctx/#kongctxshared

This looks to have been added here, https://github.com/Kong/kong-plugin-request-transformer/pull/7, but we lack documentation on how to reference it. Using the documented convention, kong.ctx.shared.foo, results in errors with "kong" being a nil value.

Tests have shown it successful using this with the request transformer plugin and route transformer advanced, i.e:

x-name:$((function() return shared["gruber"] end)())

Where "gruber" has been previously defined as kong.ctx.shared.gruber = "myHeader"

Modified

Week 32

Fix: Update key-auth request behaviour matrix (2024-08-09)

I've read and re-read this section a few times - and I'm pretty sure there's a typo! But my apologies in advance if I've misunderstood the situation.

Kong will return a 401 when the API key is not known.

Modified

Fix: decK select tag examples (2024-08-08)

Fixing the select-tag examples in the decK docs to match real behavior.

https://konghq.atlassian.net/browse/DOCU-4012

Modified

chore: add more explanations about aws secret with slash in kong gateway (2024-08-09)

This PR adds a note to show a correct way of referencing secrets that has special slash symbols.

https://konghq.atlassian.net/browse/KAG-5054

Modified

Release: Gateway 3.4.3.12 (2024-08-09)

Changelog and version bump for 3.4.3.12

Modified

Feat: document caCert for cert-manager (2024-08-06)

Missing docs for existing feature

Modified

Week 31

Fix: Add clarifying statement about private dev portals (2024-07-31)

The prior sentence states that and are discoverable on the internet for Public Dev Portals. It seems like it would be good to explicit that private are not (which is just an assumption I made)

Modified

Fix: Hardcode gateway version in centos doc (2024-07-31)

As of 2.8.4.12, we are no longer building Centos packages for Gateway 2.8. Changing the variables on the 2.8 page to hardcoded so that they don't pick up a version of a package that doesn't exist. The version no longer needs to change dynamically with releases.

Modified

Feat: added release notes for new refresh button (2024-07-30)

API Requests and Explorer now have a refresh button that allows users to manually refresh/fetch data without a full page site reload. It also preserves all filters.

image

image

Aha ticket: https://konghq.aha.io/features/KP-506

Modified

Release: Gateway 2.8.4.12 (2024-07-30)

Changelog and version bump for 2.8.4.12.

Do not merge until the patch goes out.

Modified

Feat: Brotli support (2024-07-31)

We added Brotli compression support in 3.6 but it was never documented. Adding a short doc on how to enable it.

Notes:

  • I considered adding it to the Nginx directives doc, but there's nothing in there about configuring specific groups of directives for a goal - that topic is a more general thing.
  • I'm also not sure about putting this under "reference", but honestly, we don't really have a place for content like this at the moment.

Addresses https://konghq.atlassian.net/browse/DOCU-3911.

Modified

Feat: Add Cost strategy to Ai Rate Limiting plugin (2024-08-02)

Add Cost strategy to Ai Rate Limiting plugin

Modified

Week 30

Update: Add API instructions for finding Konnect hostnames (2024-07-25)

Adding API instructions to find control plane and telemetry hostnames for Konnect control planes. Tested both regular and KIC control planes.

The headings on this page were also broken and didn't work as anchor links, as they were nested inside navtabs. This doesn't work, so I turned them into regular headings.

Fixes https://github.com/Kong/docs.konghq.com/issues/6869.

Modified

Fix: AI Proxy plugin: incorrect format in example (2024-07-25)

The description of the example and the example itself don't refer to the same format: the description says ollama but the example uses openai. The correct format is openai, as the example also uses an Authorization header, which is required for openai.

Fixes https://github.com/Kong/docs.konghq.com/issues/7609.

Checklist

Modified

Users are not warned about the limitations of Dynamic plugin ordering, particularly in relation to consumer scoped plugins. This change informs of the limitation and provides a link to the details.

Users are not warned about the limitations of Dynamic plugin ordering in this page, particularly in relation to consumer scoped plugins. This change informs of the limitation and provides a link to the details. There have been cases of customers implementing dynamic ordering and then realise it is incompatible with consumer scoped plugins.

Modified

Week 29

Feat: Azure support in dedicated cloud gateways (2024-07-15)

Updating docs to introduce Azure support in Konnect Dedicated Cloud Gateways.

Minor adjustments to the Konnect changelog to make it consistent.

https://konghq.atlassian.net/browse/DOCU-3870

Added

Modified

Week 28

Fix: Key Auth Encrypted note and "not applicable" konnect labels (2024-07-12)

  • Fixing misleading/confusing note for Key Auth Enc, which was not providing enough info about why the plugin doesn't run in Konnect.
  • Rephrasing the "Not applicable" table entries in the konnect compatibility table to say "Not available in Konnect" to make it clearer

Issue reported on Slack.

Modified

fix description about the execution order of the ai-request-transformer plugin (2024-07-11)

This PR is to fix the description about the execution order of the ai-request-transformer plugin

Modified

Chore: Documenting third-party tools instructions (2024-07-10)

https://konghq.atlassian.net/browse/DOCU-3817 Document expectations for writing about third-party things.

Modified

Release: Gateway 3.5.0.7 (2024-07-10)

Changelog and version bump for 3.5.0.7

Will need a plugin schema update but there's no RC yet, so will generate that when it's available.

Modified

Release: Gateway 3.6.1.7 (2024-07-10)

changelog and version bump for 3.6.1.7

Modified

Release: Gateway 3.7.1.2 (2024-07-10)

Changelog and version bump for 3.7.1.2

Modified

feat: Multi Dev Portal (2024-07-10)

This PR documents the new multi-portal functionality and also does some docs cleanup in the Dev Portal section to make the user flow a bit clearer.

DOCU-3864

Added

Modified

Week 27

chore(rate-limiting): clarify rate-limiting accuracy (2024-07-03)

Both rate-limiting and rate-limiting-advanced plugins documentation specify that various policies are possible and states that cluster and redis are "Accurate". However it's possible to configure a sync_rate option for these plugins and set it to a value that does not offer synchronous behaviour allowing for some slippage in favor of performance.

This commit clarifies that sync_rate affects mentioned accuracy.

KAG-2896

https://github.com/Kong/kong/issues/11846

Modified

Feat: Konnect analytics ingestion toggle (2024-07-03)

Konnect analytics ingestion toggle.

Modified

fix(ai-proxy): clarify model support (2024-07-01)

Clarified a number of model supports, added GPT-4o / LLAMA3.

Modified

Fix: GraphQL RLA example needs a warning to not run in prod (2024-07-02)

Adding a disclaimer to plugin basic examples about not using the examples in prod, and adding some extra language for the GraphQL RLA examples to caution against sync_rate = -1 with the cluster strategy.

We can use this same templating to add extra example descriptions to any of the plugins in the future.

https://konghq.atlassian.net/browse/DOCU-3489

Modified

Update: DeGraphQL diagram (2024-07-01)

Mermaid diagram for DeGraphQL plugin.

https://konghq.atlassian.net/browse/DOCU-110

Added

Modified

Week 26

Feat: decK gateway CLI (2024-06-27)

The decK gateway interaction commands were moved into a gateway subcommand in decK version 1.28.0, which also included some refactoring in how they function. At the time, we avoided updating the docs as users were unlikely to have a version of decK that uses those commands, and they were not yet stable. They are now ready to be updated, and the docs are causing more confusion by not using deck gateway in examples.

Took two different approaches re: versioning these commands:

  • In the decK documentation (docs.konghq.com/deck), I version-tagged the commands whenever they were used in code blocks. If they were mentioned in text, I removed the deck portion.
    • Duplicated one file (docker run reference), as the whole page would've needed version tagging otherwise.
  • In the rest of the site, I didn't version the commands, as there's no clear way to know what version of decK someone is using with a specific version of Gateway. All of the Gateway, Konnect, and plugin docs just use the deck gateway commands.

https://konghq.atlassian.net/browse/DOCU-3565 https://konghq.atlassian.net/browse/DOCU-3545

Modified

chore(release): docs for KGO 1.3.0 (2024-06-25)

Changes needed for the release

please double-check compatibility matrixes, cli&crd docs and changelog.

Modified

Fix: GW changelog heading levels (2024-06-24)

## Fixes should be ### Fixes

Modified

Release: Gateway 2.8.4.11 (2024-06-24)

changelog and version bump for 2.8.4.11

Modified

Release: Gateway 3.4.3.11 (2024-06-24)

changelog and version bump for 3.4.3.11

Modified

Release: Gateway 3.5.0.6 (2024-06-24)

changelog and version bump for 3.5.0.6

Modified

Release: Gateway 3.6.1.6 (2024-06-24)

changelog and version bump for 3.6.1.6

Modified

Release: Gateway 3.7.1.1 (2024-06-24)

changelog and version bump for 3.7.1.1

Modified

fix(ai-proxy): fix several configs in docs (2024-06-25)

Fields other than name and provider should live under options field.

Modified

doc on ai metrics (2024-06-26)

This PR is providing info on how to to expose and visualize AI metrics through Prometheus and Grafana. These metrics include the number of AI requests, the cost associated with AI services, and the token usage per provider and model.

Added

Modified

Week 25

Fix: instead of Update Cluster Config should be Edit or Resize Cluster (2024-06-20)

Documentation does not line up with the product: instead of Update Cluster Config should be Edit or Resize Cluster

Modified

fix(dpop): ambiguity of key validation description (2024-06-20)

Modified

Release: Gateway 2.8.4.10 (2024-06-20)

Changelog and version bump for 2.8.4.10

Modified

Release: Gateway 3.4.3.10 (2024-06-20)

Changelog and version bump for 3.4.3.10

Modified

Release: Gateway 3.5.0.5 (2024-06-20)

Changelog and version bump for 3.5.0.5.

Modified

Release: Gateway 3.6.1.5 (2024-06-20)

Changelog and version bump for 3.6.1.5

Modified

Release: Gateway 3.7.1.0 (2024-06-20)

Changelog and version bump for 3.7.1.0.

Modified

Fix: Use consistent/accurate product name for Google Cloud/GCP secret manager and HashiCorp (2024-06-17)

Use consistent and accurate naming for Google Cloud Secret Manager and HashiCorp Vault.

  • GCP Secret Manager and Google Cloud Secret Manager are both acceptable
  • Google Secret Manager is not used
  • "Secrets" plural is inaccurate, it's always "Secret"
  • "HashiCorp", not "Hashicorp"

Modified

Week 24

Add Konnect Terraform reference page (2024-06-13)

Add Terraform page for Konnect so that it shows up when searching for "Terraform" on the docs site.

Please run the Algolia indexer after merge

Added

docs(kic): update rewrite-host guide with URLRewrite filter (2024-06-11)

Extends Rewrite Host guide with URLRewrite filter usage implemented in KIC 3.2.

Closes https://github.com/Kong/kubernetes-ingress-controller/issues/5853.

Modified

Release: Gateway 3.4.3.9 (2024-06-10)

Changelog and version bump for 3.4.3.9.

Modified

Week 23

Fix: Typo in JWT mapping order and clarify behavior (2024-06-07)

The consumer mapping priority order for the plugin is supposed to include both access token and channel token, but instead just listed access tokens.

Also clarifying some of the phrasing around mapping so that it doesn't appear to contradict itself

https://konghq.atlassian.net/browse/DOCU-3413

Modified

Noname fix performance benchmark url (2024-06-06)

Fixed a broken URL of the Noname documentation portal

Modified

Chore: Convert codeblock diagrams into mermaid format (2024-06-06)

Converting this: Screenshot 2024-06-05 at 4 16 10 PM

Into this: Screenshot 2024-06-05 at 4 16 36 PM

Modified

Release: decK 1.37 and 1.38 (2024-06-05)

Bump deck versions, add new and missing cli flags.

Based on changelogs for 1.37 and and 1.38: https://github.com/Kong/deck/releases

Modified

Corrects broken link to demonstrated proof-of-possession page in changelog.

Modified

feat: Document Request ID in debugging, tracing, and logging (2024-06-05)

The Request ID feature was released in 3.5 and never documented. This PR adds information about it to the existing tracing, debugging, and logging docs. DOCU-3853

Modified

Fixes reversed descriptions of post and put. (2024-06-04)

Fixed 'Update and insert ACL group names' and 'Update ACL groups by ID' being reversed.

Modified

Feat: integrated markdown feature update (2024-06-04)

https://konghq.atlassian.net/browse/DOCU-3819 Update Product Documentation - Kong Konnect | Kong Docs to include information about being able to start a document from the editor.

Modified

Week 22

Fix: remove inaccurate note about AppDynamics library (2024-05-30)

During testing, it was found that Kong Gateway will start without the library, and won't error out.

https://konghq.atlassian.net/browse/DOCU-3862

Modified

Update: Graphql proxy cache adv plugin API not supported in hybrid mode (2024-05-29)

Adding a note on API usage in hybrid mode for the graphql proxy cache plugin.

Addresses docs callout in KAG-4357.

Modified

Update: Telemetry FAQs for Konnect (2024-05-29)

Updating the Konnect network FAQ with Q&As about telemetry data communication between cp and dp.

https://konghq.atlassian.net/browse/DOCU-3859

Modified

chore: Convert remaining OIDC topic that uses httpie to curl (2024-05-29)

Converting HTTPie to curl. This topic was added in 3.6 and I ran out of time to convert it, so we just merged it.

Modified

chore: Changelog for 3.7.0.0 (2024-05-29)

  • Compile changelog for 3.7.
  • Add changelogs to plugins.
  • Add missing breaking change to 3.7 breaking changes doc.

https://konghq.atlassian.net/browse/DOCU-3797

Added

Modified

Fix: Unifiy Kong Manager and Kong Manager OSS sections in GW docs (2024-05-31)

Unify the two Kong Manager sections into one.

Background request tracked on https://konghq.atlassian.net/browse/DOCU-3861

Modified

Week 21

chore: set version tags around table (2024-05-22)

Add version tags to plugin table, since streaming only appears in 3.7.

Modified

Release: Gateway 3.5.0.4 (2024-05-20)

Changelog, version bump, and remove 'unless' statements for 3.5

https://konghq.atlassian.net/browse/DOCU-3739

Modified

add content-type and body-validation explanation in _index.md (2024-05-22)

request-validation limitations are not listed anymore since 3.4 version. Adding them in the main page

https://github.com/Kong/docs.konghq.com/commit/b492d3ecb31e2335f37dfe361295c8bc545f2e85#diff-f88716a1e934cd881cb07ecb1cc41ebdcd62fd950aa0e821603755e1a8caa2d4

New feature in 3.6 to perform body validation on +json content-types.

Modified

Feat: AI Azure Content Safety plugin doc (2024-05-21)

Docs for new AI Azure Content Safety plugin.

https://konghq.atlassian.net/browse/DOCU-3767

Added

Week 20

feat(ai-proxy): added Azure native auth explanation (2024-05-16)

I have added an explanation on how to use Azure Managed Identity authentication when using the Kong AI Proxy within the Azure SaaS.

Added

chore: Set source URLs for moved EE plugins (2024-05-17)

A bunch of EE plugins were moved to a new directory, breaking the "Edit this page" links on their schema config reference pages. This PR adds a source_url to each moved plugin to use as the link for editing.

https://konghq.atlassian.net/browse/DOCU-3841

Modified

Release: Gateway 3.4.3.8 (2024-05-16)

Changelog and version bump for 3.4.3.8

Schema update will come separately.

Modified

Release: Gateway 3.6.1.4 (2024-05-15)

Changelog and version bump for 3.6.1.4

https://konghq.atlassian.net/browse/DOCU-3842

Modified

request-termination and forward-proxy incompatibility (2024-05-15)

Clarification: the plugin won't execute if if forward-proxy is enabled (valid for all versions) Jira: https://konghq.atlassian.net/browse/FTI-5909 Kong idea reported to review the plugin priority: https://kong-internal-portal.ideas.aha.io/ideas/GTWY-I-886

Modified

docs(oidc): supporting dpop (2024-05-15)

KAG-4377

New feature support.

https://github.com/Kong/kong-ee/pull/8482

Added

Modified

Week 19

Remove duplicated entry (2024-05-10)

control_plane was listed twice.

Modified

(fix) Remove "enterprise" category from Datadome (2024-05-07)

Based on review w/ @DaniellaFreese and Eric, this plugin doesn't qualify as Enterprise based on the revised categorization set at end of last year.

Modified

Plugins troubleshooting (2024-05-07)

Added

feat: add OCI plugin distribution docs (2024-05-07)

Added docs around using an OCI registry and OSS tooling to sign and distribute custom plugins.

Modified

Week 18

Adding links to Kong with GraphQL ebook to make it more discoverable: https://konghq.com/solutions/api-management-graphql

Modified

Chore: Generate 3.7 kong.conf reference (2024-05-03)

https://konghq.atlassian.net/browse/DOCU-3804

Added

chore: Add 3.7 support tabs/pages and fix typo (2024-05-03)

Update support pages for 3.7.

https://konghq.atlassian.net/browse/DOCU-3800

Modified

Add paragraph to explain queue parameter scope (2024-05-02)

Explicitly mention that queue parameters are scoped to one worker in the Queueing section of plugins that use queues.

Modified

Improved readability and detatched some commands from their output (2024-05-01)

I improved the readability of some commands separating their outputs, facilitating user copy-paste flow when trying out when trying the autoscaling setup, clarified the k6s installation is required before running the command and its javascript test.

Modified

Fix guide docs about using configPatches (2024-04-29)

Fix instructions in the guide page of uing configPatches in plugins. Docs part of https://github.com/Kong/kubernetes-ingress-controller/issues/5687.

Modified

Fix typos under app/ (2024-05-01)

Fix tons of typos under app/ directory.

Some backgrounds on how theses typos are fixed, I've wrote a (Chinese) blog about this: https://nova.moe/fast-typo-fix/ (English version: https://nova.moe/fast-typo-fix-en/) 😇

Modified

Some links in our konnect docs point explicitly to v2 of various APIs, when they should be pointing to latest to remain evergreen. The only API where this is currently an issue is the identity API, as the latest version is now v3. Updating all versioned links to avoid this issue in the future.

Issue reported on slack.

Modified

feat(gateway/oas-validation): OpenAPI 3.1.0 documentation (2024-05-03)

Update document for OAS-Validation plugin about OpenAPI 3.1.0

Modified

Feat: new expressions flavor in 3.7 (2024-04-30)

KAG-3927

Modified

Chore: Split AI Gateway into its own section (2024-05-01)

Splitting AI gateway into its own nav section to make it more prominent.

This is a 3.7 ticket, but it really also applies to 3.6, so making the change in both.

https://konghq.atlassian.net/browse/DOCU-3792

Added

Modified

feat(openid-connect): fapi docs (2024-05-03)

This PR adds a page to summarize/link all the FAPI-related features that the OpenID Connect plugin provides.

https://konghq.atlassian.net/browse/DOCU-3627

Added

Week 17

Fix multiple typos under app/_src/gateway (2024-04-26)

Fix multiple typos under app/_src/gateway

Modified

Fix multiple typos under app/konnect directory (2024-04-26)

Fixed multiple typos under app/konnect directory

  • stratgies -> strategies
  • trasparent -> transparent
  • mutliple -> multiple

Modified

Add Kong 3.6.x to the list of supported versions by the Noname Security plugin. (2024-04-25)

Added Kong 3.6.x to the list of supported versions by the Noname Security plugin.

Modified

chore(kgo): KGO 1.2.3 (2024-04-26)

Adding KGO 1.2.3 changelog

Closes https://github.com/Kong/gateway-operator-enterprise/issues/124

Modified

Release: Gateway 3.4.3.7 (2024-04-23)

Changelog and version bump for Gateway 3.4.3.7.

Also merge https://github.com/Kong/docs.konghq.com/pull/7120 when this goes out.

Modified

Fix: update docker logo on Mesh docs (2024-04-22)

Fixing broken link test failure: https://github.com/Kong/docs.konghq.com/actions/runs/8768698057/job/24063340313

The old docker logo was deleted but the Mesh install page is still pointing to it. Changing it to use the latest docker logo instead.

Modified

Changed from: Any to from: All (2024-04-22)

"Any" is not a valid value, it should be "All": spec.listeners[0].allowedRoutes.namespaces.from: Unsupported value: "Any": supported values: "All", "Selector", "Same",

Fixed an apparent mistake in the docs where it said "Any", but meant "All"

Modified

Week 16

Chore: LTS labels (2024-04-19)

Label LTS versions in the navigation to make them easier to identify: Screenshot 2024-04-19 at 9 45 38 AM

And adjust heading levels on the support page. The LTS section needed a heading to make it easier to find, both visually and via search; had to fix nesting to make that work.

Modified

fix: Add two missing OTEL images to Kong Mesh docs (2024-04-19)

There were two missing images from a Kuma doc that was shared in Kong Mesh. The link checker caught one (https://github.com/Kong/docs.konghq.com/actions/runs/8677190800/job/23792517751), but I added both to our site.

Added

Fix: Broken ordered list in getting started guide (2024-04-18)

Fixing broken ordered list and putting the sections into tabs for better flow:

Screenshot 2024-04-18 at 2 02 59 PM

Modified

Get Started: httpbin.org doesn't return a content-type charset (2024-04-18)

Fix proxy caching getting started guide after the move from mockbin to httpbin

Modified

Release: Gateway 2.8.4.9 (2024-04-19)

Version bump and changelog for 2.8.4.9.

"Backported from 3.7.0.0 " is commented out because that version isn't out yet.

Modified

(fix) upload current docker logos (2024-04-18)

Replacing Docker logos w/ most current version from https://www.docker.com/company/newsroom/media-resources/. Changed icon is one shade of blue not multiple.

docs(*): add a deprecated message to granular tracing (2024-04-18)

This is for 3.7.0.0 release.

The Granular Tracing is removed from 3.7.0.0 onward. Add a warning message to docs. See https://github.com/Kong/kong-ee/pull/8669 and https://konghq.atlassian.net/browse/KAG-2713.

Modified

Fix: Upstream URL for llama2 completion example (2024-04-16)

The example provided in the curl command references the ollama endpoint, http://ollama-server.local:11434/v1/chat, which returns a 404.

Per the docs (referenced earlier on this page), the correct endpoint should be /api/chat which I can confirm works.

https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion

example:

$ curl localhost:11434/api/generate -d '{ "model": "llama2", "prompt":"Why does Kong make the best gateway?", "stream":false }' -i HTTP/1.1 200 OK

$ curl localhost:11434/v1/generate -d '{ "model": "llama2", "prompt":"Why does Kong make the best gateway?", stream":false }' -i HTTP/1.1 404 Not Found Content-Type: text/plain Date: Tue, 16 Apr 2024 01:56:56 GMT

404 page not found

Modified

Make Docker page show all available base images (2024-04-15)

Switch /install page to point to our Docker installation docs

Modified

Fixing a couple of undefined anchor links in the Session plugin. Ended up cleaning up a bit of grammar/style/punctuation as well.

Modified

Fix -correct conflict statement in debug-request.md (2024-04-16)

We found conflicting statements which need to be fixed.

Modified

Release: Gateway 3.4.3.6 (2024-04-16)

Changelog and version bump for 3.4.3.6

Trying out a method to label backported items.

https://konghq.atlassian.net/browse/DOCU-3757

Modified

Release: Gateway 3.6.1.3 (2024-04-17)

Changelog and version bump for gateway 3.6.1.3.

No ticket, this is an ad hoc patch.

Modified

feat: change path to v1/messages api for anthropic (2024-04-17)

Anthropic released a new messages API, we change the chat route_type of Anthropic to the new messages API correspondingly. This new feature is about to be released in 3.7.0.0, the doc should be updated simultaneously. The sister PR for kong-ee has already been merged.

Modified

Fixes broken links in request transformer changelog.

Modified

Feat: Gateway landing page layout updates (2024-04-17)

Updating the tiles on the gateway landing page. https://konghq.atlassian.net/browse/DOCU-3743

Added

Modified

feat(portal): describe developer auto approval behavior when using SSO login (2024-04-17)

  • Describe developer auto approval behavior when using SSO login
  • Change Konnect catalog to Dev Portal catalog in SSO login instructions

Modified

feat(plugins): tracing headers propagation (2024-04-19)

Documentation for the new (3.7.0.0+) tracing headers propagation module, available to the OpenTelemetry and Zipkin plugins.

Modified

plugins(jwt): support more algorithms (2024-04-18)

Update docs to reflect recent changes in the JWT plugins.

Added support for:

  • ES512
  • PS256
  • PS384
  • PS512
  • EdDSA

Jira: https://konghq.atlassian.net/browse/KAG-4029

Modified

Feat: Cloud Gateways Documentation (2024-04-16)

Cloud Gateways: https://konghq.atlassian.net/browse/DOCU-3686

Preview Ready for review Overview Page Networking and Peering information Supported regions Transit Gateways How to upgrade data planes Custom Domains How to use CGW Diagrams API Spec

Preview Link: https://deploy-preview-7097--kongdocs.netlify.app/konnect/

Added

Modified

Week 15

kic: add section about events for cluster scoped resources (2024-04-12)

Adds a section about Events for cluster scoped resources

Relevant KIC issue: https://github.com/Kong/kubernetes-ingress-controller/issues/5847

Modified

  • Added notes about restarting the Kong Gateway nodes/service when updating a license.
  • Linked the Troubleshooting documentation from Overview page on the Deploy page.

Added because this was an occasional issue with customers after updating a license where they kept seeing warnings in the logs and Kong Manager UI about an expiring license after updating it.

Modified

Release: Gateway 3.6.1.2 (2024-04-08)

Changelog and version bump for Gateway 3.6.1.2.

There are no kong.conf updates.

https://konghq.atlassian.net/browse/DOCU-3756

Modified

Update Gateway install page (2024-04-11)

Related Jira ticket

Update Gateway's install page.

Note: The on this page section isn't rendered because it parses the headings on the page and creates the list out of those which we no longer have with the table.

Modified

Week 14

Feat: Interactive markdown renderer (2024-04-03)

https://konghq.atlassian.net/browse/DOCU-3620

  • Adds docs for interactive markdown renderer.
  • Renames Manage API Product Documentation -> Product Documentation in navigation bar
  • Updates and replaces screenshots
  • Does not update shotscraper script this will be a fast follow.
  • adds changelog

https://deploy-preview-7140--kongdocs.netlify.app/

Added

Modified

Add gateway image build provenance verification docs (2024-04-01)

These are the customer-facing docs needed to allow customers to take full advantage of the recent changes to the Kong Enterprise build that implement SLSA build provenance and verification for only container images

Confluence: Solutions Document Jira: SEC-973 https://github.com/Kong/kong-ee/pull/7179

Added

Week 13

style(gateway/expressions-language): fix incorrect formatting (2024-03-27)

Bad format:

Modified

Release: Gateway 2.8.4.8 (2024-03-26)

Changelog, version bump, and generating kong.conf reference.

https://konghq.atlassian.net/browse/DOCU-3738

Modified

The docs on Kong Tracing had incorrect information

Modified

kgo: add status field monitoring section (2024-03-29)

This PR adds pages to KGO's monitoring guide.

Specifically how to retrieve and use objects' .status field.

Part of: https://github.com/Kong/gateway-operator-archive/issues/1207

Added

chore: Clarify our use of SemVer with Kong Gateway (2024-03-29)

Adding a note to clarify what we deliver in a version, most notably patch versions, to make it clear that it is never safe to upgrade automatically. We can break semver with backports, and it isn't always predicatable.

https://konghq.atlassian.net/browse/DOCU-3717

Modified

Week 12

fix: Update auth0 instructions to include warning on trailing forward slash in URL (2024-03-22)

Updated the Issuer URL information, as providing a trailing slash will cause issues.

When we have trailing slash for issuer URL, it get concatenated which will result in issuer as this https://dev-26uur0y8i4n8x3ez.us.auth0.com//api/v2/". So, informing users via docs will be valuable until if this can be gracefully handled.

Modified

fix: Use consistent names in Mocking plugin example (2024-03-22)

Fixes https://konghq.atlassian.net/browse/DOCU-3284.

Examples were using two sets of names, Ron and Jessica, and Hao and Sasha. The latter two are carried through the rest of the topic; the first two don't appear anywhere else, and feel like they might be left over from a previous version of the example .

Modified

Fix: Generate 3.6 Gateway kong.conf reference (2024-03-21)

Regenerating the configuration reference for Gateway based on latest 3.6.1.1 patch. We didn't generate it with the release and there were significant changes to the file in that version. Now that these files are split out by version, this is easier to see.

Also making some tweaks to run.lua and data.lua to use the same text that we have in the page description, and to remove a badge that doesn't need to exist.

Fixes https://konghq.atlassian.net/browse/DOCU-2889.

Will do the same for 3.5 with upcoming patch release (should be end of next week).

Modified

Kong Gateway Operator: use helm as installation method (2024-03-21)

Rewrites KGO installation guides to all use helm and KGO's helm chart.

Removes the old instructions which used the manifests.

Related: https://github.com/Kong/gateway-operator-archive/issues/1594

Modified

Kong Gateway Operator: fix Prometheus query in the guide which intermittently produced 0s which caused the targeted workload to scale down to 0 (2024-03-20)

Fix Prometheus query in KGO guide which caused it to intermittently (incorrectly) report 0 which then in turn caused the HPA to scale the workload to 0.

Modified

kgo: add cli args docs and regenerate 1.2 CRD ref doc (2024-03-20)

Add KGO 1.2 and 1.1 CLI arguments page.

Added

Modified

Update: Document custom annotations for decK APIOps (2024-03-22)

Added documentation for the custom annotations that can be added to OpenAPI specifications to support APIOps, and specifically the deck file openapi2kong command.

Example OAS

Modified

KGO: AIGateway docs (2024-03-18)

Add example usage for AIGateway

Added

Release: Gateway 3.4.3.5 (2024-03-21)

Sourced from https://github.com/Kong/kong-ee/blob/next/3.4.x.x/changelog/3.4.3.5/3.4.3.5.md

Addresses https://konghq.atlassian.net/browse/DOCU-3719 and https://konghq.atlassian.net/browse/DOCU-3713.

Modified

Week 11

Fix: Update get-admins endpoint description (2024-03-12)

Update Admin API's get-admins endpoint description.

Modified

kgo: guides for workloads latency based autoscaling (2024-03-12)

  • Add DataPlaneMetricsExtension CRD and update CRD reference
  • Add Horizontally autoscale workloads guide

Part of https://github.com/Kong/gateway-operator-enterprise/issues/71

Milestone: KGO 1.2 https://github.com/Kong/gateway-operator-enterprise/milestone/1

Added

Modified

Week 10

Feat: Topology diagrams for gateway docs (2024-03-08)

Adding topology diagrams based on a couple of slide decks of similar diagrams, converted into mermaid format.

https://konghq.atlassian.net/browse/DOCU-2482

Modified

Fix: adjust references to ulimit -n in Gateway docs (2024-03-08)

The wording of https://github.com/Kong/docs.konghq.com/pull/6984 around ulimit is ambiguous; this PR changes it to specifically mention ulimit -n.

Modified

Chore: Update the 'No support available' plugins category and language (2024-03-06)

For more accuracy, we are updating the category "No support available". We've had a lot of feedback from plugin owners that this category is misleading, because support is available, it's just not done by Kong.

Summary of changes:

  • Category name and banner text: "No support available" -> "Contact 3rd party for support"
  • Category in filter: "No support available" -> "Support by 3rd party" ("Contact 3rd party for support" doesn't fit in the space)
  • URL slugs:
    • "third-party" -> "third-party-partner" for tech partners - changed this for clarity
    • "none" -> "community" for 3rd party plugins that aren't partners
  • Updates plugin templates to reflect the changes

Modified

Update: Add note about Google ACME and DNS requirement (2024-03-05)

Added a couple of notes to clarify that a requirement is to also allow Google Trust Services (pki.goog) by adding a CAA DNS record in a situation where a domain is already explicitly using CAA DNS records.

What is a little complicated by this is that if a domain doesn't include any CAA DNS records then it's all good, but if they even set one CAA DNS record then it implicitly denies all issuers that they did not define, requiring them to add a new one for pki.goog since that is the issuer we utilize in Konnect.

Related Slack thread.

Modified

Release: Gateway 3.6.1.1 (2024-03-05)

Bump version and create changelog entry for Gateway 3.6.1.1.

Modified

fix: decK file merge example (2024-03-05)

deck file merge example uses deck file patch, where it should be merge.

Parallel PR in decK repo: https://github.com/Kong/deck/pull/1237

Modified

Fix: TCL/TCP typo (2024-03-05)

Doc said "TCL/TLS", should be "TCP/TLS".

Was reported in docs Slack. Ended up making this fix since it appears in old versioned files, and it's easier/cleaner to quickly search & replace.

Modified

Update: Kong Gateway overview diagram (2024-03-06)

Updating the Kong Gateway overview diagram to 1) remove Dev Portal and Vitals, as both are deprecated, and 2) update the styling to match Konnect and Mesh.

https://konghq.atlassian.net/browse/DOCU-3679

Added

Fix: rephrase 'sugar parameter' into more common terms (2024-03-04)

Adjusting the phrasing to remove confusing term.

https://konghq.atlassian.net/browse/DOCU-3707

Modified

Homepage rebrand (2024-03-05)

Mainly updating:

  • Product logos
  • Card styles & layouts

These styles (cards) also apply to /api/ and /search/.

https://konghq.atlassian.net/browse/DOCU-3682 https://konghq.atlassian.net/browse/DOCU-1707

https://github.com/Kong/docs.konghq.com/assets/715229/dd3372a2-76e3-4c5e-add1-7902b6f664b7

Added

Modified

chore(*): remove references to Dev Portal and Vitals (2024-03-05)

Hide references to Dev Portal and Vitals from docs for Gateway >= 3.5. The last minor release these features were included is 3.4.

Modified

fix: Updated HTTP method for setting targets health (2024-03-04)

Updated the HTTP method from POST to PUT for setting targets health. The current doc references a POST method which results in a 405 - Method not allowed error.

Modified

Feat: Convert navbar to dark theme (2024-03-04)

Converting navbar to dark theme and using new logos.

I left the blue headers as-is mostly, and just had them fade into the navbar - I think that looks pretty good for the in-between stage.

I have asked the design team for what they expect from the expanded menu as well - leaving it as white for now, until they respond.

@fabianrbzg there's couple of things I couldn't figure out here, if you could take a look:

  • Why the hover/interact state for the search bar looks... not so great. But I don't know how to find the source of the variable it's using for the hover state - looks like we're pulling it from somewhere else?
  • Some issues with the mobile nav (see video) - can't figure out why the slideout overlaps with the nav while it's sliding:

https://github.com/Kong/docs.konghq.com/assets/54370747/29846a70-9f93-47b5-ac91-15d2d094df3d

https://konghq.atlassian.net/browse/DOCU-3681

Added

docs(traceableai) - Initial docs for traceable.ai plugin (2024-03-06)

This adds documentation for the Traceable.ai kong plugin

Added

DOCU-3662: improve plugin versioning (2024-03-05)

Related Jira ticket

Add support for minimum_version and maximum_version in the frontmatter of plugin pages.

  • If a page has one of these set in frontmatter, it gets generated for that version range, similar to versions.yml
  • If a page doesn’t have any minimum or maximum version, it defaults to the setting for the whole plugin, which is set in versions.yml

The only caveat is that we had to replace _metadata.yml with a specific _metadata folder. If a file for a specific version exists, (e.g. _metadata/_2.6.x.yml) it will be used for that specific release, if not _metadata/_index.yml will be used.

I also fixed a bug in the releases dropdown. When switching to an older version for which the current page does not exist, it redirected the user to the plugin's landing page in its latest version instead of the version selected by the user.

https://github.com/Kong/docs.konghq.com/assets/715229/526c0144-2fd2-40df-b433-3769d50805e1

Added

Modified

Feat: Konnect Explorer and summary dashboard documentation (2024-03-07)

Todo:

  • Review w/ Christian
  • New shot scraper scripts

https://konghq.atlassian.net/browse/DOCU-3665 https://konghq.atlassian.net/browse/DOCU-3601 Changelog for this here: https://github.com/Kong/docs.konghq.com/pull/6811

Added

Modified

Week 9

The consumer groups description is outdated on the Kong Enterprise overview, as it describes consumer groups for rate limiting only. This is no longer the case.

https://docs.konghq.com/gateway/latest/kong-enterprise/#consumer-groups

Modified

chore: Add step to stop kong before uninstalling (2024-02-28)

Add a step to stop Kong before trying to uninstall it to prevent errors, per https://konghq.atlassian.net/browse/DOCU-253

Modified

Fix: Delete Kong prevention plugin directory and update metadata show compatibility with Konnect (2024-02-29)

Deleted the prevention plugin directory and updated docs and the metadata to show compatibility with kong konnect and the merging of the prevention plugin with the traffic source plugin and version compatibility with 3.5.x

Modified

Chore: Move Gateway 3.2 to sunset versions (2024-02-29)

Gateway 3.2.x enters sunset support on Feb 28th.

Resolves DOCU-3521.

Modified

Feat: Appreg v2 updates (2024-02-28)

Updating DCR docs for App Reg v2 API, specifically documenting two major changes:

  1. You now create auth configs independently (instead of at the Org wide level) and apply them to the API Product versions of your choice
  2. If you want to use a DCR auth config, you need to independently create the DCR config and then apply it your auth config.

https://github.com/Kong/docs.konghq.com/pull/6855 https://konghq.atlassian.net/browse/DOCU-3602 https://konghq.atlassian.net/browse/DOCU-3684

Added

Modified

Add Gateway 3.6 to KIC compatibility matrix (2024-02-27)

Modified

Updated example of Auth0 configuration _auth0.md (2024-02-27)

Auth0 configurations example is misleading in docs, updated the doc to remove properties that are not needed and added the important property that is needed.

Modified

Release: Gateway 3.6.1.0 (2024-02-26)

Changelog and version bump for gateway 3.6.1.0

Modified

Fix: replace benchmark redirect with moved url entry (2024-02-29)

This URL got flagged as 404ing at /latest/ by google console.

Modified

docs(mesh): update MeshGlobalRateLimit and MeshOPA targetref support table (2024-02-28)

Change the targetRef support table since 2.6 it has a different layout.

Listener tags are not yet supported because the plugins need to be adjusted

Modified

Week 8

fix: Remove inaccurate note in OAuth2 plugin (2024-02-22)

The note was added based on an old ticket that doesn't apply now. The OAuth2 plugin can be run in production.

Modified

Feat: Add documentation on higher ulimit requirement for 3.6.0.0 (2024-02-21)

Document missing entry for ulimit breaking change.

Modified

Fix:Add more information about cache key generation in proxy-cache-advanced (2024-02-21)

Adding more info about how cache key is generated based on https://github.com/Kong/kong-ee/blob/3.6.0.0/plugins-ee/proxy-cache-advanced/kong/plugins/proxy-cache-advanced/cache_key.lua#L110-L122

Preview: https://deploy-preview-6982--kongdocs.netlify.app/hub/kong-inc/proxy-cache-advanced/#cache-key

Modified

Flagged in https://github.com/Kong/docs.konghq.com/actions/runs/7945193457/job/21691549272. Links have no src, so they're not being generated properly.

Generator will need adjusting to add a space between the end of the table and <!--vale off-->, otherwise the table breaks and looks like this: Screenshot 2024-02-20 at 10 42 57 AM

Ran into a couple other cross-folder issues (kic-v2 vs kubernetes-ingress-controller):

Modified

Fix: remove if_version on the Or operator in the expressions router table (2024-02-20)

Remove the if_version on OR operator in expression language reference page to let the OR operator (||) displayed correctly. fixes #6972.

Modified

fix: Add 3.6 conditional rendering for single backup nodes (2024-02-21)

We missed some conditional rendering for a note about single backup nodes. It should only apply to 3.6 and later? (waiting on confirmation for the correct version, so this PR might change a little)

https://kongstrong.slack.com/archives/CDSTDSG9J/p1708369514356029?thread_ts=1708368658.991799&cid=CDSTDSG9J

Modified

fix(kong-manager): add ignored params to the OIDC migration guide (2024-02-20)

This pull request adds the ignored parameters to the migration guide for Kong Manager's OIDC feature.

Modified

Fix: docs(mesh)- in Vault docs switch to orphan tokens (2024-02-23)

As described in the PR changes, it's likely users want to create orphan tokens to authenticate to vault.

See also https://github.com/Kong/kong-mesh/issues/5412

Modified

Fix: docs(mesh/rbac): add information how to unlock yourself (2024-02-23)

Added docs how to unlock yourself in case you remove default rbac

Modified

Week 7

release deck 1.34.0 (2024-02-15)

Add deck 1.34 release information with new deck file namespace command

Added

Release: Gateway 3.6 (2024-02-14)

Releasing the docs for for Gateway 3.6.

List of changes in this release: https://github.com/Kong/docs.konghq.com/milestone/56?closed=1

kic: split CRD reference types into sections (2024-02-13)

Splits the top-level CRDs and the types that they rely on into separate sections to make it clear which types are meant to be used to create objects in the Kubernetes API.

Addresses @liyangau concern about the reference not signaling clearly which types are meant to be used to create objects in a cluster.

It's propagated from the KIC repo: https://github.com/Kong/kubernetes-ingress-controller/pull/5611

Modified

Feat: Add new performance testing results doc for Gateway 3.6 (2024-02-13)

Beginning in Gateway 3.6, Kong is now publishing performance testing results for several use cases. This PR adds a doc that publishes those results, covers the testing methodology, and provides info for customers to use the Kong test suite to conduct their own tests. This PR also creates a new Performance section of the docs so it's easier to find performance related docs.

Added

Modified

Week 6

Release: Gateway 3.4.3.4 (2024-02-10)

Changelog and version bump for Gateway 3.4.3.4.

Modified

fix(rt-plugin): fix description of variables (2024-02-09)

Modified

kic: extend secrets in plugins guide with configFrom field (2024-02-08)

Extends Using Kubernetes Secrets in Plugins guide to describe the new configPatches fields and its usage.

Fixes https://github.com/Kong/kubernetes-ingress-controller/issues/5572.

Modified

Fix a typo (2024-02-08)

Fixed a mistake in attaching json data to curl command.
The =, not :, must be used to attach the 'body'.

  -d, --data <data>
         (HTTP MQTT) Sends the specified data in a POST request to the HTTP server, in the same way that a browser does when a
         user has filled in an HTML form and presses the submit button. This makes curl pass the data to the server using the
         content-type application/x-www-form-urlencoded. Compare to -F, --form.

         --data-raw is almost the same but does not have a special interpretation of the @ character. To post data purely
         binary, you should instead use the --data-binary option. To URL-encode the value of a form field you may use
         --data-urlencode.

         If any of these options is used more than once on the same command line, the data pieces specified are merged with a
         separating &-symbol. Thus, using '-d name=daniel -d skill=lousy' would generate a post chunk that looks like
         'name=daniel&skill=lousy'.

         If you start the data with the letter @, the rest should be a file name to read the data from, or - if you want curl
         to read the data from stdin. Posting data from a file named 'foobar' would thus be done with -d, --data @foobar. When
         -d, --data is told to read from a file like that, carriage returns and newlines are stripped out. If you do not want
         the @ character to have a special interpretation use --data-raw instead.

         The data for this option is passed on to the server exactly as provided on the command line. curl does not convert,
         change or improve it. It is up to the user to provide the data in the correct form.

         -d, --data can be used several times in a command line

         Examples:
          curl -d "name=curl" https://example.com
          curl -d "name=curl" -d "tool=cmdline" https://example.com
          curl -d @filename https://example.com

         See also --data-binary, --data-urlencode and --data-raw. This option is mutually exclusive to -F, --form and -I,
         --head and -T, --upload-file.

man curl

Modified

Fix: Reference lua package path location in Exit Transformer plugin (2024-02-08)

Original document assumed knowledge about location for reference of .lua files. Added instruction to save file in referenced lua package path location as per https://docs.konghq.com/gateway/latest/plugin-development/distribution/#manually

Modified

kic: extend vault guide with KongVault CRD usage (2024-02-08)

Updates the "Kong Vault" guide with KongVault CRD usage.

Fixes https://github.com/Kong/kubernetes-ingress-controller/issues/5571.

Modified

Update docs for KIC 3.1.0 (2024-02-08)

Prepares documentation for KIC 3.1.0 release.

Added

Modified

Release: Gateway 2.8.4.7 (2024-02-09)

Version bump and changelog for Gateway 2.8.4.7.

Modified

kic: extend license guide with KongLicense CRD (2024-02-08)

Adds a section describing KongLicense CRD usage to the license guide.

Fixes https://github.com/Kong/kubernetes-ingress-controller/issues/5570.

Modified

kic: document konghq.com/tags annotation (2024-02-06)

Documents KIC's konghq.com/tags annotation.

Modified

Chore: Plan and usage UI changes (2024-02-07)

https://konghq.atlassian.net/browse/DOCU-3674

Update shot scraper and add new screenshots. There is no script for /assets/images/products/konnect/billing/billing-and-usage.png our environment doesn't let us generate it.

Modified

chore(deps): bump kumahq/kuma-website from 316d2427 to 9948b52a (2024-02-07)

Auto upgrade PR log:

9948b52a52d83b0f4b7ce7800229b3dda25e2060 feat(installer): Source Packages from Cloudsmith (kumahq/kuma-website#1625) b64d438edaa1116ab5d398c54c0bebda168f710e chore(deps): update docs from repo source (kumahq/kuma-website#1640) ac7644c178787d64a74d01964b5a48673bf6b72e chore(deps): update docs from repo source (kumahq/kuma-website#1636) 050de0c32b1606761518411b8db082831c4efb0c chore(blog) add release 2.6.0 blogpost (kumahq/kuma-website#1620)

Triggered by action. labels: skip-changelog,review:general

Modified

Fix all the broken links reported by the full scan.

Added

Modified

Refactor title tag generation (2024-02-05)

Jira ticket Automate title tag generation.

It follows the following format:

H1 - <product> - <optional version> | site title

where:

  • evergreen urls (/latest/) don't include the optional version
  • if H1 contains don't include - - so we don't repeat text

Modified

Week 5

Update: Change dev label and banner color (2024-01-31)

Changing the "dev" label to "unreleased" to make it clearer what this doc version is supposed to be.

Also changing the banner colour to red, as the previous banner looked too similar to the "outdated version" banner.

Some minor version/conditionals cleanup here as well.

Modified

Fix: kic - add explanation for Gateway's publish service (2024-01-30)

Adds an explanation of --publish-service vs. konghq.com/publish-service Gateway's annotation relation.

Part of https://github.com/Kong/kubernetes-ingress-controller/issues/5328.

Modified

Week 4

Fix: kic - Use standard repository in Helm example instructions (2024-01-26)

The KIC Helm install docs showed how to customise the image by using the nightly KIC image. This confused some users who actually tried to use the nightly image in a non-test environment.

Modified

Fix: Incorrect request format in DB-less and declarative config doc (2024-01-26)

Corrected the command to send the config to the Gateway. It was using a GET instead of POST and when using form-urlencoded data (--data) it throws a 400 error.

{"message":"declarative config is invalid: {error="failed parsing declarative configuration: 1:1: found character that cannot start any token"}","name":"invalid declarative configuration","code":14,"fields":{"error":"failed parsing declarative configuration: 1:1: found character that cannot start any token"}}

This was changed to use multipart/form-data (--form)

Modified

chore: add notice for trusting vault backend's ssl certificate (2024-01-26)

This PR adds a notice in the AWS/GCP vault backend doc page, to remind user to trust system ca-certificates store so that SSL certificate returned by those cloud providers are being trusted by kong.

Modified

Fix: Use config.scopes instead of config.scopes_required in OIDC okta guide (2024-01-24)

The OIDC Okta guide incorrectly references config.scopes_required when it's actually configuring config.scopes. Fixing that + some broken/outdated links + Dev Portal info that should be behind a conditional tag. Also fixing the same links in the rest of the OIDC 3rd party guides.

https://konghq.atlassian.net/browse/DOCU-2277

Modified

Fix: Incorrect value listed for OIDC consumer claim field (2024-01-24)

Fix okta config doc bug, where the consumer claim field was listed as needing an application ID, but actually needs the name of the field that contains the application ID.

https://konghq.atlassian.net/browse/DOCU-1456

Modified

Fixed the broken link for the refresh grant type, previously pointing at /hub/kong-inc/openid-connect/how-to/authentication/refresh-token-grant but should be /hub/kong-inc/openid-connect/how-to/authentication/refresh-token/

Modified

Release: Gateway 3.5.0.3 (2024-01-26)

Changelog and version bump for Gateway 3.5.0.3.

https://konghq.atlassian.net/browse/DOCU-3654

Modified

Fix: update azure vault variable names (2024-01-25)

Updating the Azure Vault variable names as with the existing naming the Vault configuration doesn't work.

Modified

Chore: fixes for a minor change in the Quickstart script output (2024-01-22)

Where the quickstart is used, the output changed slightly to indicate the gateway was ready.

Modified

chore(deps): bump kumahq/kuma-website from 79481f3c to e2f955bb (2024-01-22)

Auto upgrade PR log:

e2f955bb34bbb0ea6d34c798055fd240c06560bd fix(policies): update /policies page to /features (kumahq/kuma-website#1595) df6130cd578a74487a7d5b15aab4d3c77d02d207 feat(dns): add instructions for customizing DNS configuration template (kumahq/kuma-website#1576) 42ee81041b9ef710d52400ba0f00ad40caeedd69 docs(policy): improve targetRef table (kumahq/kuma-website#1579) e76bc74e24f3f3a7ce78fe18bcae8d062da553d1 chore(deps): update docs from repo source (kumahq/kuma-website#1586) dc13a6856c94acf46d542f49b048ed15ef289422 docs(website): change button order (kumahq/kuma-website#1596) 37c87e64c8731cd3130e850bb016df2435ff5747 chore(policies): move all non targetRef policies in a subsection (kumahq/kuma-website#1592)

Triggered by action. labels: skip-changelog,review:general

Modified

Feat: Add ARM support to install-instructions-test (2024-01-23)

Use qemu to add arm64 tests for the install pages using GH Actions.

Modified

DOCU-3511: Refactor version is (2024-01-23)

Related Jira ticket

  • Point jekyll-generator-single-source to the feature branch
  • Set latest: true to the corresponding versions in kong_versions.yml
  • Refactor Versions generators, we now have specific classes that handle setting the releases and versions information.
  • Rename app/_data/docs_nav_mesh_dev.yml to app/_data/docs_nav_mesh_2.6.x.yml.
  • Refactor Versions dropdown, we no longer need to maintain the routes and version info in the template.
  • Don't include URLs from versions that are labeled to the sitemap
  • Add label: dev to the unreleased version of mesh

How it works

  • We need to explicitly set latest: true to the corresponding versions in app/_data/kong_versions.yml
  • For adding a new unreleased version, we need to add a new entry in app/_data/kong_versions.yml with a label (it could be any string, e.g. dev, next, etc) and a new nav file, e.g. for gateway

In app/_data/kong_versions.yml

- release: "3.5.x"
  ee-version: "3.5.0.2"
  ce-version: "3.5.0"
  edition: "gateway"
  latest: true # <- Set latest to the right version
  ...
- release: "3.6.x"
  ee-version: "3.6.0.0"
  ce-version: "3.6.0"
  edition: "gateway"
  label: dev # <- label the new unreleased version 
  ...

and we need to create the file app/_data/docs_nav_gateway_3.6.x.yml The URLs generated for this version would be: /gateway/dev/.../, i.e. /<edition>/<label or release>/....

Note that the file includes the actual release name in its name and not the label. This simplifies the release process. We just need to remove the label and set latest: true to it.

page.release

page.release is a Liquid Drop which is essentially an object that can be used in the templates (code here).

It's a replacement for page.kong_version, and whenever it is used in a template the to_s method gets called. It returns the release's label if it has one, or the release's value, e.g 3.4.x.

It has a few other methods defined that should be useful:

  • value: the actual release defined in kong_versions.yml, e.g. 3.4.x.
  • label: the name of the label.
  • latest?: returns true if the release is marked as latest in kong_versions.yml.
  • versions: returns a hash with the corresponding versions defined in kong_versions.yml. For gateway it returns the versions without the suffix, i.e. { 'ee' => '3.0.0.0', 'ce' => '3.0.0' }, for products that only have one version it returns a has with default as key, e.g. { 'default' => '2.6.x' }.

The only time when we can't rely on the to_s method and we need to use page.release.value is when it is used as key when accessing hashes, like the compatibility table.

Modified

Nearly every page. See:

Week 3

Release: decK 1.30.0 (2024-01-19)

Version bump for decK 1.30 + any relevant updates to decK CLI docs. Mainly, this update softens the language of the warnings to make it clear that the old decK commands will still work.

Modified

Feat: AppDynamics certificate env variables (2024-01-19)

Document missing certificate environment variables for AppDynamics, added in 3.4.3.3.

Values only appear in the 3.4.x version table. Will add to 3.5 when the patch is released as well.

Also adding a conditional for 3.6, which will remain hidden until we have a 3.6 version.

Modified

Fix 2.8.4.6 changelog.md (2024-01-18)

Fix version number in changelog.

Modified

Release: Changelog and version bump for Gateway 2.8.4.6 (2024-01-17)

Changelog and version bump for upcoming 2.8.4.6 patch.

Modified

docs(mesh): update docs and changelog (2024-01-16)

Syncing docs from source code.

Generated by action

Modified

Fix linked to Verify signatures for Signed Images (2024-01-16)

Fix the broken link that came up in the last scheduled broken link action run.

Modified

Release: Gateway version 3.4.3.3 (2024-01-17)

EE changelog here: https://github.com/Kong/kong-ee/pull/7816

Modified

Feat: Split+consolidate OIDC plugin docs into many guides (2024-01-16)

Summary

Big OpenID Connect doc consolidation + split out how-to guides + cleanup. https://konghq.atlassian.net/browse/DOCU-3384

Changes in this PR:

  • Moving the OpenID Connect guides that are buried in Gateway into the OIDC plugin doc
  • Splitting out all the flow guides into their own pages for better discoverability/navigation
  • Keycloak + gateway setup are now collapsible prereq sections that we can reuse in every OIDC demo
  • Cross-linking to all the other OIDC content that's scattered all over our docs, for all the bits where OIDC is used internally
  • Remade all the diagrams with mermaid.js; deleted all the images that are no longer in use

The scope of the work is scaled back here somewhat to get this project moving. Not doing yet:

  • Use opinionated examples in how-to guides
  • Convert everything httpie into curl
  • All the testing
  • All the cleanup

Added

Modified

Week 2

Update: Prerequisite to review version compatibility before Gateway upgrade (2024-01-10)

Customer noted that the instructions to review OS compatibility are buried too deeply within the upgrade guide, and they missed them on their first read through the guide.

Adding the links/instructions to review compatibility as the first step, as no upgrade can be performed if your system doesn't support it.

Modified

Add enterprise image signing verification docs (2024-01-12)

These are the customer-facing docs needed to allow customers to take full advantage of the recent changes to the Kong Enterprise build that implement cosign-based image signing.

Added

Update: Rework style guide and add guidelines for writing recommendations (2024-01-08)

The Kong docs style guide was missing info on writing recommendations. I ran into some phrasing during a review and wanted to reference our guide, and realized that we never documented it (even though we did discuss it and decided on a style).

Also took this opportunity to split up the "best practices" table into separate sections and add more info.

  • One of the main benefits of having a style guide is being able to link to specific guidelines, and that table made it difficult to do that + didn't have room to add more explanation.
  • As well, when you scrolled past a certain point, you couldn't tell which column was "Do" and which was "Do not" anymore.
  • Removed the "Not british english" phrase from the language section. Seemed strange that we were singling out just British English, and there's no sense in trying to exhaustively list all varieties of English that are docs are not.
  • Did some reorganization.

Modified

Add internal/external traffic KIC guide (2024-01-08)

Add a guide that explains how to run internal/external ingresses using KIC

Added

Revamped Gateway on Kubernetes install guide (2024-01-11)

Rework the Kubernetes installation guide for Kong Gateway

Added

Modified

feat(acl): add consumer-group support and examples (2024-01-12)

For: https://github.com/Kong/kong-ee/pull/7603 Add support for the ACL plugin to understand consumer-groups. This allows to use (core) consumer-groups to be used in the "allow|deny" fields.

Added

Modified

doc(kic) add reference grant guide (2024-01-08)

For https://github.com/Kong/kubernetes-ingress-controller/issues/5154

Add a guide that covers using Gateway API resources with KIC across namespaces, including references to a Gateway from another namespace using listener allowedRoutes and references from an HTTPRoute to a Service in another namespace using a ReferenceGrant.

Added

feat(new-consumer): release notes and reference updates (2024-01-11)

For the new Consumer dimension coming next week, I added release notes and also updated our reference doc.

Modified

Week 1

fix: typo in ingress redirect docs (2024-01-03)

Fix type in redirect docs

Modified

Fix: Spacing on gateway overview page (2024-01-02)

if_version tags aren't spaced out correctly, so they're causing the following issues:

3.5: Screenshot 2024-01-02 at 9 46 10 AM

3.4 and earlier: Screenshot 2024-01-02 at 9 45 55 AM

Fixing by splitting out if_version tags, so that they don't encompass part of a still-existing section. The previous approach is harder to maintain + causes these spacing issues.

Modified

fix: use more informative example for request-debug docs (2024-01-02)

Currently, the example output of request-debug in docs is too simple, so I replace it with a more better one.

Modified

rewrite the loadbalancing document (2024-01-05)

Rewrite of the outdated page on loadbalancing

Modified

feat: Add KIC configFrom guide (2024-01-03)

Add a guide that shows how to use configFrom when configuring a plugin config from k8s secrets

Added

feat: Plugin guide to rate limit requests based on peak and off-peak times (2024-01-05)

Created a how to guide based on https://konghq.atlassian.net/browse/DOCU-3546 for “How to rate limit Kong Gateway based on peak/non-peak time”.

Uses the pre-function and rate limiting advanced plugins together.

Added

Modified

feat: Create Benchmark Guide for Kong Gateway (2024-01-05)

Convert internal benchmark performance KB into documentation.

Added

(feat) how to guides for mTLS-auth plugin (2024-01-04)

Split out content from the mTLS-auth landing page into a how-to section + some cleanup.

Added

Modified

Week 50

Make port 8100 consistent in all examples (2023-12-15)

Port 8001 is used in the example curl command, but port 8100 is the one used in the rest of the documentation. Changing curl port to 8100.

Modified

(chore) remove 3.1 from supported versions (2023-12-14)

3.1 is moving into sunset support, 12 months after the initial release.

Modified

docs(mesh): update docs and changelog (2023-12-14)

Syncing docs from source code.

Generated by action

Added

Modified

(feat) 3.4.3.1 changelog (2023-12-16)

Changelog for CE/EE release of 3.4.3.1

Source file https://github.com/Kong/kong-ee/pull/7567/files

Modified

docs(mesh): update docs and changelog (2023-12-12)

Syncing docs from source code.

Generated by action

Modified

Fix some SEO issues (2023-12-12)

Fix some of the issues listed in the latest SEO audit.

  • Add trailing / to plugin categories in the main nav
  • Add non-single-sourced plugin pages to the sitemap
  • Remove nofollow from Kong's logo and community link
  • Downcase URLs in the sitemap: By default, Netlify downcases all the URLs segments and adds redirects to those. See https://answers.netlify.com/t/my-url-paths-are-forced-into-lowercase/1659/
  • Prevent code-snippets/spec-renderer.html from being rendered and update all its references to point to github. Added redirects to github too.

Modified

Update debug-request.md (2023-12-12)

The previous wording is confusing as it mentioned client. This feature is for admins or internal teams monitoring gateway performance. It is not for a enduser who is making API calls. The usage of client in the previous statement may cause confusion as to who this feature is meant for.

Modified

docs(gateway-upgrade): fix an argument error (2023-12-11)

Fix an error from https://github.com/Kong/docs.konghq.com/pull/6534.

Modified

Feat: Add some basic docs for making diagrams with mermaid (2023-12-12)

Instructions on using mermaid.js to make diagrams in the docs.

Added

chore(deps): bump kumahq/kuma-website from 6c4168f4 to 58bbbaca (2023-12-11)

Auto upgrade PR log:

58bbbacaac6aa63bf9241a3e98495cfa99378122 chore(deps): update docs from repo source (kumahq/kuma-website#1544) a8b0a77ab74eefb3030f497a47d9929d28fe76da chore(deps): update docs from repo source (kumahq/kuma-website#1543)

Triggered by action. labels: skip-changelog,review:general

Modified

Week 49

decK is not meant for DB-less mode, since it uses the Admin API to manage configs. There was some inaccurate info in the docs about this, suggesting that decK can be used for DB-less. Removing that and adding a note on the difference between declarative and decK config.

Issue reported on Slack.

Modified

There are no links to the kong.conf reference from the kong.conf guides, so users are having trouble finding the reference. Adding links to fix that.

Modified

doc(decK): Update authentication instructions (2023-12-08)

Remove references to username/password auth for latest versions of decK in order to promote usage of tokens instead of passwords for authentication.

Modified

Add a step to publish API Product and version docs (2023-12-07)

The step-by-step process is clear; however, one critical step was missing - guiding users on how to publish the API documentation and a dynamic API reference to the public portal. To address this issue, I am adding an extra step that instructs users on how to publish their API Product and version documentation.

Modified

tls-handshake-modifier is compatible with Konnect (2023-12-06)

Reported by @hbagdi; this plugin is compatible with Konnect.

Modified

fix: add missing references to Azure Key Vault (2023-12-07)

Support for Azure Key Vault as a secrets backend was added in Gateway 3.5. This PR adds references to this support in the 3rd party tools page and Gateway Enterprise index.

Modified

docs(mesh): update docs and changelog (2023-12-06)

Syncing docs from source code.

Generated by action

Modified

Update:JWT plugin overview section (2023-12-08)

Fixes: https://konghq.atlassian.net/browse/DOCU-2347 updated the incorrect examples section. No validation done.

Modified

tls-metadata-headers is compatible with Konnect (2023-12-05)

Reported by Fero. This is a DP only plugin which is compatible with Konnect

Modified

fix: Mermaid rubocop fail (2023-12-04)

hopefully addressing the issue related to method length

Modified

update: OAuth 2.0 Authentication (2023-12-04)

Add a note about not recommended for Production environment. Fixes: https://konghq.atlassian.net/browse/DOCU-2310

Modified

docs(mesh): update docs and changelog (2023-12-04)

Syncing docs from source code.

Generated by action

Modified

chore(deps): bump kumahq/kuma-website from 74af1337 to 609a37e9 (2023-12-04)

Auto upgrade PR log:

609a37e902fe7d2691df3e9c7830f5ad220de450 chore(deps): bump @adobe/css-tools from 4.3.1 to 4.3.2 (kumahq/kuma-website#1540) 2e440e044271ca41d4619b194783836c1c067dfe chore(deps): update docs from repo source (kumahq/kuma-website#1541)

Triggered by action. labels: skip-changelog,review:general

Modified

Fix: Azure vault env variables (2023-12-04)

To set any environment variables to configure Kong Gateway (kong.conf), each env variable must be prefixed with KONG_. These prefixes, along with the VAULT portion of each config parameter, are missing from the example codeblocks in the Azure Vaults doc.

See https://docs.konghq.com/gateway/latest/reference/configuration/#vault_azure_vault_uri for the relevant parameter names, which all start with vault.

Modified

feat(plugin): Rate Limiting Advanced window types explanation (2023-12-08)

https://konghq.atlassian.net/browse/DOCU-3397 Turn KB into doc: https://support.konghq.com/support/s/article/What-is-the-expected-behaviour-for-the-Rate-Limiting-Advanced-plugin-with-sliding-window-strategy

Modified

kic: update and extend gRPC how-to (2023-12-04)

closes https://github.com/Kong/kubernetes-ingress-controller/issues/5134

For HTTPRoute (support was added in https://github.com/Kong/kubernetes-ingress-controller/pull/5128, so KIC >= 3.1.0 wii support it). For ingress, it works for older versions too

Modified

Update auth0.md to include developer managed scopes UI steps (2023-12-08)

Modified

Feat: Gateway Upgrade Refactoring + LTS upgrade guide (2023-12-08)

This PR add general Gateway upgrade docs and an LTS 2.8 > LTS 3.4 upgrade guide. These two pieces of content are extremely interdependent, so they have to be published together.

https://konghq.atlassian.net/browse/DOCU-3244 https://konghq.atlassian.net/browse/DOCU-3193

Added

Modified

Week 48

Set if_version on links to the APIOps decK guide, as it was added with 1.24.x.

Modified

Update: Gateway Manager filtering release note (2023-11-30)

Added to changelog for gateway manager filtering

Modified

chore: Add missing search aliases and supported versions for 3rd party plugins (2023-11-29)

Keep expecting to find third-party plugins by filtering on publisher name, but that doesn't work.

Adding 3rd party plugin publisher names as search aliases, as well as literal plugin names (eg aws-request-signing).

Also updating the supported versions for Optum plugins. Versions are based on the plugins' source code repos.

Modified

fix: update deck schema URL (2023-11-27)

Updated the URL of the deck JSON schema. This now resides in another repository.

Modified

docs(mesh): try to clarify what an AccessRole type is (2023-11-27)

Modified

chore(deps): bump kumahq/kuma-website from 31bc302b to 74af1337 (2023-11-28)

Auto upgrade PR log:

74af13372ca829dbdc9ee75f554ed3887043f1b6 ci(.github): automatic sync of files in kumahq/.github (kumahq/kuma-website#1536)

Triggered by action. labels: skip-changelog,review:general

Modified

Just ran it locally and got this:

[
  {
    "page": "http://localhost:8888/konnect/gateway-manager/kic/",
    "text": "Kong Ingress Controller Deployment",
    "target": "http://localhost:8888/kubernetes-ingress-controller/latest/concepts/deployment/",
    "reason": "HTTP_404"
  },
  {
    "page": "http://localhost:8888/konnect/gateway-manager/kic/",
    "text": "Using Kong Gateway Enterprise",
    "target": "http://localhost:8888/kubernetes-ingress-controller/latest/guides/choose-gateway-image/",
    "reason": "HTTP_404"
  },
  {
    "page": "http://localhost:8888/gateway/latest/how-kong-works/routing-traffic/",
    "text": "Router Expressions language",
    "target": "http://localhost:8888/gateway/latest/reference/router-expressions-language/",
    "reason": "HTTP_404"
  },
  {
    "page": "http://localhost:8888/gateway/latest/production/monitoring/readiness-check/",
    "text": "Get Started with Kong Ingress Controller",
    "target": "http://localhost:8888/kubernetes-ingress-controller/latest/deployment/overview/",
    "reason": "HTTP_404"
  },
  {
    "page": "http://localhost:8888/gateway/3.5.x/how-kong-works/routing-traffic/",
    "text": "Router Expressions language",
    "target": "http://localhost:8888/gateway/latest/reference/router-expressions-language/",
    "reason": "HTTP_404"
  },
  {
    "page": "http://localhost:8888/gateway/3.5.x/production/monitoring/readiness-check/",
    "text": "Get Started with Kong Ingress Controller",
    "target": "http://localhost:8888/kubernetes-ingress-controller/latest/deployment/overview/",
    "reason": "HTTP_404"
  }
]

I'm not 💯 sure about these changes though, so please review them carefully.

  •  {
   "page": "http://localhost:8888/konnect/gateway-manager/kic/",
   "text": "Kong Ingress Controller Deployment",
   "target": "http://localhost:8888/kubernetes-ingress-controller/latest/concepts/deployment/",
   "reason": "HTTP_404"
 }

    prod URL Screenshot 2023-11-23 at 13 52 17 I don't think that /kubernetes-ingress-controller/VERSION/concepts/deployment/: /kubernetes-ingress-controller/VERSION/production/deployment-topologies/ is the right call here, I couldn't find anything remotely similar to it though. We might want to update the Note though.

  • {
  "page": "http://localhost:8888/konnect/gateway-manager/kic/",
  "text": "Using Kong Gateway Enterprise",
  "target": "http://localhost:8888/kubernetes-ingress-controller/latest/guides/choose-gateway-image/",
  "reason": "HTTP_404"
}

    This guide no longer exists in KIC v3.

  • {
  "page": "http://localhost:8888/gateway/latest/how-kong-works/routing-traffic/",
  "text": "Router Expressions language",
  "target": "http://localhost:8888/gateway/latest/reference/router-expressions-language/",
  "reason": "HTTP_404"
}

    reference/router-expressions-language was removed in this PR and most of the references were updated but not all.

  •   {
    "page": "http://localhost:8888/gateway/latest/production/monitoring/readiness-check/",
    "text": "Get Started with Kong Ingress Controller",
    "target": "http://localhost:8888/kubernetes-ingress-controller/latest/deployment/overview/",
    "reason": "HTTP_404"
  }

    In KIC v3 there's no deployment/overview. I couldn't find a similar page though.

This also ignores linux.die.net, for some reason it returns HTTP_403 in the CI - not locally though.

Modified

fix: add the missing part of kong gateway vault's secrets versioning description (2023-11-30)

The PR adds the missing part of Kong Gateway Vault's secrets versioning description.

Gateway's vault supports accessing versioning secrets by specifying version number as a fragment in the vault reference URL.

Note that this is not a new feature added recently, it exists long time ago, only the doc part is missing.

https://konghq.atlassian.net/browse/FTI-5168

Modified

Update: Listing a license requires license added via Admin API to begin with (2023-11-27)

We've had a few customer support cases where customers are confused by a null response from the /licenses endpoint when they're not actually using the Admin API to load the license in the first place which is a requirement for this to work properly. When using an environment variable to set the license instead, the /licenses endpoint will not work for listing licenses. This PR is to make this clearer in the documentation.

Modified

remove Kubernetes requirements and put the OpenShift requirements (2023-11-27)

https://github.com/Kong/docs.konghq.com/issues/5688

Modified

KGO: v1.1.0 docs (2023-12-01)

Includes 1.1.0 changelog and assets:

BLOCKED by https://github.com/Kong/docs.konghq.com/pull/6518

Added

Modified

docs(KIC): improved KIC ingress to gateway migration guide (2023-11-29)

The guide to migrate from Ingress API to Gateway API has been improved under the following aspects:

  • it is no longer necessary to build the i2gw tool. We have a release with binary that can be directly downloaded
  • further information about the types of resources converted has been added

Modified

Add reference page for required permissions to install KIC (2023-11-30)

Add a reference page to list the permissions required to install KIC when user do not have the super admin permission. Fixes https://github.com/Kong/kubernetes-ingress-controller/issues/5166.

Added

feat: Portal Management API documentation (2023-11-28)

For Reviewers this needs:

  • Testing
  • Copy Edit
  • Narrative structure review

Questions:

  • The original draft has another section, I have some of it commented out, I felt like what I had ended pretty nicely and in combination with a blog and a spec could make a complete package but let me know if you don't agree.
  • I tried to write a purpose statement, does it answer it?

AC: This doc helps portal administrators and developers understand how to integrate the API into their workflow for tasks like automating approvals, assigning permissions, and monitoring developer activity.

https://konghq.atlassian.net/browse/DOCU-3527

Added

docs: clarify on rate-limit redis cluster support (2023-11-30)

Adds clarification that the basic rate-limiting plugin does not support Redis Cluster mode.

Context

Modified

fix: mention required secret field for JWT plugin in KIC how to (2023-11-30)

Fix how to guide, it was reported by the user in the discussion

https://github.com/Kong/kubernetes-ingress-controller/discussions/5146

indeed field secret is missing you can read about this requirement at https://docs.konghq.com/hub/kong-inc/jwt/#create-a-jwt-credential see image

This PR adds it in the required places.

Modified

Week 47

style(expressions): fix typo in performance.md (2023-11-22)

Modified

Chore: Update Changelog for Gateway Milestone updates (2023-11-20)

https://konghq.atlassian.net/browse/DOCU-3533 https://konghq.aha.io/epics/KP-E-320

Changelog update for this feature update.

Modified

chore(deps): bump kumahq/kuma-website from 80fb6b2a to b3eeb1bc (2023-11-22)

Auto upgrade PR log:

b3eeb1bcc7bc398eab666dd1cfe94e960294906b chore(deps): update docs from repo source (kumahq/kuma-website#1534)

Triggered by action. labels: skip-changelog,review:general

Modified

kgo: add kgo version compatibility matrix (2023-11-20)

Add KGO version compat matrix for

  • Kubernetes versions
  • KIC versions
  • GW API versions

Added

feat: Multi-geo GA (2023-11-21)

Multi-geo is going GA, so we needed to pull in the current beta docs from the konnect branch, as well as add information about the newly added geo, AU.

DOCU-2593

Added

Modified

update: Rewrite the expressions router Gateway doc (2023-11-21)

This is a complete rewrite of the Expressions router doc to make it easier to understand and more comprehensive.

KAG-2288

Added

Modified

Week 46

(chore) Konnect + 3.5 support (2023-11-16)

Adding statements of Konnect support for 3.5 to changelog + compatibility table, including Azure Key Vault support.

Modified

Feat: Azure Key Vault docs for Konnect (2023-11-16)

Added Azure Key Vault as a supported secret manager for Konnect docs

https://konghq.aha.io/features/KP-391 This was hidden behind a feature flag from back in March. It is now ready to be turned on and released.

Modified

Fix: custom Docker build instructions (2023-11-16)

Fix custom Docker build instructions. openresty is now symlinked in the package, which caused the Dockerfile provided to fail.

Modified

feat(dbless): add compatibility warning for Kong Manager (2023-11-17)

Adding a section for the compatibility warning while using Kong Manager with Kong under DB-less mode.

Modified

docs(mesh): update docs and changelog (2023-11-16)

Syncing docs from source code.

Generated by action

Modified

(chore) Add end off support dates to Konnect/GW compatibility table (2023-11-16)

Adding end of support column to Konnect's compatibility w/ Gateway matrix. Dates will match Gateway's dates starting with 3.2, prior versions will end support in Feb 2024.

Modified

Update Konnect curl request in renew-certificates.md (2023-11-17)

Modified curl example for Konnect:

Modified

Update gw manager docs (2023-11-14)

Updating gateway manager doc page since Plus and Enterprise users can create multiple control planes. This was new as part of KOD1 for API Summit.

Modified

(chore) 3.5.0.1 changelog (2023-11-16)

Build changelog for 3.5.0.1 based on source from https://github.com/Kong/kong-ee/blob/next/3.5.x.x/changelog/3.5.0.1/3.5.0.1.md

Modified

docs(changelog): consolidate the lua-resty-aws version bump changelog (2023-11-14)

Consolidate the lua-resty-aws version bump entries into one as both entries happened in the same release.

This is for Gateway Enterprise 3.5.0.0 changelog.

Modified

chore: improve docs about support of gRPC in KIC (2023-11-15)

Improve documentation for gRPC support in KIC

Modified

kic: fix the description of kic's leader election permission (2023-11-16)

fixes: https://github.com/Kong/docs.konghq.com/issues/6410

Modified

Week 45

Release Gateway 3.4.2.0 (2023-11-10)

Update changelog for the Gateway 3.4.2.0 release

https://github.com/Kong/kong-ee/blob/next/3.4.x.x/changelog/3.4.2.0/3.4.2.0.md

https://konghq.atlassian.net/browse/DOCU-3563

Modified

docs: add KIC 3.0 missing docs updates (2023-11-08)

Adds missing KIC 3.0 docs:

  • updates compatibility matrices (drops Kubernetes 1.23 and 1.24 support)
  • adds konghq.com/upstream-policy annotation to annotations reference
  • updates support policy table (not sure if we should also update Supported versions table - so far we've been recommending LTS releases so I didn't change that to recommend 3.0 @mheap).

Modified

fix: remove unnecessary brackets from proxy config (2023-11-08)

Removes unnecessary brackets from example helm values proxy configuration that break it.

Modified

removing warning about the websocket pdk (2023-11-07)

This removes the unstable warning from the gateway's WebSocket client/upstream Lua PDKs.

Modified

KIC: Fix GRPC Guide (2023-11-08)

Add GRPC guide to KIC 3.0 docs

Modified

Release: KIC 3.0 (2023-11-06)

Merge the long-lived KIC 3.0 branch in to main

Added

Modified

RateLimit header fields for HTTP -> https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/

Modified

Release: Gateway 3.5 (2023-11-08)

Description

Release roll-up PR for Gateway 3.5 release.

Added

Modified

Week 44

Fix: 2.8.1.3 changelog entry for aws-lambda plugin changes to match 3.0.0.0 (2023-11-02)

Copied the text written in 3.0.0.0 changelog entry for the aws-lambda plugin to when it was introduced in 2.8.1.3 for consistency. Makes it easier to find the versions in which those properties were added for aws_assume_role_arn for example.

Modified

Fix: Align wording of 2.8.1.3 update for aws_assume_role_arn property (2023-11-02)

Extending the wording from the Gateway changelog in 3.0.0.0 and 2.8.1.3 to the plugin changelog for aws-lambda for 2.8.1.3 for consistency.

Modified

Update resource limit language (2023-11-01)

Update resource limit language from entity resource limit to Default entity resource limit.

Modified

Topnav tweaks (2023-11-01)

Add a few tweaks based on the feedback we received.

  • Remove "We are hiring"
  • Move "API Specs" into the "Docs" dropdown

Note: I added a "Documentation" title to the section for consistency

Added

Release: decK 1.28 (2023-11-03)

Release 1.28.x decK docs MVP. CLI reference updates only. Guides to follow.

Added

Modified

Fix mistake in auth0 markdown (2023-10-31)

Fix description for the konnect_org_id field.

Modified

Fix: App registration doc lists hybrid mode as not supported (2023-11-02)

We've had the same wrong info in the app registration docs since 2.1.x: that when using Kong Gateway as the system of record, app reg can't be used in hybrid mode. This issue recently resurfaced as a customer ran into it.

Changes made:

  • Removing the inaccurate info and making it clear that the limitation is for the OAuth2 plugin only.
  • Added a column to the table in the App Reg plugin overview with info about supported topologies, to make it very clear up front.
  • Cleaning up the app reg auth provider strategy docs to remove all the duplicate info and cut the content down to what the user needs to know. We have the same info repeated three times in one topic, making it very difficult to actually follow along with any instructions.
  • Removed outdated images from the edited topics.

Backported it back through 2.6 since it was just a matter of copy & paste.

Modified

Add Kong Mesh specific policies to the migration script (2023-11-01)

In the recently introduced guide, I forgot to include Kong Mesh specific policies in the script.

Modified

fix(opentelemetry): address invalid request to set up plugin (2023-10-30)

The request documented to configure the Opentelemetry plugin is invalid because it uses a dot . in the name of the attribute, which is interpreted as a field separator in the curl form data.

This updates the documentation without changing the example, using JSON instead of form data to allow passing a name that includes a dot.

Modified

fix: fix changelog entry for openssl version bump (2023-10-30)

The PR fixes the issue that the changelog entries of OpenSSL version bumping from 1.1.1t to 3.1.1 are missing from several specific versions.

The missing version list are:

  • 2.8.4.2
  • 3.1.1.5
  • 3.2.2.4
  • 3.3.1.1

The PR adds all of them.

Modified

Feat: Portal Management API (2023-11-02)

Customers are able to integrate portal management operations with their automation systems (such as CI/CD pipelines) by utilizing a refactored and newly-published AIP-compliant Portal Management API.

Modified

docs(mesh): update docs and changelog (2023-10-31)

Syncing docs from source code.

Generated by action

Modified

Week 43

Minor update to Noname plugin description (2023-10-26)

Minor update to Noname plugin description.

Modified

Update cert-manager guide to use Kuma labels (2023-10-25)

Kuma uses labels now instead of annotations.

Modified

docs(mesh): update docs and changelog (2023-10-27)

Syncing docs from source code.

Generated by action

Modified

fix(portal) remove examples with path in portal gui host (2023-10-24)

Summary

Removes examples of adding a path when configuring portal_gui_host

Related: https://github.com/Kong/docs.konghq.com/pull/4179

Reason

Adding a path to portal_gui_host is not supported

Modified

Fix API URL in Konnect Custom Plugin docs (2023-10-24)

Fix the API URL for uploading custom plugin schemas

Modified

fix(jwt): state what happens when multiple JWTs are provided (2023-10-24)

A user asked to clarify the docs in scenario when multiple JWTs tokens are provided: https://github.com/Kong/kong/issues/11796. With the change from some time ago: https://github.com/Kong/kong/pull/9946 - kong rejects request when multiple JWTs were provided that differ from each other.

This PR explicitly states that the request will be rejected.

Modified

Add GWAPI redirect instructions (2023-10-27)

Add GWAPI instructions to the KIC HTTPS redirect guide. Due to https://github.com/Kong/kubernetes-ingress-controller/issues/4890 this uses our vendor annotations.

Adds a TLS configuration include. This creates a certificate and injects configuration to use it into either an Ingress or Gateway. The certificate hostname is configurable. The Gateway and Ingress names are not and expect the standard echo Ingress or kong Gateway.

GWAPI does not easily allow adding HTTPS configuration without a TLS Listener, and these Listeners must have a certificate as of GWAPI v0.8. We can't use the default Kong certificates if we don't care about the specific certificates, so we need this include for any guides that touch HTTPS-specific functionality.

Guide to migrate Zone CP from On-Prem Global CP to Konnect (2023-10-23)

Added a new guide on how to migrate Zone from on-prem Global to Konnect

Added

Update: reflect latest FIPS support status (2023-10-24)

From https://docs.google.com/document/d/1PJCcO_5DSTbv_08XxDlaS2Cx2-YeYfAencrFhS190AA/edit and https://github.com/Kong/kong/pull/11725

Modified

Week 42

Chore: Add search aliases for plugins (2023-10-18)

The search field on the plugin hub homepage relies on the plugin's name and the optional search_aliases metadata field. Adding shortform aliases (eg mtls), related terms (eg certificates), and plugin literal names in code (eg mtls-auth).

Modified

Fix: Kong Gateway support matrix (2023-10-17)

Fixing the following issues with the Kong Gateway support matrix:

  • PostgreSQL 9 and 10 are no longer supported by upstream but our docs claim to support them. Also, PostgreSQL 11 is also going out of support in 3 weeks

  • Our support policy doc incorrectly stated the EOLs of many OSes. We have this statement (adjusted for dates/versions) at the top of every version's support table:

    " Kong Gateway 2.8 LTS supports the following deployment targets until March 2025, unless otherwise noted by an earlier OS vendor end of life (EOL) date."

    However, our support tables aren't listing the accurate "earlier OS vendor end of life (EOL) dates".

  • The support table inaccurately lists available Docker images. We have many new Docker images available now that weren't listed (especially for 2.8 LTS).

    As I was trying to figure out which versions we have images for, I also noticed that the base OS for our convenience images changed once again in 3.2.1.0. It originally switched from Alpine to Debian in 3.0.0.0, which is already in the changelog, but we were unaware of the switch to Ubuntu later. Added a changelog entry for that.

https://konghq.atlassian.net/browse/DOCU-3541

Modified

feat(multiple-metrics): updated latency section and images (2023-10-19)

Updated content to support our new multiple metrics feature hopefully coming out by the end of this week. In details:

  • Updated latency use case section to only cover how to compare upstream vs kong latency. Previously, we had two separate section but you don't need to create two individual reports anymore.
  • Updated all images to cover UI changes.

Jira: https://konghq.atlassian.net/browse/MA-1914 Aha: https://konghq.aha.io/features/KP-299

Added

Modified

Update: SSH access note for instances deployed using Konnect Tech Preview install platforms (2023-10-18)

Add a note about SSH access to Konnect data plane nodes when using the AWS, Azure, or GCP deployment styles and how it's not allowed directly but need to use the cloud provider tools.

Raised in Slack: https://kongstrong.slack.com/archives/C03NRECFJPM/p1691689181346589

Modified

update: Portal OIDC teams mapping post-GA improvements for IdP config instructions (2023-10-16)

When this was first published, we weren't able to get SME confirmation on the correct steps for setting up the IdP configuration. Users still needed this information, as well as information about configuring groups claims, so I added those in.

Modified

update: Add Portal RBAC diagram to Managing Developer Team Access Page (2023-10-17)

We were requested to make a diagram that better visually explained how the scenario worked with the Pizza Ordering API and developer teams RBAC. I created the diagram and added it.

Added

Modified

Week 41

Fix: Missing ldaps option in Kong Manager LDAP setup. Resolves DOCU-2529. (2023-10-12)

Added ldaps to the admin_gui_auth_conf setting and added to the attribute table. Resolves DOCU-2529.

Modified

Release: Changelog and version bump for Gateway 2.8.4.4 (2023-10-12)

Changelog for Gateway EE 2.8.4.4 patch version.

Modified

Release: Changelog and version bump for Gateway 3.1.1.6 (2023-10-12)

Changelog for Gateway EE 3.1.1.6 patch version.

Modified

Release: Changelog and version bump for Gateway 3.2.2.5 (2023-10-12)

Changelog for Gateway EE 3.2.2.5 patch version.

Modified

Fix: Konnect OIDC sign-in & sign-out redirect URIs (2023-10-12)

Fixes the reported issue in Jira DOCU-3311 which was causing confusion with the examplepath name in the testing section of the login URL.

Modified

Release: Changelog and version bump for Gateway 3.3.1.1 (2023-10-12)

Changelog for Gateway EE 3.3.1.1 patch version.

Modified

Release: Changelog and version bump for Gateway 3.4.1.1 and 3.4.2 (2023-10-12)

Changelog for Gateway EE 3.4.1.1 and OSS 3.4.2 releases.

Modified

update: Remove Gateway 3.0 from supported versions and move to older versions table (2023-10-12)

Support for Gateway 3.0 was removed in September, so we needed to update our support version docs to reflect that.

DOCU-3519

Modified

Update: Salt plugin now supports new queue in 3.3+ (2023-10-11)

In Kong 3.3, the queue logic was updated, forcing a change to the plugin logic. This is that update.

background: https://konghq.com/blog/product-releases/reworked-plugin-queues-in-kong-gateway-3-3

Modified

Fix: curl examples for custom plugins schemas in Konnect (2023-10-10)

Turns out that you can't pass a file directly via cURL to our Konnect CP configuration API. The contents of the file don't get escaped correctly. When testing this out originally, I used a mix of cURL and HTTPie, and HTTPie had no issues - but our default cURL instructions have problems here.

Issue was reported on Slack.

Updating the doc with Fero's help, tested it all with curl this time around.

The jq instructions are in a "tip", since we can't tell them to use jq if they don't want to or don't have it.

Modified

Update: Third-party categorization (2023-10-11)

Third party plugins are now categorized as:

  • Partner plugins: third party contributors that have a close relationship with Kong, usually meaning contracts, rigorous testing, etc.
  • Unsupported community plugins: Plugins from contributors that haven't gone through the above process.

This update makes it clearer which is which by using better filtering, banners, and categorization.

https://konghq.atlassian.net/browse/DOCU-3509

Modified

Update: Add info on cache locations in Gateway 2.x vs 3.x (2023-10-11)

The latest version of the documentation refers only to the config.json.gz which is misleading as on 3.x this was moved to lmdb. It has been updated to reflect both noting the version change.

https://docs.konghq.com/gateway/latest/production/deployment-topologies/hybrid-mode/#data-plane-cache-configuration

Modified

Week 40

Fix: Badge alignment (2023-10-06)

Badges & their tooltips are currently misaligned on h2-h5s:

Screenshot 2023-10-05 at 1 45 43 PM Screenshot 2023-10-05 at 1 46 26 PM

This PR fixes the alignment for both.

While testing out the fix, I also noticed that we had some wrong badges applied to the Konnect section of the Gateway intro page. We got rid of Plus and Enterprise badges for Konnect with the switch to consumption-based billing, since it isn't accurate to apply either tier to features in Konnect anymore.

Modified

fix: Plugin tiers for konnect-incompatible plugins (2023-10-05)

Some konnect-incompatible plugins were displaying Konnect Paid or Konnect Premium badges. This was happening because the metadata was incorrectly set to include either paid: true or premium: true for these plugins.

Fixing that, and adding a banner to konnect-incompatible plugin landing pages to call that out.

Modified

feat: OIDC team mapping documentation (2023-10-04)

The OIDC team mapping feature will be released, so we need documentation that explains the workflow for how to set it up in Konnect. This PR also made some fixes after the previous PR was reverted.

Added

Modified

Update: Docs 404 page (2023-10-02)

Docs 404 page had bad alignment and outdated links. Making some adjustments to the layout and using better element hierarchy.

Modified

Update: Add cache names to mem_cache_size (2023-10-03)

The mem_cache_size parameter in kong.conf mentions that it controls the size of two caches, but doesn't say what the names of the caches are. According to our changelog, these two in-memory caches are kong_core_cache and kong_cache.

Resolves doc ticket https://konghq.atlassian.net/browse/DOCU-1878.

Parallel PR to https://github.com/Kong/kong/pull/11680.

Modified

feat: OIDC IdP Team Mapping functionality (2023-10-03)

Adds new documentation about the OIDC iDP team mapping function.

Added

Modified

Feat: PKI Certs for CP/DP authentication (2023-10-02)

Konnect now supports pinned PKI certs for CP/DP authentication. This means that Konnect supports digital certificates signed by a trusted CA in Konnect for CP/DP authentication.

DOCU-3357

Added

Modified

Week 39

Fix: View Organizations (2023-09-29)

To navigate back to the org switcher from Konnect. The button now says "View Organizations" rather than "Back to org switcher".

image

Modified

Fix: AWS Lambda plugin headers line (2023-09-29)

Previous line wasn't clear and readers were confused. The suggested text makes it clearer what the "additional headers" are.

https://konghq.atlassian.net/browse/DOCU-1554

Modified

Update: Add info about untrusted_lua param to exit transformer plugin (2023-09-29)

The Exit Transformer plugin allows you to execute Lua functions. There is a setting in kong.conf that controls any plugins or other functionality that can do that. There was nothing in the plugin's doc about the setting, so I added that in.

https://konghq.atlassian.net/browse/DOCU-1046

Modified

From ticket:

The documentation would be more helpful if there was a link back to the using-regexes-in-paths to capture uri from the request transform doc to show how this is actually done. This would provide the additional context of how to initially implement this functionality.

Adding the requested link + minor formatting edits to arrange the steps into an ordered list.

https://konghq.atlassian.net/browse/DOCU-156

Modified

Chore: Consistent banners/callouts across docs site (2023-09-28)

We have a lot of different alert/callout/banner styles across the docs site. They are a mix of two styles:

  • alert div elements and all of their classes and subclasses
  • blockquote elements with a few different classes

The alert div is the old method, where we used html tags in the docs. The blockquote method is what we use now, where we can use markdown and apply a banner class like this:

{:.note}
> This is my note.


{:.note .no-icon}
> This is my note without an icon.

The issue is that the CSS styling for the old and new elements keeps growing wider apart, as changes are made to the blockquote and not to the alert. This became far more obvious after the site redesign, where we ended up with lot of different font sizes and spacing issues in banners:

Inconsistent styling using alert: Screenshot 2023-09-27 at 2 41 14 PM Screenshot 2023-09-27 at 2 41 32 PM

Consistent styling using markdown and blockquotes: Screenshot 2023-09-27 at 2 41 55 PM

If we want to adjust styling after this, we should do so based on the blockquote element.

Modified

fix: MinK control plane diagram (2023-09-27)

The original diagram showed zones and ingress/egress as being Konnect managed, which was incorrect. This PR corrects it since only the global control plane is managed by Konnect.

Fixes #6180

Modified

Fix: Configuring https redirect (2023-09-27)

Tested, validated, and rewrote the guide.

Modified

Feat: Changelog for konnect custom plugin management (2023-09-26)

Changelog entry for Konnect custom plugins.

Relates to https://github.com/Kong/docs.konghq.com/pull/6164.

Modified

Feat: Konnect plus metered billing (2023-09-26)

https://konghq.atlassian.net/browse/DOCU-3353 Changes:

  • Adds new metadata for paid and premium, deleted mentions of Plus in the metadata.
  • Navbar changes - Deletes the old UI instructions for billing
  • Redirects
  • Added SS of billing dashboard
  • Reworked table logic across docs.
  • Updates PH tiers and badges and compatibility(Thanks Lena) image

https://deploy-preview-6099--kongdocs.netlify.app/konnect/compatibility/ https://deploy-preview-6099--kongdocs.netlify.app/konnect/account-management/

New table looks like this: image

Added

Modified

Chore: Remove old konnect api doc (2023-09-25)

Removing the old Konnect Runtime Groups Config API doc. It has been replaced with:

https://docs.konghq.com/konnect/api/ https://docs.konghq.com/konnect/api/control-plane-configuration/latest/

Feat: Custom plugin management in Konnect (2023-09-28)

Documentation for managing custom plugins through Konnect, using either the UI or the Konnect custom plugins API.

https://konghq.atlassian.net/browse/DOCU-2596

Added

Modified

Social Login and Org Switcher (2023-09-25)

Docs for Social Login and Org Switcher.

Epic: https://konghq.aha.io/epics/KP-E-65

Added

Modified

Add Kong Gateway Operator docs (2023-09-27)

Kong Gateway Operator docs.

Added

fix: Expose an external application (2023-09-27)

Tested, validated, rewrote the guide.

Modified

fix: Exposing UDP service (2023-09-25)

Tested, Validated, and Formatted the UDP service guide.

Modified

Feat: Add tool that detects broken markdown anchors (2023-09-28)

Add a new tool that detects output of [.+][.+] in the dist folder. These are markdown links where the anchor at the bottom of the file could not be found.

#6101 is a good example of where this happens

Modified

fix: Using Redis for rate limiting (2023-09-25)

Formatting changes and curl option changes. Used placeholders because the command varies based on the install method

Modified

Feat(api-requests): Added API requests beta to docs (2023-09-26)

Added a new section under Analytics to document our upcoming API Requests feature. This feature is in beta. Please take a look at this release minutes page to learn more about this feature.

https://konghq.atlassian.net/browse/DOCU-3264

Added

Modified

doc(portal): add documentation for auth0 dcr metadata TDX-3342 (2023-09-26)

Adds documentation around auth0 metadata, and how to use it via an action.

https://konghq.atlassian.net/browse/TDX-3342

Modified

Update: Sectioned cluster_fallback configs + added WebAssembly text to Wasm section (2023-09-27)

Moved the DP Resilience feature (Cluster Fallback) properties to their own section for better organization and linking. Loosely related to https://github.com/Kong/docs.konghq.com/pull/6064.

Also noticed our Wasm section had no reference to the text 'WebAssembly' which resulted in it not being found easily. Added that to the title of that section to allow for better searchability.

Modified

Week 38

Update: Konnect audit log webhooks only allow HTTPS (2023-09-20)

Konnect Audit Webhook Configurations only allow HTTPS endpoints - HTTP endpoint traffic will blocked at network level. Hence, updated docs to reflect same.

Modified

fix(dcr): Note about Azure DCR v1 endpoints (2023-09-20)

We wanted to add a small note about Azure DCR only supporting v1 endpoints.

Modified

Feat: Konnect Great Rename (2023-09-20)

The “runtime” terminology has become overloaded and not meaningful to users. Since the conception of Konnect, users have struggled with understanding the “runtime group” and “runtime instances” terms and how they match up with the gateway topology.

With this rename, kong-ified terms such as “runtime” are replaced with more standardized terminology such as control plane and data plane. As a result, new users to Konnect should have an easier time understanding and navigating the Konnect UI and APIs.

https://konghq.atlassian.net/browse/DOCU-3151

Summary of changes

UI:

  • Runtime Manager to Gateway Manager
  • Runtime group to control plane
  • Composite runtime group to control plane group
  • Runtime instance to data plane node

API:

  • /v2/systems-accounts to /v3/system-accounts
  • /v2/teams to /v3/teams
  • /v2/users to /v3/users
  • /v2/roles to /v3/roles
  • /v2/runtime-groups to /v2/control-planes
  • /v2/runtime-groups/{runtimeGroupId}/ to /v2/control-planes/{controlPlaneId}/
  • /v2/runtime-groups/{runtimeGroupId}/composite-status to /v2/control-planes/{controlPlaneId}/group-status

decK:

  • decK command flag: --konnect-runtime-group-name to --konnect-control-plane-name
  • decK state file attribute: _konnect.runtime_group_name to _konnect.control_plane_name

Added

Modified

Update: Add note about group filtering to Konnect SSO (2023-09-20)

Just adding a note to the Konnect SSO doc page about group filtering as it's needed in the rare case where a user in the IdP has over ~150 groups assigned which some IdPs will then not send the groups_claim in a standard manner and prevents successful authentication as a result. Customers need to use group filtering capabilities from the IdP to work effectively in that situation.

Stems from an issue discussed in Kong Support case #00037499.

Modified

fix(docs): correct the influxdb - gateway startup order (2023-09-19)

  • Update the startup order and startup InfluxDB before starting up kong-gateway.

  • From 3.4.0.0 Kong doesn't release the alpine docker image anymore thus correct the doc.

Modified

chore: Add the 2.8.4.3 Gateway changelog (2023-09-18)

What did you change and why?

  • Added the 2.8.4.3 Gateway changelog and the 2.8.4.3 breaking changes in preparation for the upcoming release.
  • Updating AWS Lambda plugin with info related to refactor.

Modified

Week 37

GraphQL Introspection endpoint will only be read from the Kong service (service = ngx.ctx.service) instead of reading from a specific variable or ingress - local.

Documenting this behavior so consumers are aware of how to configure correctly and know about the limitation.

Modified

[Fix]- KIC: Setting up Active and Passive health checks guide (2023-09-11)

Revised and rewrote the guide after validating.

Modified

fix missing keyword config in curl data (2023-09-12)

To enable grpc-web plugin via Admin API, the keywork config in curl data is missing.

Modified

fix: remove unsupported KIC feature (2023-09-11)

Remove the custom entities guide from KIC 2.x pages.

This feature was never actually supported in 2.x, and we removed the leftover flag in 2.9. In earlier 2.x versions, the flag was available but did not work.

Week 36

chore: Split the gateway changelogs to archive changelogs for sunset versions (2023-09-08)

Our Gateway changelog page is massive. This is a problem for everyone involved:

  • Bad page load times/performance
  • Difficult to edit
  • Lots of unnecessary info
  • Documenting versions that we don't support
  • And the most recent discovery, a not-insignificant chunk of our Algolia records

From now on, we will be archiving old changelogs at the same time we archive old versions of our docs. You can find the changelogs at https://legacy-gateway--kongdocs.netlify.app/enterprise/changelog/.

Modified

Post-launch tidy of Konnect API overview page + nav (2023-09-07)

Update links to api specs in overview page to reference evergreen links, repeat spec description from devportal description field, update nav links to consistently refer to API spec and use evergreen links.

Modified

update urls to latest and remove mention of dev portal (2023-09-06)

Update urls to latest for gateway APIs.

Remove mention of dev portal from API announcement banner.

Modified

Fix(plugin scopes): Consumer groups scope and application registration plugin (2023-09-05)

The scopes compatibility table was missing a column for consumer groups. This update enables generating the column and all entries from the plugins' schemas.

Additionally, the Application Registration plugin was listed as incompatible with all scopes, which is wrong - it's compatible with services only. Turns out we were selecting for the wrong key. Fixing this also fixes the display of the plugin's config and basic examples, which were both missing services.

Modified

(fix) remove note about cloud launcher support (2023-09-06)

Existing note was incorrect and causing confusion. https://kongstrong.slack.com/archives/CQK8J4VN3/p1693903551408579

Modified

Fix "supported-router-flavors" typos (2023-09-05)

This change fixes small typos in the documentation.

Modified

Salt plugin: add konnect and update version compatibility (2023-09-05)

Updating for Konnect compatibility & Kong version support taking colleagues work and putting into PR on main for Kong's docs repo

Modified

feat: Split serverless plugins into their own pages (2023-09-08)

We currently document one entry for Serverless Functions, but it’s actually two plugins: pre-function and post-function. When searching for docs, users look for one of those names, not for Serverless Function. The UI also has them as two separate plugins, so one docs entry doesn't make sense.

This PR aims to solve that by splitting Serverless Functions into Post-function and Pre-function plugins.

https://konghq.atlassian.net/browse/DOCU-3434

Added

Modified

[Fix] KIC guides (2023-09-06)

Update existing Kong Ingress Controller guides for consistency and readability. Audit that all guides work as intended by copy/pasting the instructions.

Modified

fix: change go-apiops to deck file in deck_file_remove-tags.md (2023-09-06)

go-apiops cli is built for testing purposes. End users are encumbered to use this utility through deck file command

I changed go-apiops cli example to deck file. As mentioned in go-apiops repository

Currently, the functionality is released as a library and as part of the decK CLI tool. The repository also contains a CLI named go-apiops for local testing. For general CLI usage, prefer the decK tool docs tool.

go-apiops is used for testing and deck is encouraged for general usage.

Modified

Feat: Plugin hub nested overviews (2023-09-05)

Add the ability to nest overview pages to plugins, they work in the same way as the how-tos. Add redirects, so that existing URLs redirect to /overview/. Add nav_title: Introduction to existing pages.

Modified

Adds documentation for the Filter Chain entity available in Kong Gateway 3.4 (2023-09-05)

Adds documentation for the Filter Chain entity available in Kong Gateway 3.4 when WebAssembly support is enabled.

Modified

Week 35

Add info about how IP address is determined for IP Restriction plugin (2023-08-31)

Added a blurb about how the IP Address is determined when using the IP Restriction plugin, as this was confusing customers who were unaware of the appropriate settings that needed to be tweaked for their environment so the IP could be determined accurately.

Modified

Added info about limiting by IP address (2023-08-31)

We were missing details about how the IP address was determined when customers want to limit by IP address. Added these details to clarify how this works and linked to other sources for the appropriate properties that need to be set.

Modified

Updated RLA index page to share some details from RL plugin (2023-08-31)

There were some missing details from the RL (Rate Limiting) plugin which I pasted into the RLA (Rate Limiting Advanced) plugin index page, including extra details about the strategies that can be used and the use-cases for each.

Also added a section for how the IP address is determined as this was missing from the details and was not obvious to customers how this worked when limiting by IP address.

Modified

Update index.md (2023-08-31)

Fixed spelling mistake and commas

  • Fixed spelling error: changed confict to conflict.
  • Added commas

Modified

fix: Update OSS install instructions for Kong Manager (2023-08-31)

Our OSS install instructions (specifically Docker and I found some Linux ones as well) that still said that KM wasn't for OSS even though it is. I fixed those spots.

DOCU-3445

Modified

chore(deps): update docs from repo source (2023-08-31)

Syncing docs from source code.

Generated by action

Modified

Update: Add link to changelog entry for Kong Manager OSS (2023-08-29)

Add link to https://docs.konghq.com/gateway/latest/kong-manager-oss/ in the feature annoucement

Modified

(Fix) Cross-ref CP-DP communication through forward proxy in Konnect docs (2023-08-29)

You can now find cross-reference to the "Control Plane and Data Plane Communication through a Forward Proxy" page in the "Konnect Ports and Networking Requirements" page.

Updated based on Slack feedback here.

Modified

kic: update CombinedServices feature gate default for 2.11 (2023-08-30)

Update CombinedServices feature gate default for 2.11 as it was made in https://github.com/Kong/kubernetes-ingress-controller/pull/4138

Modified

chore(deps): bump kumahq/kuma-website from c530a7a4 to 045ff986 (2023-08-30)

Auto upgrade PR log:

045ff9868acdb4b322759dde3f8053f41948100f feat: extend kubernetes perf tuning section (kumahq/kuma-website#1444) cac5fd764b722ee64e1be31f26d9d006d9cf1574 fix(annotations): remove reference to injection annotation (kumahq/kuma-website#1450)

Triggered by action.

Modified

Edited the CP outage handling doc to add emphasis to environment variables (2023-08-28)

Corrected some wording and bolded the "import" and "export" portions in the environment variables as customers are often seeing these are the same variables without realizing they're different between export and import.

Reverted the bolding after I realized it didn't load correctly in the preview. Overall the final change is just a mild correction to a wrongly formatted sentence from earlier.

Modified

Add if_versions tags so windows support does not show up in KM v2.4 (2023-08-29)

Remove Windows support from KM 2.4 onwards

Modified

chore(deps): bump kumahq/kuma-website from 2064c900 to 707fb928 (2023-08-28)

Auto upgrade PR log:

707fb928c63b3d4cc57628ecfb8f53845b4ab314 fix(MeshGateway): fix typo on example tags table (kumahq/kuma-website#1442)

Triggered by action.

Modified

feat(pre-built-reports): added changelog entry and an intro sentence (2023-08-28)

Added a changelog item to release our pre-built reports feature (Aha ticket) and an intro sentence into the Analytics section inside the Konnect intro chapter. This feature is rather small and is only for new organization. Therefore, I think we don't need a lot of docs changes.

Here is a list of the pre-built reports we deploy for all new organizations.

Modified

chore(deps): update docs from repo source (2023-08-29)

Syncing docs from source code.

Generated by action

Added

Modified

fix: Docker installation for Kong Gateway OSS missing port for Kong Manager OSS (2023-08-29)

The installation instructions for Kong Gateway OSS on Docker were missing the Kong Manager OSS port mapping. Adding it for 3.4, along with a troubleshooting entry, in case anyone else runs into it.

Added

Modified

Add blog post note to gateway install pages (2023-08-31)

This addition was requested by the marketing folks just to further cement usage of the new site.

Modified

chore: Sunset Kong Gateway versions 2.1.x-2.5.x (2023-08-29)

As of August 24th, 2023, Kong Gateway OSS and Enterprise versions 2.1.x-2.5.x end their sunset support.

This PR removes all of the old versions from the docs site, as well as the /archive folder maintained on the main branch. We no longer need that folder, since we have a legacy-gateway site.

You can find all of the archived versions at the following links: https://legacy-gateway--kongdocs.netlify.app/enterprise/2.5.x/ https://legacy-gateway--kongdocs.netlify.app/gateway-oss/2.5.x/ https://legacy-gateway--kongdocs.netlify.app/getting-started-guide/2.5.x/overview/

For the additions to the archive, see https://github.com/Kong/docs.konghq.com/pull/5993.

https://konghq.atlassian.net/browse/DOCU-3347

Some specifics:

  • Deleting everything to do with enterprise, gateway-oss, and getting-started-guide editions and URLs. All three of those editions were replaced with one gateway edition in 2.6.x. Since we're archiving everything before 2.6.x, we no longer need to maintain all of the exceptions for the old editions.
  • Plugins: We will no longer build versions 2.5.x or earlier. There wasn't a lot of 2.5.x or earlier content that was unique, so I think that should be fine.
    • If we want to move the old plugin docs to the archive site, we will need to port the whole new plugin hub over there. I'm not sure that it's worth it yet.

Modified

Week 34

Fix missing icon (2023-08-25)

The OSS/Enterprise icon was missing. We changed it to a white version when we added it to the blue navigation, and forgot to change it back when we put it back in the TOC.

Add missing alt text to konnect's dashboard image.

Modified

Chore: Bump GW to version 3.1.1.5 (2023-08-25)

https://konghq.atlassian.net/browse/DOCU-3410

  • changelog

  • updated app/_data/kong_versions.yml

Modified

chore(deps): bump kumahq/kuma-website from 643f230a to 2064c900 (2023-08-25)

Auto upgrade PR log:

2064c9000e7605c6b057ac3e668708a45046c8aa chore(deps): update docs from repo source (kumahq/kuma-website#1443)

Triggered by action.

Modified

fix: Add missing metadata to appdynamics and serverless functions plugins (2023-08-24)

The AppDynamics and Serverless functions plugins were incorrectly listed as being incompatible with all Kong Gateway deployment modes: https://docs.konghq.com/hub/plugins/compatibility/#serverless

Fixing that by adding network_config_opts to the metadata files for both plugins. Both plugins can be run in DB-less, traditional, and hybrid modes.

Modified

chore(deps): bump kumahq/kuma-website from b49b8059 to 643f230a (2023-08-23)

Auto upgrade PR log:

643f230ab275957febf4c5195e83939dd8bdf16e fix(retry): correct baseDuration to baseInterval (kumahq/kuma-website#1441)

Triggered by action.

Modified

feat: Konnect API examples for plugins (2023-08-23)

For any plugin that is supported in Konnect, it’s now possible to configure it using the Konnect runtime groups API, via core-entities. This PR adds support for generated Konnect API examples in the plugin docs, which makes the Konnect API more visible and positions it as a parallel option to the Kong Admin API.

A simple service example for the Basic auth plugin: Screenshot 2023-08-17 at 1 54 20 PM

A global example for the Rate Limiting Advanced plugin: Screenshot 2023-08-17 at 2 57 19 PM

Along with that, there were several fixes/improvements that I had to make:

  • Placeholders in curl examples: after team discussion, settled on { } as the placeholder characters for URLs. This format is heavily used in our API specs, and is the OpenAPI standard: https://swagger.io/docs/specification/describing-parameters/. Going forward, we should be using { } to enclose variables in specs and API examples.

    • Placeholders in other situations still need revisiting. Out of scope here.

  • The global example now explains what "global" means in the context of Konnect, Kong Enterprise, and Kong OSS. This is a long-running painpoint, and it seems timely to add this as we add Konnect examples.

  • Removed the duplicate konnect_examples and manager_examples metadata keys from plugin docs. We don't have Kong Manager examples, and we don't need a separate konnect_examples key. konnect: false/true already performs the same function.

https://konghq.atlassian.net/browse/DOCU-2949

Modified