Skip to main content

Quickstart

This guide will help you create and deploy your first route.

1

Create a Project

  1. Navigate to Projects in the sidebar
  2. Click Create Project
  3. Enter a project name (e.g., my-first-project)
  4. Add a description (optional)
  5. Click Create
Create a project
2

Create a Domain Template

  1. Navigate to Domain Templates in the sidebar
  2. Click Create Template
  3. Enter a template name (e.g., default-template)
  4. Configure the template settings:
    • Select service type (LoadBalancer or ClusterIP)
    • Configure TLS settings if needed
    • Configure HPA scaling and compute requests limits
  5. Click Create
Create a domain template
3

Create a Domain

  1. Navigate to your project
  2. Go to the Domains tab
  3. Click Create Domain
  4. Enter the domain hostname (e.g., api.example.com)
  5. Select the domain template you created
  6. Click Create
Create a domain
4

Create a Route

  1. Within your domain, click Create Route
  2. Configure the route:
    • Name: my-first-route
    • Path: /api/v1
    • Match Type: PathPrefix
  3. Add a backend:
    • Service Name: Your backend service name
    • Service Port: The port your service listens on
  4. Click Create
Create a route
5

Approve and Deploy

  1. Navigate to Approvals in the sidebar
  2. Find your pending route
  3. Review the configuration
  4. Click Approve to approve the change
  5. Once approved, the route will be deployed to your cluster

Verify the Deployment

Check that the HTTPRoute was created:

kubectl get httproute -n your-namespace

Test your route:

curl -H "Host: api.example.com" http://your-gateway-ip/api/v1