diff --git a/app/_includes/md/custom-plugin.md b/app/_includes/md/custom-plugin.md index 820e1dd6023..6a600b090c7 100644 --- a/app/_includes/md/custom-plugin.md +++ b/app/_includes/md/custom-plugin.md @@ -1,7 +1,7 @@ ## Create a custom plugin -1. Create a directory with test plugin code. +1. Create a directory with plugin code. {:.note} > If you already have a real plugin, you can skip this step. diff --git a/app/_src/gateway-operator/guides/plugin-distribution.md b/app/_src/gateway-operator/guides/plugin-distribution.md index 0b816f86063..a930cfbfa23 100644 --- a/app/_src/gateway-operator/guides/plugin-distribution.md +++ b/app/_src/gateway-operator/guides/plugin-distribution.md @@ -4,278 +4,281 @@ title: Kong custom plugin distribution with KongPluginInstallation -{{ site.kgo_product_name }} can install Kong custom plugins packaged as container images. This guide shows how to install and use a custom plugin in {{site.base_gateway}} instances managed by the {{ site.kgo_product_name }}. +{{ site.kgo_product_name }} can install Kong custom plugins packaged as container images. This guide shows how to package, install and use a custom plugin in {{site.base_gateway}} instances managed by the {{ site.kgo_product_name }}. {% include md/kgo/prerequisites.md version=page.version release=page.release kongplugininstallation=true %} {% include md/custom-plugin.md %} -2. Build container image with the plugin code. - - It is expected to have plugin related files in the root of the image. Thus for aforementioned plugin, the Dockerfile would look like this: - - ```bash - echo 'FROM scratch - - COPY myheader / - ' > Dockerfile - ``` - - where `myheader` is a directory that contains `handler.lua` and `schema.lua`. - - Build the image: - - ```bash - docker build -t myheader:1.0.0 . - ``` - - next push it to a registry that is available to the Kubernetes cluster where {{ site.kgo_product_name }} is running. - - ```bash - docker tag myheader:1.0.0 /myheader:1.0.0 - docker push /myheader:1.0.0 - ``` - - The plugin from the example above is available in public Docker Hub as `kong/plugin-example:1.0.0`. You can use it too to follow this guide. - -3. Install the plugin using the `KongPluginInstallation` resource. It makes it available to be referenced by `Gateway` resources. - - ```yaml - echo ' - kind: KongPluginInstallation - apiVersion: gateway-operator.konghq.com/v1alpha1 - metadata: - name: custom-plugin-myheader - spec: - image: kong/plugin-example:1.0.0 - ' | kubectl apply -f - - ``` - - Verify that the plugin is fetched and available by examining the status of the `KongPluginInstallation` resource: - - ```bash - kubectl get kongplugininstallations.gateway-operator.konghq.com -o jsonpath-as-json='{.items[*].status}' - ``` - - The output should look like this: - - ```json - [ - { - "conditions": [ - { - "lastTransitionTime": "2024-10-09T19:39:39Z", - "message": "plugin successfully saved in cluster as ConfigMap", - "observedGeneration": 1, - "reason": "Ready", - "status": "True", - "type": "Accepted" - } - ], - "underlyingConfigMapName": "custom-plugin-myheader-hnzf9" - } - ] - ``` - - in case of problems respective `conditions` will provide more information. - - > `KonpluginInstalaltion` resource creates a ConfigMap with the plugin content. Some additional ConfigMaps are created - > when plugin is referenced by other resources. Lifecycle of all these ConfigMaps is managed automatically by the operator. - -4. Make plugin available in a `Gateway` resource by referencing it in the `spec.pluginsToInstall` field. - Plugins can be referenced cross-namespace without any additional configuration (for Secret used to authenticate - to container registry in case of cross-namespace `ReferenceGrant` in place is needed). - - ```yaml - echo ' - kind: GatewayConfiguration - apiVersion: gateway-operator.konghq.com/v1beta1 - metadata: - name: kong - namespace: default - spec: - dataPlaneOptions: - deployment: - replicas: 2 - podTemplateSpec: - spec: - containers: - - name: proxy - image: kong/kong-gateway:3.8 - readinessProbe: - initialDelaySeconds: 1 - periodSeconds: 1 - pluginsToInstall: - - name: custom-plugin-myheader - controlPlaneOptions: - deployment: - podTemplateSpec: - spec: - containers: - - name: controller - image: kong/kubernetes-ingress-controller:3.3.1 - readinessProbe: - initialDelaySeconds: 1 - periodSeconds: 1 - --- - apiVersion: gateway.networking.k8s.io/v1 - kind: GatewayClass - metadata: - name: kong - spec: - controllerName: konghq.com/gateway-operator - parametersRef: - group: gateway-operator.konghq.com - kind: GatewayConfiguration - name: kong - namespace: default - --- - apiVersion: gateway.networking.k8s.io/v1 - kind: Gateway - metadata: - name: kong - namespace: default - spec: - gatewayClassName: kong - listeners: - - name: http - protocol: HTTP - port: 80 - ' | kubectl apply -f - - ``` - -5. Deploy an example service and expose it by configuring`HTTPRoute` with custom plugin. - - Example service: - - ```yaml - echo ' - apiVersion: v1 - kind: Service - metadata: - name: echo - spec: - ports: - - protocol: TCP - name: http - port: 80 - targetPort: http - selector: - app: echo - --- - apiVersion: apps/v1 - kind: Deployment - metadata: - labels: - app: echo - name: echo - spec: - replicas: 1 - selector: - matchLabels: - app: echo - template: - metadata: - labels: - app: echo - spec: - containers: - - name: echo - image: registry.k8s.io/e2e-test-images/agnhost:2.40 - command: - - /agnhost - - netexec - - --http-port=8080 - ports: - - containerPort: 8080 - name: http - env: - - name: NODE_NAME - valueFrom: - fieldRef: - fieldPath: spec.nodeName - - name: POD_NAME - valueFrom: - fieldRef: - fieldPath: metadata.name - - name: NAMESPACE - valueFrom: - fieldRef: - fieldPath: metadata.namespace - - name: POD_IP - valueFrom: - fieldRef: - fieldPath: status.podIP - resources: - requests: - cpu: 10m - ' | kubectl apply -f - - ``` - - `HTTPRoute` with custom plugin, setting to a plugin are provided like for any other plugin with `KongPlugin` CRD where - field `plugin` is set to the name of the `KongPluginInstallation` resource. - - ```yaml - echo ' - apiVersion: configuration.konghq.com/v1 - kind: KongPlugin - metadata: - name: myheader - plugin: custom-plugin-myheader - config: - header_value: "my-first-plugin" - --- - apiVersion: gateway.networking.k8s.io/v1 - kind: HTTPRoute - metadata: - name: httproute-echo - namespace: default - annotations: - konghq.com/strip-path: "true" - konghq.com/plugins: myheader - spec: - parentRefs: - - name: kong - rules: - - matches: - - path: - type: PathPrefix - value: /echo - backendRefs: - - name: echo - kind: Service - port: 80 - ' | kubectl apply -f - - ``` - - The `HTTPRoute` above will route requests to the `echo` service and apply the plugin to respons. - - 6. Ensure that everything is up and running and make a request to the service: - - To call the API, fetch the PROXY_IP for the Gateway: - - ```bash - export PROXY_IP=$(kubectl get gateway kong -o jsonpath='{.status.addresses[0].value}') - ``` - - Finally, make a `curl` request to the service: - - ```bash - curl -I $PROXY_IP/echo - ``` - - The response should include the custom header set by the plugin: - - ```txt - HTTP/1.1 200 OK - Content-Type: text/plain; charset=utf-8 - Content-Length: 61 - Connection: keep-alive - Date: Wed, 09 Oct 2024 20:21:23 GMT - Server: kong/3.8.0.0-enterprise-edition - myheader: my-first-plugin - X-Kong-Upstream-Latency: 3 - X-Kong-Proxy-Latency: 0 - Via: 1.1 kong/3.8.0.0-enterprise-edition - X-Kong-Request-Id: 6eec26150170fe3547bc1a4a20e93d74 - ``` +2. Build a container image with the plugin code. + + It is expected to have plugin-related files at the root of the image. Thus for the aforementioned plugin, the Dockerfile would look like this: + + ```bash + echo 'FROM scratch + + COPY myheader / + ' > Dockerfile + ``` + + where `myheader` is a directory that contains `handler.lua` and `schema.lua`. + + Build the image: + + ```bash + docker build -t myheader:1.0.0 . + ``` + + next push it to a registry that is available to the Kubernetes cluster where {{ site.kgo_product_name }} is running. How to use a private registry is + described in the CRD reference documentation. + + ```bash + docker tag myheader:1.0.0 /myheader:1.0.0 + docker push /myheader:1.0.0 + ``` + + The plugin from the example above is available in the public registry (Docker Hub) as `kong/plugin-example:1.0.0`. It is used in the following steps. + +3. Install the plugin using the `KongPluginInstallation` resource. It makes it available for instances of {{site.base_gateway}} resources. + + ```yaml + echo ' + kind: KongPluginInstallation + apiVersion: gateway-operator.konghq.com/v1alpha1 + metadata: + name: custom-plugin-myheader + spec: + image: kong/plugin-example:1.0.0 + ' | kubectl apply -f - + ``` + + Learn more about the `KongPluginInstallation` resource in the CRD reference documentation. + + Verify that the plugin is fetched and available by examining the status of the `KongPluginInstallation` resource: + + ```bash + kubectl get kongplugininstallations.gateway-operator.konghq.com -o jsonpath-as-json='{.items[*].status}' + ``` + + The output should look like this: + + ```json + [ + { + "conditions": [ + { + "lastTransitionTime": "2024-10-09T19:39:39Z", + "message": "plugin successfully saved in cluster as ConfigMap", + "observedGeneration": 1, + "reason": "Ready", + "status": "True", + "type": "Accepted" + } + ], + "underlyingConfigMapName": "custom-plugin-myheader-hnzf9" + } + ] + ``` + + in case of problems respective `conditions` or respective resources will provide more information. + + {:.note} + > `KongPluginInstalaltion` resource creates a `ConfigMap` with the plugin content. More `ConfigMap`s are created when a plugin is referenced by other resources. The operator automatically manages the lifecycle of all these `ConfigMap`s. + +4. Make the plugin available in a `Gateway` resource by referencing it in the `spec.pluginsToInstall` field. + Plugins can be referenced cross-namespace without any additional configuration (for a `Secret` used to authenticate + to container registry in case of cross-namespace a `ReferenceGrant` is needed). + + ```yaml + echo ' + kind: GatewayConfiguration + apiVersion: gateway-operator.konghq.com/v1beta1 + metadata: + name: kong + namespace: default + spec: + dataPlaneOptions: + deployment: + replicas: 2 + podTemplateSpec: + spec: + containers: + - name: proxy + image: kong/kong-gateway:3.8 + readinessProbe: + initialDelaySeconds: 1 + periodSeconds: 1 + pluginsToInstall: + - name: custom-plugin-myheader + controlPlaneOptions: + deployment: + podTemplateSpec: + spec: + containers: + - name: controller + image: kong/kubernetes-ingress-controller:3.3.1 + readinessProbe: + initialDelaySeconds: 1 + periodSeconds: 1 + --- + apiVersion: gateway.networking.k8s.io/v1 + kind: GatewayClass + metadata: + name: kong + spec: + controllerName: konghq.com/gateway-operator + parametersRef: + group: gateway-operator.konghq.com + kind: GatewayConfiguration + name: kong + namespace: default + --- + apiVersion: gateway.networking.k8s.io/v1 + kind: Gateway + metadata: + name: kong + namespace: default + spec: + gatewayClassName: kong + listeners: + - name: http + protocol: HTTP + port: 80 + ' | kubectl apply -f - + ``` + +5. Deploy an example service and expose it by configuring `HTTPRoute` with the s custom plugin. + + Example service: + + ```yaml + echo ' + apiVersion: v1 + kind: Service + metadata: + name: echo + spec: + ports: + - protocol: TCP + name: http + port: 80 + targetPort: http + selector: + app: echo + --- + apiVersion: apps/v1 + kind: Deployment + metadata: + labels: + app: echo + name: echo + spec: + replicas: 1 + selector: + matchLabels: + app: echo + template: + metadata: + labels: + app: echo + spec: + containers: + - name: echo + image: registry.k8s.io/e2e-test-images/agnhost:2.40 + command: + - /agnhost + - netexec + - --http-port=8080 + ports: + - containerPort: 8080 + name: http + env: + - name: NODE_NAME + valueFrom: + fieldRef: + fieldPath: spec.nodeName + - name: POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + - name: POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + resources: + requests: + cpu: 10m + ' | kubectl apply -f - + ``` + + `HTTPRoute` with custom plugin, settings to a plugin are provided with `KongPlugin` CRD where + field `plugin` is set to the name of the `KongPluginInstallation` resource. + + ```yaml + echo ' + apiVersion: configuration.konghq.com/v1 + kind: KongPlugin + metadata: + name: myheader + plugin: custom-plugin-myheader + config: + header_value: "my-first-plugin" + --- + apiVersion: gateway.networking.k8s.io/v1 + kind: HTTPRoute + metadata: + name: httproute-echo + namespace: default + annotations: + konghq.com/strip-path: "true" + konghq.com/plugins: myheader + spec: + parentRefs: + - name: kong + rules: + - matches: + - path: + type: PathPrefix + value: /echo + backendRefs: + - name: echo + kind: Service + port: 80 + ' | kubectl apply -f - + ``` + + The `HTTPRoute` above routes requests to the `echo` service and applies the plugin to responses. + +6. Ensure that everything is up and running and make a request to the service: + + To call the API, fetch the PROXY_IP for the Gateway: + + ```bash + export PROXY_IP=$(kubectl get gateway kong -o jsonpath='{.status.addresses[0].value}') + ``` + + Finally, make a `curl` request to the service: + + ```bash + curl -I $PROXY_IP/echo + ``` + + The response should include the custom header set by the plugin: + + ```txt + HTTP/1.1 200 OK + Content-Type: text/plain; charset=utf-8 + Content-Length: 61 + Connection: keep-alive + Date: Wed, 09 Oct 2024 20:21:23 GMT + Server: kong/3.8.0.0-enterprise-edition + myheader: my-first-plugin + X-Kong-Upstream-Latency: 3 + X-Kong-Proxy-Latency: 0 + Via: 1.1 kong/3.8.0.0-enterprise-edition + X-Kong-Request-Id: 6eec26150170fe3547bc1a4a20e93d74 + ``` diff --git a/app/_src/gateway-operator/reference/custom-resources/1.4.x.md b/app/_src/gateway-operator/reference/custom-resources/1.4.x.md index 401aae0f835..9cd370c764d 100644 --- a/app/_src/gateway-operator/reference/custom-resources/1.4.x.md +++ b/app/_src/gateway-operator/reference/custom-resources/1.4.x.md @@ -6,16 +6,1754 @@ title: Custom Resource Definitions API Reference ## Packages +- [configuration.konghq.com/v1](#configurationkonghqcomv1) +- [configuration.konghq.com/v1alpha1](#configurationkonghqcomv1alpha1) +- [configuration.konghq.com/v1beta1](#configurationkonghqcomv1beta1) - [gateway-operator.konghq.com/v1alpha1](#gateway-operatorkonghqcomv1alpha1) - [gateway-operator.konghq.com/v1beta1](#gateway-operatorkonghqcomv1beta1) +- [konnect.konghq.com/v1alpha1](#konnectkonghqcomv1alpha1) +## configuration.konghq.com/v1 + +Package v1 contains API Schema definitions for the konghq.com v1 API group. + +- [KongConsumer](#kongconsumer) +- [KongPlugin](#kongplugin) + +### KongConsumer + + +KongConsumer is the Schema for the kongconsumers API. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1` +| `kind` _string_ | `KongConsumer` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `username` _string_ | Username is a Kong cluster-unique username of the consumer. | +| `custom_id` _string_ | CustomID is a Kong cluster-unique existing ID for the consumer - useful for mapping Kong with users in your existing database. | +| `credentials` _string array_ | Credentials are references to secrets containing a credential to be provisioned in Kong. | +| `consumerGroups` _string array_ | ConsumerGroups are references to consumer groups (that consumer wants to be part of) provisioned in Kong. | +| `spec` _[KongConsumerSpec](#kongconsumerspec)_ | | +| `status` _[KongConsumerStatus](#kongconsumerstatus)_ | Status represents the current status of the KongConsumer resource. | + + + + +### KongPlugin + + +KongPlugin is the Schema for the kongplugins API. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1` +| `kind` _string_ | `KongPlugin` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `consumerRef` _string_ | ConsumerRef is a reference to a particular consumer. | +| `disabled` _boolean_ | Disabled set if the plugin is disabled or not. | +| `config` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#json-v1-apiextensions-k8s-io)_ | Config contains the plugin configuration. It's a list of keys and values required to configure the plugin. Please read the documentation of the plugin being configured to set values in here. For any plugin in Kong, anything that goes in the `config` JSON key in the Admin API request, goes into this property. Only one of `config` or `configFrom` may be used in a KongPlugin, not both at once. | +| `plugin` _string_ | PluginName is the name of the plugin to which to apply the config. | +| `run_on` _string_ | RunOn configures the plugin to run on the first or the second or both nodes in case of a service mesh deployment. | +| `protocols` _[KongProtocol](#kongprotocol) array_ | Protocols configures plugin to run on requests received on specific protocols. | +| `ordering` _[PluginOrdering](#pluginordering)_ | Ordering overrides the normal plugin execution order. It's only available on Kong Enterprise. `` is a request processing phase (for example, `access` or `body_filter`) and `` is the name of the plugin that will run before or after the KongPlugin. For example, a KongPlugin with `plugin: rate-limiting` and `before.access: ["key-auth"]` will create a rate limiting plugin that limits requests _before_ they are authenticated. | +| `instance_name` _string_ | InstanceName is an optional custom name to identify an instance of the plugin. This is useful when running the same plugin in multiple contexts, for example, on multiple services. | +| `status` _[KongPluginStatus](#kongpluginstatus)_ | Status represents the current status of the KongPlugin resource. | + + + +### Types + +In this section you will find types that the CRDs rely on. + + + + +#### KongConsumerSpec + + +KongConsumerSpec defines the specification of the KongConsumer. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this Consumer is associated with. | + + +_Appears in:_ +- [KongConsumer](#kongconsumer) + +#### KongConsumerStatus + + +KongConsumerStatus represents the current status of the KongConsumer resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the KongConsumer.

Known condition types are:

* "Programmed" | + + +_Appears in:_ +- [KongConsumer](#kongconsumer) + +#### KongPluginStatus + + +KongPluginStatus represents the current status of the KongPlugin resource. + + + +| Field | Description | +| --- | --- | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the KongPluginStatus.

Known condition types are:

* "Programmed" | + + +_Appears in:_ +- [KongPlugin](#kongplugin) + +#### KongProtocol +_Underlying type:_ `string` + +KongProtocol is a valid Kong protocol. +This alias is necessary to deal with https://github.com/kubernetes-sigs/controller-tools/issues/342 + + + + + +_Appears in:_ +- [KongClusterPlugin](#kongclusterplugin) +- [KongIngressRoute](#kongingressroute) +- [KongPlugin](#kongplugin) + + +## configuration.konghq.com/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the configuration.konghq.com v1alpha1 API group. + +- [KongCACertificate](#kongcacertificate) +- [KongCertificate](#kongcertificate) +- [KongCredentialACL](#kongcredentialacl) +- [KongCredentialAPIKey](#kongcredentialapikey) +- [KongCredentialBasicAuth](#kongcredentialbasicauth) +- [KongCredentialHMAC](#kongcredentialhmac) +- [KongCredentialJWT](#kongcredentialjwt) +- [KongDataPlaneClientCertificate](#kongdataplaneclientcertificate) +- [KongKey](#kongkey) +- [KongKeySet](#kongkeyset) +- [KongLicense](#konglicense) +- [KongPluginBinding](#kongpluginbinding) +- [KongRoute](#kongroute) +- [KongSNI](#kongsni) +- [KongService](#kongservice) +- [KongTarget](#kongtarget) +- [KongUpstream](#kongupstream) +- [KongVault](#kongvault) + +### KongCACertificate + + +KongCACertificate is the schema for CACertificate API which defines a Kong CA Certificate. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCACertificate` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCACertificateSpec](#kongcacertificatespec)_ | | +| `status` _[KongCACertificateStatus](#kongcacertificatestatus)_ | | + + + +### KongCertificate + + +KongCertificate is the schema for Certificate API which defines a Kong Certificate. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCertificate` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCertificateSpec](#kongcertificatespec)_ | | +| `status` _[KongCertificateStatus](#kongcertificatestatus)_ | | + + + +### KongCredentialACL + + +KongCredentialACL is the schema for ACL credentials API which defines a ACL credential for consumers. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCredentialACL` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCredentialACLSpec](#kongcredentialaclspec)_ | Spec contains the ACL credential specification. | +| `status` _[KongCredentialACLStatus](#kongcredentialaclstatus)_ | Status contains the ACL credential status. | + + + +### KongCredentialAPIKey + + +KongCredentialAPIKey is the schema for API key credentials API which defines a API key credential for consumers. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCredentialAPIKey` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCredentialAPIKeySpec](#kongcredentialapikeyspec)_ | Spec contains the API Key credential specification. | +| `status` _[KongCredentialAPIKeyStatus](#kongcredentialapikeystatus)_ | Status contains the API Key credential status. | + + + +### KongCredentialBasicAuth + + +KongCredentialBasicAuth is the schema for BasicAuth credentials API which defines a BasicAuth credential for consumers. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCredentialBasicAuth` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCredentialBasicAuthSpec](#kongcredentialbasicauthspec)_ | Spec contains the BasicAuth credential specification. | +| `status` _[KongCredentialBasicAuthStatus](#kongcredentialbasicauthstatus)_ | Status contains the BasicAuth credential status. | + + + +### KongCredentialHMAC + + +KongCredentialHMAC is the schema for HMAC credentials API which defines a HMAC credential for consumers. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCredentialHMAC` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCredentialHMACSpec](#kongcredentialhmacspec)_ | Spec contains the HMAC credential specification. | +| `status` _[KongCredentialHMACStatus](#kongcredentialhmacstatus)_ | Status contains the HMAC credential status. | + + + +### KongCredentialJWT + + +KongCredentialJWT is the schema for JWT credentials API which defines a JWT credential for consumers. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongCredentialJWT` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongCredentialJWTSpec](#kongcredentialjwtspec)_ | Spec contains the JWT credential specification. | +| `status` _[KongCredentialJWTStatus](#kongcredentialjwtstatus)_ | Status contains the JWT credential status. | + + + + +### KongDataPlaneClientCertificate + + +KongDataPlaneClientCertificate is the schema for KongDataPlaneClientCertificate API which defines a KongDataPlaneClientCertificate entity. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongDataPlaneClientCertificate` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongDataPlaneClientCertificateSpec](#kongdataplaneclientcertificatespec)_ | | +| `status` _[KongDataPlaneClientCertificateStatus](#kongdataplaneclientcertificatestatus)_ | | + + + +### KongKey + + +KongKey is the schema for KongKey API which defines a KongKey entity. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongKey` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongKeySpec](#kongkeyspec)_ | | +| `status` _[KongKeyStatus](#kongkeystatus)_ | | + + + +### KongKeySet + + +KongKeySet is the schema for KongKeySet API which defines a KongKeySet entity. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongKeySet` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongKeySetSpec](#kongkeysetspec)_ | | +| `status` _[KongKeySetStatus](#kongkeysetstatus)_ | | + + + +### KongLicense + + +KongLicense stores a Kong enterprise license to apply to managed Kong gateway instances. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongLicense` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `rawLicenseString` _string_ | RawLicenseString is a string with the raw content of the license. | +| `enabled` _boolean_ | Enabled is set to true to let controllers (like KIC or KGO) to reconcile it. Default value is true to apply the license by default. | +| `status` _[KongLicenseStatus](#konglicensestatus)_ | Status is the status of the KongLicense being processed by controllers. | + + + +### KongPluginBinding + + +KongPluginBinding is the schema for Plugin Bindings API which defines a Kong Plugin Binding. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongPluginBinding` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongPluginBindingSpec](#kongpluginbindingspec)_ | | +| `status` _[KongPluginBindingStatus](#kongpluginbindingstatus)_ | | + + + +### KongRoute + + +KongRoute is the schema for Routes API which defines a Kong Route. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongRoute` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongRouteSpec](#kongroutespec)_ | | +| `status` _[KongRouteStatus](#kongroutestatus)_ | | + + + +### KongSNI + + +KongSNI is the schema for SNI API which defines a Kong SNI. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongSNI` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongSNISpec](#kongsnispec)_ | | +| `status` _[KongSNIStatus](#kongsnistatus)_ | | + + + +### KongService + + +KongService is the schema for Services API which defines a Kong Service. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongService` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongServiceSpec](#kongservicespec)_ | | +| `status` _[KongServiceStatus](#kongservicestatus)_ | | + + + +### KongTarget + + +KongTarget is the schema for Target API which defines a Kong Target attached to a Kong Upstream. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongTarget` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongTargetSpec](#kongtargetspec)_ | | +| `status` _[KongTargetStatus](#kongtargetstatus)_ | | + + + +### KongUpstream + + +KongUpstream is the schema for Upstream API which defines a Kong Upstream. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongUpstream` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongUpstreamSpec](#kongupstreamspec)_ | | +| `status` _[KongUpstreamStatus](#kongupstreamstatus)_ | | + + + +### KongVault + + +KongVault is the schema for kongvaults API which defines a custom Kong vault. +A Kong vault is a storage to store sensitive data, where the values can be referenced in configuration of plugins. +See: https://docs.konghq.com/gateway/latest/kong-enterprise/secrets-management/ + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1` +| `kind` _string_ | `KongVault` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongVaultSpec](#kongvaultspec)_ | | +| `status` _[KongVaultStatus](#kongvaultstatus)_ | | + + + +### Types + +In this section you will find types that the CRDs rely on. +#### ControlPlaneRef + + +ControlPlaneRef is the schema for the ControlPlaneRef type. +It is used to reference a Control Plane entity. + + + +| Field | Description | +| --- | --- | +| `type` _string_ | Type can be one of: - konnectID - konnectNamespacedRef | +| `konnectID` _string_ | KonnectID is the schema for the KonnectID type. This field is required when the Type is konnectID. | +| `konnectNamespacedRef` _[KonnectNamespacedRef](#konnectnamespacedref)_ | KonnectNamespacedRef is a reference to a Konnect Control Plane entity inside the cluster. It contains the name of the Konnect Control Plane. This field is required when the Type is konnectNamespacedRef. | + + +_Appears in:_ +- [KongCACertificateSpec](#kongcacertificatespec) +- [KongCertificateSpec](#kongcertificatespec) +- [KongDataPlaneClientCertificateSpec](#kongdataplaneclientcertificatespec) +- [KongKeySetSpec](#kongkeysetspec) +- [KongKeySpec](#kongkeyspec) +- [KongPluginBindingSpec](#kongpluginbindingspec) +- [KongRouteSpec](#kongroutespec) +- [KongServiceSpec](#kongservicespec) +- [KongUpstreamSpec](#kongupstreamspec) +- [KongVaultSpec](#kongvaultspec) + +#### ControllerReference + + +ControllerReference is a reference to a controller that reconciles the KongLicense. + + + +| Field | Description | +| --- | --- | +| `group` _[Group](#group)_ | Group is the group of referent. It should be empty if the referent is in "core" group (like pod). | +| `kind` _[Kind](#kind)_ | Kind is the kind of the referent. By default the nil kind means kind Pod. | +| `namespace` _[Namespace](#namespace)_ | Namespace is the namespace of the referent. It should be empty if the referent is cluster scoped. | +| `name` _[ObjectName](#objectname)_ | Name is the name of the referent. | + + +_Appears in:_ +- [KongLicenseControllerStatus](#konglicensecontrollerstatus) + +#### Group +_Underlying type:_ `string` + +Group refers to a Kubernetes Group. It must either be an empty string or a +RFC 1123 subdomain. + + + + + +_Appears in:_ +- [ControllerReference](#controllerreference) + +#### KeySetNamespacedRef + + +KeySetNamespacedRef is the schema for the KeySetNamespacedRef type. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the KeySet object. | + + +_Appears in:_ +- [KeySetRef](#keysetref) + +#### KeySetRef + + +KeySetRef is the schema for the KeySetRef type. +It is used to reference a KeySet entity. + + + +| Field | Description | +| --- | --- | +| `type` _[KeySetRefType](#keysetreftype)_ | Type defines type of the KeySet object reference. It can be one of: - konnectID - namespacedRef | +| `konnectID` _string_ | KonnectID is the schema for the KonnectID type. This field is required when the Type is konnectID. | +| `namespacedRef` _[KeySetNamespacedRef](#keysetnamespacedref)_ | NamespacedRef is a reference to a KeySet entity inside the cluster. This field is required when the Type is namespacedRef. | + + +_Appears in:_ +- [KongKeySpec](#kongkeyspec) + +#### KeySetRefType +_Underlying type:_ `string` + +KeySetRefType is the enum type for the KeySetRef. + + + + + +_Appears in:_ +- [KeySetRef](#keysetref) + +#### Kind +_Underlying type:_ `string` + +Kind refers to a Kubernetes kind. + + + + + +_Appears in:_ +- [ControllerReference](#controllerreference) + +#### KongCACertificateAPISpec + + +KongCACertificateAPISpec contains the API specification for the KongCACertificate. + + + +| Field | Description | +| --- | --- | +| `cert` _string_ | Cert is the PEM-encoded CA certificate. | +| `tags` _string array_ | Tags is an optional set of tags applied to the certificate. | + + +_Appears in:_ +- [KongCACertificateSpec](#kongcacertificatespec) + +#### KongCACertificateSpec + + +KongCACertificateSpec contains the specification for the KongCACertificate. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef references the Konnect Control Plane that this KongCACertificate should be created in. | +| `cert` _string_ | Cert is the PEM-encoded CA certificate. | +| `tags` _string array_ | Tags is an optional set of tags applied to the certificate. | + + +_Appears in:_ +- [KongCACertificate](#kongcacertificate) + +#### KongCACertificateStatus + + +KongCACertificateStatus defines the observed state of KongCACertificate. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCACertificate](#kongcacertificate) + +#### KongCertificateAPISpec + + +KongCertificateAPISpec contains the API specification for the KongCertificate. + + + +| Field | Description | +| --- | --- | +| `cert` _string_ | Cert is the PEM-encoded certificate. | +| `cert_alt` _string_ | CertAlt is the PEM-encoded certificate. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. | +| `key` _string_ | Key is the PEM-encoded private key. | +| `key_alt` _string_ | KeyAlt is the PEM-encoded private key. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. | +| `tags` _string array_ | Tags is an optional set of tags applied to the certificate. | + + +_Appears in:_ +- [KongCertificateSpec](#kongcertificatespec) + +#### KongCertificateSpec + + +KongCertificateSpec contains the specification for the KongCertificate. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef references the Konnect Control Plane that this KongCertificate should be created in. | +| `cert` _string_ | Cert is the PEM-encoded certificate. | +| `cert_alt` _string_ | CertAlt is the PEM-encoded certificate. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. | +| `key` _string_ | Key is the PEM-encoded private key. | +| `key_alt` _string_ | KeyAlt is the PEM-encoded private key. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. | +| `tags` _string array_ | Tags is an optional set of tags applied to the certificate. | + + +_Appears in:_ +- [KongCertificate](#kongcertificate) + +#### KongCertificateStatus + + +KongCertificateStatus defines the observed state of KongCertificate. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCertificate](#kongcertificate) + +#### KongCredentialACLAPISpec + + +KongCredentialACLAPISpec defines specification of an ACL credential. + + + +| Field | Description | +| --- | --- | +| `group` _string_ | Group is the name for the ACL credential. | +| `tags` _string array_ | Tags is a list of tags for the ACL credential. | + + +_Appears in:_ +- [KongCredentialACLSpec](#kongcredentialaclspec) + +#### KongCredentialACLSpec + + +KongCredentialACLSpec defines specification of Kong ACL. + + + +| Field | Description | +| --- | --- | +| `consumerRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ConsumerRef is a reference to a Consumer this KongCredentialACL is associated with. | +| `group` _string_ | Group is the name for the ACL credential. | +| `tags` _string array_ | Tags is a list of tags for the ACL credential. | + + +_Appears in:_ +- [KongCredentialACL](#kongcredentialacl) + +#### KongCredentialACLStatus + + +KongCredentialACLStatus represents the current status of the ACL credential resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCredentialACL](#kongcredentialacl) + +#### KongCredentialAPIKeyAPISpec + + +KongCredentialAPIKeyAPISpec defines specification of an API Key credential. + + + +| Field | Description | +| --- | --- | +| `key` _string_ | Key is the key for the API Key credential. | +| `tags` _string array_ | Tags is a list of tags for the API Key credential. | + + +_Appears in:_ +- [KongCredentialAPIKeySpec](#kongcredentialapikeyspec) + +#### KongCredentialAPIKeySpec + + +KongCredentialAPIKeySpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `consumerRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ConsumerRef is a reference to a Consumer this KongCredentialAPIKey is associated with. | +| `key` _string_ | Key is the key for the API Key credential. | +| `tags` _string array_ | Tags is a list of tags for the API Key credential. | + + +_Appears in:_ +- [KongCredentialAPIKey](#kongcredentialapikey) + +#### KongCredentialAPIKeyStatus + + +KongCredentialAPIKeyStatus represents the current status of the API Key credential resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCredentialAPIKey](#kongcredentialapikey) + +#### KongCredentialBasicAuthAPISpec + + +KongCredentialBasicAuthAPISpec defines specification of a BasicAuth credential. + + + +| Field | Description | +| --- | --- | +| `password` _string_ | Password is the password for the BasicAuth credential. | +| `tags` _string array_ | Tags is a list of tags for the BasicAuth credential. | +| `username` _string_ | Username is the username for the BasicAuth credential. | + + +_Appears in:_ +- [KongCredentialBasicAuthSpec](#kongcredentialbasicauthspec) + +#### KongCredentialBasicAuthSpec + + +KongCredentialBasicAuthSpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `consumerRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ConsumerRef is a reference to a Consumer this CredentialBasicAuth is associated with. | +| `password` _string_ | Password is the password for the BasicAuth credential. | +| `tags` _string array_ | Tags is a list of tags for the BasicAuth credential. | +| `username` _string_ | Username is the username for the BasicAuth credential. | + + +_Appears in:_ +- [KongCredentialBasicAuth](#kongcredentialbasicauth) + +#### KongCredentialBasicAuthStatus + + +KongCredentialBasicAuthStatus represents the current status of the BasicAuth credential resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCredentialBasicAuth](#kongcredentialbasicauth) + +#### KongCredentialHMACAPISpec + + +KongCredentialHMACAPISpec defines specification of an HMAC credential. + + + +| Field | Description | +| --- | --- | +| `id` _string_ | ID is the unique identifier for the HMAC credential. | +| `secret` _string_ | Secret is the secret for the HMAC credential. | +| `tags` _string array_ | Tags is a list of tags for the HMAC credential. | +| `username` _string_ | Username is the username for the HMAC credential. | + + +_Appears in:_ +- [KongCredentialHMACSpec](#kongcredentialhmacspec) + +#### KongCredentialHMACSpec + + +KongCredentialHMACSpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `consumerRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ConsumerRef is a reference to a Consumer this KongCredentialHMAC is associated with. | +| `id` _string_ | ID is the unique identifier for the HMAC credential. | +| `secret` _string_ | Secret is the secret for the HMAC credential. | +| `tags` _string array_ | Tags is a list of tags for the HMAC credential. | +| `username` _string_ | Username is the username for the HMAC credential. | + + +_Appears in:_ +- [KongCredentialHMAC](#kongcredentialhmac) + +#### KongCredentialHMACStatus + + +KongCredentialHMACStatus represents the current status of the HMAC credential resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCredentialHMAC](#kongcredentialhmac) + +#### KongCredentialJWTAPISpec + + +KongCredentialJWTAPISpec defines specification of an JWT credential. + + + +| Field | Description | +| --- | --- | +| `algorithm` _string_ | Algorithm is the algorithm used to sign the JWT token. | +| `id` _string_ | ID is the unique identifier for the JWT credential. | +| `key` _string_ | Key is the key for the JWT credential. | +| `rsa_public_key` _string_ | RSA PublicKey is the RSA public key for the JWT credential. | +| `secret` _string_ | Secret is the secret for the JWT credential. | +| `tags` _string array_ | Tags is a list of tags for the JWT credential. | + + +_Appears in:_ +- [KongCredentialJWTSpec](#kongcredentialjwtspec) + +#### KongCredentialJWTSpec + + +KongCredentialJWTSpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `consumerRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core)_ | ConsumerRef is a reference to a Consumer this KongCredentialJWT is associated with. | +| `algorithm` _string_ | Algorithm is the algorithm used to sign the JWT token. | +| `id` _string_ | ID is the unique identifier for the JWT credential. | +| `key` _string_ | Key is the key for the JWT credential. | +| `rsa_public_key` _string_ | RSA PublicKey is the RSA public key for the JWT credential. | +| `secret` _string_ | Secret is the secret for the JWT credential. | +| `tags` _string array_ | Tags is a list of tags for the JWT credential. | + + +_Appears in:_ +- [KongCredentialJWT](#kongcredentialjwt) + +#### KongCredentialJWTStatus + + +KongCredentialJWTStatus represents the current status of the JWT credential resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongCredentialJWT](#kongcredentialjwt) + +#### KongDataPlaneClientCertificateAPISpec + + +KongDataPlaneClientCertificateAPISpec defines the attributes of a Kong DP certificate. + + + +| Field | Description | +| --- | --- | +| `cert` _string_ | Cert is the certificate in PEM format. Once the certificate gets programmed this field becomes immutable. | + + +_Appears in:_ +- [KongDataPlaneClientCertificateSpec](#kongdataplaneclientcertificatespec) + +#### KongDataPlaneClientCertificateSpec + + +KongDataPlaneClientCertificateSpec defines the spec for a KongDataPlaneClientCertificate. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a Konnect ControlPlane this KongDataPlaneClientCertificate is associated with. | +| `cert` _string_ | Cert is the certificate in PEM format. Once the certificate gets programmed this field becomes immutable. | + + +_Appears in:_ +- [KongDataPlaneClientCertificate](#kongdataplaneclientcertificate) + +#### KongDataPlaneClientCertificateStatus + + +KongDataPlaneClientCertificateStatus defines the status for a KongDataPlaneClientCertificate. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongDataPlaneClientCertificate](#kongdataplaneclientcertificate) + +#### KongKeyAPISpec + + +KongKeyAPISpec defines the attributes of a Kong Key. + + + +| Field | Description | +| --- | --- | +| `kid` _string_ | KID is a unique identifier for a key. When JWK is provided, KID has to match the KID in the JWK. | +| `name` _string_ | Name is an optional name to associate with the given key. | +| `jwk` _string_ | JWK is a JSON Web Key represented as a string. The JWK must contain a KID field that matches the KID in the KongKey. Either JWK or PEM must be set. | +| `pem` _[PEMKeyPair](#pemkeypair)_ | PEM is a keypair in PEM format. Either JWK or PEM must be set. | +| `tags` _string array_ | Tags is an optional set of strings associated with the Key for grouping and filtering. | + + +_Appears in:_ +- [KongKeySpec](#kongkeyspec) + +#### KongKeySetAPISpec + + +KongKeySetAPISpec defines the attributes of a Kong KeySet. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is a name of the KeySet. | +| `tags` _string array_ | Tags is an optional set of strings associated with the KeySet for grouping and filtering. | + + +_Appears in:_ +- [KongKeySetSpec](#kongkeysetspec) + +#### KongKeySetSpec + + +KongKeySetSpec defines the spec for a KongKeySet. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a Konnect ControlPlane with which KongKeySet is associated. | +| `name` _string_ | Name is a name of the KeySet. | +| `tags` _string array_ | Tags is an optional set of strings associated with the KeySet for grouping and filtering. | + + +_Appears in:_ +- [KongKeySet](#kongkeyset) + +#### KongKeySetStatus + + +KongKeySetStatus defines the status for a KongKeySet. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongKeySet](#kongkeyset) + +#### KongKeySpec + + +KongKeySpec defines the spec for a KongKey. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a Konnect ControlPlane this KongKey is associated with. | +| `keySetRef` _[KeySetRef](#keysetref)_ | KeySetRef is a reference to a KongKeySet this KongKey is attached to. ControlPlane referenced by a KongKeySet must be the same as the ControlPlane referenced by the KongKey. | +| `kid` _string_ | KID is a unique identifier for a key. When JWK is provided, KID has to match the KID in the JWK. | +| `name` _string_ | Name is an optional name to associate with the given key. | +| `jwk` _string_ | JWK is a JSON Web Key represented as a string. The JWK must contain a KID field that matches the KID in the KongKey. Either JWK or PEM must be set. | +| `pem` _[PEMKeyPair](#pemkeypair)_ | PEM is a keypair in PEM format. Either JWK or PEM must be set. | +| `tags` _string array_ | Tags is an optional set of strings associated with the Key for grouping and filtering. | + + +_Appears in:_ +- [KongKey](#kongkey) + +#### KongKeyStatus + + +KongKeyStatus defines the status for a KongKey. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndKeySetRef](#konnectentitystatuswithcontrolplaneandkeysetref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongKey](#kongkey) + +#### KongLicenseControllerStatus + + +KongLicenseControllerStatus is the status of owning KongLicense being processed +identified by the controllerName field. + + + +| Field | Description | +| --- | --- | +| `controllerName` _string_ | ControllerName is an identifier of the controller to reconcile this KongLicense. Should be unique in the list of controller statuses. | +| `controllerRef` _[ControllerReference](#controllerreference)_ | ControllerRef is the reference of the controller to reconcile this KongLicense. It is usually the name of (KIC/KGO) pod that reconciles it. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the KongLicense on the controller. | + + +_Appears in:_ +- [KongLicenseStatus](#konglicensestatus) + +#### KongLicenseStatus + + +KongLicenseStatus stores the status of the KongLicense being processesed in each controller that reconciles it. + + + +| Field | Description | +| --- | --- | +| `controllers` _[KongLicenseControllerStatus](#konglicensecontrollerstatus) array_ | | + + +_Appears in:_ +- [KongLicense](#konglicense) + +#### KongObjectRef + + +KongObjectRef is a reference to another object representing a Kong entity with deterministic type.

+TODO: https://github.com/Kong/kubernetes-configuration/issues/96 +change other types to use the generic `KongObjectRef` and move it to a common package to prevent possible import cycles. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the entity.

NOTE: the `Required` validation rule does not reject empty strings so we use `MinLength` to reject empty string here. | + + +_Appears in:_ +- [KongSNISpec](#kongsnispec) + +#### KongPluginBindingSpec + + +KongPluginBindingSpec defines specification of a KongPluginBinding. + + + +| Field | Description | +| --- | --- | +| `pluginRef` _[PluginRef](#pluginref)_ | PluginReference is a reference to the KongPlugin or KongClusterPlugin resource. | +| `targets` _[KongPluginBindingTargets](#kongpluginbindingtargets)_ | Targets contains the targets references. It is possible to set multiple combinations of references, as described in https://docs.konghq.com/gateway/latest/key-concepts/plugins/#precedence The complete set of allowed combinations and their order of precedence for plugins configured to multiple entities is:

1. Consumer + route + service 2. Consumer group + service + route 3. Consumer + route 4. Consumer + service 5. Consumer group + route 6. Consumer group + service 7. Route + service 8. Consumer 9. Consumer group 10. Route 11. Service | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this KongPluginBinding is associated with. | + + +_Appears in:_ +- [KongPluginBinding](#kongpluginbinding) + +#### KongPluginBindingStatus + + +KongPluginBindingStatus represents the current status of the KongBinding resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongPluginBinding](#kongpluginbinding) + +#### KongPluginBindingTargets + + +KongPluginBindingTargets contains the targets references. + + + +| Field | Description | +| --- | --- | +| `routeRef` _[TargetRefWithGroupKind](#targetrefwithgroupkind)_ | RouteReference can be used to reference one of the following resouces: - networking.k8s.io/Ingress - gateway.networking.k8s.io/HTTPRoute - gateway.networking.k8s.io/GRPCRoute - configuration.konghq.com/KongRoute | +| `serviceRef` _[TargetRefWithGroupKind](#targetrefwithgroupkind)_ | ServiceReference can be used to reference one of the following resouces: - core/Service or /Service - configuration.konghq.com/KongService | +| `consumerRef` _[TargetRef](#targetref)_ | ConsumerReference is used to reference a configuration.konghq.com/Consumer resource. The group/kind is fixed, therefore the reference is performed only by name. | +| `consumerGroupRef` _[TargetRef](#targetref)_ | ConsumerGroupReference is used to reference a configuration.konghq.com/ConsumerGroup resource. The group/kind is fixed, therefore the reference is performed only by name. | + + +_Appears in:_ +- [KongPluginBindingSpec](#kongpluginbindingspec) + +#### KongRouteAPISpec + + +KongRouteAPISpec represents the configuration of a Route in Kong as defined by the Konnect API.

+These fields are mostly copied from sdk-konnect-go but some modifications have been made +to make the code generation required for Kubernetes CRDs work. + + + +| Field | Description | +| --- | --- | +| `destinations` _Destinations array_ | A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port". | +| `headers` _object (keys:string, values:string)_ | One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this attribute: hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression. | +| `hosts` _string array_ | A list of domain names that match this Route. Note that the hosts value is case sensitive. | +| `https_redirect_status_code` _[HTTPSRedirectStatusCode](#httpsredirectstatuscode)_ | The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the `https` protocol. | +| `methods` _string array_ | A list of HTTP methods that match this Route. | +| `name` _string_ | The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test". | +| `path_handling` _[PathHandling](#pathhandling)_ | Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. | +| `paths` _string array_ | A list of paths that match this Route. | +| `preserve_host` _boolean_ | When matching a Route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the Service's `host`. | +| `protocols` _RouteProtocols array_ | An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `"https"`, HTTP requests are answered with an upgrade error. When set to only `"http"`, HTTPS requests are answered with an error. | +| `regex_priority` _integer_ | A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones). | +| `request_buffering` _boolean_ | Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. | +| `response_buffering` _boolean_ | Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. | +| `snis` _string array_ | A list of SNIs that match this Route when using stream routing. | +| `sources` _Sources array_ | A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port". | +| `strip_path` _boolean_ | When matching a Route via one of the `paths`, strip the matching prefix from the upstream request URL. | +| `tags` _string array_ | An optional set of strings associated with the Route for grouping and filtering. | + + +_Appears in:_ +- [KongRouteSpec](#kongroutespec) + +#### KongRouteSpec + + +KongRouteSpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this KongRoute is associated with. Route can either specify a ControlPlaneRef and be 'serviceless' route or specify a ServiceRef and be associated with a Service. | +| `serviceRef` _[ServiceRef](#serviceref)_ | ServiceRef is a reference to a Service this KongRoute is associated with. Route can either specify a ControlPlaneRef and be 'serviceless' route or specify a ServiceRef and be associated with a Service. | +| `destinations` _Destinations array_ | A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port". | +| `headers` _object (keys:string, values:string)_ | One or more lists of values indexed by header name that will cause this Route to match if present in the request. The `Host` header cannot be used with this attribute: hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression. | +| `hosts` _string array_ | A list of domain names that match this Route. Note that the hosts value is case sensitive. | +| `https_redirect_status_code` _[HTTPSRedirectStatusCode](#httpsredirectstatuscode)_ | The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the `https` protocol. | +| `methods` _string array_ | A list of HTTP methods that match this Route. | +| `name` _string_ | The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test". | +| `path_handling` _[PathHandling](#pathhandling)_ | Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior. | +| `paths` _string array_ | A list of paths that match this Route. | +| `preserve_host` _boolean_ | When matching a Route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the Service's `host`. | +| `protocols` _RouteProtocols array_ | An array of the protocols this Route should allow. See the [Route Object](#route-object) section for a list of accepted protocols. When set to only `"https"`, HTTP requests are answered with an upgrade error. When set to only `"http"`, HTTPS requests are answered with an error. | +| `regex_priority` _integer_ | A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones). | +| `request_buffering` _boolean_ | Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding. | +| `response_buffering` _boolean_ | Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding. | +| `snis` _string array_ | A list of SNIs that match this Route when using stream routing. | +| `sources` _Sources array_ | A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port". | +| `strip_path` _boolean_ | When matching a Route via one of the `paths`, strip the matching prefix from the upstream request URL. | +| `tags` _string array_ | An optional set of strings associated with the Route for grouping and filtering. | + + +_Appears in:_ +- [KongRoute](#kongroute) + +#### KongRouteStatus + + +KongRouteStatus represents the current status of the Kong Route resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndServiceRefs](#konnectentitystatuswithcontrolplaneandservicerefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongRoute](#kongroute) + +#### KongSNIAPISpec + + +KongSNIAPISpec defines specification of an SNI. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the SNI. Required and must be a host or wildcard host. | +| `tags` _string array_ | Tags is an optional set of strings associated with the SNI for grouping and filtering. | + + +_Appears in:_ +- [KongSNISpec](#kongsnispec) + +#### KongSNISpec + + +KongSNISpec defines specification of a Kong SNI. + + + +| Field | Description | +| --- | --- | +| `certificateRef` _[KongObjectRef](#kongobjectref)_ | CertificateRef is the reference to the certificate to which the KongSNI is attached. | +| `name` _string_ | Name is the name of the SNI. Required and must be a host or wildcard host. | +| `tags` _string array_ | Tags is an optional set of strings associated with the SNI for grouping and filtering. | + + +_Appears in:_ +- [KongSNI](#kongsni) + +#### KongSNIStatus + + +KongSNIStatus defines the status for a KongSNI. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndCertificateRefs](#konnectentitystatuswithcontrolplaneandcertificaterefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongSNI](#kongsni) + +#### KongServiceAPISpec + + +KongServiceAPISpec defines specification of a Kong Service. + + + +| Field | Description | +| --- | --- | +| `url` _string_ | Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses. | +| `connect_timeout` _integer_ | The timeout in milliseconds for establishing a connection to the upstream server. | +| `enabled` _boolean_ | Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404). Default: `true`. | +| `host` _string_ | The host of the upstream server. Note that the host value is case sensitive. | +| `name` _string_ | The Service name. | +| `path` _string_ | The path to be used in requests to the upstream server. | +| `port` _integer_ | The upstream server port. | +| `protocol` _[Protocol](#protocol)_ | The protocol used to communicate with the upstream. | +| `read_timeout` _integer_ | The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. | +| `retries` _integer_ | The number of retries to execute upon failure to proxy. | +| `tags` _string array_ | An optional set of strings associated with the Service for grouping and filtering. | +| `tls_verify` _boolean_ | Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected. | +| `tls_verify_depth` _integer_ | Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected. | +| `write_timeout` _integer_ | The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. | + + +_Appears in:_ +- [KongServiceSpec](#kongservicespec) + +#### KongServiceSpec + + +KongServiceSpec defines specification of a Kong Route. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this KongService is associated with. | +| `url` _string_ | Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses. | +| `connect_timeout` _integer_ | The timeout in milliseconds for establishing a connection to the upstream server. | +| `enabled` _boolean_ | Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404). Default: `true`. | +| `host` _string_ | The host of the upstream server. Note that the host value is case sensitive. | +| `name` _string_ | The Service name. | +| `path` _string_ | The path to be used in requests to the upstream server. | +| `port` _integer_ | The upstream server port. | +| `protocol` _[Protocol](#protocol)_ | The protocol used to communicate with the upstream. | +| `read_timeout` _integer_ | The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. | +| `retries` _integer_ | The number of retries to execute upon failure to proxy. | +| `tags` _string array_ | An optional set of strings associated with the Service for grouping and filtering. | +| `tls_verify` _boolean_ | Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected. | +| `tls_verify_depth` _integer_ | Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected. | +| `write_timeout` _integer_ | The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. | + + +_Appears in:_ +- [KongService](#kongservice) + +#### KongServiceStatus + + +KongServiceStatus represents the current status of the Kong Service resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongService](#kongservice) + +#### KongTargetAPISpec + + +KongTargetAPISpec are the attributes of the Kong Target itself. + + + +| Field | Description | +| --- | --- | +| `target` _string_ | Target is the target address of the upstream. | +| `weight` _integer_ | Weight is the weight this target gets within the upstream loadbalancer. | +| `tags` _string array_ | Tags is an optional set of strings associated with the Target for grouping and filtering. | + + +_Appears in:_ +- [KongTargetSpec](#kongtargetspec) + +#### KongTargetSpec + + +KongTargetSpec defines the specification of a Kong Target. +KongTargetSpec defines the desired state of KongTarget. + + + +| Field | Description | +| --- | --- | +| `upstreamRef` _[TargetRef](#targetref)_ | UpstreamRef is a reference to a KongUpstream this KongTarget is attached to. | +| `target` _string_ | Target is the target address of the upstream. | +| `weight` _integer_ | Weight is the weight this target gets within the upstream loadbalancer. | +| `tags` _string array_ | Tags is an optional set of strings associated with the Target for grouping and filtering. | + + +_Appears in:_ +- [KongTarget](#kongtarget) + +#### KongTargetStatus + + +KongTargetStatus defines the observed state of KongTarget. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneAndUpstreamRefs](#konnectentitystatuswithcontrolplaneandupstreamrefs)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongTarget](#kongtarget) + +#### KongUpstreamAPISpec + + +KongUpstreamAPISpec defines specification of a Kong Upstream. + + + +| Field | Description | +| --- | --- | +| `algorithm` _[UpstreamAlgorithm](#upstreamalgorithm)_ | Which load balancing algorithm to use. | +| `client_certificate` _[UpstreamClientCertificate](#upstreamclientcertificate)_ | If set, the certificate to be used as client certificate while TLS handshaking to the upstream server. | +| `hash_fallback` _[HashFallback](#hashfallback)_ | What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`. | +| `hash_fallback_header` _string_ | The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`. | +| `hash_fallback_query_arg` _string_ | The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`. | +| `hash_fallback_uri_capture` _string_ | The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`. | +| `hash_on` _[HashOn](#hashon)_ | What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing. | +| `hash_on_cookie` _string_ | The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response. | +| `hash_on_cookie_path` _string_ | The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`. | +| `hash_on_header` _string_ | The header name to take the value from as hash input. Only required when `hash_on` is set to `header`. | +| `hash_on_query_arg` _string_ | The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`. | +| `hash_on_uri_capture` _string_ | The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`. | +| `healthchecks` _[Healthchecks](#healthchecks)_ | | +| `host_header` _string_ | The hostname to be used as `Host` header when proxying requests through Kong. | +| `name` _string_ | This is a hostname, which must be equal to the `host` of a Service. | +| `slots` _integer_ | The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`. | +| `tags` _string array_ | An optional set of strings associated with the Upstream for grouping and filtering. | +| `use_srv_name` _boolean_ | If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`. | + + +_Appears in:_ +- [KongUpstreamSpec](#kongupstreamspec) + +#### KongUpstreamSpec + + +KongUpstreamSpec defines specification of a Kong Upstream. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this KongUpstream is associated with. | +| `algorithm` _[UpstreamAlgorithm](#upstreamalgorithm)_ | Which load balancing algorithm to use. | +| `client_certificate` _[UpstreamClientCertificate](#upstreamclientcertificate)_ | If set, the certificate to be used as client certificate while TLS handshaking to the upstream server. | +| `hash_fallback` _[HashFallback](#hashfallback)_ | What to use as hashing input if the primary `hash_on` does not return a hash (eg. header is missing, or no Consumer identified). Not available if `hash_on` is set to `cookie`. | +| `hash_fallback_header` _string_ | The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`. | +| `hash_fallback_query_arg` _string_ | The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`. | +| `hash_fallback_uri_capture` _string_ | The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`. | +| `hash_on` _[HashOn](#hashon)_ | What to use as hashing input. Using `none` results in a weighted-round-robin scheme with no hashing. | +| `hash_on_cookie` _string_ | The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response. | +| `hash_on_cookie_path` _string_ | The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`. | +| `hash_on_header` _string_ | The header name to take the value from as hash input. Only required when `hash_on` is set to `header`. | +| `hash_on_query_arg` _string_ | The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`. | +| `hash_on_uri_capture` _string_ | The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`. | +| `healthchecks` _[Healthchecks](#healthchecks)_ | | +| `host_header` _string_ | The hostname to be used as `Host` header when proxying requests through Kong. | +| `name` _string_ | This is a hostname, which must be equal to the `host` of a Service. | +| `slots` _integer_ | The number of slots in the load balancer algorithm. If `algorithm` is set to `round-robin`, this setting determines the maximum number of slots. If `algorithm` is set to `consistent-hashing`, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range `10`-`65536`. | +| `tags` _string array_ | An optional set of strings associated with the Upstream for grouping and filtering. | +| `use_srv_name` _boolean_ | If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream `Host`. | + + +_Appears in:_ +- [KongUpstream](#kongupstream) + +#### KongUpstreamStatus + + +KongUpstreamStatus represents the current status of the Kong Upstream resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect entity. | + + +_Appears in:_ +- [KongUpstream](#kongupstream) + +#### KongVaultSpec + + +KongVaultSpec defines specification of a custom Kong vault. + + + +| Field | Description | +| --- | --- | +| `backend` _string_ | Backend is the type of the backend storing the secrets in the vault. The supported backends of Kong is listed here: https://docs.konghq.com/gateway/latest/kong-enterprise/secrets-management/backends/ | +| `prefix` _string_ | Prefix is the prefix of vault URI for referencing values in the vault. It is immutable after created. | +| `description` _string_ | Description is the additional information about the vault. | +| `config` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#json-v1-apiextensions-k8s-io)_ | Config is the configuration of the vault. Varies for different backends. | +| `tags` _string array_ | Tags are the tags associated to the vault for grouping and filtering. | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a Konnect ControlPlane this KongVault is associated with. | + + +_Appears in:_ +- [KongVault](#kongvault) + +#### KongVaultStatus + + +KongVaultStatus represents the current status of the KongVault resource. + + + +| Field | Description | +| --- | --- | +| `konnect` _[KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref)_ | Konnect contains the Konnect entity status. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the KongVaultStatus.

Known condition types are:

* "Programmed" | + + +_Appears in:_ +- [KongVault](#kongvault) + +#### KonnectNamespacedRef + + +KonnectNamespacedRef is the schema for the KonnectNamespacedRef type. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the Konnect Control Plane. | +| `namespace` _string_ | Namespace is the namespace where the Konnect Control Plane is in. Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`. | + + +_Appears in:_ +- [ControlPlaneRef](#controlplaneref) + +#### Namespace +_Underlying type:_ `string` + +Namespace refers to a Kubernetes namespace. It must be a RFC 1123 label. + + + + + +_Appears in:_ +- [ControllerReference](#controllerreference) + +#### NamespacedServiceRef + + +NamespacedServiceRef is a namespaced reference to a KongService.

+NOTE: currently cross namespace references are not supported. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | | + + +_Appears in:_ +- [ServiceRef](#serviceref) + +#### ObjectName +_Underlying type:_ `string` + +ObjectName refers to the name of a Kubernetes object. +Object names can have a variety of forms, including RFC1123 subdomains, +RFC 1123 labels, or RFC 1035 labels. + + + + + +_Appears in:_ +- [ControllerReference](#controllerreference) + +#### PEMKeyPair + + +PEMKeyPair defines a keypair in PEM format. + + + +| Field | Description | +| --- | --- | +| `private_key` _string_ | The private key in PEM format. | +| `public_key` _string_ | The public key in PEM format. | + + +_Appears in:_ +- [KongKeyAPISpec](#kongkeyapispec) +- [KongKeySpec](#kongkeyspec) + +#### PluginRef + + +PluginRef is a reference to a KongPlugin or KongClusterPlugin resource. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the KongPlugin or KongClusterPlugin resource. | +| `kind` _string_ | Kind can be KongPlugin or KongClusterPlugin. If not set, it is assumed to be KongPlugin. | + + +_Appears in:_ +- [KongPluginBindingSpec](#kongpluginbindingspec) + +#### ServiceRef + + +ServiceRef is a reference to a KongService. + + + +| Field | Description | +| --- | --- | +| `type` _string_ | Type can be one of: - namespacedRef | +| `namespacedRef` _[NamespacedServiceRef](#namespacedserviceref)_ | NamespacedRef is a reference to a KongService. | + + +_Appears in:_ +- [KongRouteSpec](#kongroutespec) + +#### TargetRef + + +TargetRef is a reference based on the object's name. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the entity. | + + +_Appears in:_ +- [KongPluginBindingTargets](#kongpluginbindingtargets) +- [KongTargetSpec](#kongtargetspec) + +#### TargetRefWithGroupKind + + +TargetRefWithGroupKind is a reference based on the object's group, kind, and name. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the entity. | +| `kind` _string_ | | +| `group` _string_ | | + + +_Appears in:_ +- [KongPluginBindingTargets](#kongpluginbindingtargets) + + +## configuration.konghq.com/v1beta1 + +Package v1beta1 contains API Schema definitions for the configuration.konghq.com v1beta1 API group. + +- [KongConsumerGroup](#kongconsumergroup) +### KongConsumerGroup + + +KongConsumerGroup is the Schema for the kongconsumergroups API. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `configuration.konghq.com/v1beta1` +| `kind` _string_ | `KongConsumerGroup` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongConsumerGroupSpec](#kongconsumergroupspec)_ | | +| `status` _[KongConsumerGroupStatus](#kongconsumergroupstatus)_ | Status represents the current status of the KongConsumerGroup resource. | + + + + + + +### Types + +In this section you will find types that the CRDs rely on. + ## gateway-operator.konghq.com/v1alpha1 Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group - [AIGateway](#aigateway) +- [DataPlaneKonnectExtension](#dataplanekonnectextension) - [DataPlaneMetricsExtension](#dataplanemetricsextension) +- [KongPluginInstallation](#kongplugininstallation) ### AIGateway @@ -61,6 +1799,26 @@ See: https://kubernetes.io/docs/reference/using-api/cel/ +### DataPlaneKonnectExtension + + +DataPlaneKonnectExtension is the Schema for the dataplanekonnectextension API, +and is intended to be referenced as extension by the dataplane API. +If a DataPlane successfully refers a DataPlaneKonnectExtension, the DataPlane +deployment spec gets customized to include the konnect-related configuration. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1alpha1` +| `kind` _string_ | `DataPlaneKonnectExtension` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[DataPlaneKonnectExtensionSpec](#dataplanekonnectextensionspec)_ | Spec is the specification of the DataPlaneKonnectExtension resource. | +| `status` _[DataPlaneKonnectExtensionStatus](#dataplanekonnectextensionstatus)_ | Status is the status of the DataPlaneKonnectExtension resource. | + + + ### DataPlaneMetricsExtension @@ -85,6 +1843,25 @@ the EE version of Kong Gateway Operator with a valid license. +### KongPluginInstallation + + +KongPluginInstallation allows using a custom Kong Plugin distributed as a container image available in a registry. +Such a plugin can be associated with GatewayConfiguration or DataPlane to be available for particular Kong Gateway +and configured with KongPlugin CRD. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1alpha1` +| `kind` _string_ | `KongPluginInstallation` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KongPluginInstallationSpec](#kongplugininstallationspec)_ | | +| `status` _[KongPluginInstallationStatus](#kongplugininstallationstatus)_ | | + + + ### Types In this section you will find types that the CRDs rely on. @@ -226,6 +2003,55 @@ Azure, e.t.c.). _Appears in:_ - [LargeLanguageModels](#largelanguagemodels) +#### ClusterCertificateSecretRef + + +ClusterCertificateSecretRef contains the reference to the Secret containing the Konnect Control Plane's cluster certificate. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the Secret containing the Konnect Control Plane's cluster certificate. | + + +_Appears in:_ +- [KonnectControlPlaneAPIAuthConfiguration](#konnectcontrolplaneapiauthconfiguration) + +#### DataPlaneKonnectExtensionSpec + + +DataPlaneKonnectExtensionSpec defines the desired state of DataPlaneKonnectExtension. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this DataPlaneKonnectExtension is associated with. | +| `controlPlaneRegion` _string_ | ControlPlaneRegion is the region of the Konnect Control Plane. | +| `serverHostname` _string_ | ServerHostname is the fully qualified domain name of the konnect server. This matches the RFC 1123 definition of a hostname with 1 notable exception that numeric IP addresses are not allowed.

Note that as per RFC1035 and RFC1123, a *label* must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. | +| `konnectControlPlaneAPIAuthConfiguration` _[KonnectControlPlaneAPIAuthConfiguration](#konnectcontrolplaneapiauthconfiguration)_ | AuthConfiguration must be used to configure the Konnect API authentication. | +| `clusterDataPlaneLabels` _object (keys:string, values:string)_ | ClusterDataPlaneLabels is a set of labels that will be applied to the Konnect DataPlane. | + + +_Appears in:_ +- [DataPlaneKonnectExtension](#dataplanekonnectextension) + +#### DataPlaneKonnectExtensionStatus + + +DataPlaneKonnectExtensionStatus defines the observed state of DataPlaneKonnectExtension. + + + +| Field | Description | +| --- | --- | +| `dataPlaneRefs` _[NamespacedRef](#namespacedref) array_ | DataPlaneRefs is the array of DataPlane references this is associated with. A new reference is set by the operator when this extension is associated with a DataPlane through its extensions spec. | + + +_Appears in:_ +- [DataPlaneKonnectExtension](#dataplanekonnectextension) + #### DataPlaneMetricsExtensionSpec @@ -273,25 +2099,58 @@ such as "internet-accessible", "internal-only". _Appears in:_ - [AIGatewayEndpoint](#aigatewayendpoint) -#### ExtensionRef -ExtensionRef corresponds to another resource in the Kubernetes cluster which -defines extended behavior for a resource (e.g. ControlPlane). + + + + +#### KongPluginInstallationSpec + + +KongPluginInstallationSpec provides the information necessary to retrieve and install a Kong custom plugin. | Field | Description | | --- | --- | -| `group` _string_ | Group is the group of the extension resource. | -| `kind` _string_ | Kind is kind of the extension resource. | -| `name` _string_ | Name is the name of the referred resource. | -| `namespace` _string_ | Namespace is the namespace of the referred resource.

For namespace-scoped resources if no Namespace is provided then the namespace of the parent object MUST be used.

This field MUST not be set when referring to cluster-scoped resources. | +| `image` _string_ | The image is an OCI image URL for a packaged custom Kong plugin. | +| `imagePullSecretRef` _[SecretObjectReference](#secretobjectreference)_ | ImagePullSecretRef is a reference to a Kubernetes Secret containing credentials necessary to pull the OCI image in Image. It must follow the format in https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry. It is optional. If the image is public, omit this field. | _Appears in:_ -- [ControlPlaneOptions](#controlplaneoptions) -- [ControlPlaneSpec](#controlplanespec) +- [KongPluginInstallation](#kongplugininstallation) + +#### KongPluginInstallationStatus + + +KongPluginInstallationStatus defines the observed state of KongPluginInstallation. + + + +| Field | Description | +| --- | --- | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of this KongPluginInstallation. | +| `underlyingConfigMapName` _string_ | UnderlyingConfigMapName is the name of the ConfigMap that contains the plugin's content. It is set when the plugin is successfully fetched and unpacked. | + + +_Appears in:_ +- [KongPluginInstallation](#kongplugininstallation) + +#### KonnectControlPlaneAPIAuthConfiguration + + +KonnectControlPlaneAPIAuthConfiguration contains the configuration to authenticate with Konnect API ControlPlane. + + + +| Field | Description | +| --- | --- | +| `clusterCertificateSecretRef` _[ClusterCertificateSecretRef](#clustercertificatesecretref)_ | ClusterCertificateSecretName is a name of the Secret containing the Konnect Control Plane's cluster certificate. | + + +_Appears in:_ +- [DataPlaneKonnectExtensionSpec](#dataplanekonnectextensionspec) #### LLMPrompt @@ -407,6 +2266,7 @@ NamespacedRef is a reference to a namespaced resource. _Appears in:_ +- [DataPlaneKonnectExtensionStatus](#dataplanekonnectextensionstatus) - [DataPlaneMetricsExtensionStatus](#dataplanemetricsextensionstatus) - [ExtensionRef](#extensionref) @@ -601,7 +2461,7 @@ deploy and connect a ControlPlane to a DataPlane object. | --- | --- | | `deployment` _[ControlPlaneDeploymentOptions](#controlplanedeploymentoptions)_ | | | `dataplane` _string_ | DataPlanes refers to the named DataPlane objects which this ControlPlane is responsible for. Currently they must be in the same namespace as the DataPlane. | -| `extensions` _[ExtensionRef](#extensionref) array_ | Extensions provide additional or replacement features for the ControlPlane resources to influence or enhance functionality. | +| `extensions` _ExtensionRef array_ | Extensions provide additional or replacement features for the ControlPlane resources to influence or enhance functionality. | _Appears in:_ @@ -619,7 +2479,7 @@ ControlPlaneSpec defines the desired state of ControlPlane | --- | --- | | `deployment` _[ControlPlaneDeploymentOptions](#controlplanedeploymentoptions)_ | | | `dataplane` _string_ | DataPlanes refers to the named DataPlane objects which this ControlPlane is responsible for. Currently they must be in the same namespace as the DataPlane. | -| `extensions` _[ExtensionRef](#extensionref) array_ | Extensions provide additional or replacement features for the ControlPlane resources to influence or enhance functionality. | +| `extensions` _ExtensionRef array_ | Extensions provide additional or replacement features for the ControlPlane resources to influence or enhance functionality. | | `gatewayClass` _[ObjectName](#objectname)_ | GatewayClass indicates the Gateway resources which this ControlPlane should be responsible for configuring routes for (e.g. HTTPRoute, TCPRoute, UDPRoute, TLSRoute, e.t.c.).

Required for the ControlPlane to have any effect: at least one Gateway must be present for configuration to be pushed to the data-plane and only Gateway resources can be used to identify data-plane entities. | | `ingressClass` _string_ | IngressClass enables support for the older Ingress resource and indicates which Ingress resources this ControlPlane should be responsible for.

Routing configured this way will be applied to the Gateway resources indicated by GatewayClass.

If omitted, Ingress resources will not be supported by the ControlPlane. | @@ -692,9 +2552,29 @@ deploy the DataPlane. | --- | --- | | `deployment` _[DataPlaneDeploymentOptions](#dataplanedeploymentoptions)_ | | | `network` _[DataPlaneNetworkOptions](#dataplanenetworkoptions)_ | | +| `resources` _[DataPlaneResources](#dataplaneresources)_ | | +| `extensions` _ExtensionRef array_ | Extensions provide additional or replacement features for the DataPlane resources to influence or enhance functionality. NOTE: since we have one extension only (DataPlaneKonnectExtension), we limit the amount of extensions to 1. | +| `pluginsToInstall` _[NamespacedName](#namespacedname) array_ | PluginsToInstall is a list of KongPluginInstallation resources that will be installed and available in the DataPlane. | + + +_Appears in:_ +- [DataPlaneSpec](#dataplanespec) + +#### DataPlaneResources + + +DataPlaneResources defines the resources that will be created and managed +for the DataPlane. + + + +| Field | Description | +| --- | --- | +| `podDisruptionBudget` _[PodDisruptionBudget](#poddisruptionbudget)_ | PodDisruptionBudget is the configuration for the PodDisruptionBudget that will be created for the DataPlane. | _Appears in:_ +- [DataPlaneOptions](#dataplaneoptions) - [DataPlaneSpec](#dataplanespec) #### DataPlaneRolloutStatus @@ -776,7 +2656,7 @@ DataPlaneServicePort contains information on service's port. | --- | --- | | `name` _string_ | The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. | | `port` _integer_ | The port that will be exposed by this service. | -| `targetPort` _[IntOrString](#intorstring)_ | Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service | +| `targetPort` _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#intorstring-intstr-util)_ | Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service | _Appears in:_ @@ -808,6 +2688,9 @@ DataPlaneSpec defines the desired state of DataPlane | --- | --- | | `deployment` _[DataPlaneDeploymentOptions](#dataplanedeploymentoptions)_ | | | `network` _[DataPlaneNetworkOptions](#dataplanenetworkoptions)_ | | +| `resources` _[DataPlaneResources](#dataplaneresources)_ | | +| `extensions` _ExtensionRef array_ | Extensions provide additional or replacement features for the DataPlane resources to influence or enhance functionality. NOTE: since we have one extension only (DataPlaneKonnectExtension), we limit the amount of extensions to 1. | +| `pluginsToInstall` _[NamespacedName](#namespacedname) array_ | PluginsToInstall is a list of KongPluginInstallation resources that will be installed and available in the DataPlane. | _Appears in:_ @@ -825,7 +2708,7 @@ DataPlaneStatus defines the observed state of DataPlane | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the DataPlane. | | `service` _string_ | Service indicates the Service that exposes the DataPlane's configured routes | | `addresses` _[Address](#address) array_ | Addresses lists the addresses that have actually been bound to the DataPlane. | -| `selector` _string_ | Selector contains a unique DataPlane identifier used as a deterministic label selector that is used throughout its dependent resources. This is used e.g. as a label selector for DataPlane's Services and Deployments. | +| `selector` _string_ | Selector contains a unique DataPlane identifier used as a deterministic label selector that is used throughout its dependent resources. This is used e.g. as a label selector for DataPlane's Services, Deployments and PodDisruptionBudgets. | | `readyReplicas` _integer_ | ReadyReplicas indicates how many replicas have reported to be ready. | | `replicas` _integer_ | Replicas indicates how many replicas have been set for the DataPlane. | | `rollout` _[DataPlaneRolloutStatus](#dataplanerolloutstatus)_ | RolloutStatus contains information about the rollout. It is set only if a rollout strategy was configured in the spec. | @@ -882,6 +2765,8 @@ configure and deploy a DataPlane object. | --- | --- | | `deployment` _[DataPlaneDeploymentOptions](#dataplanedeploymentoptions)_ | | | `network` _[GatewayConfigDataPlaneNetworkOptions](#gatewayconfigdataplanenetworkoptions)_ | | +| `extensions` _ExtensionRef array_ | Extensions provide additional or replacement features for the DataPlane resources to influence or enhance functionality. NOTE: since we have one extension only (DataPlaneKonnectExtension), we limit the amount of extensions to 1. | +| `pluginsToInstall` _[NamespacedName](#namespacedname) array_ | PluginsToInstall is a list of KongPluginInstallation resources that will be installed and available in the Gateways (DataPlanes) that use this GatewayConfig. | _Appears in:_ @@ -1003,8 +2888,43 @@ NamespacedName is a resource identified by name and optional namespace. _Appears in:_ +- [DataPlaneOptions](#dataplaneoptions) +- [DataPlaneSpec](#dataplanespec) +- [GatewayConfigDataPlaneOptions](#gatewayconfigdataplaneoptions) - [KonnectCertificateOptions](#konnectcertificateoptions) +#### PodDisruptionBudget + + +PodDisruptionBudget defines the configuration for the PodDisruptionBudget. + + + +| Field | Description | +| --- | --- | +| `spec` _[PodDisruptionBudgetSpec](#poddisruptionbudgetspec)_ | Spec defines the specification of the PodDisruptionBudget. Selector is managed by the controller and cannot be set by the user. | + + +_Appears in:_ +- [DataPlaneResources](#dataplaneresources) + +#### PodDisruptionBudgetSpec + + +PodDisruptionBudgetSpec defines the specification of a PodDisruptionBudget. + + + +| Field | Description | +| --- | --- | +| `minAvailable` _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#intorstring-intstr-util)_ | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | +| `maxUnavailable` _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#intorstring-intstr-util)_ | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | +| `unhealthyPodEvictionPolicy` _[UnhealthyPodEvictionPolicyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#unhealthypodevictionpolicytype-v1-policy)_ | UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True".

Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.

IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.

AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.

Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.

This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default). | + + +_Appears in:_ +- [PodDisruptionBudget](#poddisruptionbudget) + #### Promotion @@ -1172,3 +3092,200 @@ _Appears in:_ - [DataPlaneServiceOptions](#dataplaneserviceoptions) - [GatewayConfigServiceOptions](#gatewayconfigserviceoptions) + + +## konnect.konghq.com/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the konnect.konghq.com v1alpha1 API group. + +- [KonnectAPIAuthConfiguration](#konnectapiauthconfiguration) +- [KonnectGatewayControlPlane](#konnectgatewaycontrolplane) +### KonnectAPIAuthConfiguration + + +KonnectAPIAuthConfiguration is the Schema for the Konnect configuration type. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `konnect.konghq.com/v1alpha1` +| `kind` _string_ | `KonnectAPIAuthConfiguration` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KonnectAPIAuthConfigurationSpec](#konnectapiauthconfigurationspec)_ | Spec is the specification of the KonnectAPIAuthConfiguration resource. | +| `status` _[KonnectAPIAuthConfigurationStatus](#konnectapiauthconfigurationstatus)_ | Status is the status of the KonnectAPIAuthConfiguration resource. | + + + +### KonnectGatewayControlPlane + + +KonnectGatewayControlPlane is the Schema for the KonnectGatewayControlplanes API. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `konnect.konghq.com/v1alpha1` +| `kind` _string_ | `KonnectGatewayControlPlane` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[KonnectGatewayControlPlaneSpec](#konnectgatewaycontrolplanespec)_ | Spec defines the desired state of KonnectGatewayControlPlane. | +| `status` _[KonnectGatewayControlPlaneStatus](#konnectgatewaycontrolplanestatus)_ | Status defines the observed state of KonnectGatewayControlPlane. | + + + +### Types + +In this section you will find types that the CRDs rely on. +#### KonnectAPIAuthConfigurationRef + + +KonnectAPIAuthConfigurationRef is a reference to a KonnectAPIAuthConfiguration resource. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the KonnectAPIAuthConfiguration resource. | + + +_Appears in:_ +- [KonnectConfiguration](#konnectconfiguration) + +#### KonnectAPIAuthConfigurationSpec + + +KonnectAPIAuthConfigurationSpec is the specification of the KonnectAPIAuthConfiguration resource. + + + +| Field | Description | +| --- | --- | +| `type` _[KonnectAPIAuthType](#konnectapiauthtype)_ | | +| `token` _string_ | Token is the Konnect token used to authenticate with the Konnect API. | +| `secretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#secretreference-v1-core)_ | SecretRef is a reference to a Kubernetes Secret containing the Konnect token. This secret is required to has the konghq.com/credential label set to "konnect". | +| `serverURL` _string_ | ServerURL is the URL of the Konnect server. | + + +_Appears in:_ +- [KonnectAPIAuthConfiguration](#konnectapiauthconfiguration) + +#### KonnectAPIAuthConfigurationStatus + + +KonnectAPIAuthConfigurationStatus is the status of the KonnectAPIAuthConfiguration resource. + + + +| Field | Description | +| --- | --- | +| `organizationID` _string_ | OrganizationID is the unique identifier of the organization in Konnect. | +| `serverURL` _string_ | ServerURL is configured server URL. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the status of the Konnect configuration. | + + +_Appears in:_ +- [KonnectAPIAuthConfiguration](#konnectapiauthconfiguration) + +#### KonnectAPIAuthType +_Underlying type:_ `string` + +KonnectAPIAuthType is the type of authentication used to authenticate with the Konnect API. + + + + + +_Appears in:_ +- [KonnectAPIAuthConfigurationSpec](#konnectapiauthconfigurationspec) + +#### KonnectConfiguration + + +KonnectConfiguration is the Schema for the KonnectConfiguration API. + + + +| Field | Description | +| --- | --- | +| `authRef` _[KonnectAPIAuthConfigurationRef](#konnectapiauthconfigurationref)_ | APIAuthConfigurationRef is the reference to the API Auth Configuration that should be used for this Konnect Configuration. | + + +_Appears in:_ +- [KonnectGatewayControlPlaneSpec](#konnectgatewaycontrolplanespec) + +#### KonnectEntityStatus + + +KonnectEntityStatus represents the status of a Konnect entity. + + + +| Field | Description | +| --- | --- | +| `id` _string_ | ID is the unique identifier of the Konnect entity as assigned by Konnect API. If it's unset (empty string), it means the Konnect entity hasn't been created yet. | +| `serverURL` _string_ | ServerURL is the URL of the Konnect server in which the entity exists. | +| `organizationID` _string_ | OrgID is ID of Konnect Org that this entity has been created in. | + + +_Appears in:_ +- [KonnectEntityStatusWithControlPlaneAndCertificateRefs](#konnectentitystatuswithcontrolplaneandcertificaterefs) +- [KonnectEntityStatusWithControlPlaneAndConsumerRefs](#konnectentitystatuswithcontrolplaneandconsumerrefs) +- [KonnectEntityStatusWithControlPlaneAndKeySetRef](#konnectentitystatuswithcontrolplaneandkeysetref) +- [KonnectEntityStatusWithControlPlaneAndServiceRefs](#konnectentitystatuswithcontrolplaneandservicerefs) +- [KonnectEntityStatusWithControlPlaneAndUpstreamRefs](#konnectentitystatuswithcontrolplaneandupstreamrefs) +- [KonnectEntityStatusWithControlPlaneRef](#konnectentitystatuswithcontrolplaneref) +- [KonnectGatewayControlPlaneStatus](#konnectgatewaycontrolplanestatus) + + + + + + + + + + + + + +#### KonnectGatewayControlPlaneSpec + + +KonnectGatewayControlPlaneSpec defines the desired state of KonnectGatewayControlPlane. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | The name of the control plane. | +| `description` _string_ | The description of the control plane in Konnect. | +| `cluster_type` _[ClusterType](#clustertype)_ | The ClusterType value of the cluster associated with the Control Plane. | +| `auth_type` _[AuthType](#authtype)_ | The auth type value of the cluster associated with the Runtime Group. | +| `cloud_gateway` _boolean_ | Whether this control-plane can be used for cloud-gateways. | +| `proxy_urls` _[ProxyURL](#proxyurl) array_ | Array of proxy URLs associated with reaching the data-planes connected to a control-plane. | +| `labels` _object (keys:string, values:string)_ | Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". | +| `members` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core) array_ | Members is a list of references to the KonnectGatewayControlPlaneMembers that are part of this control plane group. Only applicable for ControlPlanes that are created as groups. | +| `konnect` _[KonnectConfiguration](#konnectconfiguration)_ | | + + +_Appears in:_ +- [KonnectGatewayControlPlane](#konnectgatewaycontrolplane) + +#### KonnectGatewayControlPlaneStatus + + +KonnectGatewayControlPlaneStatus defines the observed state of KonnectGatewayControlPlane. + + + +| Field | Description | +| --- | --- | +| `id` _string_ | ID is the unique identifier of the Konnect entity as assigned by Konnect API. If it's unset (empty string), it means the Konnect entity hasn't been created yet. | +| `serverURL` _string_ | ServerURL is the URL of the Konnect server in which the entity exists. | +| `organizationID` _string_ | OrgID is ID of Konnect Org that this entity has been created in. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the KonnectGatewayControlPlane.

Known condition types are:

* "Programmed" | + + +_Appears in:_ +- [KonnectGatewayControlPlane](#konnectgatewaycontrolplane) diff --git a/app/_src/kubernetes-ingress-controller/plugins/custom.md b/app/_src/kubernetes-ingress-controller/plugins/custom.md index e569715ff32..257424bd78b 100644 --- a/app/_src/kubernetes-ingress-controller/plugins/custom.md +++ b/app/_src/kubernetes-ingress-controller/plugins/custom.md @@ -7,6 +7,9 @@ purpose: | Install a custom plugin in Kong without using a Docker build. +{:.note} +> The recommended way to install custom plugins is with {{ site.kgo_product_name }}. See [Kong custom plugin distribution with KongPluginInstallation](/gateway-operator/unreleased/guides/plugin-distribution/) for more information. + {% include md/custom-plugin.md %} 2. Create a ConfigMap or Secret with the plugin code. If you're not sure which option is correct, use a `ConfigMap`.