Feat(Platform): Replace httproute include with httproute block (#3721)

mheap · Guaris · web-flow · commit 6920a51edc95 · 2025-12-23T12:55:25.000-05:00
* Replace httproute include with httproute block

* vale

* vale

---------

Co-authored-by: Angel &lt;angel.guarisma@konghq.com&gt;
diff --git a/app/_how-tos/kic-external-service.md b/app/_how-tos/kic-external-service.md
@@ -58,16 +58,23 @@ spec:
 ## Create an HTTPRoute
 
 To route HTTP traffic, you need to create an `HTTPRoute` or an `Ingress` resource pointing at your Kubernetes `Service`.
-
-{% include_cached /k8s/httproute.md path='/httpbin' name='proxy-from-k8s-to-httpbin' service='proxy-to-httpbin' port='80' skip_host=true %}
-
+<!--vale off-->
+{% httproute %}
+name: proxy-from-k8s-to-httpbin
+matches:
+  - path: /httpbin
+    service: proxy-to-httpbin
+    port: 80
+{% endhttproute %}
+<!--vale on-->
 ## Validate your configuration
 
 Once the resource has been reconciled, you'll be able to call the `/httpbin` endpoint and {{ site.base_gateway }} will route the request to the external `httpbin` service.
-
+<!--vale off-->
 {% validation request-check %}
 url: /httpbin/anything
 status_code: 200
 on_prem_url: $PROXY_IP
 konnect_url: $PROXY_IP
 {% endvalidation %}
+<!--vale on-->
diff --git a/app/_how-tos/kic-get-started-services-routes.md b/app/_how-tos/kic-get-started-services-routes.md
@@ -85,7 +85,16 @@ kubectl apply -f {{ site.links.web }}/manifests/kic/echo-service.yaml -n kong
 
 To route traffic to the `echo` service, create an `HTTPRoute` or `Ingress` resource:
 
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' skip_host=true %}
+
+<!--vale off-->
+{% httproute %}
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 
 ## Validate your configuration
 
diff --git a/app/_how-tos/kic-observability-prometheus-grafana.md b/app/_how-tos/kic-observability-prometheus-grafana.md
@@ -95,8 +95,22 @@ Deploy the Services and create routing resources:
 ```bash
 kubectl apply -f {{ site.links.web }}/manifests/kic/multiple-services.yaml -n kong
 ```
-
-{% include_cached /k8s/httproute.md name='sample-routes' path='/billing,/comments,/invoice' service='billing,comments,invoice' port='80,80,80' skip_host=true %}
+<!--vale off-->
+{% httproute %}
+name: sample-routes
+matches:
+  - path: /billing
+    service: billing
+    port: 80
+  - path: /comments
+    service: comments
+    port: 80
+  - path: /invoice
+    service: invoice
+    port: 80
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 
 ## Generate traffic
 
diff --git a/app/_how-tos/kic-plugin-authentication.md b/app/_how-tos/kic-plugin-authentication.md
@@ -173,7 +173,16 @@ data:
 
 To route HTTP traffic, you need to create an `HTTPRoute` or an `Ingress` resource pointing at your Kubernetes `Service`.
 
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' skip_host=true %}
+<!--vale off-->
+{% httproute %}
+name: echo
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 
 ## Validate your configuration
 
diff --git a/app/_how-tos/kic-plugin-custom.md b/app/_how-tos/kic-plugin-custom.md
@@ -150,7 +150,17 @@ data:
 
 1. Create a Route to the `echo` service to test your custom plugin: 
 
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' skip_host=true indent=4 %}
+<!--vale off-->
+{% httproute %}
+name: echo
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+skip_host: true
+indent: 4
+{% endhttproute %}
+<!--vale on-->
 
 ## Validate your configuration
 
diff --git a/app/_how-tos/kic-plugin-degraphql.md b/app/_how-tos/kic-plugin-degraphql.md
@@ -142,8 +142,16 @@ curl -X POST -H "Content-Type:application/json" -H "X-Hasura-Role:admin" http://
 
 Our Hasura API will be exposed using the `/contacts` path. Create an `HTTPRoute` or `Ingress` resource pointing to the `hasura` Service that we can attach the `degraphql` plugin to:
 
-{% include_cached /k8s/httproute.md path='/contacts' name='demo-graphql' service='hasura' port='80' namespace='kong' skip_host=true %}
-
+<!--vale off-->
+{% httproute %}
+name: demo-graphql
+matches:
+  - path: /contacts
+    service: hasura
+    port: 80
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 ## Configure the DeGraphQL plugin
 
 The `degraphql` plugin accepts a single configuration option, `graphql_server_path`. Create a `KongPlugin` resource and attach it to the `demo-graphql` route that you just created:
diff --git a/app/_how-tos/kic-proxy-http.md b/app/_how-tos/kic-proxy-http.md
@@ -48,9 +48,16 @@ cleanup:
 ## Create an HTTPRoute
 
 To route HTTP traffic, you need to create an `HTTPRoute` or an `Ingress` resource pointing at your Kubernetes `Service`:
-
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' skip_host=true %}
-
+<!--vale off-->
+{% httproute %}
+name: echo
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 ## Validate your configuration
 
 Once the resource has been reconciled, you'll be able to call the `/echo` endpoint and {{ site.base_gateway }} will route the request to the `echo` service:
diff --git a/app/_how-tos/kic-proxy-https.md b/app/_how-tos/kic-proxy-https.md
@@ -76,8 +76,18 @@ kubectl patch -n kong --type=json gateway kong -p='[
 
 To route HTTP traffic, you need to create an `HTTPRoute` or an `Ingress` resource pointing at your Kubernetes `Service`.
 
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' hostname='demo.example.com' section_name='https' %}
 
+<!--vale off-->
+{% httproute %}
+name: echo
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+hostname: demo.example.com
+section_name: https
+{% endhttproute %}
+<!--vale on-->
 ## Validate your configuration
 
 Once the resource has been reconciled, you'll be able to call the `/echo` endpoint and {{ site.base_gateway }} will route the request to the `echo` service.
diff --git a/app/_how-tos/kic-proxy-rewriting-paths.md b/app/_how-tos/kic-proxy-rewriting-paths.md
@@ -61,7 +61,20 @@ The annotation can be used on `Ingress` and `HTTPRoute` resources, and configure
 
 The following definition creates a Route that matches the path `/external-path/(\w+)` and rewrites it to `/anything/$1` before sending the request upstream:
 
-{% include /k8s/httproute.md disable_gateway=true path='/external-path/(\w+)' name='httpbin' service='httpbin' port='80' skip_host=true route_type='RegularExpression' annotation_rewrite="/anything/$1" %}
+<!--vale off-->
+{% httproute %}
+name: httpbin
+matches:
+  - path: /external-path/(\w+)
+    service: httpbin
+    port: 80
+    route_type: RegularExpression
+annotation_rewrite: /anything/$1
+skip_host: true
+disable_gateway: true
+{% endhttproute %}
+<!--vale on-->
+
 
 Alternatively, you can define this in a plugin configuration:
 
diff --git a/app/_how-tos/kic-redirect-to-https.md b/app/_how-tos/kic-redirect-to-https.md
@@ -51,7 +51,15 @@ cleanup:
 
 To route HTTP traffic, you need to create an `HTTPRoute` or an `Ingress` resource pointing at your Kubernetes `Service`.
 
-{% include /k8s/httproute.md path='/echo' name='echo' service='echo' port='1027' skip_host=true %}
+<!--vale off-->
+{% httproute %}
+matches:
+  - path: /echo
+    service: echo
+    port: 1027
+skip_host: true
+{% endhttproute %}
+<!--vale on-->
 
 ## Add TLS configuration
 
diff --git a/app/_how-tos/kic-verify-upstream-tls.md b/app/_how-tos/kic-verify-upstream-tls.md
@@ -150,7 +150,16 @@ As part of the [prerequisites](#prerequisites), you deployed the `echo` Service
 
 Now that the `echo` Service is serving an HTTPS endpoint, we need to expose it:
 
-{% include_cached /k8s/httproute.md path='/echo' name='echo' service='echo' port='443' host='kong.example' %}
+<!--vale off-->
+{% httproute %}
+name: echo
+matches:
+  - path: /echo
+    service: echo
+    port: 443
+host: kong.example
+{% endhttproute %}
+<!--vale on-->
 
 Verify connectivity by making an HTTP request to proxy. The Service serves HTTPS but {{ site.base_gateway }} initiates the connection and proxies it as HTTP in this case, so the request should be made over HTTP. The `Host` header  has to match the hostname of the Service.
 
diff --git a/app/_includes/k8s/content/fallback-configuration/scenario-setup.md b/app/_includes/k8s/content/fallback-configuration/scenario-setup.md
@@ -52,10 +52,29 @@ Let's create two Routes for testing purposes:
 
 * `route-a` has no plugins attached
 * `route-b` has the three plugins created above attached
-
-{% include /k8s/httproute.md path='/route-a' name='route-a' service='echo' port='1027' skip_host=true %}
-{% include /k8s/httproute.md path='/route-b' name='route-b' service='echo' port='1027' skip_host=true annotation_plugins='key-auth,rate-limit-base,rate-limit-consumer'%}
-
+<!--vale off-->
+{% httproute %}
+name: route-a
+matches:
+  - path: /route-a
+    service: echo
+    port: 1027
+skip_host: true
+{% endhttproute %}
+
+{% httproute %}
+name: route-b
+matches:
+  - path: /route-b
+    service: echo
+    port: 1027
+skip_host: true
+annotation_plugins:
+  - key-auth
+  - rate-limit-base
+  - rate-limit-consumer
+{% endhttproute %}
+<!--vale on-->
 ## Create a Consumer
 
 Finally, let's create a `KongConsumer` with credentials and associate the `rate-limit-consumer` `KongPlugin`.
diff --git a/app/_includes/k8s/httproute.md b/app/_includes/k8s/httproute.md
diff --git a/app/_includes/prereqs/entities/kic.md b/app/_includes/prereqs/entities/kic.md
@@ -17,7 +17,11 @@ kubectl apply -f {{ site.links.web }}/manifests/kic/{{ service.name }}-service.y
 This how-to also requires {{ routeCount }} pre-configured route{% if routeCount > 1 %}s{% endif %}:
 
 {% for route in include.data.routes %}
-{% include /k8s/httproute.md path=route.path name=route.name service=route.service port=route.port skip_host=true %}
+{% httproute %}
+name: {{ route.name }}
+matches: [{{ route | json_prettify }}]
+skip_host: true
+{% endhttproute %}
 {% endfor %}
 
 {% endif %}
diff --git a/app/_includes/prereqs/kubernetes/keycloak.md b/app/_includes/prereqs/kubernetes/keycloak.md
@@ -13,9 +13,16 @@ kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-quickstarts
 ### Create a Route
 
 We'll use {{ site.base_gateway }} to expose Keycloak in our cluster on a custom domain:
-
-{% include_cached /k8s/httproute.md path='/' name='keycloak' service='keycloak' port='8080' hostname='keycloak.$PROXY_IP.nip.io' %}
-
+<!--vale off-->
+{% httproute %}
+name: keycloak
+matches:
+  - path: /
+    service: keycloak
+    port: 8080
+hostname: 'keycloak.$PROXY_IP.nip.io' 
+{% endhttproute %}
+<!--vale on-->
 ### Register a client and user
 
 Set two variables containing your client ID and secret:
diff --git a/app/_plugins/blocks/httproute.rb b/app/_plugins/blocks/httproute.rb
diff --git a/app/kubernetes-ingress-controller/split-traffic.md b/app/kubernetes-ingress-controller/split-traffic.md
