From 6cbaa3c927eefce0ace9a2c853ddd8fac544c78d Mon Sep 17 00:00:00 2001 From: Mayo Date: Tue, 14 Jun 2022 14:40:50 +0800 Subject: [PATCH 1/3] Add note for Kong Manager perf issue in traditional mode --- app/gateway/2.8.x/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/app/gateway/2.8.x/index.md b/app/gateway/2.8.x/index.md index b3bba36f220c..21e5ac434039 100644 --- a/app/gateway/2.8.x/index.md +++ b/app/gateway/2.8.x/index.md @@ -89,6 +89,12 @@ using the Kong Admin API. ### Kong Manager {:.badge .free} +{:.note} +> **Note**: If you are using the traditional mode of Kong, high traffic on Kong Manager might +> lead to potential performance issues to the Kong proxy, like tail latency and high CPU usage. +> Server-side sorting and filtering with a large amount of entities will cause high CPU usage in +> both Kong CP and database. + [Kong Manager](/gateway/{{page.kong_version}}/configure/auth/kong-manager) is the graphical user interface (GUI) for {{site.base_gateway}}. It uses the Kong Admin API under the hood to administer and control {{site.base_gateway}}. From 87f058ca8b28f0446950e23ed8960b5cf2783be6 Mon Sep 17 00:00:00 2001 From: angel Date: Tue, 14 Jun 2022 10:02:12 -0400 Subject: [PATCH 2/3] Vale changes --- app/gateway/2.8.x/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/app/gateway/2.8.x/index.md b/app/gateway/2.8.x/index.md index 21e5ac434039..6d8af8cd0860 100644 --- a/app/gateway/2.8.x/index.md +++ b/app/gateway/2.8.x/index.md @@ -18,9 +18,9 @@ With {{site.base_gateway}}, users can: * Create a thriving API developer ecosystem * Proactively identify API-related anomalies and threats * Secure and govern APIs/services, and improve API visibility across the -entire organization +entire organization ss -## Extending the Kong Gateway +## Extending the {{site.base_gateway}} {{site.base_gateway}} is a Lua application running in Nginx. {{site.base_gateway}} is distributed along with [OpenResty](https://openresty.org/), which is a bundle @@ -43,11 +43,11 @@ the [PDK reference](/gateway/{{page.kong_version}}/pdk), and the guide on {{site.base_gateway}} is available in the following modes: -**Kong Gateway (OSS)**: an open-source package containing the basic API gateway +**{{site.base_gateway}} (OSS)**: an open-source package containing the basic API gateway functionality and open-source plugins. You can manage the open-source Gateway with Kong's [Admin API](#kong-admin-api) or with [declarative configuration](#deck). -**Kong Gateway** (available in +**{{site.base_gateway}}** (available in [Free, Plus, or Enterprise modes](https://konghq.com/pricing)): Kong's API gateway with added functionality. * In **Free mode**, @@ -136,7 +136,7 @@ Kong also provides API lifecycle management tools that you can use with {{site.b ### decK [decK](/deck) helps manage {{site.base_gateway}}’s configuration in a declarative fashion. This means that a developer can define the desired state of Kong Gateway or -Konnect – services, routes, plugins, and more – and let decK handle +{{site.konnect_short_name}} – services, routes, plugins, and more – and let decK handle implementation without needing to execute each step manually, as you would with the Kong Admin API. @@ -155,7 +155,7 @@ The complete {{site.base_gateway}} getting started guide provides in-depth examples, explanations, and step-by-step instructions, and explores Kong's many available tools for managing the gateway. -### Try in Konnect +### Try in {{site.konnect_short_name}} [{{site.konnect_product_name}}](/konnect/) can manage {{site.base_gateway}} instances. With this setup, Kong hosts the control plane and you host your From b5c83815241e4b5476ee104273d955ed57ec2d08 Mon Sep 17 00:00:00 2001 From: angel Date: Tue, 14 Jun 2022 10:43:52 -0400 Subject: [PATCH 3/3] vale and copy edit --- app/gateway/2.8.x/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/app/gateway/2.8.x/index.md b/app/gateway/2.8.x/index.md index 6d8af8cd0860..715ae77ad81f 100644 --- a/app/gateway/2.8.x/index.md +++ b/app/gateway/2.8.x/index.md @@ -18,7 +18,7 @@ With {{site.base_gateway}}, users can: * Create a thriving API developer ecosystem * Proactively identify API-related anomalies and threats * Secure and govern APIs/services, and improve API visibility across the -entire organization ss +entire organization. ## Extending the {{site.base_gateway}} @@ -90,10 +90,10 @@ using the Kong Admin API. {:.badge .free} {:.note} -> **Note**: If you are using the traditional mode of Kong, high traffic on Kong Manager might -> lead to potential performance issues to the Kong proxy, like tail latency and high CPU usage. -> Server-side sorting and filtering with a large amount of entities will cause high CPU usage in -> both Kong CP and database. +> **Note**: If you are running Kong in traditional mode, increased traffic could +> lead to potential performance with Kong Proxy. +> Server-side sorting and filtering large quantities of entities will also cause increased CPU usage in both Kong CP and database. + [Kong Manager](/gateway/{{page.kong_version}}/configure/auth/kong-manager) is the graphical user interface (GUI) for {{site.base_gateway}}. It uses the Kong @@ -122,7 +122,7 @@ object-level health using intuitive, customizable dashboards {{site.base_gateway}} can run natively on Kubernetes with its custom [ingress controller](/kubernetes-ingress-controller/), Helm chart, and Operator. A Kubernetes ingress controller is a proxy that exposes Kubernetes services from applications (for example, Deployments, ReplicaSets) running on a Kubernetes cluster to client applications running outside of the cluster. The intent of an ingress controller is to provide a single point of control for all incoming traffic into the Kubernetes cluster. -### Kong Gateway plugins +### {{site.base_gateway}} plugins [{{site.base_gateway}} plugins](/hub/) provide advanced functionality to better manage your API and microservices. With turnkey capabilities to meet the most challenging use cases, {{site.base_gateway}} plugins ensure maximum control and minimizes unnecessary overhead. Enable features like authentication, rate-limiting, and transformations by enabling {{site.base_gateway}} plugins through Kong Manager or the Admin API. @@ -135,17 +135,17 @@ Kong also provides API lifecycle management tools that you can use with {{site.b ### decK [decK](/deck) helps manage {{site.base_gateway}}’s configuration in a declarative fashion. -This means that a developer can define the desired state of Kong Gateway or +This means that a developer can define the desired state of {{site.base_gateway}} or {{site.konnect_short_name}} – services, routes, plugins, and more – and let decK handle implementation without needing to execute each step manually, as you would with the Kong Admin API. -## Get started with Kong Gateway +## Get started with {{site.base_gateway}} -[Download and install Kong Gateway](/gateway/{{page.kong_version}}/install-and-run). +[Download and install {{site.base_gateway}}](/gateway/{{page.kong_version}}/install-and-run). To test it out, you can choose either the open-source package, or -run Kong Gateway in free mode and also try out Kong Manager. +run {{site.base_gateway}} in free mode and also try out Kong Manager. After installation, get started with one of our introductory guides: * **[Quickstart](/gateway/{{page.kong_version}}/get-started/quickstart)**: An introduction to