Skip to content

Commit e48d082

Browse files
mlavaccamlavacca
committed
feat: rework operator landing page
Signed-off-by: Mattia Lavacca <lavacca.mattia@gmail.com>
1 parent aab68b5 commit e48d082

22 files changed

+317
-541
lines changed

‎app/_data/series.yml‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,16 @@ kic-get-started:
44
plugin-dev-get-started:
55
title: Get started with custom plugin development
66
url: /custom-plugins/get-started/set-up-plugin-project/
7-
operator-konnectcrds-get-started:
8-
title: Get Started with the Kong Gateway Operator
9-
url: /index/operator/#get-started
10-
operator-get-started-hybrid:
11-
title: Deploy Hybrid DataPlanes with {{ site.operator_product_name }}
12-
url: /operator/dataplanes/get-started/hybrid/install/
13-
operator-get-started-kic:
14-
title: Deploy self-managed Control Plane with {{ site.operator_product_name }}
15-
url: /operator/dataplanes/get-started/kic/install/
167
gateway-k8s-on-prem-install:
178
title: Install {{ site.base_gateway }} on-prem on Kubernetes
189
breadcrumb_title: On-Prem Kubernetes
1910
url: /gateway/install/kubernetes/on-prem/
11+
operator-get-started-gateway-api:
12+
title: Get started with {{ site.operator_product_name }} and Gateway API
13+
url: /operator/get-started/gateway-api/install/
14+
operator-get-started-konnect-crds:
15+
title: Get started with {{ site.operator_product_name }} and Konnect CRDs
16+
url: /operator/get-started/konnect-crds/install/
2017
mcp-traffic:
2118
title: Secure, govern and observe MCP traffic with Kong AI Gateway
2219
url: /mcp/secure-mcp-traffic/

‎app/_how-tos/operator-get-started-gateway-api-create-route.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Configure route and service
3+
description: "Configure a {{ site.base_gateway }} Service and Route using {{ site.operator_product_name }}."
4+
content_type: how_to
5+
6+
permalink: /operator/get-started/gateway-api/create-route/
7+
8+
series:
9+
id: operator-get-started-gateway-api
10+
position: 3
11+
12+
breadcrumbs:
13+
- /operator/
14+
- index: operator
15+
group: Gateway Deployment
16+
- index: operator
17+
group: Gateway Deployment
18+
section: "Get Started"
19+
20+
products:
21+
- operator
22+
23+
works_on:
24+
- konnect
25+
- on-prem
26+
27+
prereqs:
28+
skip_product: true
29+
30+
tldr:
31+
q: How can I create a Route with {{ site.operator_product_name }}?
32+
a: Create a Gateway API `HTTPRoute` object.
33+
next_steps:
34+
- text: Learn about Custom resource definitions (CRDs)
35+
url: /operator/reference/custom-resources/
36+
---
37+
38+
## Create an HTTPRoute
39+
40+
TODO
41+
42+
## Send test traffic
43+
44+
After the Service and Route are created, send traffic to the proxy. {{site.base_gateway}} will forward the request to `httpbin.konghq.com`. You can use the `/anything` endpoint to echo the request made in the response.
45+
46+
To make a request to the proxy, fetch the LoadBalancer IP address using `kubectl get services`:
47+
48+
```bash
49+
NAME=$(kubectl get -o yaml -n kong service | yq '.items[].metadata.name | select(contains("dataplane-ingress"))')
50+
export PROXY_IP=$(kubectl get svc -n kong $NAME -o jsonpath='{range .status.loadBalancer.ingress[0]}{@.ip}{@.hostname}{end}')
51+
echo "Proxy IP: $PROXY_IP"
52+
```
53+
54+
{:.info}
55+
> Note: If your cluster can't provision LoadBalancer type Services, then you might not receive an IP address.
56+
57+
Test the routing rules by sending a request to the proxy IP address:
58+
59+
{% validation request-check %}
60+
url: /anything/hello
61+
status_code: 200
62+
on_prem_url: $PROXY_IP
63+
konnect_url: $PROXY_IP
64+
{% endvalidation %}

‎app/_how-tos/operator-get-started-gateway-api-install.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Install {{ site.operator_product_name }}
3+
description: "Deploy the {{ site.operator_product_name }}"
4+
content_type: how_to
5+
6+
permalink: /operator/get-started/gateway-api/install/
7+
series:
8+
id: operator-get-started-gateway-api
9+
position: 1
10+
11+
breadcrumbs:
12+
- /operator/
13+
- index: operator
14+
group: Gateway Deployment
15+
- index: operator
16+
group: Gateway Deployment
17+
section: "Get Started"
18+
19+
products:
20+
- operator
21+
22+
works_on:
23+
- konnect
24+
- on-prem
25+
26+
min_version:
27+
ko: '2.1'
28+
29+
entities: []
30+
31+
tldr:
32+
q: How do I manage a {{ site.base_gateway }} through the {{ site.operator_product_name }}?
33+
a: Update the Helm repository and use Helm to install {{ site.operator_product_name }}.
34+
35+
prereqs:
36+
skip_product: true
37+
38+
tags:
39+
- install
40+
- helm
41+
---
42+
43+
{% assign gwapi_version = "1.3.0" %}
44+
45+
## Install CRDs
46+
47+
```shell
48+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v{{ gwapi_version }}/standard-install.yaml
49+
```
50+
51+
## Cert-Manager integration
52+
53+
{% include k8s/cert-manager.md raw=true %}
54+
55+
## Install {{ site.operator_product_name }}
56+
57+
{: data-deployment-topology="konnect" }
58+
{% include prereqs/products/operator.md raw=true v_maj=2 platform="konnect" %}
59+
60+
{: data-deployment-topology="on-prem" }
61+
{% include prereqs/products/operator.md raw=true v_maj=2 platform="on-prem" %}
62+
63+
## Validate
64+
65+
Wait for {{ site.operator_product_name }} to be ready
66+
67+
{% include prereqs/products/operator-validate-deployment.md %}
68+
69+
Once the `kong-operator-kong-operator-controller-manager` deployment is ready, you can deploy a `Gateway` and a `GatewayClass` that references the `GatewayConfiguration` holding the {{ site.konnect_short_name }} parameters.

app/_how-tos/operator-konnect-hybrid-gw.md renamed to app/_how-tos/operator-get-started-gateway-api-provision-gateway.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
---
2-
title: Provision a Hybrid Gateway
3-
description: "Provision a Hybrid Gateway in {{site.konnect_short_name}} using the Gateway API CRDs."
2+
title: Provision a Gateway
3+
description: "Provision a Hybrid Gateway in {{site.konnect_short_name}} using the Gateway API."
44
content_type: how_to
5-
permalink: /operator/konnect/crd/gateway/hybrid
5+
6+
permalink: /operator/get-started/gateway-api/deploy-gateway/
7+
series:
8+
id: operator-get-started-gateway-api
9+
position: 2
10+
611
breadcrumbs:
712
- /operator/
813
- index: operator
@@ -11,12 +16,12 @@ breadcrumbs:
1116
group: Konnect
1217
section: "Konnect CRDs: Hybrid Gateway"
1318

14-
1519
products:
1620
- operator
1721

1822
works_on:
1923
- konnect
24+
- on-prem
2025

2126
entities: []
2227
search_aliases:
@@ -29,6 +34,7 @@ tldr:
2934
a: Fill Konnect related fields in `GatewayConfiguration` for `GatewayClass` that will be used for Hybrid Gateways.
3035

3136
prereqs:
37+
skip_product: true
3238
operator:
3339
konnect:
3440
auth: true

‎app/_how-tos/operator-get-started-hybrid-create-route.md‎

Lines changed: 0 additions & 117 deletions
This file was deleted.

‎app/_how-tos/operator-get-started-hybrid-install.md‎

Lines changed: 0 additions & 69 deletions
This file was deleted.

0 commit comments

Comments
 (0)