Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
    • Overview of Konnect
    • Architecture
    • Network Resiliency and Availability
    • Port and Network Requirements
    • Compatibility
    • Stages of Software Availability
    • Release Notes
      • Control Plane Upgrades FAQ
      • Supported Installation Options
    • Overview
    • Access a Konnect Account
    • Set up a Runtime
    • Configure a Service
    • Implement and Test the Service
      • Publish and Consume Services
      • Register Applications
    • Import Kong Gateway Entities into Konnect
    • Overview
      • Overview
      • Upgrade a Runtime Instance
      • Verify a Runtime Instance
      • Renew Data Plane Certificates
      • Runtime Parameter Reference
      • Overview
      • Create Consumer Groups
        • Overview
        • Set Up and Use a Vault in Konnect
      • Manage Runtime Configuration using decK
    • Backup and Restore
    • Version Compatibility
    • Troubleshooting
    • Overview
    • Manage Service Documentation
      • Overview
      • Configure a Plugin on a Service
      • Configure a Plugin on a Route
    • Overview
    • Access the Dev Portal
    • Sign Up for a Dev Portal Account
      • Manage Developer Access
      • Manage Application Registration Requests
      • Manage Application Connections
      • Auto Approve Dev and App Registrations
      • Azure OIDC
      • Application Overview
      • Enable and Disable App Registration
        • Overview
        • Okta
        • Curity
        • Auth0
      • Create, Edit, and Delete an Application
      • Register an Application with a Service
      • Generate Credentials for an Application
    • Customize Dev Portal
    • Troubleshoot
    • Introduction to Analytics
    • Analyze Services and Routes
    • Reports Use Cases
    • Reports Reference
    • Troubleshoot
      • Manage a Konnect Account or Plan
      • Change to a Different Plan
      • Manage Payment Methods and Invoices
      • Overview
        • Overview
        • Manage Teams
        • Teams Reference
        • Roles Reference
      • Manage Users
      • Manage System Accounts
      • Set up SSO with OIDC
      • Set up SSO with Okta
      • Login Sessions Reference
    • Account and Org Deactivation
    • Troubleshoot
    • Overview
      • API Documentation
      • Identity Integration Guide
      • API Documentation
      • API Documentation
      • Portal RBAC Guide
      • Overview
      • Nodes
      • Data Plane Certificiates
        • Services
        • Routes
        • Consumers
        • Plugins
        • Upstreams
        • Certificates
        • CA Certificates
        • SNIs
        • Targets
        • Vaults
      • API Spec
      • Filtering
    • Labels
    • Plugin Ordering Reference

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Implement a service version (Kong Gateway)
  • Add a route to a version
  • Verify an implementation
Kong Konnect
  • Home
  • Kong Konnect
  • Service Hub
  • Manage Services through Service Hub

Manage Services through Service Hub

An implementation is a Gateway service. By implementing a Konnect service version, you create a Gateway service in the version’s runtime group.

Implement a service version (Kong Gateway)

Expose the service version by pointing it to an upstream service and creating a route for the proxy. Traffic traveling through this proxy route can use any runtime instance in the runtime group that the service version belongs to.

Note: Currently, the only supported implementation type is a Kong Gateway runtime.

From the servicehub icon Service Hub, select a service version. Add an implementation from this page:

  1. Click New Implementation.

  2. In the Create Implementation dialog, in step 1, enter the connection details for the upstream service.

    1. Enter a name for the Gateway service.

      The name can be any string containing letters, numbers, or the following characters: ., -, _, ~, :. Do not use spaces.

      For example, you can use example_service, ExampleService, Example-Service. However, Example Service is invalid.

    2. Enter a URL in the default Add using URL field, or switch to Add using Protocol, Host and Path and enter each piece separately.

    3. Optional: Expand to View 6 Advanced Fields and further customize your implementation.

      See the Service Object documentation for parameter descriptions.

    4. Click Next.

  3. In step 2, Add a Route to your service implementation.

    1. Enter any name.

      This route name must be unique in the account. Variations on capitalization are considered unique, for example, foo and Foo.

    2. For Method, enter an HTTP method or a comma-separated list of methods that match this route.

      For example, GET or GET, POST.

    3. For Path(s), click Add Path and enter a path in the format /<path>.

    4. Optional: Click View 4 Advanced Fields to see all options. You can accept the defaults, or further customize your route.

      See the Route Object documentation for parameter descriptions.

    5. Click Create.

    If you want to view the configuration, edit or delete the implementation, or delete the version, click the Version actions drop-down menu from the version overview.

    You can find the linked Gateway service in the Runtime Manager.

Add a route to a version

When creating an implementation, you only create one route. If the service version needs more routes, you can add them to the version after creating the first one.

All routes are created in the same runtime group as their parent service version.

Important: Starting with Kong Gateway 3.0.0.0, the router supports logical expressions. Regex routes must begin with a ~ character. For example: ~/foo/bar/(?baz\w+). Learn more in the route configuration guide.

From the servicehub icon Service Hub, select a service version. Add a route from this page:

  1. In the Routes section, click Add route.

  2. Fill in the fields as described in Implement a Service Version, then click Create.

Verify an implementation

For any runtime instance created with the provided Docker script (see Setting up a Kong Gateway Runtime), the default proxy URL is localhost:8000.

Enter the proxy URL into your browser’s address bar and append any route path. The final URL should look something like this:

http://localhost:8000/foo

If successful, you’ll be able to access your upstream service. The service version’s overview page will also update with a new record for status code 200. This might take a few moments.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023