Create a Service and Route

Uses: Kong Operator

Incompatible with

on-prem

Prerequisites

Series Prerequisites

This page is part of the Get Started with the Kong Gateway Operator series.

Complete the previous page, Deploy a data plane before completing this page.

A Kubernetes Service represents an application running on a group of Pods. In Kong Gateway, this maps to a Service and Upstream.

The KongService defines protocol-specific information and connection settings to reach the upstream application.
The Upstream defines load balancing and health checking behavior across backend targets.

 
flowchart LR
    H(Request traffic)
    subgraph Pods
        direction LR
        E(Target)
        F(Target)
        G(Target)
    end

    subgraph Kubernetes Service
        direction TB
        C(Service)
        D(Upstream)
    end
    
    subgraph Ingress / HTTPRoute
        direction LR
        A(Route)
        B(Route)
    end

    A --> C
    B --> C
    C --> D
    D --> E
    D --> F
    D --> G
    H --> A

    linkStyle 6 stroke:#b6d7a8

Create a `KongService`

The KongService resource is used to define an upstream service that Konnect will route traffic to. This must include a reference to a KonnectGatewayControlPlane to associate the service with your Konnect environment.

echo '
kind: KongService
apiVersion: configuration.konghq.com/v1alpha1
metadata:
  name: service
  namespace: kong
spec:
  name: service
  host: httpbin.konghq.com
  controlPlaneRef:
    type: konnectNamespacedRef
    konnectNamespacedRef:
      name: gateway-control-plane
' | kubectl apply -f -

Copied!

Create a `KongRoute`

Define a KongRoute to expose the Service you created. The Route determines how requests are matched and routed to the associated Service.

echo '
kind: KongRoute
apiVersion: configuration.konghq.com/v1alpha1
metadata:
  name: route
  namespace: kong
spec:
  name: route
  protocols:
  - http
  paths:
  - "/"
  serviceRef:
    type: namespacedRef
    namespacedRef:
      name: service
' | kubectl apply -f -

Copied!

Validation

You can validate from the command line or Konnect UI to confirm that both the KongService and KongRoute have been provisioned and are in a valid state:

You can verify the KongService was reconciled successfully by checking its Programmed condition.

kubectl get -n kong kongservice service \
  -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq

Copied!

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}

Copied!

You can verify the KongRoute was reconciled successfully by checking its Programmed condition.

kubectl get -n kong kongroute route \
  -o=jsonpath='{.status.conditions[?(@.type=="Programmed")]}' | jq

Copied!

The output should look similar to this:

{
  "observedGeneration": 1,
  "reason": "Programmed",
  "status": "True",
  "type": "Programmed"
}

Copied!

← Previous 4. Deploy a data plane Next → 6. Apply Rate Limiting

Create a Service and Route

Prerequisites

Series Prerequisites

Create a `KongService`

Create a `KongRoute`

Validation

Help us make these docs great!

Still need help

Create a Service and Route

Prerequisites

Series Prerequisites

Create a KongService

Create a KongRoute

Validation

Help us make these docs great!

Still need help

Create a `KongService`

Create a `KongRoute`