Skip to content

Commit

Permalink
chore: regenerate
Browse files Browse the repository at this point in the history
  • Loading branch information
pmalek committed Aug 16, 2024
1 parent 96015d0 commit 1688fa7
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ generate.clientsets: client-gen
--output-pkg $(REPO_URL)/pkg/

.PHONY: generate.docs
generate.docs: generate.apidocs # generate.cli-arguments-docs
generate.docs: generate.apidocs

.PHONY: generate.apidocs
generate.apidocs: crd-ref-docs
Expand Down
40 changes: 20 additions & 20 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ KongClusterPlugin is the Schema for the kongclusterplugins API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1`
| `kind` _string_ | `KongClusterPlugin`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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](#json)_ | 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 KongClusterPlugin, not both at once. |
| `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 KongClusterPlugin, not both at once. |
| `configFrom` _[NamespacedConfigSource](#namespacedconfigsource)_ | ConfigFrom references a secret containing the plugin configuration. This should be used when the plugin configuration contains sensitive information, such as AWS credentials in the Lambda plugin or the client secret in the OIDC plugin. Only one of `config` or `configFrom` may be used in a KongClusterPlugin, not both at once. |
| `configPatches` _[NamespacedConfigPatch](#namespacedconfigpatch) array_ | ConfigPatches represents JSON patches to the configuration of the plugin. Each item means a JSON patch to add something in the configuration, where path is specified in `path` and value is in `valueFrom` referencing a key in a secret. When Config is specified, patches will be applied to the configuration in Config. Otherwise, patches will be applied to an empty object. |
| `plugin` _string_ | PluginName is the name of the plugin to which to apply the config. |
Expand All @@ -50,7 +50,7 @@ KongConsumer is the Schema for the kongconsumers API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1`
| `kind` _string_ | `KongConsumer`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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. |
Expand All @@ -70,7 +70,7 @@ KongIngress is the Schema for the kongingresses API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1`
| `kind` _string_ | `KongIngress`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `upstream` _[KongIngressUpstream](#kongingressupstream)_ | Upstream represents a virtual hostname and can be used to loadbalance incoming requests over multiple targets (e.g. Kubernetes `Services` can be a target, OR `Endpoints` can be targets). |
| `proxy` _[KongIngressService](#kongingressservice)_ | Proxy defines additional connection options for the routes to be configured in the Kong Gateway, e.g. `connection_timeout`, `retries`, etc. |
| `route` _[KongIngressRoute](#kongingressroute)_ | Route define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. |
Expand All @@ -88,10 +88,10 @@ KongPlugin is the Schema for the kongplugins API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1`
| `kind` _string_ | `KongPlugin`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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](#json)_ | 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. |
| `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. |
| `configFrom` _[ConfigSource](#configsource)_ | ConfigFrom references a secret containing the plugin configuration. This should be used when the plugin configuration contains sensitive information, such as AWS credentials in the Lambda plugin or the client secret in the OIDC plugin. Only one of `config` or `configFrom` may be used in a KongPlugin, not both at once. |
| `configPatches` _[ConfigPatch](#configpatch) array_ | ConfigPatches represents JSON patches to the configuration of the plugin. Each item means a JSON patch to add something in the configuration, where path is specified in `path` and value is in `valueFrom` referencing a key in a secret. When Config is specified, patches will be applied to the configuration in Config. Otherwise, patches will be applied to an empty object. |
| `plugin` _string_ | PluginName is the name of the plugin to which to apply the config. |
Expand Down Expand Up @@ -346,7 +346,7 @@ IngressClassParameters is the Schema for the IngressClassParameters API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `IngressClassParameters`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[IngressClassParametersSpec](#ingressclassparametersspec)_ | Spec is the IngressClassParameters specification. |


Expand All @@ -362,7 +362,7 @@ KongCustomEntity defines a "custom" Kong entity that KIC cannot support the enti
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongCustomEntity`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[KongCustomEntitySpec](#kongcustomentityspec)_ | |


Expand All @@ -378,7 +378,7 @@ KongLicense stores a Kong enterprise license to apply to managed Kong gateway in
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongLicense`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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. |

Expand All @@ -395,7 +395,7 @@ KongPluginBinding is the schema for Plugin Bindings API which defines a Kong Plu
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongPluginBinding`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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)_ | |


Expand All @@ -411,7 +411,7 @@ KongRoute is the schema for Routes API which defines a Kong Route.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongRoute`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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)_ | |


Expand All @@ -427,7 +427,7 @@ KongService is the schema for Services API which defines a Kong Service.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongService`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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)_ | |


Expand All @@ -445,7 +445,7 @@ See: https://docs.konghq.com/gateway/latest/kong-enterprise/secrets-management/
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1alpha1`
| `kind` _string_ | `KongVault`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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)_ | |


Expand Down Expand Up @@ -543,7 +543,7 @@ _Appears in:_
| Field | Description |
| --- | --- |
| `type` _string_ | EntityType is the type of the Kong entity. The type is used in generating declarative configuration. |
| `fields` _[JSON](#json)_ | Fields defines the fields of the Kong entity itself. |
| `fields` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#json-v1-apiextensions-k8s-io)_ | Fields defines the fields of the Kong entity itself. |
| `controllerName` _string_ | ControllerName specifies the controller that should reconcile it, like ingress class. |
| `parentRef` _[ObjectReference](#objectreference)_ | ParentRef references the kubernetes resource it attached to when its scope is "attached". Currently only KongPlugin/KongClusterPlugin allowed. This will make the custom entity to be attached to the entity(service/route/consumer) where the plugin is attached. |

Expand All @@ -567,7 +567,7 @@ identified by the controllerName field.
| --- | --- |
| `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.25/#condition-v1-meta) array_ | Conditions describe the current conditions of the KongLicense on the controller. |
| `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:_
Expand Down Expand Up @@ -754,7 +754,7 @@ KongVaultSpec defines specification of a custom Kong vault.
| `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](#json)_ | Config is the configuration of the vault. Varies for different backends. |
| `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. |


_Appears in:_
Expand Down Expand Up @@ -921,7 +921,7 @@ KongConsumerGroup is the Schema for the kongconsumergroups API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1beta1`
| `kind` _string_ | `KongConsumerGroup`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |



Expand All @@ -948,7 +948,7 @@ used instead. This is to allow reusing the same KongUpstreamPolicy for multiple
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1beta1`
| `kind` _string_ | `KongUpstreamPolicy`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[KongUpstreamPolicySpec](#kongupstreampolicyspec)_ | Spec contains the configuration of the Kong upstream. |


Expand All @@ -964,7 +964,7 @@ TCPIngress is the Schema for the tcpingresses API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1beta1`
| `kind` _string_ | `TCPIngress`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[TCPIngressSpec](#tcpingressspec)_ | Spec is the TCPIngress specification. |


Expand All @@ -980,7 +980,7 @@ UDPIngress is the Schema for the udpingresses API.
| --- | --- |
| `apiVersion` _string_ | `configuration.konghq.com/v1beta1`
| `kind` _string_ | `UDPIngress`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[UDPIngressSpec](#udpingressspec)_ | Spec is the UDPIngress specification. |


Expand Down
2 changes: 1 addition & 1 deletion docs/incubator-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ matching the ingressClass of the Kong Ingress Controller (`kong` by default) to
| --- | --- |
| `apiVersion` _string_ | `incubator.ingress-controller.konghq.com/v1alpha1`
| `kind` _string_ | `KongServiceFacade`
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `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` _[KongServiceFacadeSpec](#kongservicefacadespec)_ | |


Expand Down
Loading

0 comments on commit 1688fa7

Please sign in to comment.