Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Angel <[email protected]>
  • Loading branch information
czeslavo and Guaris committed Oct 30, 2024
1 parent 4d79237 commit 3f077c5
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 65 deletions.
20 changes: 10 additions & 10 deletions app/_includes/md/kgo/konnect-entities-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<details class="custom" markdown="1">
<summary>
<blockquote class="note">
<p style="cursor: pointer">Before you create any Konnect entity, make sure you've <u>installed {{site.kgo_product_name}} and created a valid KonnectAPIAuthConfiguration{% if include.with-control-plane %} and KonnectGatewayControlPlane{% endif %}</u> in your cluster.</p>
<p style="cursor: pointer">Before you create any Konnect entity, make sure you've <u>installed {{site.kgo_product_name}} and created a valid `KonnectAPIAuthConfiguration` {% if include.with-control-plane %} and `KonnectGatewayControlPlane`{% endif %}</u> in your cluster.</p>
</blockquote>
</summary>

Expand All @@ -18,11 +18,11 @@ You may create either a Personal Access Token (PAT) or a Service Account Token (
to create a `KonnectAPIAuthConfiguration` object that will be used by the {{site.kgo_product_name}} to authenticate
with Konnect APIs.

### Create a Konnect API Auth Configuration
### Create a {{site.konnect_product_name}} API Auth Configuration

Depending on your preferences, you might want to create a `KonnectAPIAuthConfiguration` object with the token specified
Depending on your preferences, you can create a `KonnectAPIAuthConfiguration` object with the token specified
directly in its spec or as a reference to a Kubernetes Secret. The `serverURL` field should be set to the Konnect API
URL in a region where your Konnect account is located. Please refer to the [list of available API URLs](/konnect/network/)
URL in a region where your {{site.konnect_product_name}} account is located. Please refer to the [list of available API URLs](/konnect/network/)
for more information.

{% navtabs token %}
Expand Down Expand Up @@ -86,14 +86,14 @@ konnect-api-auth True <your-konnect-org-id> https://eu.api
```
{% if include.with-control-plane %}
### Create a Gateway Control Plane
### Create a {{site.base_gateway}} Control Plane
Creating the `KonnectGatewayControlPlane` object in your Kubernetes cluster will provision a Konnect Gateway
Control Plane in your [Gateway Manager](/konnect/gateway-manager). The `KonnectGatewayControlPlane` CR
Creating the `KonnectGatewayControlPlane` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} Gateway
control plane in your [Gateway Manager](/konnect/gateway-manager). The `KonnectGatewayControlPlane` CR
[API](/gateway-operator/{{ page.release }}/reference/custom-resources/#konnectgatewaycontrolplane) allows you to
explicitly set a type of the Gateway Control Plane, but if you don't specify it, the default type is
explicitly set a type of the {{site.base_gateway}} control plane, but if you don't specify it, the default type is
a [Self-Managed Hybrid
Gateway Control Plane](/konnect/gateway-manager/#kong-gateway-control-planes).
gateway control plane](/konnect/gateway-manager/#kong-gateway-control-planes).

You can create one by applying the following YAML manifest:

Expand Down Expand Up @@ -125,7 +125,7 @@ NAME PROGRAMMED ID ORGI
gateway-control-plane True <konnect-control-plane-id> <your-konnect-ord-id>
```

Having that in place, you will be able to reference the `gateway-control-plane` in your Konnect entities as their parent.
Having that in place, you will be able to reference the `gateway-control-plane` in your {{site.konnect_product_name}} entities as their parent.
{% endif %}

{% unless include.disable_accordian %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Architecture
---

In this guide you'll learn how your Kubernetes resources are synchronized against Konnect.
In this guide you'll learn how your Kubernetes resources are synchronized against {{site.konnect_product_name}}.

## Overview

{{site.kgo_product_name}} 1.4.0 introduced support for managing Konnect entities.
{{site.kgo_product_name}} 1.4.0 introduced support for managing {{site.konnect_product_name}} entities.
It is designed to allow users drive their {{site.konnect_short_name}} configuration through Kubernetes [CRDs][k8s_crds].

[k8s_crds]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/

{:.note}
> **Note:** Konnect entities management is an opt-in feature. You must
> **Note:** {{site.konnect_product_name}} entities management is an opt-in feature. You must
> enable it by setting `GATEWAY_OPERATOR_ENABLE_CONTROLLER_KONNECT` environment variable to `true`.
At a high level {{site.kgo_product_name}}, watches for changes in the Kubernetes cluster and synchronizes them against {{site.konnect_product_name}}.
Expand Down Expand Up @@ -131,9 +131,9 @@ Each Kubernetes resource that is mapped to a {{site.konnect_short_name}} entity

Objects that are native to {{site.konnect_short_name}} - they exist only in {{site.konnect_short_name}} - have the following `status` fields:

- `id` is the unique identifier of the Konnect entity as assigned by Konnect API. If it's unset (empty string), it means the Konnect entity hasn't been created yet.
- `serverURL` is the URL of the Konnect server in which the entity exists.
- `organizationID` is ID of Konnect Org that this entity has been created in.
- `id` is the unique identifier of the Konnect entity as assigned by {{site.konnect_product_name}} API. If it's unset (empty string), it means the {{site.konnect_product_name}} entity hasn't been created yet.
- `serverURL` is the URL of the {{site.konnect_product_name}} server in which the entity exists.
- `organizationID` is ID of {{site.konnect_product_name}} Org that this entity has been created in.

You can observe these fields by running:

Expand Down Expand Up @@ -163,9 +163,9 @@ They can also be used in other contexts like for instance: be used for reconcili
These objects have their {{site.konnect_short_name}} status related fields nested under `konnect` field. These fields are:

- `controlPlaneID` is the ID of the Control Plane this entity is associated with.
- `id` is the unique identifier of the Konnect entity as assigned by Konnect API. If it's unset (empty string), it means the Konnect entity hasn't been created yet.
- `serverURL` is the URL of the Konnect server in which the entity exists.
- `organizationID` is ID of Konnect Org that this entity has been created in.
- `id` is the unique identifier of the Konnect entity as assigned by {{site.konnect_product_name}} API. If it's unset (empty string), it means the {{site.konnect_product_name}} entity hasn't been created yet.
- `serverURL` is the URL of the {{site.konnect_product_name}} server in which the entity exists.
- `organizationID` is ID of {{site.konnect_product_name}} Org that this entity has been created in.

You can observe these fields by running:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ to see all the available fields.

Your `KongCertificate` must be associated with a `KonnectGatewayControlPlane` object that you've created in your
cluster.
It will make it part of the Gateway Control Plane's configuration.
It will make it part of the Gateway control plane's configuration.

You can create a `KongCertificate` by applying the following YAML manifest:

Expand Down Expand Up @@ -64,7 +64,7 @@ spec:
{% include md/kgo/check-condition.md name='cert' kind='KongCertificate' %}

At this point, you should see the Certificate in the Gateway Manager UI.
At this point, you should see the certificate in the Gateway Manager UI.

### Assign an SNI to the Certificate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ title: Consumer, Credentials and Consumer Group
---

In this guide you'll learn how to use the `KongConsumer` and `KongConsumerGroup` custom resources to
manage Konnect [Consumers](/konnect/gateway-manager/configuration/#consumers)
and Consumer Groups natively from your Kubernetes cluster.
manage {{site.konnect_product_name}} [Consumers](/konnect/gateway-manager/configuration/#consumers)
and consumer groups natively from your Kubernetes cluster.

{% include md/kgo/konnect-entities-prerequisites.md disable_accordian=false version=page.version release=page.release
with-control-plane=true %}

## Create a Consumer

Creating the `KongConsumer` object in your Kubernetes cluster will provision a Konnect Consumer in
Creating the `KongConsumer` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} Consumer in
your [Gateway Manager](/konnect/gateway-manager).
You can refer to the CR [API](/gateway-operator/{{ page.release }}/reference/custom-resources/#kongconsumer)
to see all the available fields.
Expand Down Expand Up @@ -40,12 +40,12 @@ spec:
{% include md/kgo/check-condition.md name='consumer' kind='KongConsumer' %}

At this point, you should see the Consumer in the Gateway Manager UI.
At this point, you should see the consumer in the Gateway Manager UI.

## Associate the Consumer with Credentials

Consumers can have credentials associated with them. You can create one of the supported credential types. Please refer
to the below Custom Resource's documentation links to learn all the available fields for each credential type.
to the below custom resource's documentation links to learn all the available fields for each credential type.

- [KongCredentialBasicAuth](/gateway-operator/{{ page.release }}/reference/custom-resources/#kongcredentialbasicauth)
- [KongCredentialKeyAuth](/gateway-operator/{{ page.release }}/reference/custom-resources/#kongcredentialkeyauth)
Expand Down Expand Up @@ -73,11 +73,11 @@ spec:

{% include md/kgo/check-condition.md name='basic-auth-cred' kind='KongCredentialBasicAuth' %}

At this point, you should see the Credential in the Consumer's Credentials in the Gateway Manager UI.
At this point, you should see the credential in the consumer's credentials in the Gateway Manager UI.

## Create a Consumer Group

Creating the `KongConsumerGroup` object in your Kubernetes cluster will provision a Konnect Consumer Group in
Creating the `KongConsumerGroup` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} consumer group in
your [Gateway Manager](/konnect/gateway-manager). Please refer to the
`KongConsumerGroup` CR [API](/gateway-operator/{{ page.release }}/reference/custom-resources/#kongconsumergroup) to see
all the available fields.
Expand All @@ -102,7 +102,7 @@ spec:

{% include md/kgo/check-condition.md name='consumer-group' kind='KongConsumerGroup' %}

At this point, you should see the Consumer Group in the Gateway Manager UI.
At this point, you should see the consumer group in the Gateway Manager UI.

### Associate a Consumer with a Consumer Group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ with-control-plane=true %}

## Create a Data Plane Client Certificate

Creating the `KongDataPlaneClientCertificate` object in your Kubernetes cluster will provision a Data Plane Client Certificate in
Creating the `KongDataPlaneClientCertificate` object in your Kubernetes cluster will provision a data plane client certificate in
your [Gateway Manager](/konnect/gateway-manager). You can refer to the CR [API](/gateway-operator/{{ page.release
}}/reference/custom-resources/#kongdataplaneclientcertificate) to see all the available fields.

Your `KongDataPlaneClientCertificate` must be associated with a `KonnectGatewayControlPlane` object that you've created in your cluster.
It will make it part of the Gateway Control Plane's configuration.
It will make it part of the gateway control plane's configuration.

To create a `KongDataPlaneClientCertificate`, you can apply the following YAML manifest:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Planes](/konnect/gateway-manager/#control-planes) natively from your Kubernetes

{% include md/kgo/konnect-entities-prerequisites.md disable_accordian=false version=page.version release=page.release %}

## Creating a Self-Managed Hybrid Gateway Control Plane
## Create a Self-Managed Hybrid Gateway Control Plane

Creating the `KonnectGatewayControlPlane` object in your Kubernetes cluster will provision a Konnect Gateway
Control Plane in your [Gateway Manager](/konnect/gateway-manager). The `KonnectGatewayControlPlane` CR
Creating the `KonnectGatewayControlPlane` object in your Kubernetes cluster will provision a {{site.konnect_short_name}} Gateway
control plane in your [Gateway Manager](/konnect/gateway-manager). The `KonnectGatewayControlPlane` CR
[API](/gateway-operator/{{ page.release }}/reference/custom-resources/#konnectgatewaycontrolplane) allows you to
explicitly set a type of the Gateway Control Plane, but if you don't specify it, the default type is
explicitly set a type of the Gateway control plane, but if you don't specify it, the default type is
a [Self-Managed Hybrid
Gateway Control Plane](/konnect/gateway-manager/#kong-gateway-control-planes).

Expand All @@ -34,13 +34,13 @@ spec:
' | kubectl apply -f -
```
You can see the status of the Gateway Control Plane by running:
You can see the status of the Gateway control plane by running:
```shell
kubectl get konnectgatewaycontrolplanes.konnect.konghq.com gateway-control-plane
```
If the Gateway Control Plane is successfully created, you should see the following output:
If the Gateway control plane is successfully created, you should see the following output:
```shell
NAME PROGRAMMED ID ORGID
Expand All @@ -49,7 +49,7 @@ gateway-control-plane True <konnect-control-plane-id> <you
## Creating a Control Plane Group
Gateway Manager allows you to group multiple Gateway Control Planes. You can create
Gateway Manager allows you to group multiple Gateway control planes. You can create
a [Control Plane Group](/konnect/gateway-manager/#control-plane-groups) by setting the `cluster_type`
field in the `spec` section of the `KonnectGatewayControlPlane` object to `CLUSTER_TYPE_CONTROL_PLANE_GROUP`.
Expand Down Expand Up @@ -82,9 +82,9 @@ NAME PROGRAMMED ID ORGI
control-plane-group True <konnect-control-plane-id> <your-konnect-ord-id>
```
### Adding a Gateway Control Plane to a Control Plane Group
### Add a Gateway Control Plane to a Control Plane Group
To assign Gateway Control Planes to a Control Plane Group, you need to specify the `members` field in the `spec` section of the `KonnectGatewayControlPlane` object.
To assign Gateway control planes to a control plane group, you need to specify the `members` field in the `spec` section of the `KonnectGatewayControlPlane` object.
```yaml
echo '
Expand All @@ -104,7 +104,7 @@ spec:
' | kubectl apply -f -
```
You can check in your Gateway Manager to see if the Gateway Control Plane was successfully added to the Control Plane Group.
You can check in your Gateway Manager to see if the Gateway control plane was successfully added to the control plane group.
## Creating a Kubernetes Ingress Controller Control Plane
Expand All @@ -128,13 +128,13 @@ spec:
' | kubectl apply -f -
```
You can see the status of the Gateway Control Plane by running:
You can see the status of the Gateway control plane by running:
```shell
kubectl get konnectgatewaycontrolplane kic-control-plane
```
If the Control Plane is successfully created, you should see the following output:
If the control plane is successfully created, you should see the following output:
```shell
NAME PROGRAMMED ID ORGID
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ title: Key and Key Set
---

In this guide you'll learn how to use the `KongKey` and `KongKeySet` custom resources to
manage Konnect [Keys](/konnect/gateway-manager/configuration/#keys)
and Key Sets natively from your Kubernetes cluster.
manage {{site.konnect_product_name}} [keys](/konnect/gateway-manager/configuration/#keys)
and key sets natively from your Kubernetes cluster.

{% include md/kgo/konnect-entities-prerequisites.md disable_accordian=false version=page.version release=page.release
with-control-plane=true %}

## Create a Key

Creating the `KongKey` object in your Kubernetes cluster will provision a Konnect Key in
Creating the `KongKey` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} key in
your [Gateway Manager](/konnect/gateway-manager).
You can refer to the CR [API](/gateway-operator/{{ page.release }}/reference/custom-resources/#kongkey)
to see all the available fields.

Your `KongKey` must be associated with a `KonnectGatewayControlPlane` object that you've created in your cluster.
It will make it part of the Gateway Control Plane's configuration.
It will make it part of the Gateway control plane's configuration.

`KongKey` supports two types of keys: JWK and PEM. You can create a PEM `KongKey` by providing `spec.pem.private_key`
and `spec.pem.public_key` fields. For JWK keys, you should provide `spec.jwk` field with the JWK key string
Expand Down Expand Up @@ -61,11 +61,11 @@ spec:
{% include md/kgo/check-condition.md name='key' kind='KongKey' %}

At this point, you should see the Key in the Gateway Manager UI.
At this point, you should see the key in the Gateway Manager UI.

## Create a Key Set

Creating the `KongKeySet` object in your Kubernetes cluster will provision a Konnect Key Set in
Creating the `KongKeySet` object in your Kubernetes cluster will provision a {{site.konnect_product_name}} key set in
your [Gateway Manager](/konnect/gateway-manager). You can refer to the CR [API](/gateway-operator/{{ page.release
}}/reference/custom-resources/#kongkeyset)
to see all the available fields.
Expand All @@ -92,7 +92,7 @@ spec:

{% include md/kgo/check-condition.md name='key-set' kind='KongKeySet' %}

At this point, you should see the Key Set in the Gateway Manager UI.
At this point, you should see the key set in the Gateway Manager UI.

### Associate the Key with the Key Set

Expand Down Expand Up @@ -155,4 +155,4 @@ The output should look similar to this:
}
```

At this point, you should see the Key associated with the Key Set in the Gateway Manager UI.
At this point, you should see the key associated with the key set in the Gateway Manager UI.
Loading

0 comments on commit 3f077c5

Please sign in to comment.