diff --git a/app/_data/docs_nav_kgo_1.3.x.yml b/app/_data/docs_nav_kgo_1.3.x.yml index 59baec4cb1bb..ae180316e291 100644 --- a/app/_data/docs_nav_kgo_1.3.x.yml +++ b/app/_data/docs_nav_kgo_1.3.x.yml @@ -120,6 +120,9 @@ items: - text: DataPlane url: /reference/custom-resources/#dataplane generate: false + - text: Configuration Options + url: /reference/cli-arguments/ + src: reference/cli-arguments/1.3.x - text: License url: /reference/license - text: Version Compatibility diff --git a/app/_data/docs_nav_kgo_1.4.x.yml b/app/_data/docs_nav_kgo_1.4.x.yml new file mode 100644 index 000000000000..4f23b6944880 --- /dev/null +++ b/app/_data/docs_nav_kgo_1.4.x.yml @@ -0,0 +1,132 @@ +product: gateway-operator +release: 1.4.x +generate: true +assume_generated: true +items: + - title: Introduction + icon: /assets/images/icons/documentation/icn-flag.svg + items: + - text: Overview + url: /gateway-operator/1.4.x/ + absolute_url: true + - text: Deployment Topologies + items: + - text: Hybrid Mode + url: /topologies/hybrid/ + - text: DB-less Mode + url: /topologies/dbless/ + - text: Key Concepts + items: + - text: Gateway API + url: /concepts/gateway-api + - text: Gateway Configuration + url: /concepts/gateway-configuration + - text: Managed Gateways + url: /concepts/managed-gateways + - text: Changelog + url: /gateway-operator/changelog + absolute_url: true + - text: Version Support Policy + url: /support + - text: FAQ + url: /faq + - title: Get Started + icon: /assets/images/icons/documentation/icn-learning.svg + items: + - text: Konnect + items: + - text: Install Gateway Operator + url: /get-started/konnect/install/ + - text: Deploy a Data Plane + url: /get-started/konnect/deploy-data-plane/ + - text: Create a Route + url: /get-started/konnect/create-route/ + - text: Kong Ingress Controller + items: + - text: Install Gateway Operator + url: /get-started/kic/install/ + - text: Create a Gateway + url: /get-started/kic/create-gateway/ + - text: Create a Route + url: /get-started/kic/create-route/ + - title: Production Deployment + icon: /assets/images/icons/icn-server.svg + items: + - text: Overview + url: /production/ + - text: Install + url: /install/ + - text: Enterprise License + url: /license/ + - text: Monitoring + items: + - text: Metrics + url: /production/monitoring/metrics/ + - text: Status fields + items: + - text: Overview + url: /production/monitoring/status/overview/ + - text: DataPlane + url: /production/monitoring/status/dataplane/ + - text: ControlPlane + url: /production/monitoring/status/controlplane/ + - text: Gateway + url: /production/monitoring/status/gateway/ + - text: Upgrade Gateway Operator + url: /production/upgrade/gateway-operator/ + - title: Guides + icon: /assets/images/icons/documentation/icn-solution-guide.svg + items: + - text: AI Gateway + url: /guides/ai-gateway/ + - text: Customization + items: + - text: Set data plane image + url: /customization/data-plane-image/ + - text: Deploying Sidecars + url: /customization/sidecars/ + - text: Customizing PodTemplateSpec + url: /customization/pod-template-spec/ + - text: Autoscaling Kong Gateway + url: /guides/autoscaling-kong/ + - text: Autoscaling Workloads + items: + - text: Overview + url: /guides/autoscaling-workloads/overview/ + - text: Prometheus + url: /guides/autoscaling-workloads/prometheus/ + - text: Datadog + url: /guides/autoscaling-workloads/datadog/ + - text: Upgrading Data Planes + items: + - text: Rolling Deployment + url: /guides/upgrade/data-plane/rolling/ + - text: Blue / Green Deployment + url: /guides/upgrade/data-plane/blue-green/ + - title: Reference + icon: /assets/images/icons/icn-magnifying-glass.svg + items: + - text: Custom Resources + items: + - text: Overview + url: /reference/custom-resources/ + src: reference/custom-resources/1.4.x + - text: GatewayConfiguration + url: /reference/custom-resources/#gatewayconfiguration + generate: false + - text: ControlPlane + url: /reference/custom-resources/#controlplane + generate: false + - text: DataPlane + url: /reference/custom-resources/#dataplane + generate: false + - text: KongPluginInstallation + url: /reference/custom-resources/#kongplugininstallation + generate: false + - text: Configuration Options + url: /reference/cli-arguments/ + src: reference/cli-arguments/1.4.x + - text: License + url: /reference/license + - text: Version Compatibility + url: /reference/version-compatibility diff --git a/app/_data/kong_versions.yml b/app/_data/kong_versions.yml index 2fbf953c51e4..2f51ceae28fc 100644 --- a/app/_data/kong_versions.yml +++ b/app/_data/kong_versions.yml @@ -307,6 +307,12 @@ releaseDate: "2024-06-24" endOfLifeDate: "2025-06-24" latest: true +- edition: gateway-operator + version: 1.4.0 + release: 1.4.x + releaseDate: "2024-10-28" + endOfLifeDate: "2025-10-28" + label: unreleased - edition: mesh version: 1.2.6 release: 1.2.x diff --git a/app/_src/gateway-operator/reference/cli-arguments/1.4.x.md b/app/_src/gateway-operator/reference/cli-arguments/1.4.x.md new file mode 100644 index 000000000000..f0d517557e81 --- /dev/null +++ b/app/_src/gateway-operator/reference/cli-arguments/1.4.x.md @@ -0,0 +1,61 @@ +--- +title: CLI Arguments +--- + +Learn about the various settings and configurations of the controller can be tweaked +using CLI flags. + +## Environment variables + +Each flag defined in the table below can also be configured using +an environment variable. The name of the environment variable is `GATEWAY_OPERATOR_` +string followed by the name of flag in uppercase. + +For example, `--enable-gateway-controller` can be configured using the following +environment variable: + +``` +GATEWAY_OPERATOR_ENABLE_GATEWAY_CONTROLLER=false +``` + +It is recommended that all the configuration is done through environment variables +and not CLI flags. + + + + + +## Flags + +| Flag | Type | Description | Default | +| ---- | ---- | ----------- | ------- | +| `--anonymous-reports` | `bool` | Send anonymized usage data to help improve Kong. | `true` | +| `--apiserver-host` | `string` | The Kubernetes API server URL. If not set, the operator will use cluster config discovery. | `""` | +| `--cluster-ca-secret` | `string` | Name of the Secret containing the cluster CA certificate. | `kong-operator-ca` | +| `--cluster-ca-secret-namespace` | `string` | Name of the namespace for Secret containing the cluster CA certificate. | `""` | +| `--controller-name` | `string` | Controller name to use if other than the default, only needed for multi-tenancy. | `""` | +| `--enable-controller-aigateway` | `bool` | Enable the AIGateway controller. (Experimental). | `false` | +| `--enable-controller-controlplane` | `bool` | Enable the ControlPlane controller. | `true` | +| `--enable-controller-controlplaneextensions` | `bool` | Enable the ControlPlane extensions controller. _Only supported by the Enterprise version of the Gateway Operator._ | `true` | +| `--enable-controller-dataplane` | `bool` | Enable the DataPlane controller. | `true` | +| `--enable-controller-dataplane-bluegreen` | `bool` | Enable the DataPlane BlueGreen controller. Mutually exclusive with DataPlane controller. | `true` | +| `--enable-controller-gateway` | `bool` | Enable the Gateway controller. | `true` | +| `--enable-controller-konglicense` | `bool` | Enable the Kong License controller. _Only supported by the Enterprise version of the Gateway Operator._ | `true` | +| `--enable-controller-kongplugininstallation` | `bool` | Enable the KongPluginInstallation controller. | `false` | +| `--enable-controller-konnect` | `bool` | Enable the Konnect controllers. | `false` | +| `--enable-validating-webhook` | `bool` | Enable the validating webhook. | `true` | +| `--health-probe-bind-address` | `string` | The address the probe endpoint binds to. | `:8081` | +| `--konnect-sync-period` | `string` | Sync period for Konnect entities. After a successful reconciliation of Konnect entities the controller will wait this duration before enforcing configuration on Konnect once again. | `1m0s` | +| `--kubeconfig` | `string` | Path to the kubeconfig file. | `""` | +| `--metrics-bind-address` | `string` | The address the metric endpoint binds to. | `:8080` | +| `--no-leader-election` | `bool` | Disable leader election for controller manager. Disabling this will not ensure there is only one active controller manager. | `false` | +| `--version` | `bool` | Print version information. | `false` | +| `--webhook-certificate-config-base-image` | `string` | The base image for the certgen Jobs. | `registry.k8s.io/ingress-nginx/kube-webhook-certgen:v1.3.0` | +| `--webhook-certificate-config-shell-image` | `string` | The shell image for the certgen Jobs. | `busybox` | +| `--zap-devel` | `bool` | Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error). | `false` | +| `--zap-encoder` | `string` | Zap log encoding (one of 'json' or 'console'). | `""` | +| `--zap-log-level` | `string` | Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity. | `""` | +| `--zap-stacktrace-level` | `string` | Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic'). | `""` | +| `--zap-time-encoding` | `string` | Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'. | `""` | + + 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 new file mode 100644 index 000000000000..e34b4d0e8cec --- /dev/null +++ b/app/_src/gateway-operator/reference/custom-resources/1.4.x.md @@ -0,0 +1,3294 @@ +--- +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. | +| `tags` _[Tags](#tags)_ | Tags is an optional set of tags applied to the consumer. | + + +_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 - kic | +| `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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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 KongRoute 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` _[Tags](#tags)_ | 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 KongRoute 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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` _[Tags](#tags)_ | 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) +- [DataPlaneMetricsExtension](#dataplanemetricsextension) +- [KongPluginInstallation](#kongplugininstallation) +- [KonnectExtension](#konnectextension) +### AIGateway + + +AIGateway is a network Gateway enabling access and management for AI & +Machine Learning models such as Large Language Models (LLM).

+The underlying technology for the AIGateway is the Kong Gateway configured +with a variety of plugins which provide the the AI featureset.

+This is a list of the plugins, which are available in Kong Gateway v3.6.x+:

+ - ai-proxy (https://github.com/kong/kong/tree/master/kong/plugins/ai-proxy) + - ai-request-transformer (https://github.com/kong/kong/tree/master/kong/plugins/ai-request-transformer) + - ai-response-transformers (https://github.com/kong/kong/tree/master/kong/plugins/ai-response-transformer) + - ai-prompt-template (https://github.com/kong/kong/tree/master/kong/plugins/ai-prompt-template) + - ai-prompt-guard-plugin (https://github.com/kong/kong/tree/master/kong/plugins/ai-prompt-guard) + - ai-prompt-decorator-plugin (https://github.com/kong/kong/tree/master/kong/plugins/ai-prompt-decorator)

+So effectively the AIGateway resource provides a bespoke Gateway resource +(which it owns and manages) with the gateway, consumers and plugin +configurations automated and configurable via Kubernetes APIs.

+The current iteration only supports the proxy itself, but the API is being +built with room for future growth in several dimensions. For instance:

+ - Supporting auxiliary functions (e.g. decorator, guard, templater, token-rate-limit) + - Supporting request/response transformers + - Supporting more than just LLMs (e.g. CCNs, GANs, e.t.c.) + - Supporting more hosting options for LLMs (e.g. self hosted) + - Supporting more AI cloud providers + - Supporting more AI cloud provider features

+The validation rules throughout are set up to ensure at least one +cloud-provider-based LLM is specified, but in the future when we have more +model types and more hosting options for those types so we may want to look +into using CEL validation to ensure that at least one model configuration is +provided. We may also want to use CEL to validate things like identifier +unique-ness, e.t.c.

+See: https://kubernetes.io/docs/reference/using-api/cel/ + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1alpha1` +| `kind` _string_ | `AIGateway` +| `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` _[AIGatewaySpec](#aigatewayspec)_ | Spec is the desired state of the AIGateway. | +| `status` _[AIGatewayStatus](#aigatewaystatus)_ | Status is the observed state of the AIGateway. | + + + +### DataPlaneMetricsExtension + + +DataPlaneMetricsExtension holds the configuration for the DataPlane metrics extension. +It can be attached to a ControlPlane using its spec.extensions. +When attached it will make the ControlPlane configure its DataPlane with +the specified metrics configuration. +Additionally, it will also make the operator expose DataPlane's metrics +enriched with metadata required for in-cluster Kubernetes autoscaling.

+NOTE: This is an enterprise feature. In order to use it you need to use +the EE version of Kong Gateway Operator with a valid license. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1alpha1` +| `kind` _string_ | `DataPlaneMetricsExtension` +| `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` _[DataPlaneMetricsExtensionSpec](#dataplanemetricsextensionspec)_ | | +| `status` _[DataPlaneMetricsExtensionStatus](#dataplanemetricsextensionstatus)_ | | + + + +### 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)_ | | + + + +### KonnectExtension + + +KonnectExtension is the Schema for the KonnectExtension API, +and is intended to be referenced as extension by the dataplane API. +If a DataPlane successfully refers a KonnectExtension, the DataPlane +deployment spec gets customized to include the konnect-related configuration. + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1alpha1` +| `kind` _string_ | `KonnectExtension` +| `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` _[KonnectExtensionSpec](#konnectextensionspec)_ | Spec is the specification of the KonnectExtension resource. | +| `status` _[KonnectExtensionStatus](#konnectextensionstatus)_ | Status is the status of the KonnectExtension resource. | + + + +### Types + +In this section you will find types that the CRDs rely on. +#### AICloudProvider + + +AICloudProvider is the organization that provides API access to Large Language +Models (LLMs). + + + +| Field | Description | +| --- | --- | +| `name` _[AICloudProviderName](#aicloudprovidername)_ | Name is the unique name of an LLM provider. | + + +_Appears in:_ +- [CloudHostedLargeLanguageModel](#cloudhostedlargelanguagemodel) + +#### AICloudProviderAPITokenRef + + +AICloudProviderAPITokenRef is an reference to another object which contains +the API token for an AI cloud provider. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the reference object. | +| `namespace` _string_ | Namespace is the namespace of the reference object.

If not specified, it will be assumed to be the same namespace as the object which references it. | +| `kind` _string_ | Kind is the API object kind

If not specified, it will be assumed to be "Secret". If a Secret is used as the Kind, the secret must contain a single key-value pair where the value is the secret API token. The key can be named anything, as long as there's only one entry, but by convention it should be "apiToken". | + + +_Appears in:_ +- [AIGatewaySpec](#aigatewayspec) + +#### AICloudProviderName +_Underlying type:_ `string` + +AICloudProviderName indicates the unique name of a supported AI cloud +provider. + + + + + +_Appears in:_ +- [AICloudProvider](#aicloudprovider) + +#### AIGatewayConsumerRef + + +AIGatewayConsumerRef indicates the Secret resource containing the credentials +for the Kong consumer. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the reference object. | +| `namespace` _string_ | Namespace is the namespace of the reference object. | + + +_Appears in:_ +- [AIGatewayEndpoint](#aigatewayendpoint) + +#### AIGatewayEndpoint + + +AIGatewayEndpoint is a network endpoint for accessing an AIGateway. + + + +| Field | Description | +| --- | --- | +| `network` _[EndpointNetworkAccessHint](#endpointnetworkaccesshint)_ | NetworkAccessHint is a hint to the user about what kind of network access is expected for the reachability of this endpoint. | +| `url` _string_ | URL is the URL to access the endpoint from the network indicated by the NetworkAccessHint. | +| `models` _string array_ | AvailableModels is a list of the identifiers of all the AI models that are accessible from this endpoint. | +| `consumer` _[AIGatewayConsumerRef](#aigatewayconsumerref)_ | Consumer is a reference to the Secret that contains the credentials for the Kong consumer that is allowed to access this endpoint. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the AIGatewayEndpoint.

Known condition types are:

- "Provisioning" - "EndpointReady" | + + +_Appears in:_ +- [AIGatewayStatus](#aigatewaystatus) + +#### AIGatewaySpec + + +AIGatewaySpec defines the desired state of an AIGateway. + + + +| Field | Description | +| --- | --- | +| `gatewayClassName` _string_ | GatewayClassName is the name of the GatewayClass which is responsible for the AIGateway. | +| `largeLanguageModels` _[LargeLanguageModels](#largelanguagemodels)_ | LargeLanguageModels is a list of Large Language Models (LLMs) to be managed by the AI Gateway.

This is a required field because we only support LLMs at the moment. In future iterations we may support other model types. | +| `cloudProviderCredentials` _[AICloudProviderAPITokenRef](#aicloudproviderapitokenref)_ | CloudProviderCredentials is a reference to an object (e.g. a Kubernetes Secret) which contains the credentials needed to access the APIs of cloud providers.

This is the global configuration that will be used by DEFAULT for all model configurations. A secret configured this way MAY include any number of key-value pairs equal to the number of providers you have, but used this way the keys MUST be named according to their providers (e.g. "openai", "azure", "cohere", e.t.c.). For example:

apiVersion: v1 kind: Secret metadata: name: devteam-ai-cloud-providers type: Opaque data: openai: ***************** azure: ***************** cohere: *****************

See AICloudProviderName for a list of known and valid cloud providers.

Note that the keys are NOT case-sensitive (e.g. "OpenAI", "openai", and "openAI" are all valid and considered the same keys) but if there are duplicates endpoints failures conditions will be emitted and endpoints will not be configured until the duplicates are resolved.

This is currently considered required, but in future iterations will be optional as we do things like enable configuring credentials at the model level. | + + +_Appears in:_ +- [AIGateway](#aigateway) + +#### AIGatewayStatus + + +AIGatewayStatus defines the observed state of AIGateway. + + + +| Field | Description | +| --- | --- | +| `endpoints` _[AIGatewayEndpoint](#aigatewayendpoint) array_ | Endpoints are collections of the URL, credentials and metadata needed in order to access models served by the AIGateway for inference. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions describe the current conditions of the AIGateway.

Known condition types are:

- "Accepted" - "Provisioning" - "EndpointsReady" | + + +_Appears in:_ +- [AIGateway](#aigateway) + +#### CloudHostedLargeLanguageModel + + +CloudHostedLargeLanguageModel is the configuration for Large Language Models +(LLM) hosted by a known and supported AI cloud provider (e.g. OpenAI, Cohere, +Azure, e.t.c.). + + + +| Field | Description | +| --- | --- | +| `identifier` _string_ | Identifier is the unique name which identifies the LLM. This will be used as part of the requests made to an AIGateway endpoint. For instance: if you provided the identifier "devteam-gpt-access", then you would access this model via "https://${endpoint}/devteam-gpt-access" and supply it with your consumer credentials to authenticate requests. | +| `model` _string_ | Model is the model name of the LLM (e.g. gpt-3.5-turbo, phi-2, e.t.c.).

If not specified, whatever the cloud provider specifies as the default model will be used. | +| `promptType` _[LLMPromptType](#llmprompttype)_ | PromptType is the type of prompt to be used for inference requests to the LLM (e.g. "chat", "completions").

If "chat" is specified, prompts sent by the user will be interactive, contextual and stateful. The LLM will dynamically answer questions and simulate a dialogue, while also keeping track of the conversation to provide contextually relevant responses.

If "completions" is specified, prompts sent by the user will be stateless and "one-shot". The LLM will provide a single response to the prompt, without any context from previous prompts.

If not specified, "completions" will be used as the default. | +| `defaultPrompts` _[LLMPrompt](#llmprompt) array_ | DefaultPrompts is a list of prompts that should be provided to the LLM by default. This is generally used to influence inference behavior, for instance by providing a "system" role prompt that instructs the LLM to take on a certain persona. | +| `defaultPromptParams` _[LLMPromptParams](#llmpromptparams)_ | DefaultPromptParams configures the parameters which will be sent with any and every inference request.

If this is set, there is currently no way to override these parameters at the individual prompt level. This is an expected feature from later releases of our AI plugins. | +| `aiCloudProvider` _[AICloudProvider](#aicloudprovider)_ | AICloudProvider defines the cloud provider that will fulfill the LLM requests for this CloudHostedLargeLanguageModel | + + +_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) + +#### DataPlaneMetricsExtensionSpec + + +DataPlaneMetricsExtensionSpec defines the spec for the DataPlaneMetricsExtension. + + + +| Field | Description | +| --- | --- | +| `serviceSelector` _[ServiceSelector](#serviceselector)_ | ServiceSelector holds the service selector specifying the services for which metrics should be collected. | +| `config` _[MetricsConfig](#metricsconfig)_ | Config holds the configuration for the DataPlane metrics. | + + +_Appears in:_ +- [DataPlaneMetricsExtension](#dataplanemetricsextension) + +#### DataPlaneMetricsExtensionStatus + + +DataPlaneMetricsExtensionStatus defines the status of the DataPlaneMetricsExtension. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[NamespacedRef](#namespacedref)_ | ControlPlaneRef is a reference to the ControlPlane that this is associated with. This field is set by the operator when this extension is associated with a ControlPlane through its extensions spec. There can only be one ControlPlane associated with a given DataPlaneMetricsExtension. When this is unset it means that the association has been removed. | + + +_Appears in:_ +- [DataPlaneMetricsExtension](#dataplanemetricsextension) + +#### EndpointNetworkAccessHint +_Underlying type:_ `string` + +EndpointNetworkAccessHint provides a human readable indication of what kind +of network access is expected for a Gateway.

+This isn't meant to reflect knowledge of any specific network by name, which +is why it includes "hint" in the name. It's meant to be a hint to the user +such as "internet-accessible", "internal-only". + + + + + +_Appears in:_ +- [AIGatewayEndpoint](#aigatewayendpoint) + + + + + + + +#### KongPluginInstallationSpec + + +KongPluginInstallationSpec provides the information necessary to retrieve and install a Kong custom plugin. + + + +| Field | Description | +| --- | --- | +| `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:_ +- [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)_ | ClusterCertificateSecretRef is the reference to the Secret containing the Konnect Control Plane's cluster certificate. | + + +_Appears in:_ +- [KonnectExtensionSpec](#konnectextensionspec) + +#### KonnectExtensionSpec + + +KonnectExtensionSpec defines the desired state of KonnectExtension. + + + +| Field | Description | +| --- | --- | +| `controlPlaneRef` _[ControlPlaneRef](#controlplaneref)_ | ControlPlaneRef is a reference to a ControlPlane this KonnectExtension 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:_ +- [KonnectExtension](#konnectextension) + +#### KonnectExtensionStatus + + +KonnectExtensionStatus defines the observed state of KonnectExtension. + + + +| 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:_ +- [KonnectExtension](#konnectextension) + +#### LLMPrompt + + +LLMPrompt is a text prompt that includes parameters, a role and content.

+This is intended for situations like when you need to provide roles in a +prompt to an LLM in order to influence its behavior and responses.

+For example, you might want to provide a "system" role and tell the LLM +something like "you are a helpful assistant who responds in the style of +Sherlock Holmes". + + + +| Field | Description | +| --- | --- | +| `content` _string_ | Content is the prompt text sent for inference. | +| `role` _[LLMPromptRole](#llmpromptrole)_ | Role indicates the role of the prompt. This is used to identify the prompt's purpose, such as "system" or "user" and can influence the behavior of the LLM.

If not specified, "user" will be used as the default. | + + +_Appears in:_ +- [CloudHostedLargeLanguageModel](#cloudhostedlargelanguagemodel) + +#### LLMPromptParams + + +LLMPromptParams contains parameters that can be used to control the behavior +of a large language model (LLM) when generating text based on a prompt. + + + +| Field | Description | +| --- | --- | +| `temperature` _string_ | Temperature controls the randomness of predictions by scaling the logits before applying softmax. A lower temperature (e.g., 0.0 to 0.7) makes the model more confident in its predictions, leading to more repetitive and deterministic outputs. A higher temperature (e.g., 0.8 to 1.0) increases randomness, generating more diverse and creative outputs. At very high temperatures, the outputs may become nonsensical or highly unpredictable. | +| `maxTokens` _integer_ | Max Tokens specifies the maximum length of the model's output in terms of the number of tokens (words or pieces of words). This parameter limits the output's size, ensuring the model generates content within a manageable scope. A token can be a word or part of a word, depending on the model's tokenizer. | +| `topK` _integer_ | TopK sampling is a technique where the model's prediction is limited to the K most likely next tokens at each step of the generation process. The probability distribution is truncated to these top K tokens, and the next token is randomly sampled from this subset. This method helps in reducing the chance of selecting highly improbable tokens, making the text more coherent. A smaller K leads to more predictable text, while a larger K allows for more diversity but with an increased risk of incoherence. | +| `topP` _string_ | TopP (also known as nucleus sampling) is an alternative to top K sampling. Instead of selecting the top K tokens, top P sampling chooses from the smallest set of tokens whose cumulative probability exceeds the threshold P. This method dynamically adjusts the number of tokens considered at each step, depending on their probability distribution. It helps in maintaining diversity while also avoiding very unlikely tokens. A higher P value increases diversity but can lead to less coherence, whereas a lower P value makes the model's outputs more focused and coherent. | + + +_Appears in:_ +- [CloudHostedLargeLanguageModel](#cloudhostedlargelanguagemodel) + +#### LLMPromptRole +_Underlying type:_ `string` + +LLMPromptRole indicates the role of a prompt for a large language model (LLM). + + + + + +_Appears in:_ +- [LLMPrompt](#llmprompt) + +#### LLMPromptType +_Underlying type:_ `string` + +LLMPromptType indicates the type of prompt to be used for a large +language model (LLM). + + + + + +_Appears in:_ +- [CloudHostedLargeLanguageModel](#cloudhostedlargelanguagemodel) + +#### LargeLanguageModels + + +LargeLanguageModels is a list of Large Language Models (LLM) hosted in +various ways (cloud hosted, self hosted, e.t.c.) which the AIGateway should +serve and manage traffic for. + + + +| Field | Description | +| --- | --- | +| `cloudHosted` _[CloudHostedLargeLanguageModel](#cloudhostedlargelanguagemodel) array_ | CloudHosted configures LLMs hosted and served by cloud providers.

This is currently a required field, requiring at least one cloud-hosted LLM be specified, however in future iterations we may add other hosting options such as self-hosted LLMs as separate fields. | + + +_Appears in:_ +- [AIGatewaySpec](#aigatewayspec) + +#### MetricsConfig + + +MetricsConfig holds the configuration for the DataPlane metrics. + + + +| Field | Description | +| --- | --- | +| `latency` _boolean_ | Latency indicates whether latency metrics are enabled for the DataPlane. This translates into deployed instances having `latency_metrics` option set on the Prometheus plugin. | +| `bandwidth` _boolean_ | Bandwidth indicates whether bandwidth metrics are enabled for the DataPlane. This translates into deployed instances having `bandwidth_metrics` option set on the Prometheus plugin. | +| `upstreamHealth` _boolean_ | UpstreamHealth indicates whether upstream health metrics are enabled for the DataPlane. This translates into deployed instances having `upstream_health_metrics` option set on the Prometheus plugin. | +| `statusCode` _boolean_ | StatusCode indicates whether status code metrics are enabled for the DataPlane. This translates into deployed instances having `status_code_metrics` option set on the Prometheus plugin. | + + +_Appears in:_ +- [DataPlaneMetricsExtensionSpec](#dataplanemetricsextensionspec) + +#### NamespacedRef + + +NamespacedRef is a reference to a namespaced resource. + + + +| Field | Description | +| --- | --- | +| `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. | + + +_Appears in:_ +- [DataPlaneMetricsExtensionStatus](#dataplanemetricsextensionstatus) +- [ExtensionRef](#extensionref) +- [KonnectExtensionStatus](#konnectextensionstatus) + +#### ServiceSelector + + +ServiceSelector holds the service selector specification. + + + +| Field | Description | +| --- | --- | +| `matchNames` _[ServiceSelectorEntry](#serviceselectorentry) array_ | MatchNames holds the list of Services names to match. | + + +_Appears in:_ +- [DataPlaneMetricsExtensionSpec](#dataplanemetricsextensionspec) + +#### ServiceSelectorEntry + + +ServiceSelectorEntry holds the name of a service to match. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name is the name of the service to match. | + + +_Appears in:_ +- [ServiceSelector](#serviceselector) + + +## gateway-operator.konghq.com/v1beta1 + +Package v1beta1 contains API Schema definitions for the gateway-operator.konghq.com v1beta1 API group + +- [ControlPlane](#controlplane) +- [DataPlane](#dataplane) +- [GatewayConfiguration](#gatewayconfiguration) +### ControlPlane + + +ControlPlane is the Schema for the controlplanes API + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1beta1` +| `kind` _string_ | `ControlPlane` +| `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` _[ControlPlaneSpec](#controlplanespec)_ | | +| `status` _[ControlPlaneStatus](#controlplanestatus)_ | | + + + +### DataPlane + + +DataPlane is the Schema for the dataplanes API + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1beta1` +| `kind` _string_ | `DataPlane` +| `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` _[DataPlaneSpec](#dataplanespec)_ | | +| `status` _[DataPlaneStatus](#dataplanestatus)_ | | + + + +### GatewayConfiguration + + +GatewayConfiguration is the Schema for the gatewayconfigurations API + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `gateway-operator.konghq.com/v1beta1` +| `kind` _string_ | `GatewayConfiguration` +| `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` _[GatewayConfigurationSpec](#gatewayconfigurationspec)_ | | +| `status` _[GatewayConfigurationStatus](#gatewayconfigurationstatus)_ | | + + + +### Types + +In this section you will find types that the CRDs rely on. +#### Address + + +Address describes an address which can be either an IP address or a hostname. + + + +| Field | Description | +| --- | --- | +| `type` _[AddressType](#addresstype)_ | Type of the address. | +| `value` _string_ | Value of the address. The validity of the values will depend on the type and support by the controller.

Examples: `1.2.3.4`, `128::1`, `my-ip-address`. | +| `sourceType` _[AddressSourceType](#addresssourcetype)_ | Source type of the address. | + + +_Appears in:_ +- [DataPlaneStatus](#dataplanestatus) +- [RolloutStatusService](#rolloutstatusservice) + +#### AddressSourceType +_Underlying type:_ `string` + +AddressSourceType defines the type of source this address represents.

+Can be one of:

+* `PublicLoadBalancer` +* `PrivateLoadBalancer` +* `PublicIP` +* `PrivateIP` + + + + + +_Appears in:_ +- [Address](#address) + +#### AddressType +_Underlying type:_ `string` + +AddressType defines how a network address is represented as a text string.

+Can be one of:

+* `IPAddress` +* `Hostname` + + + + + +_Appears in:_ +- [Address](#address) + +#### BlueGreenStrategy + + +BlueGreenStrategy defines the Blue Green deployment strategy. + + + +| Field | Description | +| --- | --- | +| `promotion` _[Promotion](#promotion)_ | Promotion defines how the operator handles promotion of resources. | +| `resources` _[RolloutResources](#rolloutresources)_ | Resources controls what happens to operator managed resources during or after a rollout. | + + +_Appears in:_ +- [RolloutStrategy](#rolloutstrategy) + +#### ControlPlaneDeploymentOptions + + +ControlPlaneDeploymentOptions is a shared type used on objects to indicate that their +configuration results in a Deployment which is managed by the Operator and +includes options for managing Deployments such as the the number of replicas +or pod options like container image and resource requirements. +version, as well as Env variable overrides. + + + +| Field | Description | +| --- | --- | +| `replicas` _integer_ | Replicas describes the number of desired pods. This is a pointer to distinguish between explicit zero and not specified. This only affects the DataPlane deployments for now, for more details on ControlPlane scaling please see https://github.com/Kong/gateway-operator/issues/736. | +| `podTemplateSpec` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | PodTemplateSpec defines PodTemplateSpec for Deployment's pods. | + + +_Appears in:_ +- [ControlPlaneOptions](#controlplaneoptions) +- [ControlPlaneSpec](#controlplanespec) + +#### ControlPlaneOptions + + +ControlPlaneOptions indicates the specific information needed to +deploy and connect a ControlPlane to a DataPlane object. + + + +| Field | Description | +| --- | --- | +| `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 array_ | Extensions provide additional or replacement features for the ControlPlane resources to influence or enhance functionality. | + + +_Appears in:_ +- [ControlPlaneSpec](#controlplanespec) +- [GatewayConfigurationSpec](#gatewayconfigurationspec) + +#### ControlPlaneSpec + + +ControlPlaneSpec defines the desired state of ControlPlane + + + +| Field | Description | +| --- | --- | +| `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 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. | + + +_Appears in:_ +- [ControlPlane](#controlplane) + +#### ControlPlaneStatus + + +ControlPlaneStatus defines the observed state of ControlPlane + + + +| 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 Gateway. | + + +_Appears in:_ +- [ControlPlane](#controlplane) + +#### DataPlaneDeploymentOptions + + +DataPlaneDeploymentOptions specifies options for the Deployments (as in the Kubernetes +resource "Deployment") which are created and managed for the DataPlane resource. + + + +| Field | Description | +| --- | --- | +| `rollout` _[Rollout](#rollout)_ | Rollout describes a custom rollout strategy. | +| `replicas` _integer_ | Replicas describes the number of desired pods. This is a pointer to distinguish between explicit zero and not specified. This is effectively shorthand for setting a scaling minimum and maximum to the same value. This field and the scaling field are mutually exclusive: You can only configure one or the other. | +| `scaling` _[Scaling](#scaling)_ | Scaling defines the scaling options for the deployment. | +| `podTemplateSpec` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | PodTemplateSpec defines PodTemplateSpec for Deployment's pods. It's being applied on top of the generated Deployments using [StrategicMergePatch](https://pkg.go.dev/k8s.io/apimachinery/pkg/util/strategicpatch#StrategicMergePatch). | + + +_Appears in:_ +- [DataPlaneOptions](#dataplaneoptions) +- [DataPlaneSpec](#dataplanespec) +- [GatewayConfigDataPlaneOptions](#gatewayconfigdataplaneoptions) + +#### DataPlaneNetworkOptions + + +DataPlaneNetworkOptions defines network related options for a DataPlane. + + + +| Field | Description | +| --- | --- | +| `services` _[DataPlaneServices](#dataplaneservices)_ | Services indicates the configuration of Kubernetes Services needed for the topology of various forms of traffic (including ingress, e.t.c.) to and from the DataPlane. | +| `konnectCertificate` _[KonnectCertificateOptions](#konnectcertificateoptions)_ | KonnectCA is the certificate authority that the operator uses to provision client certificates the DataPlane will use to authenticate itself to the Konnect API. Requires Enterprise. | + + +_Appears in:_ +- [DataPlaneOptions](#dataplaneoptions) +- [DataPlaneSpec](#dataplanespec) + +#### DataPlaneOptions + + +DataPlaneOptions defines the information specifically needed to +deploy the DataPlane. + + + +| Field | Description | +| --- | --- | +| `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 (KonnectExtension), 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 + + +DataPlaneRolloutStatus describes the DataPlane rollout status. + + + +| Field | Description | +| --- | --- | +| `services` _[DataPlaneRolloutStatusServices](#dataplanerolloutstatusservices)_ | Services contain the information about the services which are available through which user can access the preview deployment. | +| `deployment` _[DataPlaneRolloutStatusDeployment](#dataplanerolloutstatusdeployment)_ | Deployment contains the information about the preview deployment. | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions contains the status conditions about the rollout. | + + +_Appears in:_ +- [DataPlaneStatus](#dataplanestatus) + +#### DataPlaneRolloutStatusDeployment + + +DataPlaneRolloutStatusDeployment is a rollout status field which contains +fields specific for Deployments during the rollout. + + + +| Field | Description | +| --- | --- | +| `selector` _string_ | Selector is a stable label selector value assigned to a DataPlane rollout status which is used throughout the rollout as a deterministic labels selector for Services and Deployments. | + + +_Appears in:_ +- [DataPlaneRolloutStatus](#dataplanerolloutstatus) + +#### DataPlaneRolloutStatusServices + + +DataPlaneRolloutStatusServices describes the status of the services during +DataPlane rollout. + + + +| Field | Description | +| --- | --- | +| `ingress` _[RolloutStatusService](#rolloutstatusservice)_ | Ingress contains the name and the address of the preview service for ingress. Using this service users can send requests that will hit the preview deployment. | +| `adminAPI` _[RolloutStatusService](#rolloutstatusservice)_ | AdminAPI contains the name and the address of the preview service for Admin API. Using this service users can send requests to configure the DataPlane's preview deployment. | + + +_Appears in:_ +- [DataPlaneRolloutStatus](#dataplanerolloutstatus) + +#### DataPlaneServiceOptions + + +DataPlaneServiceOptions contains Services related DataPlane configuration. + + + +| Field | Description | +| --- | --- | +| `ports` _[DataPlaneServicePort](#dataplaneserviceport) array_ | Ports defines the list of ports that are exposed by the service. The ports field allows defining the name, port and targetPort of the underlying service ports, while the protocol is defaulted to TCP, as it is the only protocol currently supported. | +| `type` _[ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#servicetype-v1-core)_ | Type determines how the Service is exposed. Defaults to `LoadBalancer`.

Valid options are `LoadBalancer` and `ClusterIP`.

`ClusterIP` allocates a cluster-internal IP address for load-balancing to endpoints.

`LoadBalancer` builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | +| `annotations` _object (keys:string, values:string)_ | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: http://kubernetes.io/docs/user-guide/annotations | +| `externalTrafficPolicy` _[ServiceExternalTrafficPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#serviceexternaltrafficpolicy-v1-core)_ | ExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.

More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip | + + +_Appears in:_ +- [DataPlaneServices](#dataplaneservices) + +#### DataPlaneServicePort + + +DataPlaneServicePort contains information on service's port. + + + +| Field | Description | +| --- | --- | +| `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](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:_ +- [DataPlaneServiceOptions](#dataplaneserviceoptions) + +#### DataPlaneServices + + +DataPlaneServices contains Services related DataPlane configuration, shared with the GatewayConfiguration. + + + +| Field | Description | +| --- | --- | +| `ingress` _[DataPlaneServiceOptions](#dataplaneserviceoptions)_ | Ingress is the Kubernetes Service that will be used to expose ingress traffic for the DataPlane. Here you can determine whether the DataPlane will be exposed outside the cluster (e.g. using a LoadBalancer type Services) or only internally (e.g. ClusterIP), and inject any additional annotations you need on the service (for instance, if you need to influence a cloud provider LoadBalancer configuration). | + + +_Appears in:_ +- [DataPlaneNetworkOptions](#dataplanenetworkoptions) + +#### DataPlaneSpec + + +DataPlaneSpec defines the desired state of DataPlane + + + +| Field | Description | +| --- | --- | +| `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 (KonnectExtension), 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:_ +- [DataPlane](#dataplane) + +#### DataPlaneStatus + + +DataPlaneStatus defines the observed state of DataPlane + + + +| Field | Description | +| --- | --- | +| `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, 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. | + + +_Appears in:_ +- [DataPlane](#dataplane) + +#### DeploymentOptions + + +DeploymentOptions is a shared type used on objects to indicate that their +configuration results in a Deployment which is managed by the Operator and +includes options for managing Deployments such as the number of replicas +or pod options like container image and resource requirements. +version, as well as Env variable overrides. + + + +| Field | Description | +| --- | --- | +| `replicas` _integer_ | Replicas describes the number of desired pods. This is a pointer to distinguish between explicit zero and not specified. This is effectively shorthand for setting a scaling minimum and maximum to the same value. This field and the scaling field are mutually exclusive: You can only configure one or the other. | +| `scaling` _[Scaling](#scaling)_ | Scaling defines the scaling options for the deployment. | +| `podTemplateSpec` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | PodTemplateSpec defines PodTemplateSpec for Deployment's pods. It's being applied on top of the generated Deployments using [StrategicMergePatch](https://pkg.go.dev/k8s.io/apimachinery/pkg/util/strategicpatch#StrategicMergePatch). | + + +_Appears in:_ +- [DataPlaneDeploymentOptions](#dataplanedeploymentoptions) + +#### GatewayConfigDataPlaneNetworkOptions + + +GatewayConfigDataPlaneNetworkOptions defines network related options for a DataPlane. + + + +| Field | Description | +| --- | --- | +| `services` _[GatewayConfigDataPlaneServices](#gatewayconfigdataplaneservices)_ | Services indicates the configuration of Kubernetes Services needed for the topology of various forms of traffic (including ingress, etc.) to and from the DataPlane. | + + +_Appears in:_ +- [GatewayConfigDataPlaneOptions](#gatewayconfigdataplaneoptions) + +#### GatewayConfigDataPlaneOptions + + +GatewayConfigDataPlaneOptions indicates the specific information needed to +configure and deploy a DataPlane object. + + + +| Field | Description | +| --- | --- | +| `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 (KonnectExtension), 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:_ +- [GatewayConfigurationSpec](#gatewayconfigurationspec) + +#### GatewayConfigDataPlaneServices + + +GatewayConfigDataPlaneServices contains Services related DataPlane configuration. + + + +| Field | Description | +| --- | --- | +| `ingress` _[GatewayConfigServiceOptions](#gatewayconfigserviceoptions)_ | Ingress is the Kubernetes Service that will be used to expose ingress traffic for the DataPlane. Here you can determine whether the DataPlane will be exposed outside the cluster (e.g. using a LoadBalancer type Services) or only internally (e.g. ClusterIP), and inject any additional annotations you need on the service (for instance, if you need to influence a cloud provider LoadBalancer configuration). | + + +_Appears in:_ +- [GatewayConfigDataPlaneNetworkOptions](#gatewayconfigdataplanenetworkoptions) + +#### GatewayConfigServiceOptions + + +GatewayConfigServiceOptions is used to includes options to customize the ingress service, +such as the annotations. + + + +| Field | Description | +| --- | --- | +| `type` _[ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#servicetype-v1-core)_ | Type determines how the Service is exposed. Defaults to `LoadBalancer`.

Valid options are `LoadBalancer` and `ClusterIP`.

`ClusterIP` allocates a cluster-internal IP address for load-balancing to endpoints.

`LoadBalancer` builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | +| `annotations` _object (keys:string, values:string)_ | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: http://kubernetes.io/docs/user-guide/annotations | +| `externalTrafficPolicy` _[ServiceExternalTrafficPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#serviceexternaltrafficpolicy-v1-core)_ | ExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.

More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip | + + +_Appears in:_ +- [GatewayConfigDataPlaneServices](#gatewayconfigdataplaneservices) + +#### GatewayConfigurationSpec + + +GatewayConfigurationSpec defines the desired state of GatewayConfiguration + + + +| Field | Description | +| --- | --- | +| `dataPlaneOptions` _[GatewayConfigDataPlaneOptions](#gatewayconfigdataplaneoptions)_ | DataPlaneOptions is the specification for configuration overrides for DataPlane resources that will be created for the Gateway. | +| `controlPlaneOptions` _[ControlPlaneOptions](#controlplaneoptions)_ | ControlPlaneOptions is the specification for configuration overrides for ControlPlane resources that will be created for the Gateway. | + + +_Appears in:_ +- [GatewayConfiguration](#gatewayconfiguration) + +#### GatewayConfigurationStatus + + +GatewayConfigurationStatus defines the observed state of GatewayConfiguration + + + +| 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 GatewayConfigurationStatus. | + + +_Appears in:_ +- [GatewayConfiguration](#gatewayconfiguration) + + + +#### HorizontalScaling + + +HorizontalScaling defines horizontal scaling options for the deployment. +It holds all the options from the HorizontalPodAutoscalerSpec besides the +ScaleTargetRef which is being controlled by the Operator. + + + +| Field | Description | +| --- | --- | +| `minReplicas` _integer_ | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. | +| `maxReplicas` _integer_ | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. | +| `metrics` _[MetricSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#metricspec-v2-autoscaling) array_ | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. | +| `behavior` _[HorizontalPodAutoscalerBehavior](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#horizontalpodautoscalerbehavior-v2-autoscaling)_ | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. | + + +_Appears in:_ +- [Scaling](#scaling) + +#### KonnectCertificateOptions + + +KonnectCertificateOptions indicates how the operator should manage the certificates that managed entities will use +to interact with Konnect. + + + +| Field | Description | +| --- | --- | +| `issuer` _[NamespacedName](#namespacedname)_ | Issuer is the cert-manager Issuer or ClusterIssuer the operator will use to request certificates. When Namespace is set, the operator will retrieve the Issuer with that Name in that Namespace. When Namespace is omitted, the operator will retrieve the ClusterIssuer with that name. | + + +_Appears in:_ +- [DataPlaneNetworkOptions](#dataplanenetworkoptions) + +#### NamespacedName + + +NamespacedName is a resource identified by name and optional namespace. + + + +| Field | Description | +| --- | --- | +| `namespace` _string_ | | +| `name` _string_ | | + + +_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 + + +Promotion is a type that contains fields that define how the operator handles +promotion of resources during a blue/green rollout. + + + +| Field | Description | +| --- | --- | +| `strategy` _[PromotionStrategy](#promotionstrategy)_ | Strategy indicates how you want the operator to handle the promotion of the preview (green) resources (Deployments and Services) after all workflows and tests succeed, OR if you even want it to break before performing the promotion to allow manual inspection. | + + +_Appears in:_ +- [BlueGreenStrategy](#bluegreenstrategy) + +#### PromotionStrategy +_Underlying type:_ `string` + +PromotionStrategy is the type of promotion strategy consts.

+Allowed values:

+ - `BreakBeforePromotion` is a promotion strategy which will ensure all new + resources are ready and then break, to enable manual inspection. + The user must indicate manually when they want the promotion to continue. + That can be done by annotating the `DataPlane` object with + `"gateway-operator.konghq.com/promote-when-ready": "true"`. + + + + + +_Appears in:_ +- [Promotion](#promotion) + +#### Rollout + + +Rollout defines options for rollouts. + + + +| Field | Description | +| --- | --- | +| `strategy` _[RolloutStrategy](#rolloutstrategy)_ | Strategy contains the deployment strategy for rollout. | + + +_Appears in:_ +- [DataPlaneDeploymentOptions](#dataplanedeploymentoptions) + +#### RolloutResourcePlan + + +RolloutResourcePlan is a type that holds rollout resource plan related fields +which control how the operator handles resources during and after a rollout. + + + +| Field | Description | +| --- | --- | +| `deployment` _[RolloutResourcePlanDeployment](#rolloutresourceplandeployment)_ | Deployment describes how the operator manages Deployments during and after a rollout. | + + +_Appears in:_ +- [RolloutResources](#rolloutresources) + +#### RolloutResourcePlanDeployment +_Underlying type:_ `string` + +RolloutResourcePlanDeployment is the type that holds the resource plan for +managing the Deployment objects during and after a rollout.

+Allowed values:

+ - `ScaleDownOnPromotionScaleUpOnRollout` is a rollout + resource plan for Deployment which makes the operator scale down + the Deployment to 0 when the rollout is not initiated by a spec change + and then to scale it up when the rollout is initiated (the owner resource + like a DataPlane is patched or updated). + + + + + +_Appears in:_ +- [RolloutResourcePlan](#rolloutresourceplan) + +#### RolloutResources + + +RolloutResources is the type which contains the fields which control how the operator +manages the resources it manages during or after the rollout concludes. + + + +| Field | Description | +| --- | --- | +| `plan` _[RolloutResourcePlan](#rolloutresourceplan)_ | Plan defines the resource plan for managing resources during and after a rollout. | + + +_Appears in:_ +- [BlueGreenStrategy](#bluegreenstrategy) + +#### RolloutStatusService + + +RolloutStatusService is a struct which contains status information about +services that are exposed as part of the rollout. + + + +| Field | Description | +| --- | --- | +| `name` _string_ | Name indicates the name of the service. | +| `addresses` _[Address](#address) array_ | Addresses contains the addresses of a Service. | + + +_Appears in:_ +- [DataPlaneRolloutStatusServices](#dataplanerolloutstatusservices) + +#### RolloutStrategy + + +RolloutStrategy holds the rollout strategy options. + + + +| Field | Description | +| --- | --- | +| `blueGreen` _[BlueGreenStrategy](#bluegreenstrategy)_ | BlueGreen holds the options specific for Blue Green Deployments. | + + +_Appears in:_ +- [Rollout](#rollout) + +#### Scaling + + +Scaling defines the scaling options for the deployment. + + + +| Field | Description | +| --- | --- | +| `horizontal` _[HorizontalScaling](#horizontalscaling)_ | HorizontalScaling defines horizontal scaling options for the deployment. | + + +_Appears in:_ +- [DataPlaneDeploymentOptions](#dataplanedeploymentoptions) +- [DeploymentOptions](#deploymentoptions) + +#### ServiceOptions + + +ServiceOptions is used to includes options to customize the ingress service, +such as the annotations. + + + +| Field | Description | +| --- | --- | +| `type` _[ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#servicetype-v1-core)_ | Type determines how the Service is exposed. Defaults to `LoadBalancer`.

Valid options are `LoadBalancer` and `ClusterIP`.

`ClusterIP` allocates a cluster-internal IP address for load-balancing to endpoints.

`LoadBalancer` builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | +| `annotations` _object (keys:string, values:string)_ | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: http://kubernetes.io/docs/user-guide/annotations | +| `externalTrafficPolicy` _[ServiceExternalTrafficPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#serviceexternaltrafficpolicy-v1-core)_ | ExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.

More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip | + + +_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 have the konghq.com/credential label set to "konnect". | +| `serverURL` _string_ | ServerURL is the URL of the Konnect server. It can be either a full URL with an HTTPs scheme or just a hostname. Please refer to https://docs.konghq.com/konnect/network/ for the list of supported hostnames. | + + +_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/gateway-operator/reference/version-compatibility.md b/app/_src/gateway-operator/reference/version-compatibility.md index f458a180fa9c..937dbe3dfa65 100644 --- a/app/_src/gateway-operator/reference/version-compatibility.md +++ b/app/_src/gateway-operator/reference/version-compatibility.md @@ -8,27 +8,29 @@ The following table presents the general compatibility of {{site.kgo_product_nam ## Kubernetes -| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | -|:---------------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| -| {{ site.kic_product_name }} 2.11 | | | | | -| {{ site.kic_product_name }} 2.12 | | | | | -| {{ site.kic_product_name }} 3.0 | | | | | -| {{ site.kic_product_name }} 3.1 | | | | | -| {{ site.kic_product_name }} 3.2 | | | | | +| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | 1.4.x | +|:---------------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| +| {{ site.kic_product_name }} 2.11 | | | | | | +| {{ site.kic_product_name }} 2.12 | | | | | | +| {{ site.kic_product_name }} 3.0 | | | | | | +| {{ site.kic_product_name }} 3.1 | | | | | | +| {{ site.kic_product_name }} 3.2 | | | | | | +| {{ site.kic_product_name }} 3.3 | | | | | | ### General The following table presents the general compatibility of {{site.kgo_product_name}} with specific Kubernetes versions. Users should expect all the combinations marked with to work and to be supported. -| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | -|:--------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| -| Kubernetes 1.25 | | | | | -| Kubernetes 1.26 | | | | | -| Kubernetes 1.27 | | | | | -| Kubernetes 1.28 | | | | | -| Kubernetes 1.29 | | | | | -| Kubernetes 1.30 | | | | | +| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | 1.4.x | +|:--------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| +| Kubernetes 1.25 | | | | | | +| Kubernetes 1.26 | | | | | | +| Kubernetes 1.27 | | | | | | +| Kubernetes 1.28 | | | | | | +| Kubernetes 1.29 | | | | | | +| Kubernetes 1.30 | | | | | | +| Kubernetes 1.30 | | | | | | ### Gateway API @@ -37,11 +39,12 @@ As {{site.kgo_product_name}} implements Gateway API features using the upstream project, which defines [its own compatibility declarations][gateway-api-supported-versions], the expected compatibility of Gateway API features might be limited to those. -| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | -|:--------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| -| Gateway API 0.8.1 | | | | | -| Gateway API 1.0.0 | | | | | -| Gateway API 1.1.0 | | | | | +| {{site.kgo_product_name}} | 1.0.x | 1.1.x | 1.2.x | 1.3.x | 1.4.x | +|:--------------------------|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:|:---------------------------:| +| Gateway API 0.8.1 | | | | | | +| Gateway API 1.0.0 | | | | | | +| Gateway API 1.1.0 | | | | | | +| Gateway API 1.2.0 | | | | | | [gateway-api]: https://github.com/kubernetes-sigs/gateway-api [gateway-api-supported-versions]:https://gateway-api.sigs.k8s.io/concepts/versioning/#supported-versions diff --git a/app/gateway-operator/changelog.md b/app/gateway-operator/changelog.md index 37d631ece459..157434547d92 100644 --- a/app/gateway-operator/changelog.md +++ b/app/gateway-operator/changelog.md @@ -5,6 +5,120 @@ no_version: true Changelog for supported {{ site.kgo_product_name }} versions. +## 1.4.0 + +**Release Date** TBA + +### Added + +- Proper `User-Agent` header is now set on outgoing HTTP requests. + [#387](https://github.com/Kong/gateway-operator/pull/387) +- Introduce `KongPluginInstallation` CRD to allow installing custom Kong + plugins distributed as container images. + [#400](https://github.com/Kong/gateway-operator/pull/400), [#424](https://github.com/Kong/gateway-operator/pull/424), [#474](https://github.com/Kong/gateway-operator/pull/474), [#560](https://github.com/Kong/gateway-operator/pull/560), [#615](https://github.com/Kong/gateway-operator/pull/615), [#476](https://github.com/Kong/gateway-operator/pull/476) +- Extended `DataPlane` API with a possibility to specify `PodDisruptionBudget` to be + created for the `DataPlane` deployments via `spec.resources.podDisruptionBudget`. + [#464](https://github.com/Kong/gateway-operator/pull/464) +- Add `KonnectAPIAuthConfiguration` reconciler. + [#456](https://github.com/Kong/gateway-operator/pull/456) +- Add support for Konnect tokens in `Secrets` in `KonnectAPIAuthConfiguration` + reconciler. + [#459](https://github.com/Kong/gateway-operator/pull/459) +- Add `KonnectControlPlane` reconciler. + [#462](https://github.com/Kong/gateway-operator/pull/462) +- Add `KongService` reconciler for Konnect control planes. + [#470](https://github.com/Kong/gateway-operator/pull/470) +- Add `KongUpstream` reconciler for Konnect control planes. + [#593](https://github.com/Kong/gateway-operator/pull/593) +- Add `KongConsumer` reconciler for Konnect control planes. + [#493](https://github.com/Kong/gateway-operator/pull/493) +- Add `KongRoute` reconciler for Konnect control planes. + [#506](https://github.com/Kong/gateway-operator/pull/506) +- Add `KongConsumerGroup` reconciler for Konnect control planes. + [#510](https://github.com/Kong/gateway-operator/pull/510) +- Add `KongCACertificate` reconciler for Konnect CA certificates. + [#626](https://github.com/Kong/gateway-operator/pull/626) +- Add `KongCertificate` reconciler for Konnect Certificates. + [#643](https://github.com/Kong/gateway-operator/pull/643) +- Added command line flags to configure the certificate generator job's images. + [#516](https://github.com/Kong/gateway-operator/pull/516) +- Add `KongPluginBinding` reconciler for Konnect Plugins. + [#513](https://github.com/Kong/gateway-operator/pull/513), [#535](https://github.com/Kong/gateway-operator/pull/535) +- Add `KongTarget` reconciler for Konnect Targets. + [#627](https://github.com/Kong/gateway-operator/pull/627) +- Add `KongVault` reconciler for Konnect Vaults. + [#597](https://github.com/Kong/gateway-operator/pull/597) +- Add `KongKey` reconciler for Konnect Keys. + [#646](https://github.com/Kong/gateway-operator/pull/646) +- Add `KongKeySet` reconciler for Konnect KeySets. + [#657](https://github.com/Kong/gateway-operator/pull/657) +- Add `KongDataPlaneClientCertificate` reconciler for Konnect DataPlaneClientCertificates. + [#694](https://github.com/Kong/gateway-operator/pull/694) +- The `KonnectExtension` CRD has been introduced. Such a CRD can be attached + to a `DataPlane` via the extensions field to have a konnect-flavored `DataPlane`. + [#453](https://github.com/Kong/gateway-operator/pull/453), + [#578](https://github.com/Kong/gateway-operator/pull/578), + [#736](https://github.com/Kong/gateway-operator/pull/736) +- Entities created in Konnect are now labeled (or tagged for those that does not + support labels) with origin Kubernetes object's metadata: `k8s-name`, `k8s-namespace`, + `k8s-uid`, `k8s-generation`, `k8s-kind`, `k8s-group`, `k8s-version`. + [#565](https://github.com/Kong/gateway-operator/pull/565) +- Add `KongService`, `KongRoute`, `KongConsumer`, and `KongConsumerGroup` watchers + in the `KongPluginBinding` reconciler. + [#571](https://github.com/Kong/gateway-operator/pull/571) +- Annotating the following resource with the `konghq.com/plugins` annotation results in + the creation of a managed `KongPluginBinding` resource: + - `KongService` [#550](https://github.com/Kong/gateway-operator/pull/550) + - `KongRoute` [#644](https://github.com/Kong/gateway-operator/pull/644) + - `KongConsumer` [#676](https://github.com/Kong/gateway-operator/pull/676) + - `KongConsumerGroup` [#684](https://github.com/Kong/gateway-operator/pull/684) + These `KongPluginBinding`s are taken by the `KongPluginBinding` reconciler + to create the corresponding plugin objects in Konnect. +- `KongConsumer` associated with `ConsumerGroups` is now reconciled in Konnect by removing/adding + the consumer from/to the consumer groups. + [#592](https://github.com/Kong/gateway-operator/pull/592) +- Add support for `KongConsumer` credentials: + - basic-auth [#625](https://github.com/Kong/gateway-operator/pull/625) + - API key [#635](https://github.com/Kong/gateway-operator/pull/635) + - ACL [#661](https://github.com/Kong/gateway-operator/pull/661) + - JWT [#678](https://github.com/Kong/gateway-operator/pull/678) + - HMAC Auth [#687](https://github.com/Kong/gateway-operator/pull/687) +- Add support for `KongRoute`s bound directly to `KonnectGatewayControlPlane`s (serviceless rotues). + [#669](https://github.com/Kong/gateway-operator/pull/669) +- Allow setting `KonnectGatewayControlPlane`s group membership + [#697](https://github.com/Kong/gateway-operator/pull/697) +- Apply Konnect-related customizations to `DataPlane`s that properly reference `KonnectExtension` + resources. + [#714](https://github.com/Kong/gateway-operator/pull/714) +- The KonnectExtension functionality is enabled only when the `--enable-controller-konnect` + flag or the `GATEWAY_OPERATOR_ENABLE_CONTROLLER_KONNECT` env var is set. + [#738](https://github.com/Kong/gateway-operator/pull/738) + +### Fixed + +- Fixed `ControlPlane` cluster wide resources not migrating to new ownership labels + (introduced in 1.3.0) when upgrading the operator form 1.2 (or older) to 1.3.0. + [#369](https://github.com/Kong/gateway-operator/pull/369) +- Requeue instead of reporting an error when a finalizer removal yields a conflict. + [#454](https://github.com/Kong/gateway-operator/pull/454) +- Requeue instead of reporting an error when a GatewayClass status update yields a conflict. + [#612](https://github.com/Kong/gateway-operator/pull/612) +- Guard object counters with checks whether CRDs for them exist + [#710](https://github.com/Kong/gateway-operator/pull/710) +- Do not reconcile Gateways nor assign any finalizers when the referred GatewayClass is not supported. + [#711](https://github.com/Kong/gateway-operator/pull/711) +- Fixed setting `ExternalTrafficPolicy` on `DataPlane`'s ingress `Service` during update and patch operations. + [#750](https://github.com/Kong/gateway-operator/pull/750) + +### Changes + +- Default version of `ControlPlane` is bumped to 3.3.1 + [#580](https://github.com/Kong/gateway-operator/pull/580) +- Default version of `DataPlane` is bumped to 3.8.0 + [#572](https://github.com/Kong/gateway-operator/pull/572) +- Gateway API has been bumped to v1.2.0 + [#674](https://github.com/Kong/gateway-operator/pull/674) + ## 1.3.0 **Release Date** 2024/06/24