Configuring Custom Entities

Kong Ingress Controller provides an interface to configure Kong Gateway entities using CRDs.

Some Kong Gateway plugins define custom entities that require configuration. These entities can be configured using the KongCustomEntity resource.

The KongCustomEntity resource contains a type field which indicates the type of Kong entity to create, and a fields property which can contain any values that need to be set on an entity.

In the following example, a degraphql_routes entity is created with two properties, uri and query.

spec:
  type: degraphql_routes
  fields:
    uri: "/contacts"
    query: "query{ contacts { name } }"

This corresponds to the uri and query parameters documented in the DeGraphQL plugin documentation.

Each KongCustomEntity is validated against the schema from Kong. If the configuration is invalid, an Event with the reason set to KongConfigurationTranslationFailed will be emitted. The involvedObject of this Event will be set to the KongCustomEntity resource.

For more information on observability with events, see our events guide.