Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/styles/base/Kongterms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ swap:
Kong Gateway Operator: "{{site.gateway_operator_product_name}}"
"{{site.kgo_product_name}}": "{{site.gateway_operator_product_name}}"
ServiceHub: Service Hub
Runtime Manager: Gateway Manager
Runtime Manager: API Gateway
dbless: DB-less
2 changes: 1 addition & 1 deletion app/_gateway_entities/ca-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

tools:
- admin-api
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


tools:
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/consumer-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


api_specs:
Expand Down
24 changes: 12 additions & 12 deletions app/_gateway_entities/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ related_resources:
url: /how-to/?query=consumer
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
- text: "{{site.konnect_short_name}} control plane resource limits"
url: /gateway/control-plane-resource-limits/

faqs:
- q: What are credentials, and why do I need them?
Expand Down Expand Up @@ -167,29 +167,29 @@ rows:

## Centrally-managed Consumers {% new_in 3.10 %}

Consumers can be scoped to a {{site.konnect_short_name}} region and managed centrally, or be scoped to a Control Plane in Gateway Manager.
Consumers can be scoped to a {{site.konnect_short_name}} region and managed centrally, or be scoped to a control plane.

Centralized Consumer management provides the following benefits:
* **Set up a Consumer identity centrally**: Only define a Consumer once, instead of defining it in multiple Control Planes.
* **Avoid conflicts from duplicate Consumer configuration**: Users don't need to replicate changes to Consumer identity in multiple Control Planes and Consumer configuration doesn't conflict.
* **Reduce configuration sync issues between the Control Plane and the Data Planes**: Consumers that are managed centrally aren't part of the configuration that is pushed down from the Control Plane to the Data Planes, so it reduces config size and latency.
* **Set up a Consumer identity centrally**: Only define a Consumer once, instead of defining it in multiple control planes.
* **Avoid conflicts from duplicate Consumer configuration**: Users don't need to replicate changes to Consumer identity in multiple control planes and Consumer configuration doesn't conflict.
* **Reduce configuration sync issues between the control plane and the data planes**: Consumers that are managed centrally aren't part of the configuration that is pushed down from the control plane to the data planes, so it reduces config size and latency.

Centrally managed Consumers exist outside of Control Planes, so they can be used across Control Planes.
Centrally managed Consumers exist outside of control planes, so they can be used across control planes.

Use the following table to help you determine if you should use centrally-managed Consumers or Consumers scoped to Control Planes:
Use the following table to help you determine if you should use centrally-managed Consumers or Consumers scoped to control planes:

<!--vale off-->
{% feature_table %}
columns:
- title: "Centrally-managed Consumers"
key: central
center: true
- title: Control Plane scoped Consumer
- title: Control plane scoped Consumer
key: cp_consumer
center: true

features:
- title: "Share Consumer identity in more than one Control Plane"
- title: "Share Consumer identity in more than one control plane"
central: true
cp_consumer: false
- title: "Supported authentication strategies"
Expand All @@ -205,15 +205,15 @@ features:
<!--vale on-->

You can manage Consumers centrally using the [{{site.konnect_short_name}} Consumers API](/api/konnect/consumers/v1/).
Only Org Admins and Control Plane Admins have CRUD permissions for these Consumers.
Only Org Admins and control plane Admins have CRUD permissions for these Consumers.

When you create a Consumer centrally, you must assign it to a realm. A realm groups Consumers around an identity, defined by organizational boundaries, such as a production realm or a development realm.
Realms are connected to a [geographic region](/konnect-platform/geos/) in {{site.konnect_short_name}}. Additionally, centrally managed Consumers must have a [specific Key Authentication configuration](/plugins/key-auth/examples/identity-realms/) set up to allow these Consumers to authenticate.

For a complete tutorial, see [Create a centrally-managed Consumer in {{site.konnect_short_name}}](/how-to/create-centrally-managed-consumer/).

{:.info}
> **Note:** If you are using KIC to manage your Data Plane nodes in {{site.konnect_short_name}}, ensure that you configure the [`cluster_telemetry_endpoint`](/gateway/configuration/#cluster-telemetry-endpoint) in the Data Plane. You can find your specific `cluster_telemetry_endpoint` in [Gateway Manager](https://cloud.konghq.com/gateway-manager/), in the Data Plane node setup instructions.
> **Note:** If you are using KIC to manage your data plane nodes in {{site.konnect_short_name}}, ensure that you configure the [`cluster_telemetry_endpoint`](/gateway/configuration/#cluster-telemetry-endpoint) in the data plane. You can find your specific `cluster_telemetry_endpoint` when setting up a data plane node.

## Consumer schema

Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/key-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


tools:
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/key.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ related_resources:
- text: Securing {{site.base_gateway}}
url: /gateway/security/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


api_specs:
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ related_resources:
- text: Custom plugins
url: /custom-plugins/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


tools:
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ related_resources:
- text: Traffic control and routing
url: /gateway/traffic-control-and-routing/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

next_steps:
- text: Learn about the Expressions router
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

tools:
- admin-api
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/sni.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ related_resources:
- text: Using SSL certificates in {{site.base_gateway}}
url: /gateway/ssl-certificates/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

tools:
- admin-api
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/target.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

schema:
api: gateway/admin-ee
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ related_resources:
- text: Reserved entity names
url: /gateway/reserved-entity-names/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/

schema:
api: gateway/admin-ee
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ related_resources:
- text: Managing sensitive data with decK
url: /deck/gateway/sensitive-data/
- text: "{{site.konnect_short_name}} Control Plane resource limits"
url: /gateway-manager/control-plane-resource-limits/
url: /gateway/control-plane-resource-limits/


faqs:
Expand Down
12 changes: 6 additions & 6 deletions app/_how-tos/create-centrally-managed-consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ tags:

tldr:
q: How do I centrally manage Consumers in {{site.konnect_short_name}}?
a: Centrally-managed Consumers exist outside of a Control Plane. To create one, you must first create a realm using the {{site.konnect_short_name}} API as well as a Consumer associated with the realm. Then, create a key for the centrally-managed Consumer that they can use for authentication. Enable the Key Authentication plugin, configuring `identity_realms`. Centrally-managed Consumers can then authenticate via key auth with their key.
a: Centrally-managed Consumers exist outside of a control plane. To create one, you must first create a realm using the {{site.konnect_short_name}} API as well as a Consumer associated with the realm. Then, create a key for the centrally-managed Consumer that they can use for authentication. Enable the Key Authentication plugin, configuring `identity_realms`. Centrally-managed Consumers can then authenticate via key auth with their key.
faqs:
- q: When should I use centrally-managed Consumers instead of Consumers scoped to control planes?
a: |
Expand All @@ -58,15 +58,15 @@ cleanup:

## Create a realm

First, export your Control Plane ID and [region](/konnect-platform/geos/) (for example, `us`) so we can use it in the request. You can find these under your Control Plane settings in [Gateway Manager](https://cloud.konghq.com/gateway-manager/):
First, export your control plane ID and [region](/konnect-platform/geos/) (for example, `us`) so we can use it in the request. You can find these under your [control plane settings](https://cloud.konghq.com/gateway-manager/):
```sh
export KONNECT_CONTROL_PLANE_ID={control-plane-id}
export DECK_CONTROL_PLANE_REGION={region}
```

Centrally-managed Consumers are assigned to realms instead of Control Planes. Realms exist outside of the Control Plane.
Centrally-managed Consumers are assigned to realms instead of control planes. Realms exist outside of the control plane.

Use the [`/realms` endpoint](/api/konnect/consumers/#/operations/create-realm) to create a realm and associate it with allowed Control Planes:
Use the [`/realms` endpoint](/api/konnect/consumers/#/operations/create-realm) to create a realm and associate it with allowed control planes:

<!--vale off-->
{% konnect_api_request %}
Expand Down Expand Up @@ -126,7 +126,7 @@ export CONSUMER_KEY={consumer-key}

## Enable authentication with the Key Authentication plugin

Consumers require authentication. Currently, you can only use the [Key Auth plugin](/plugins/key-auth/) to authenticate centrally-managed Consumers. In this example, we'll configure `identity_realms` on first the realm and then the Control Plane. By doing it this way, the Data Plane will first reach out to the realm. If the API key is not found in the realm, the Data Plane will look for the API key in the Control Plane config.
Consumers require authentication. Currently, you can only use the [Key Auth plugin](/plugins/key-auth/) to authenticate centrally-managed Consumers. In this example, we'll configure `identity_realms` on first the realm and then the control plane. By doing it this way, the data plane will first reach out to the realm. If the API key is not found in the realm, the data plane will look for the API key in the control plane config.

Enable the Key Auth plugin on the `example-service`:

Expand All @@ -152,7 +152,7 @@ variables:
value: $CONTROL_PLANE_REGION
{% endentity_examples %}

`identity_realms` are scoped to the Control Plane by default (`scope: cp`). The order in which you configure the `identity_realms` dictates the priority in which the Data Plane attempts to authenticate the provided API keys. See [identity realms precedence](/plugins/key-auth/#identity-realms) for more information.
`identity_realms` are scoped to the control plane by default (`scope: cp`). The order in which you configure the `identity_realms` dictates the priority in which the data plane attempts to authenticate the provided API keys. See [identity realms precedence](/plugins/key-auth/#identity-realms) for more information.

## Validate

Expand Down
6 changes: 3 additions & 3 deletions app/_how-tos/kic-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ tags:
## Konnect setup

{:.info}
> For UI setup instructions to install {{ site.kic_product_name }} on {{ site.konnect_short_name }}, use the [Gateway Manager setup UI](https://cloud.konghq.com/us/gateway-manager/create-control-plane).
> For UI setup instructions to install {{ site.kic_product_name }} on {{ site.konnect_short_name }}, use the [control plane setup UI](https://cloud.konghq.com/us/gateway-manager/create-control-plane).

To create a {{ site.kic_product_name }} in {{ site.konnect_short_name }} deployment, you need the following items:

1. A {{ site.kic_product_name }} Control Plane, including the Control Plane URL
1. An mTLS certificate for {{ site.kic_product_name }} to talk to {{ site.konnect_short_name }}
1. A {{ site.kic_product_name }} control plane, including the control plane URL.
1. An mTLS certificate for {{ site.kic_product_name }} to talk to {{ site.konnect_short_name }}.

{% include k8s/kic-konnect-install.md %}

Expand Down
9 changes: 5 additions & 4 deletions app/_how-tos/operator-get-started-hybrid-create-route.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ next_steps:
{:data-deployment-topology='konnect'}
## Create a Service

Creating the `KongService` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} service in your [Gateway Manager](/gateway-manager/). You can refer to the CR [API](/operator/reference/custom-resources/#kongservice) to see all the available fields.
Creating the `KongService` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} service for your [API Gateway](/gateway/).
You can refer to the CR [API](/operator/reference/custom-resources/#kongservice) to see all the available fields.

Your `KongService` must be associated with a `KonnectGatewayControlPlane` object that you've created in your cluster.

Expand All @@ -61,12 +62,12 @@ spec:
{% endkonnect_crd %}
<!-- vale on -->

At this point, you should see the Service in the Gateway Manager UI.
At this point, you should see the Service in the API Gateway UI.

## Create a Route

Creating the `KongRoute` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} Route in
your [Gateway Manager](/gateway-manager/).
Creating the `KongRoute` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} Route for
your [API Gateway](/gateway/).
You can refer to the CR [API](/operator/reference/custom-resources/#kongroute) to see all the available fields.

### Associate a Route with a Service
Expand Down
6 changes: 3 additions & 3 deletions app/_how-tos/operator-konnect-consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ tags:

tldr:
q: How can I configure Consumers and Consumer Groups with KGO?
a: Use the `KongConsumer` and `KongConsumerGroup` CRDs to configure consumers and groups in Konnect Gateway Manager through your Kubernetes cluster.
a: Use the `KongConsumer` and `KongConsumerGroup` CRDs to configure Consumers and Groups in {{site.konnect_short_name}} through your Kubernetes cluster.


prereqs:
Expand All @@ -41,7 +41,7 @@ prereqs:

## Create a `KongConsumer`

Define a `KongConsumer` resource to provision a consumer in [{{site.konnect_short_name}} Gateway Manager](/gateway-manager/).
Define a `KongConsumer` resource to provision a Consumer in {{site.konnect_short_name}}.

<!-- vale off -->
{% konnect_crd %}
Expand All @@ -62,7 +62,7 @@ spec:

## Create a `KongConsumerGroup`

Creating the KongConsumerGroup object in your Kubernetes cluster will provision a {{site.konnect_short_name}} Consumer Group in your Gateway Manager.
Creating the KongConsumerGroup object in your Kubernetes cluster will provision a {{site.konnect_short_name}} Consumer Group in your control plane.

<!-- vale off -->
{% konnect_crd %}
Expand Down
2 changes: 1 addition & 1 deletion app/_how-tos/operator-konnect-dp-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ works_on:
entities: []
related_resources:
- text: Data Plane reference
url: /gateway-manager/data-plane-reference/
url: /gateway/data-plane-reference/
tags:
- konnect-crd

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ spec:

## Validation

You can validate from the command line or [Gateway Manager UI](/gateway-manager/) to confirm that both the `KongService` and `KongRoute` have been provisioned and are in a valid state:
You can validate from the command line or [{{site.konnect_short_name}} UI](/gateway/) to confirm that both the `KongService` and `KongRoute` have been provisioned and are in a valid state:


<!-- vale off -->
Expand Down
2 changes: 1 addition & 1 deletion app/_how-tos/operator-konnect-key-keyset.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create a Key and Key Set
description: "Provision Keys and Key Sets in {{site.konnect_short_name}} Gateway Manager using CRDs, and associate Keys with Key Sets."
description: "Provision Keys and Key Sets in {{site.konnect_short_name}} using CRDs, and associate Keys with Key Sets."
content_type: how_to

permalink: /operator/konnect/crd/gateway/key-keyset/
Expand Down
4 changes: 2 additions & 2 deletions app/_how-tos/operator-konnect-plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Enable a plugin on a Route
description: "Enable a plugin on a Route in {{site.konnect_short_name}} using the KongPlugin and KongPluginBinding CRDs and configure it for use with your Control Plane."
description: "Enable a plugin on a Route in {{site.konnect_short_name}} using the KongPlugin and KongPluginBinding CRDs and configure it for use with your control plane."
content_type: how_to

permalink: /operator/konnect/crd/gateway/plugin/
Expand Down Expand Up @@ -46,7 +46,7 @@ prereqs:

In this tutorial, we'll bind a plugin to {{site.base_gateway}} entities, like a Route, using the `KongPluginBinding` CRD.

First, create a Gateway Service in [{{site.konnect_short_name}} Gateway Manager](/gateway-manager/) using the `KongService` CRD:
First, create a Gateway Service in {{site.konnect_short_name}} using the `KongService` CRD:

<!-- vale off -->
{% konnect_crd %}
Expand Down
4 changes: 2 additions & 2 deletions app/_how-tos/operator-konnect-service-route.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ tags:

tldr:
q: How can I create a Service and Route for {{site.konnect_short_name}} using KGO?
a: Define a `KongService` and `KongRoute` in your Kubernetes cluster to provision and configure Gateway entities through the {{site.konnect_short_name}} Gateway Manager.
a: Define a `KongService` and `KongRoute` in your Kubernetes cluster to provision and configure Gateway entities in {{site.konnect_short_name}}.


prereqs:
Expand All @@ -39,7 +39,7 @@ prereqs:

## Create a `KongService`

Create a Gateway Service in the [{{site.konnect_short_name}} Gateway Manager](/gateway-manager/). The Service must reference an existing `KonnectGatewayControlPlane`.
Create a Gateway Service in {{site.konnect_short_name}}. The Service must reference an existing `KonnectGatewayControlPlane`.

<!-- vale off -->
{% konnect_crd %}
Expand Down
2 changes: 1 addition & 1 deletion app/_includes/components/entity_example/format/ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following creates a new Gateway Service called **{{ include.presenter.data['
1. Select **Plugins**.
1. Click **New Plugin** and choose a plugin.
1. Choose a scope for the plugin:
* **Global**, which applies the plugin to all Gateway Services, Routes, Consumers, and Consumer Groups in the Workspace (Kong Manager) or control plane (Gateway Manager).
* **Global**, which applies the plugin to all Gateway Services, Routes, Consumers, and Consumer Groups in the Workspace (Kong Manager) or control plane ({{site.konnect_short_name}}).
* **Scoped**, which lets you choose a specific Gateway Service, Route, Consumer, or Consumer Group to apply the plugin to.
The types of entities you have available here depend on the plugin you picked.

Expand Down
Loading
Loading