Kong Gateway Configuration in Konnect
You can manage any Kong Gateway services, routes, certificates, consumer-scoped configuration, and global configuration from within a runtime group.
A global object is a set of configurations that apply to, or can be used
by, all objects in a runtime group. For example, if you set up a Proxy Caching
plugin in the default runtime group and set it to Global
,
the plugin configuration will apply to all services in the group.
Consumers, SNIs, upstreams, and certificates are all global. Plugins can either be global or scoped.
Gateway services
The Gateway Service configuration page lists all Kong Gateway services in the runtime group. Service entities are abstractions of each of your own upstream services, such as a data transformation microservice, or a billing API.
Gateway services can be exposed in Service Hub, or managed though Runtime Manager only:
- When you create a Konnect service implementation through the Service Hub, it automatically creates a Gateway service.
- You can also create a Gateway service directly through Runtime Manager. This service won’t be connected to any Service Hub implementation by default, unless you add a tag to link it.
To see if a Gateway service is connected to the Service Hub, open its
detail page from Runtime Manager > Gateway Services. If it’s attached to an
implementation, you should see a tag in the following format:
_KonnectService:{SERVICE_NAME}
.
Learn more about services in Konnect or check out the service object API reference for all configuration options.
Routes
The Routes configuration page lists all routes in the runtime group, including routes created through the Service Hub. A route defines rules to match client requests, and is associated with a Gateway service. You can edit any routes in the runtime group from here.
See the route object API reference for all configuration options.
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.
Consumers
The Consumers configuration page lists all consumers in the runtime group. Consumer objects represent users of a service, and are most often used for authentication. They provide a way to divide access to your services, and make it easy to revoke that access without disturbing a service’s function.
See the consumer object API reference for all configuration options.
Plugins
The Plugins configuration page lists all plugins used by any entities in the runtime group. Plugins let you extend proxy functionality by adding rules, policies, transformations, and more on requests and responses.
Although you can see all plugins from this page, you can only edit global or consumer-scoped plugins through the Runtime Manager. Service and route plugins must be managed through the Service Hub.
Learn more about using plugins in Konnect, check out the plugin object API reference, or see all available plugins on the Plugin Hub for specific configuration options for each plugin.
Upstreams
The Upstream configuration page lists all upstreams for incoming requests, or from where the requests are being forwarded.
An upstream object represents a virtual hostname referring to your own service/API. Upstreams can be used to health check, circuit break, and load balance incoming requests over multiple services (targets).
See the upstream object API reference for all configuration options.
Certificates
The Certificates configuration page lists public certificates that enable encrypted requests and peer certification validation. A certificate object represents a public certificate and can be paired with a corresponding private key. Certificates handle SSL/TLS termination for encrypted requests, and can be used as a trusted CA store when validating the peer certificate of a client or service.
Data plane certificates can be managed from the Data plane certificates dashboard that is available as a Runtime group action. Here you can manage data plane certificates, including the creation, renewal, and removal of certificates, as well as uploading up to 16 certificates per runtime group.
See the certificate object API reference for all configuration options.
SNIs
The SNIs configuration page lists all SNIs configured in the runtime group.
An SNI object represents a many-to-one mapping of hostnames to a certificate. A certificate object can have many hostnames associated with it, so when a runtime instance receives an SSL request, it uses the SNI field in the ClientHello to look up the associated certificate object.
See the SNI object API reference for all configuration options.
Vaults
You can use vaults to add authentication to a service or route with an access token and secret token. Credential tokens are stored securely using Vaults. Credential life-cyles can be managed through Konnect.
Keys
With Keys, you can centrally store and easily access key sets and keys in Konnect. A key set object holds a collection of asymmetrical key objects. You can group keys objects by purpose. A key object holds asymmetric keys in various formats. Key objects can be used when Konnect or a Konnect plugin requires a specific public or private key to perform an operation. You can create and manage key sets and key objects in Konnect, from the Runtime Manager > Keys dashboard. Currently two key formats are supported:
- JWK
- PEM
To learn more about the details of this feature, reference the Kong Gateway key reference documentation. The Konnect keys feature is built using Kong Gateway ability to manage keys, the documentation available can serve as a reference for both Kong Gateway and Konnect.