@r8s/crds 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/crds/certmanager-certificate.yaml +794 -0
  2. package/crds/certmanager-clusterissuer.yaml +3739 -0
  3. package/crds/clickhouse-installation.yaml +1847 -0
  4. package/crds/cnpg-cluster.yaml +6794 -0
  5. package/crds/cnpg-pooler.yaml +9311 -0
  6. package/crds/cnpg-scheduledbackup.yaml +191 -0
  7. package/crds/envoy-backendtrafficpolicy.yaml +1 -0
  8. package/crds/envoy-clienttrafficpolicy.yaml +1 -0
  9. package/crds/envoy-envoyproxy.yaml +1 -0
  10. package/crds/envoy-proxy.yaml +16626 -0
  11. package/crds/envoy-securitypolicy.yaml +1 -0
  12. package/crds/externaldns-endpoint.yaml +94 -0
  13. package/crds/gatewayapi-gateway.yaml +2253 -0
  14. package/crds/gatewayapi-httproute.yaml +5643 -0
  15. package/crds/keycloak-keycloak.yaml +3192 -0
  16. package/crds/keycloak-realmimport.yaml +2878 -0
  17. package/crds/logging-flow.yaml +1768 -0
  18. package/crds/logging-logging.yaml +16770 -0
  19. package/crds/logging-output.yaml +14658 -0
  20. package/crds/loki-lokistack.yaml +5390 -0
  21. package/crds/prometheus-alertmanager.yaml +10013 -0
  22. package/crds/prometheus-podmonitor.yaml +741 -0
  23. package/crds/prometheus-prometheus.yaml +13928 -0
  24. package/crds/prometheus-prometheusrule.yaml +267 -0
  25. package/crds/prometheus-scrapeconfig.yaml +12938 -0
  26. package/crds/prometheus-servicemonitor.yaml +764 -0
  27. package/crds/prometheus-thanosruler.yaml +9795 -0
  28. package/crds/redis-cluster.yaml +7862 -0
  29. package/crds/redis-failover.yaml +1 -0
  30. package/crds/redis-replication.yaml +5593 -0
  31. package/crds/velero-backups.yaml +630 -0
  32. package/crds/velero-backupstoragelocations.yaml +174 -0
  33. package/crds/velero-schedules.yaml +584 -0
  34. package/dist/generated/cert-manager.d.ts +873 -0
  35. package/dist/generated/cert-manager.d.ts.map +1 -0
  36. package/dist/generated/cert-manager.js +24 -0
  37. package/dist/generated/cert-manager.js.map +1 -0
  38. package/dist/generated/clickhouse.d.ts +692 -0
  39. package/dist/generated/clickhouse.d.ts.map +1 -0
  40. package/dist/generated/clickhouse.js +14 -0
  41. package/dist/generated/clickhouse.js.map +1 -0
  42. package/dist/generated/externaldns.d.ts +47 -0
  43. package/dist/generated/externaldns.d.ts.map +1 -0
  44. package/dist/generated/externaldns.js +14 -0
  45. package/dist/generated/externaldns.js.map +1 -0
  46. package/dist/generated/gateway.d.ts +2396 -0
  47. package/dist/generated/gateway.d.ts.map +1 -0
  48. package/dist/generated/gateway.js +34 -0
  49. package/dist/generated/gateway.js.map +1 -0
  50. package/dist/generated/index.d.ts +24 -0
  51. package/dist/generated/index.d.ts.map +1 -0
  52. package/dist/generated/index.js +61 -0
  53. package/dist/generated/index.js.map +1 -0
  54. package/dist/generated/keycloak.d.ts +1607 -0
  55. package/dist/generated/keycloak.d.ts.map +1 -0
  56. package/dist/generated/keycloak.js +24 -0
  57. package/dist/generated/keycloak.js.map +1 -0
  58. package/dist/generated/logging.d.ts +3487 -0
  59. package/dist/generated/logging.d.ts.map +1 -0
  60. package/dist/generated/logging.js +34 -0
  61. package/dist/generated/logging.js.map +1 -0
  62. package/dist/generated/loki.d.ts +578 -0
  63. package/dist/generated/loki.d.ts.map +1 -0
  64. package/dist/generated/loki.js +14 -0
  65. package/dist/generated/loki.js.map +1 -0
  66. package/dist/generated/monitoring.d.ts +4230 -0
  67. package/dist/generated/monitoring.d.ts.map +1 -0
  68. package/dist/generated/monitoring.js +74 -0
  69. package/dist/generated/monitoring.js.map +1 -0
  70. package/dist/generated/operators.d.ts +18 -0
  71. package/dist/generated/operators.d.ts.map +1 -0
  72. package/dist/generated/operators.js +191 -0
  73. package/dist/generated/operators.js.map +1 -0
  74. package/dist/generated/postgresql.d.ts +2820 -0
  75. package/dist/generated/postgresql.d.ts.map +1 -0
  76. package/dist/generated/postgresql.js +34 -0
  77. package/dist/generated/postgresql.js.map +1 -0
  78. package/dist/generated/redis.d.ts +1253 -0
  79. package/dist/generated/redis.d.ts.map +1 -0
  80. package/dist/generated/redis.js +24 -0
  81. package/dist/generated/redis.js.map +1 -0
  82. package/dist/generated/velero.d.ts +351 -0
  83. package/dist/generated/velero.d.ts.map +1 -0
  84. package/dist/generated/velero.js +34 -0
  85. package/dist/generated/velero.js.map +1 -0
  86. package/dist/index.d.ts +18 -0
  87. package/dist/index.d.ts.map +1 -0
  88. package/dist/index.js +34 -0
  89. package/dist/index.js.map +1 -0
  90. package/operators.yaml +196 -0
  91. package/package.json +49 -0
@@ -0,0 +1,2396 @@
1
+ /**
2
+ * GENERATED from gateway CRDs — do not edit by hand.
3
+ * Regenerate with: npm run generate -w @r8s/crds
4
+ */
5
+ import type { ObjectMeta } from '@r8s/k8s-types';
6
+ export interface EnvoyProxy {
7
+ apiVersion: 'gateway.envoyproxy.io/v1alpha1';
8
+ kind: 'EnvoyProxy';
9
+ metadata: ObjectMeta;
10
+ spec: EnvoyProxySpec;
11
+ status?: EnvoyProxyStatus;
12
+ }
13
+ /** Props for the {@link EnvoyProxy} component — a 1:1 mapping of the gateway.envoyproxy.io/v1alpha1 CRD. */
14
+ export interface EnvoyProxyProps {
15
+ metadata: ObjectMeta;
16
+ spec: EnvoyProxySpec;
17
+ }
18
+ /** Render a EnvoyProxy (gateway.envoyproxy.io/v1alpha1) exactly as defined by its CRD. */
19
+ export declare function EnvoyProxyComponent(props: EnvoyProxyProps): import("@r8s/core").r8sElement;
20
+ export interface Gateway {
21
+ apiVersion: 'gateway.networking.k8s.io/v1';
22
+ kind: 'Gateway';
23
+ metadata: ObjectMeta;
24
+ spec: GatewaySpec;
25
+ status?: GatewayStatus;
26
+ }
27
+ /** Props for the {@link Gateway} component — a 1:1 mapping of the gateway.networking.k8s.io/v1 CRD. */
28
+ export interface GatewayProps {
29
+ metadata: ObjectMeta;
30
+ spec: GatewaySpec;
31
+ }
32
+ /** Render a Gateway (gateway.networking.k8s.io/v1) exactly as defined by its CRD. */
33
+ export declare function GatewayComponent(props: GatewayProps): import("@r8s/core").r8sElement;
34
+ export interface HTTPRoute {
35
+ apiVersion: 'gateway.networking.k8s.io/v1';
36
+ kind: 'HTTPRoute';
37
+ metadata: ObjectMeta;
38
+ spec: HTTPRouteSpec;
39
+ status?: HTTPRouteStatus;
40
+ }
41
+ /** Props for the {@link HTTPRoute} component — a 1:1 mapping of the gateway.networking.k8s.io/v1 CRD. */
42
+ export interface HTTPRouteProps {
43
+ metadata: ObjectMeta;
44
+ spec: HTTPRouteSpec;
45
+ }
46
+ /** Render a HTTPRoute (gateway.networking.k8s.io/v1) exactly as defined by its CRD. */
47
+ export declare function HTTPRouteComponent(props: HTTPRouteProps): import("@r8s/core").r8sElement;
48
+ export interface ClientCertificateRef {
49
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
50
+ "group"?: string;
51
+ /** Kind is kind of the referent. For example "Secret". */
52
+ "kind"?: string;
53
+ /** Name is the name of the referent. */
54
+ "name": string;
55
+ /** Namespace is the namespace of the referenced object. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core */
56
+ "namespace"?: string;
57
+ }
58
+ export interface BackendTLS {
59
+ /** ALPNProtocols supplies the list of ALPN protocols that should be exposed by the listener or used by the proxy to connect to the backend. Defaults: 1. HTTPS Routes: h2 and http/1.1 are enabled in listener context. 2. Other Routes: ALPN is disabled. 3. Backends: proxy uses the appropriate ALPN options for the backend protocol. When an empty list is provided, the ALPN TLS extension is disabled. Defaults to [h2, http/1.1] if not specified. Typical Supported values are: - http/1.0 - http/1.1 - h2 */
60
+ "alpnProtocols"?: string[];
61
+ /** Ciphers specifies the set of cipher suites supported when negotiating TLS 1.0 - 1.2. This setting has no effect for TLS 1.3. In non-FIPS Envoy Proxy builds the default cipher list is: - [ECDHE-ECDSA-AES128-GCM-SHA256|ECDHE-ECDSA-CHACHA20-POLY1305] - [ECDHE-RSA-AES128-GCM-SHA256|ECDHE-RSA-CHACHA20-POLY1305] - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 In builds using BoringSSL FIPS the default cipher list is: - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 */
62
+ "ciphers"?: string[];
63
+ /** ClientCertificateRef defines the reference to a Kubernetes Secret that contains the client certificate and private key for Envoy to use when connecting to backend services and external services, such as ExtAuth, ALS, OpenTelemetry, etc. This secret should be located within the same namespace as the Envoy proxy resource that references it. */
64
+ "clientCertificateRef"?: ClientCertificateRef;
65
+ /** ECDHCurves specifies the set of supported ECDH curves. In non-FIPS Envoy Proxy builds the default curves are: - X25519 - P-256 In builds using BoringSSL FIPS the default curve is: - P-256 */
66
+ "ecdhCurves"?: string[];
67
+ /** Max specifies the maximal TLS protocol version to allow The default is TLS 1.3 if this is not specified. */
68
+ "maxVersion"?: "Auto" | "1.0" | "1.1" | "1.2" | "1.3";
69
+ /** Min specifies the minimal TLS protocol version to allow. The default is TLS 1.2 if this is not specified. */
70
+ "minVersion"?: "Auto" | "1.0" | "1.1" | "1.2" | "1.3";
71
+ /** SignatureAlgorithms specifies which signature algorithms the listener should support. */
72
+ "signatureAlgorithms"?: string[];
73
+ }
74
+ export interface JsonPatchesItem {
75
+ /** From is the source location of the value to be copied or moved. Only valid for move or copy operations Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details. */
76
+ "from"?: string;
77
+ /** JSONPath is a JSONPath expression. Refer to https://datatracker.ietf.org/doc/rfc9535/ for more details. It produces one or more JSONPointer expressions based on the given JSON document. If no JSONPointer is found, it will result in an error. If the 'Path' property is also set, it will be appended to the resulting JSONPointer expressions from the JSONPath evaluation. This is useful when creating a property that does not yet exist in the JSON document. The final JSONPointer expressions specifies the locations in the target document/field where the operation will be applied. */
78
+ "jsonPath"?: string;
79
+ /** Op is the type of operation to perform */
80
+ "op": "add" | "remove" | "replace" | "move" | "copy" | "test";
81
+ /** Path is a JSONPointer expression. Refer to https://datatracker.ietf.org/doc/html/rfc6901 for more details. It specifies the location of the target document/field where the operation will be performed */
82
+ "path"?: string;
83
+ /** Value is the new value of the path location. The value is only used by the `add` and `replace` operations. */
84
+ "value"?: Record<string, unknown>;
85
+ }
86
+ export interface Bootstrap {
87
+ /** JSONPatches is an array of JSONPatches to be applied to the default bootstrap. Patches are applied in the order in which they are defined. */
88
+ "jsonPatches"?: JsonPatchesItem[];
89
+ /** Type is the type of the bootstrap configuration, it should be either **Replace**, **Merge**, or **JSONPatch**. If unspecified, it defaults to Replace. */
90
+ "type"?: "Merge" | "Replace" | "JSONPatch";
91
+ /** Value is a YAML string of the bootstrap. */
92
+ "value"?: string;
93
+ }
94
+ export interface FilterOrderItem {
95
+ /** After defines the filter that should come after the filter. Only one of Before or After must be set. */
96
+ "after"?: "envoy.filters.http.custom_response" | "envoy.filters.http.health_check" | "envoy.filters.http.fault" | "envoy.filters.http.cors" | "envoy.filters.http.header_mutation" | "envoy.filters.http.ext_authz" | "envoy.filters.http.api_key_auth" | "envoy.filters.http.basic_auth" | "envoy.filters.http.oauth2" | "envoy.filters.http.jwt_authn" | "envoy.filters.http.stateful_session" | "envoy.filters.http.buffer" | "envoy.filters.http.lua" | "envoy.filters.http.ext_proc" | "envoy.filters.http.wasm" | "envoy.filters.http.rbac" | "envoy.filters.http.local_ratelimit" | "envoy.filters.http.ratelimit" | "envoy.filters.http.grpc_web" | "envoy.filters.http.grpc_stats" | "envoy.filters.http.credential_injector" | "envoy.filters.http.compressor" | "envoy.filters.http.dynamic_forward_proxy";
97
+ /** Before defines the filter that should come before the filter. Only one of Before or After must be set. */
98
+ "before"?: "envoy.filters.http.custom_response" | "envoy.filters.http.health_check" | "envoy.filters.http.fault" | "envoy.filters.http.cors" | "envoy.filters.http.header_mutation" | "envoy.filters.http.ext_authz" | "envoy.filters.http.api_key_auth" | "envoy.filters.http.basic_auth" | "envoy.filters.http.oauth2" | "envoy.filters.http.jwt_authn" | "envoy.filters.http.stateful_session" | "envoy.filters.http.buffer" | "envoy.filters.http.lua" | "envoy.filters.http.ext_proc" | "envoy.filters.http.wasm" | "envoy.filters.http.rbac" | "envoy.filters.http.local_ratelimit" | "envoy.filters.http.ratelimit" | "envoy.filters.http.grpc_web" | "envoy.filters.http.grpc_stats" | "envoy.filters.http.credential_injector" | "envoy.filters.http.compressor" | "envoy.filters.http.dynamic_forward_proxy";
99
+ /** Name of the filter. */
100
+ "name": "envoy.filters.http.custom_response" | "envoy.filters.http.health_check" | "envoy.filters.http.fault" | "envoy.filters.http.cors" | "envoy.filters.http.header_mutation" | "envoy.filters.http.ext_authz" | "envoy.filters.http.api_key_auth" | "envoy.filters.http.basic_auth" | "envoy.filters.http.oauth2" | "envoy.filters.http.jwt_authn" | "envoy.filters.http.stateful_session" | "envoy.filters.http.buffer" | "envoy.filters.http.lua" | "envoy.filters.http.ext_proc" | "envoy.filters.http.wasm" | "envoy.filters.http.rbac" | "envoy.filters.http.local_ratelimit" | "envoy.filters.http.ratelimit" | "envoy.filters.http.grpc_web" | "envoy.filters.http.grpc_stats" | "envoy.filters.http.credential_injector" | "envoy.filters.http.compressor" | "envoy.filters.http.dynamic_forward_proxy";
101
+ }
102
+ export interface Logging {
103
+ /** Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to "default: warn". */
104
+ "level"?: Record<string, unknown>;
105
+ }
106
+ export interface Host {
107
+ /** EnvoyVersion is the version of Envoy to use. If unspecified, the version against which Envoy Gateway is built will be used. */
108
+ "envoyVersion"?: string;
109
+ }
110
+ export interface ConfigMapKeyRef {
111
+ /** The key to select. */
112
+ "key": string;
113
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
114
+ "name"?: string;
115
+ /** Specify whether the ConfigMap or its key must be defined */
116
+ "optional"?: boolean;
117
+ }
118
+ export interface FieldRef {
119
+ /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */
120
+ "apiVersion"?: string;
121
+ /** Path of the field to select in the specified API version. */
122
+ "fieldPath": string;
123
+ }
124
+ export interface FileKeyRef {
125
+ /** The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. */
126
+ "key": string;
127
+ /** Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation. */
128
+ "optional"?: boolean;
129
+ /** The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. */
130
+ "path": string;
131
+ /** The name of the volume mount containing the env file. */
132
+ "volumeName": string;
133
+ }
134
+ export interface ResourceFieldRef {
135
+ /** Container name: required for volumes, optional for env vars */
136
+ "containerName"?: string;
137
+ /** Specifies the output format of the exposed resources, defaults to "1" */
138
+ "divisor"?: number | string;
139
+ /** Required: resource to select */
140
+ "resource": string;
141
+ }
142
+ export interface SecretKeyRef {
143
+ /** The key of the secret to select from. Must be a valid secret key. */
144
+ "key": string;
145
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
146
+ "name"?: string;
147
+ /** Specify whether the Secret or its key must be defined */
148
+ "optional"?: boolean;
149
+ }
150
+ export interface ValueFrom {
151
+ /** Selects a key of a ConfigMap. */
152
+ "configMapKeyRef"?: ConfigMapKeyRef;
153
+ /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */
154
+ "fieldRef"?: FieldRef;
155
+ /** FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled. */
156
+ "fileKeyRef"?: FileKeyRef;
157
+ /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */
158
+ "resourceFieldRef"?: ResourceFieldRef;
159
+ /** Selects a key of a secret in the pod's namespace */
160
+ "secretKeyRef"?: SecretKeyRef;
161
+ }
162
+ export interface EnvItem {
163
+ /** Name of the environment variable. May consist of any printable ASCII characters except '='. */
164
+ "name": string;
165
+ /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */
166
+ "value"?: string;
167
+ /** Source for the environment variable's value. Cannot be used if value is not empty. */
168
+ "valueFrom"?: ValueFrom;
169
+ }
170
+ export interface ClaimsItem {
171
+ /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */
172
+ "name": string;
173
+ /** Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request. */
174
+ "request"?: string;
175
+ }
176
+ export interface Resources {
177
+ /** Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. */
178
+ "claims"?: ClaimsItem[];
179
+ /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
180
+ "limits"?: Record<string, unknown>;
181
+ /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
182
+ "requests"?: Record<string, unknown>;
183
+ }
184
+ export interface AppArmorProfile {
185
+ /** localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". */
186
+ "localhostProfile"?: string;
187
+ /** type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement. */
188
+ "type": string;
189
+ }
190
+ export interface Capabilities {
191
+ /** Added capabilities */
192
+ "add"?: string[];
193
+ /** Removed capabilities */
194
+ "drop"?: string[];
195
+ }
196
+ export interface SeLinuxOptions {
197
+ /** Level is SELinux level label that applies to the container. */
198
+ "level"?: string;
199
+ /** Role is a SELinux role label that applies to the container. */
200
+ "role"?: string;
201
+ /** Type is a SELinux type label that applies to the container. */
202
+ "type"?: string;
203
+ /** User is a SELinux user label that applies to the container. */
204
+ "user"?: string;
205
+ }
206
+ export interface SeccompProfile {
207
+ /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */
208
+ "localhostProfile"?: string;
209
+ /** type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */
210
+ "type": string;
211
+ }
212
+ export interface WindowsOptions {
213
+ /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */
214
+ "gmsaCredentialSpec"?: string;
215
+ /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */
216
+ "gmsaCredentialSpecName"?: string;
217
+ /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */
218
+ "hostProcess"?: boolean;
219
+ /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */
220
+ "runAsUserName"?: string;
221
+ }
222
+ export interface SecurityContext {
223
+ /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. */
224
+ "allowPrivilegeEscalation"?: boolean;
225
+ /** appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows. */
226
+ "appArmorProfile"?: AppArmorProfile;
227
+ /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */
228
+ "capabilities"?: Capabilities;
229
+ /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. */
230
+ "privileged"?: boolean;
231
+ /** procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. */
232
+ "procMount"?: string;
233
+ /** Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. */
234
+ "readOnlyRootFilesystem"?: boolean;
235
+ /** The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */
236
+ "runAsGroup"?: number;
237
+ /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */
238
+ "runAsNonRoot"?: boolean;
239
+ /** The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */
240
+ "runAsUser"?: number;
241
+ /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */
242
+ "seLinuxOptions"?: SeLinuxOptions;
243
+ /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */
244
+ "seccompProfile"?: SeccompProfile;
245
+ /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */
246
+ "windowsOptions"?: WindowsOptions;
247
+ }
248
+ export interface VolumeMountsItem {
249
+ /** Path within the container at which the volume should be mounted. Must not contain ':'. */
250
+ "mountPath": string;
251
+ /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None). */
252
+ "mountPropagation"?: string;
253
+ /** This must match the Name of a Volume. */
254
+ "name": string;
255
+ /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */
256
+ "readOnly"?: boolean;
257
+ /** RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled. */
258
+ "recursiveReadOnly"?: string;
259
+ /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */
260
+ "subPath"?: string;
261
+ /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */
262
+ "subPathExpr"?: string;
263
+ }
264
+ export interface Container {
265
+ /** List of environment variables to set in the container. */
266
+ "env"?: EnvItem[];
267
+ /** Image specifies the EnvoyProxy container image to be used including a tag, instead of the default image. This field is mutually exclusive with ImageRepository. */
268
+ "image"?: string;
269
+ /** ImageRepository specifies the container image repository to be used without specifying a tag. The default tag will be used. This field is mutually exclusive with Image. */
270
+ "imageRepository"?: string;
271
+ /** Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
272
+ "resources"?: Resources;
273
+ /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */
274
+ "securityContext"?: SecurityContext;
275
+ /** VolumeMounts are volumes to mount into the container's filesystem. Cannot be updated. */
276
+ "volumeMounts"?: VolumeMountsItem[];
277
+ }
278
+ export interface Patch {
279
+ /** Type is the type of merge operation to perform By default, StrategicMerge is used as the patch type. */
280
+ "type"?: string;
281
+ /** Object contains the raw configuration for merged object */
282
+ "value": Record<string, unknown>;
283
+ }
284
+ export interface MatchExpressionsItem {
285
+ /** The label key that the selector applies to. */
286
+ "key": string;
287
+ /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */
288
+ "operator": string;
289
+ /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */
290
+ "values"?: string[];
291
+ }
292
+ export interface MatchFieldsItem {
293
+ /** The label key that the selector applies to. */
294
+ "key": string;
295
+ /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */
296
+ "operator": string;
297
+ /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */
298
+ "values"?: string[];
299
+ }
300
+ export interface Preference {
301
+ /** A list of node selector requirements by node's labels. */
302
+ "matchExpressions"?: MatchExpressionsItem[];
303
+ /** A list of node selector requirements by node's fields. */
304
+ "matchFields"?: MatchFieldsItem[];
305
+ }
306
+ export interface PreferredDuringSchedulingIgnoredDuringExecutionItem {
307
+ /** A node selector term, associated with the corresponding weight. */
308
+ "preference": Preference;
309
+ /** Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. */
310
+ "weight": number;
311
+ }
312
+ export interface NodeSelectorTermsItem {
313
+ /** A list of node selector requirements by node's labels. */
314
+ "matchExpressions"?: MatchExpressionsItem[];
315
+ /** A list of node selector requirements by node's fields. */
316
+ "matchFields"?: MatchFieldsItem[];
317
+ }
318
+ export interface RequiredDuringSchedulingIgnoredDuringExecution {
319
+ /** Required. A list of node selector terms. The terms are ORed. */
320
+ "nodeSelectorTerms": NodeSelectorTermsItem[];
321
+ }
322
+ export interface NodeAffinity {
323
+ /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */
324
+ "preferredDuringSchedulingIgnoredDuringExecution"?: PreferredDuringSchedulingIgnoredDuringExecutionItem[];
325
+ /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */
326
+ "requiredDuringSchedulingIgnoredDuringExecution"?: RequiredDuringSchedulingIgnoredDuringExecution;
327
+ }
328
+ export interface LabelSelector {
329
+ /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */
330
+ "matchExpressions"?: MatchExpressionsItem[];
331
+ /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */
332
+ "matchLabels"?: Record<string, unknown>;
333
+ }
334
+ export interface NamespaceSelector {
335
+ /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */
336
+ "matchExpressions"?: MatchExpressionsItem[];
337
+ /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */
338
+ "matchLabels"?: Record<string, unknown>;
339
+ }
340
+ export interface PodAffinityTerm {
341
+ /** A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. */
342
+ "labelSelector"?: LabelSelector;
343
+ /** MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. */
344
+ "matchLabelKeys"?: string[];
345
+ /** MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. */
346
+ "mismatchLabelKeys"?: string[];
347
+ /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */
348
+ "namespaceSelector"?: NamespaceSelector;
349
+ /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */
350
+ "namespaces"?: string[];
351
+ /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */
352
+ "topologyKey": string;
353
+ }
354
+ export interface PreferredDuringSchedulingIgnoredDuringExecutionItem2 {
355
+ /** Required. A pod affinity term, associated with the corresponding weight. */
356
+ "podAffinityTerm": PodAffinityTerm;
357
+ /** weight associated with matching the corresponding podAffinityTerm, in the range 1-100. */
358
+ "weight": number;
359
+ }
360
+ export interface RequiredDuringSchedulingIgnoredDuringExecutionItem {
361
+ /** A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods. */
362
+ "labelSelector"?: LabelSelector;
363
+ /** MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. */
364
+ "matchLabelKeys"?: string[];
365
+ /** MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. */
366
+ "mismatchLabelKeys"?: string[];
367
+ /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */
368
+ "namespaceSelector"?: NamespaceSelector;
369
+ /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */
370
+ "namespaces"?: string[];
371
+ /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */
372
+ "topologyKey": string;
373
+ }
374
+ export interface PodAffinity {
375
+ /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */
376
+ "preferredDuringSchedulingIgnoredDuringExecution"?: PreferredDuringSchedulingIgnoredDuringExecutionItem2[];
377
+ /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */
378
+ "requiredDuringSchedulingIgnoredDuringExecution"?: RequiredDuringSchedulingIgnoredDuringExecutionItem[];
379
+ }
380
+ export interface PodAntiAffinity {
381
+ /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */
382
+ "preferredDuringSchedulingIgnoredDuringExecution"?: PreferredDuringSchedulingIgnoredDuringExecutionItem2[];
383
+ /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */
384
+ "requiredDuringSchedulingIgnoredDuringExecution"?: RequiredDuringSchedulingIgnoredDuringExecutionItem[];
385
+ }
386
+ export interface Affinity {
387
+ /** Describes node affinity scheduling rules for the pod. */
388
+ "nodeAffinity"?: NodeAffinity;
389
+ /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */
390
+ "podAffinity"?: PodAffinity;
391
+ /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */
392
+ "podAntiAffinity"?: PodAntiAffinity;
393
+ }
394
+ export interface ImagePullSecretsItem {
395
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
396
+ "name"?: string;
397
+ }
398
+ export interface SysctlsItem {
399
+ /** Name of a property to set */
400
+ "name": string;
401
+ /** Value of a property to set */
402
+ "value": string;
403
+ }
404
+ export interface SecurityContext2 {
405
+ /** appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. */
406
+ "appArmorProfile"?: AppArmorProfile;
407
+ /** A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. */
408
+ "fsGroup"?: number;
409
+ /** fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows. */
410
+ "fsGroupChangePolicy"?: string;
411
+ /** The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */
412
+ "runAsGroup"?: number;
413
+ /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */
414
+ "runAsNonRoot"?: boolean;
415
+ /** The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */
416
+ "runAsUser"?: number;
417
+ /** seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive". "Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. "MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows. */
418
+ "seLinuxChangePolicy"?: string;
419
+ /** The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */
420
+ "seLinuxOptions"?: SeLinuxOptions;
421
+ /** The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. */
422
+ "seccompProfile"?: SeccompProfile;
423
+ /** A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows. */
424
+ "supplementalGroups"?: number[];
425
+ /** Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows. */
426
+ "supplementalGroupsPolicy"?: string;
427
+ /** Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. */
428
+ "sysctls"?: SysctlsItem[];
429
+ /** The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */
430
+ "windowsOptions"?: WindowsOptions;
431
+ }
432
+ export interface TolerationsItem {
433
+ /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */
434
+ "effect"?: string;
435
+ /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */
436
+ "key"?: string;
437
+ /** Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators). */
438
+ "operator"?: string;
439
+ /** TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. */
440
+ "tolerationSeconds"?: number;
441
+ /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */
442
+ "value"?: string;
443
+ }
444
+ export interface TopologySpreadConstraintsItem {
445
+ /** LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. */
446
+ "labelSelector"?: LabelSelector;
447
+ /** MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). */
448
+ "matchLabelKeys"?: string[];
449
+ /** MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. */
450
+ "maxSkew": number;
451
+ /** MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. */
452
+ "minDomains"?: number;
453
+ /** NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. */
454
+ "nodeAffinityPolicy"?: string;
455
+ /** NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. */
456
+ "nodeTaintsPolicy"?: string;
457
+ /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */
458
+ "topologyKey": string;
459
+ /** WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. */
460
+ "whenUnsatisfiable": string;
461
+ }
462
+ export interface AwsElasticBlockStore {
463
+ /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */
464
+ "fsType"?: string;
465
+ /** partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). */
466
+ "partition"?: number;
467
+ /** readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */
468
+ "readOnly"?: boolean;
469
+ /** volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */
470
+ "volumeID": string;
471
+ }
472
+ export interface AzureDisk {
473
+ /** cachingMode is the Host Caching mode: None, Read Only, Read Write. */
474
+ "cachingMode"?: string;
475
+ /** diskName is the Name of the data disk in the blob storage */
476
+ "diskName": string;
477
+ /** diskURI is the URI of data disk in the blob storage */
478
+ "diskURI": string;
479
+ /** fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */
480
+ "fsType"?: string;
481
+ /** kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared */
482
+ "kind"?: string;
483
+ /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
484
+ "readOnly"?: boolean;
485
+ }
486
+ export interface AzureFile {
487
+ /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
488
+ "readOnly"?: boolean;
489
+ /** secretName is the name of secret that contains Azure Storage Account Name and Key */
490
+ "secretName": string;
491
+ /** shareName is the azure share Name */
492
+ "shareName": string;
493
+ }
494
+ export interface SecretRef {
495
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
496
+ "name"?: string;
497
+ }
498
+ export interface Cephfs {
499
+ /** monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */
500
+ "monitors": string[];
501
+ /** path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / */
502
+ "path"?: string;
503
+ /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */
504
+ "readOnly"?: boolean;
505
+ /** secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */
506
+ "secretFile"?: string;
507
+ /** secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */
508
+ "secretRef"?: SecretRef;
509
+ /** user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */
510
+ "user"?: string;
511
+ }
512
+ export interface Cinder {
513
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */
514
+ "fsType"?: string;
515
+ /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */
516
+ "readOnly"?: boolean;
517
+ /** secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. */
518
+ "secretRef"?: SecretRef;
519
+ /** volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */
520
+ "volumeID": string;
521
+ }
522
+ export interface ItemsItem {
523
+ /** key is the key to project. */
524
+ "key": string;
525
+ /** mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
526
+ "mode"?: number;
527
+ /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */
528
+ "path": string;
529
+ }
530
+ export interface ConfigMap {
531
+ /** defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
532
+ "defaultMode"?: number;
533
+ /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */
534
+ "items"?: ItemsItem[];
535
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
536
+ "name"?: string;
537
+ /** optional specify whether the ConfigMap or its keys must be defined */
538
+ "optional"?: boolean;
539
+ }
540
+ export interface NodePublishSecretRef {
541
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
542
+ "name"?: string;
543
+ }
544
+ export interface Csi {
545
+ /** driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. */
546
+ "driver": string;
547
+ /** fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. */
548
+ "fsType"?: string;
549
+ /** nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. */
550
+ "nodePublishSecretRef"?: NodePublishSecretRef;
551
+ /** readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). */
552
+ "readOnly"?: boolean;
553
+ /** volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. */
554
+ "volumeAttributes"?: Record<string, unknown>;
555
+ }
556
+ export interface ItemsItem2 {
557
+ /** Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. */
558
+ "fieldRef"?: FieldRef;
559
+ /** Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
560
+ "mode"?: number;
561
+ /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */
562
+ "path": string;
563
+ /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */
564
+ "resourceFieldRef"?: ResourceFieldRef;
565
+ }
566
+ export interface DownwardAPI {
567
+ /** Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
568
+ "defaultMode"?: number;
569
+ /** Items is a list of downward API volume file */
570
+ "items"?: ItemsItem2[];
571
+ }
572
+ export interface EmptyDir {
573
+ /** medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */
574
+ "medium"?: string;
575
+ /** sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */
576
+ "sizeLimit"?: number | string;
577
+ }
578
+ export interface DataSource {
579
+ /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */
580
+ "apiGroup"?: string;
581
+ /** Kind is the type of resource being referenced */
582
+ "kind": string;
583
+ /** Name is the name of resource being referenced */
584
+ "name": string;
585
+ }
586
+ export interface DataSourceRef {
587
+ /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */
588
+ "apiGroup"?: string;
589
+ /** Kind is the type of resource being referenced */
590
+ "kind": string;
591
+ /** Name is the name of resource being referenced */
592
+ "name": string;
593
+ /** Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */
594
+ "namespace"?: string;
595
+ }
596
+ export interface Resources2 {
597
+ /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
598
+ "limits"?: Record<string, unknown>;
599
+ /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
600
+ "requests"?: Record<string, unknown>;
601
+ }
602
+ export interface Selector {
603
+ /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */
604
+ "matchExpressions"?: MatchExpressionsItem[];
605
+ /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */
606
+ "matchLabels"?: Record<string, unknown>;
607
+ }
608
+ export interface Spec {
609
+ /** accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */
610
+ "accessModes"?: string[];
611
+ /** dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. */
612
+ "dataSource"?: DataSource;
613
+ /** dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */
614
+ "dataSourceRef"?: DataSourceRef;
615
+ /** resources represents the minimum resources the volume should have. Users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */
616
+ "resources"?: Resources2;
617
+ /** selector is a label query over volumes to consider for binding. */
618
+ "selector"?: Selector;
619
+ /** storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 */
620
+ "storageClassName"?: string;
621
+ /** volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ */
622
+ "volumeAttributesClassName"?: string;
623
+ /** volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. */
624
+ "volumeMode"?: string;
625
+ /** volumeName is the binding reference to the PersistentVolume backing this claim. */
626
+ "volumeName"?: string;
627
+ }
628
+ export interface VolumeClaimTemplate {
629
+ /** May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. */
630
+ "metadata"?: Record<string, unknown>;
631
+ /** The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. */
632
+ "spec": Spec;
633
+ }
634
+ export interface Ephemeral {
635
+ /** Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil. */
636
+ "volumeClaimTemplate"?: VolumeClaimTemplate;
637
+ }
638
+ export interface Fc {
639
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */
640
+ "fsType"?: string;
641
+ /** lun is Optional: FC target lun number */
642
+ "lun"?: number;
643
+ /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
644
+ "readOnly"?: boolean;
645
+ /** targetWWNs is Optional: FC target worldwide names (WWNs) */
646
+ "targetWWNs"?: string[];
647
+ /** wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. */
648
+ "wwids"?: string[];
649
+ }
650
+ export interface FlexVolume {
651
+ /** driver is the name of the driver to use for this volume. */
652
+ "driver": string;
653
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. */
654
+ "fsType"?: string;
655
+ /** options is Optional: this field holds extra command options if any. */
656
+ "options"?: Record<string, unknown>;
657
+ /** readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
658
+ "readOnly"?: boolean;
659
+ /** secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. */
660
+ "secretRef"?: SecretRef;
661
+ }
662
+ export interface Flocker {
663
+ /** datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated */
664
+ "datasetName"?: string;
665
+ /** datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset */
666
+ "datasetUUID"?: string;
667
+ }
668
+ export interface GcePersistentDisk {
669
+ /** fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */
670
+ "fsType"?: string;
671
+ /** partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */
672
+ "partition"?: number;
673
+ /** pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */
674
+ "pdName": string;
675
+ /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */
676
+ "readOnly"?: boolean;
677
+ }
678
+ export interface GitRepo {
679
+ /** directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */
680
+ "directory"?: string;
681
+ /** repository is the URL */
682
+ "repository": string;
683
+ /** revision is the commit hash for the specified revision. */
684
+ "revision"?: string;
685
+ }
686
+ export interface Glusterfs {
687
+ /** endpoints is the endpoint name that details Glusterfs topology. */
688
+ "endpoints": string;
689
+ /** path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */
690
+ "path": string;
691
+ /** readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */
692
+ "readOnly"?: boolean;
693
+ }
694
+ export interface HostPath {
695
+ /** path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */
696
+ "path": string;
697
+ /** type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */
698
+ "type"?: string;
699
+ }
700
+ export interface Image {
701
+ /** Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. */
702
+ "pullPolicy"?: string;
703
+ /** Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */
704
+ "reference"?: string;
705
+ }
706
+ export interface Iscsi {
707
+ /** chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication */
708
+ "chapAuthDiscovery"?: boolean;
709
+ /** chapAuthSession defines whether support iSCSI Session CHAP authentication */
710
+ "chapAuthSession"?: boolean;
711
+ /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi */
712
+ "fsType"?: string;
713
+ /** initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. */
714
+ "initiatorName"?: string;
715
+ /** iqn is the target iSCSI Qualified Name. */
716
+ "iqn": string;
717
+ /** iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). */
718
+ "iscsiInterface"?: string;
719
+ /** lun represents iSCSI Target Lun number. */
720
+ "lun": number;
721
+ /** portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */
722
+ "portals"?: string[];
723
+ /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. */
724
+ "readOnly"?: boolean;
725
+ /** secretRef is the CHAP Secret for iSCSI target and initiator authentication */
726
+ "secretRef"?: SecretRef;
727
+ /** targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */
728
+ "targetPortal": string;
729
+ }
730
+ export interface Nfs {
731
+ /** path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */
732
+ "path": string;
733
+ /** readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */
734
+ "readOnly"?: boolean;
735
+ /** server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */
736
+ "server": string;
737
+ }
738
+ export interface PersistentVolumeClaim {
739
+ /** claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */
740
+ "claimName": string;
741
+ /** readOnly Will force the ReadOnly setting in VolumeMounts. Default false. */
742
+ "readOnly"?: boolean;
743
+ }
744
+ export interface PhotonPersistentDisk {
745
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */
746
+ "fsType"?: string;
747
+ /** pdID is the ID that identifies Photon Controller persistent disk */
748
+ "pdID": string;
749
+ }
750
+ export interface PortworxVolume {
751
+ /** fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. */
752
+ "fsType"?: string;
753
+ /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
754
+ "readOnly"?: boolean;
755
+ /** volumeID uniquely identifies a Portworx volume */
756
+ "volumeID": string;
757
+ }
758
+ export interface ClusterTrustBundle {
759
+ /** Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything". */
760
+ "labelSelector"?: LabelSelector;
761
+ /** Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector. */
762
+ "name"?: string;
763
+ /** If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles. */
764
+ "optional"?: boolean;
765
+ /** Relative path from the volume root to write the bundle. */
766
+ "path": string;
767
+ /** Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated. */
768
+ "signerName"?: string;
769
+ }
770
+ export interface ConfigMap2 {
771
+ /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */
772
+ "items"?: ItemsItem[];
773
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
774
+ "name"?: string;
775
+ /** optional specify whether the ConfigMap or its keys must be defined */
776
+ "optional"?: boolean;
777
+ }
778
+ export interface DownwardAPI2 {
779
+ /** Items is a list of DownwardAPIVolume file */
780
+ "items"?: ItemsItem2[];
781
+ }
782
+ export interface PodCertificate {
783
+ /** Write the certificate chain at this path in the projected volume. Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation. */
784
+ "certificateChainPath"?: string;
785
+ /** Write the credential bundle at this path in the projected volume. The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key. The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates). Using credentialBundlePath lets your Pod's application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key. */
786
+ "credentialBundlePath"?: string;
787
+ /** Write the key at this path in the projected volume. Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation. */
788
+ "keyPath"?: string;
789
+ /** The type of keypair Kubelet will generate for the pod. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519". */
790
+ "keyType": string;
791
+ /** maxExpirationSeconds is the maximum lifetime permitted for the certificate. Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection. If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days). The signer implementation is then free to issue a certificate with any lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. `kubernetes.io` signers will never issue certificates with a lifetime longer than 24 hours. */
792
+ "maxExpirationSeconds"?: number;
793
+ /** Kubelet's generated CSRs will be addressed to this signer. */
794
+ "signerName": string;
795
+ /** userAnnotations allow pod authors to pass additional information to the signer implementation. Kubernetes does not restrict or validate this metadata in any way. These values are copied verbatim into the `spec.unverifiedUserAnnotations` field of the PodCertificateRequest objects that Kubelet creates. Entries are subject to the same validation as object metadata annotations, with the addition that all keys must be domain-prefixed. No restrictions are placed on values, except an overall size limitation on the entire field. Signers should document the keys and values they support. Signers should deny requests that contain keys they do not recognize. */
796
+ "userAnnotations"?: Record<string, unknown>;
797
+ }
798
+ export interface Secret {
799
+ /** items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */
800
+ "items"?: ItemsItem[];
801
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
802
+ "name"?: string;
803
+ /** optional field specify whether the Secret or its key must be defined */
804
+ "optional"?: boolean;
805
+ }
806
+ export interface ServiceAccountToken {
807
+ /** audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */
808
+ "audience"?: string;
809
+ /** expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. */
810
+ "expirationSeconds"?: number;
811
+ /** path is the path relative to the mount point of the file to project the token into. */
812
+ "path": string;
813
+ }
814
+ export interface SourcesItem {
815
+ /** ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time. */
816
+ "clusterTrustBundle"?: ClusterTrustBundle;
817
+ /** configMap information about the configMap data to project */
818
+ "configMap"?: ConfigMap2;
819
+ /** downwardAPI information about the downwardAPI data to project */
820
+ "downwardAPI"?: DownwardAPI2;
821
+ /** Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server. Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec. Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp. Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields. The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order). Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent. The named signer controls chooses the format of the certificate it issues; consult the signer implementation's documentation to learn how to use the certificates it issues. */
822
+ "podCertificate"?: PodCertificate;
823
+ /** secret information about the secret data to project */
824
+ "secret"?: Secret;
825
+ /** serviceAccountToken is information about the serviceAccountToken data to project */
826
+ "serviceAccountToken"?: ServiceAccountToken;
827
+ }
828
+ export interface Projected {
829
+ /** defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
830
+ "defaultMode"?: number;
831
+ /** sources is the list of volume projections. Each entry in this list handles one source. */
832
+ "sources"?: SourcesItem[];
833
+ }
834
+ export interface Quobyte {
835
+ /** group to map volume access to Default is no group */
836
+ "group"?: string;
837
+ /** readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. */
838
+ "readOnly"?: boolean;
839
+ /** registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes */
840
+ "registry": string;
841
+ /** tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin */
842
+ "tenant"?: string;
843
+ /** user to map volume access to Defaults to serivceaccount user */
844
+ "user"?: string;
845
+ /** volume is a string that references an already created Quobyte volume by name. */
846
+ "volume": string;
847
+ }
848
+ export interface Rbd {
849
+ /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd */
850
+ "fsType"?: string;
851
+ /** image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
852
+ "image": string;
853
+ /** keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
854
+ "keyring"?: string;
855
+ /** monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
856
+ "monitors": string[];
857
+ /** pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
858
+ "pool"?: string;
859
+ /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
860
+ "readOnly"?: boolean;
861
+ /** secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
862
+ "secretRef"?: SecretRef;
863
+ /** user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */
864
+ "user"?: string;
865
+ }
866
+ export interface ScaleIO {
867
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". */
868
+ "fsType"?: string;
869
+ /** gateway is the host address of the ScaleIO API Gateway. */
870
+ "gateway": string;
871
+ /** protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. */
872
+ "protectionDomain"?: string;
873
+ /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
874
+ "readOnly"?: boolean;
875
+ /** secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. */
876
+ "secretRef": SecretRef;
877
+ /** sslEnabled Flag enable/disable SSL communication with Gateway, default false */
878
+ "sslEnabled"?: boolean;
879
+ /** storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. */
880
+ "storageMode"?: string;
881
+ /** storagePool is the ScaleIO Storage Pool associated with the protection domain. */
882
+ "storagePool"?: string;
883
+ /** system is the name of the storage system as configured in ScaleIO. */
884
+ "system": string;
885
+ /** volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. */
886
+ "volumeName"?: string;
887
+ }
888
+ export interface Secret2 {
889
+ /** defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. */
890
+ "defaultMode"?: number;
891
+ /** items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */
892
+ "items"?: ItemsItem[];
893
+ /** optional field specify whether the Secret or its keys must be defined */
894
+ "optional"?: boolean;
895
+ /** secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */
896
+ "secretName"?: string;
897
+ }
898
+ export interface Storageos {
899
+ /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */
900
+ "fsType"?: string;
901
+ /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */
902
+ "readOnly"?: boolean;
903
+ /** secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. */
904
+ "secretRef"?: SecretRef;
905
+ /** volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. */
906
+ "volumeName"?: string;
907
+ /** volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. */
908
+ "volumeNamespace"?: string;
909
+ }
910
+ export interface VsphereVolume {
911
+ /** fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */
912
+ "fsType"?: string;
913
+ /** storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. */
914
+ "storagePolicyID"?: string;
915
+ /** storagePolicyName is the storage Policy Based Management (SPBM) profile name. */
916
+ "storagePolicyName"?: string;
917
+ /** volumePath is the path that identifies vSphere volume vmdk */
918
+ "volumePath": string;
919
+ }
920
+ export interface VolumesItem {
921
+ /** awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */
922
+ "awsElasticBlockStore"?: AwsElasticBlockStore;
923
+ /** azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver. */
924
+ "azureDisk"?: AzureDisk;
925
+ /** azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver. */
926
+ "azureFile"?: AzureFile;
927
+ /** cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. */
928
+ "cephfs"?: Cephfs;
929
+ /** cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */
930
+ "cinder"?: Cinder;
931
+ /** configMap represents a configMap that should populate this volume */
932
+ "configMap"?: ConfigMap;
933
+ /** csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers. */
934
+ "csi"?: Csi;
935
+ /** downwardAPI represents downward API about the pod that should populate this volume */
936
+ "downwardAPI"?: DownwardAPI;
937
+ /** emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */
938
+ "emptyDir"?: EmptyDir;
939
+ /** ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. */
940
+ "ephemeral"?: Ephemeral;
941
+ /** fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. */
942
+ "fc"?: Fc;
943
+ /** flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. */
944
+ "flexVolume"?: FlexVolume;
945
+ /** flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. */
946
+ "flocker"?: Flocker;
947
+ /** gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */
948
+ "gcePersistentDisk"?: GcePersistentDisk;
949
+ /** gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */
950
+ "gitRepo"?: GitRepo;
951
+ /** glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. */
952
+ "glusterfs"?: Glusterfs;
953
+ /** hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */
954
+ "hostPath"?: HostPath;
955
+ /** image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided: - Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. */
956
+ "image"?: Image;
957
+ /** iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi */
958
+ "iscsi"?: Iscsi;
959
+ /** name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
960
+ "name": string;
961
+ /** nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */
962
+ "nfs"?: Nfs;
963
+ /** persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */
964
+ "persistentVolumeClaim"?: PersistentVolumeClaim;
965
+ /** photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. */
966
+ "photonPersistentDisk"?: PhotonPersistentDisk;
967
+ /** portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on. */
968
+ "portworxVolume"?: PortworxVolume;
969
+ /** projected items for all in one resources secrets, configmaps, and downward API */
970
+ "projected"?: Projected;
971
+ /** quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. */
972
+ "quobyte"?: Quobyte;
973
+ /** rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. */
974
+ "rbd"?: Rbd;
975
+ /** scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. */
976
+ "scaleIO"?: ScaleIO;
977
+ /** secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */
978
+ "secret"?: Secret2;
979
+ /** storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. */
980
+ "storageos"?: Storageos;
981
+ /** vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver. */
982
+ "vsphereVolume"?: VsphereVolume;
983
+ }
984
+ export interface Pod {
985
+ /** If specified, the pod's scheduling constraints. */
986
+ "affinity"?: Affinity;
987
+ /** Annotations are the annotations that should be appended to the pods. By default, no pod annotations are appended. */
988
+ "annotations"?: Record<string, unknown>;
989
+ /** ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod */
990
+ "imagePullSecrets"?: ImagePullSecretsItem[];
991
+ /** Labels are the additional labels that should be tagged to the pods. By default, no additional pod labels are tagged. */
992
+ "labels"?: Record<string, unknown>;
993
+ /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */
994
+ "nodeSelector"?: Record<string, unknown>;
995
+ /** PriorityClassName indicates the importance of a Pod relative to other Pods. If a PriorityClassName is not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ */
996
+ "priorityClassName"?: string;
997
+ /** SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. */
998
+ "securityContext"?: SecurityContext2;
999
+ /** If specified, the pod's tolerations. */
1000
+ "tolerations"?: TolerationsItem[];
1001
+ /** TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. */
1002
+ "topologySpreadConstraints"?: TopologySpreadConstraintsItem[];
1003
+ /** Volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes */
1004
+ "volumes"?: VolumesItem[];
1005
+ }
1006
+ export interface RollingUpdate {
1007
+ /** The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediately created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. */
1008
+ "maxSurge"?: number | string;
1009
+ /** The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. */
1010
+ "maxUnavailable"?: number | string;
1011
+ }
1012
+ export interface Strategy {
1013
+ /** Rolling update config params. Present only if type = "RollingUpdate". */
1014
+ "rollingUpdate"?: RollingUpdate;
1015
+ /** Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. */
1016
+ "type"?: string;
1017
+ }
1018
+ export interface EnvoyDaemonSet {
1019
+ /** Container defines the desired specification of main container. */
1020
+ "container"?: Container;
1021
+ /** Name of the daemonSet. When unset, this defaults to an autogenerated name. */
1022
+ "name"?: string;
1023
+ /** Patch defines how to perform the patch operation to daemonset */
1024
+ "patch"?: Patch;
1025
+ /** Pod defines the desired specification of pod. */
1026
+ "pod"?: Pod;
1027
+ /** The daemonset strategy to use to replace existing pods with new ones. */
1028
+ "strategy"?: Strategy;
1029
+ }
1030
+ export interface ConfigMapRef {
1031
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
1032
+ "name"?: string;
1033
+ /** Specify whether the ConfigMap must be defined */
1034
+ "optional"?: boolean;
1035
+ }
1036
+ export interface SecretRef2 {
1037
+ /** Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
1038
+ "name"?: string;
1039
+ /** Specify whether the Secret must be defined */
1040
+ "optional"?: boolean;
1041
+ }
1042
+ export interface EnvFromItem {
1043
+ /** The ConfigMap to select from */
1044
+ "configMapRef"?: ConfigMapRef;
1045
+ /** Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='. */
1046
+ "prefix"?: string;
1047
+ /** The Secret to select from */
1048
+ "secretRef"?: SecretRef2;
1049
+ }
1050
+ export interface Exec {
1051
+ /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */
1052
+ "command"?: string[];
1053
+ }
1054
+ export interface HttpHeadersItem {
1055
+ /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */
1056
+ "name": string;
1057
+ /** The header field value */
1058
+ "value": string;
1059
+ }
1060
+ export interface HttpGet {
1061
+ /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */
1062
+ "host"?: string;
1063
+ /** Custom headers to set in the request. HTTP allows repeated headers. */
1064
+ "httpHeaders"?: HttpHeadersItem[];
1065
+ /** Path to access on the HTTP server. */
1066
+ "path"?: string;
1067
+ /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */
1068
+ "port": number | string;
1069
+ /** Scheme to use for connecting to the host. Defaults to HTTP. */
1070
+ "scheme"?: string;
1071
+ }
1072
+ export interface Sleep {
1073
+ /** Seconds is the number of seconds to sleep. */
1074
+ "seconds": number;
1075
+ }
1076
+ export interface TcpSocket {
1077
+ /** Optional: Host name to connect to, defaults to the pod IP. */
1078
+ "host"?: string;
1079
+ /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */
1080
+ "port": number | string;
1081
+ }
1082
+ export interface PostStart {
1083
+ /** Exec specifies a command to execute in the container. */
1084
+ "exec"?: Exec;
1085
+ /** HTTPGet specifies an HTTP GET request to perform. */
1086
+ "httpGet"?: HttpGet;
1087
+ /** Sleep represents a duration that the container should sleep. */
1088
+ "sleep"?: Sleep;
1089
+ /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified. */
1090
+ "tcpSocket"?: TcpSocket;
1091
+ }
1092
+ export interface PreStop {
1093
+ /** Exec specifies a command to execute in the container. */
1094
+ "exec"?: Exec;
1095
+ /** HTTPGet specifies an HTTP GET request to perform. */
1096
+ "httpGet"?: HttpGet;
1097
+ /** Sleep represents a duration that the container should sleep. */
1098
+ "sleep"?: Sleep;
1099
+ /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified. */
1100
+ "tcpSocket"?: TcpSocket;
1101
+ }
1102
+ export interface Lifecycle {
1103
+ /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */
1104
+ "postStart"?: PostStart;
1105
+ /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */
1106
+ "preStop"?: PreStop;
1107
+ /** StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name */
1108
+ "stopSignal"?: string;
1109
+ }
1110
+ export interface Grpc {
1111
+ /** Port number of the gRPC service. Number must be in the range 1 to 65535. */
1112
+ "port": number;
1113
+ /** Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. */
1114
+ "service"?: string;
1115
+ }
1116
+ export interface LivenessProbe {
1117
+ /** Exec specifies a command to execute in the container. */
1118
+ "exec"?: Exec;
1119
+ /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
1120
+ "failureThreshold"?: number;
1121
+ /** GRPC specifies a GRPC HealthCheckRequest. */
1122
+ "grpc"?: Grpc;
1123
+ /** HTTPGet specifies an HTTP GET request to perform. */
1124
+ "httpGet"?: HttpGet;
1125
+ /** Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1126
+ "initialDelaySeconds"?: number;
1127
+ /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
1128
+ "periodSeconds"?: number;
1129
+ /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. */
1130
+ "successThreshold"?: number;
1131
+ /** TCPSocket specifies a connection to a TCP port. */
1132
+ "tcpSocket"?: TcpSocket;
1133
+ /** Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. */
1134
+ "terminationGracePeriodSeconds"?: number;
1135
+ /** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1136
+ "timeoutSeconds"?: number;
1137
+ }
1138
+ export interface PortsItem {
1139
+ /** Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. */
1140
+ "containerPort": number;
1141
+ /** What host IP to bind the external port to. */
1142
+ "hostIP"?: string;
1143
+ /** Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. */
1144
+ "hostPort"?: number;
1145
+ /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */
1146
+ "name"?: string;
1147
+ /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */
1148
+ "protocol"?: string;
1149
+ }
1150
+ export interface ReadinessProbe {
1151
+ /** Exec specifies a command to execute in the container. */
1152
+ "exec"?: Exec;
1153
+ /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
1154
+ "failureThreshold"?: number;
1155
+ /** GRPC specifies a GRPC HealthCheckRequest. */
1156
+ "grpc"?: Grpc;
1157
+ /** HTTPGet specifies an HTTP GET request to perform. */
1158
+ "httpGet"?: HttpGet;
1159
+ /** Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1160
+ "initialDelaySeconds"?: number;
1161
+ /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
1162
+ "periodSeconds"?: number;
1163
+ /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. */
1164
+ "successThreshold"?: number;
1165
+ /** TCPSocket specifies a connection to a TCP port. */
1166
+ "tcpSocket"?: TcpSocket;
1167
+ /** Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. */
1168
+ "terminationGracePeriodSeconds"?: number;
1169
+ /** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1170
+ "timeoutSeconds"?: number;
1171
+ }
1172
+ export interface ResizePolicyItem {
1173
+ /** Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. */
1174
+ "resourceName": string;
1175
+ /** Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. */
1176
+ "restartPolicy": string;
1177
+ }
1178
+ export interface ExitCodes {
1179
+ /** Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values. */
1180
+ "operator": string;
1181
+ /** Specifies the set of values to check for container exit codes. At most 255 elements are allowed. */
1182
+ "values"?: number[];
1183
+ }
1184
+ export interface RestartPolicyRulesItem {
1185
+ /** Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container. */
1186
+ "action": string;
1187
+ /** Represents the exit codes to check on container exits. */
1188
+ "exitCodes"?: ExitCodes;
1189
+ }
1190
+ export interface StartupProbe {
1191
+ /** Exec specifies a command to execute in the container. */
1192
+ "exec"?: Exec;
1193
+ /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
1194
+ "failureThreshold"?: number;
1195
+ /** GRPC specifies a GRPC HealthCheckRequest. */
1196
+ "grpc"?: Grpc;
1197
+ /** HTTPGet specifies an HTTP GET request to perform. */
1198
+ "httpGet"?: HttpGet;
1199
+ /** Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1200
+ "initialDelaySeconds"?: number;
1201
+ /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
1202
+ "periodSeconds"?: number;
1203
+ /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. */
1204
+ "successThreshold"?: number;
1205
+ /** TCPSocket specifies a connection to a TCP port. */
1206
+ "tcpSocket"?: TcpSocket;
1207
+ /** Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. */
1208
+ "terminationGracePeriodSeconds"?: number;
1209
+ /** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1210
+ "timeoutSeconds"?: number;
1211
+ }
1212
+ export interface VolumeDevicesItem {
1213
+ /** devicePath is the path inside of the container that the device will be mapped to. */
1214
+ "devicePath": string;
1215
+ /** name must match the name of a persistentVolumeClaim in the pod */
1216
+ "name": string;
1217
+ }
1218
+ export interface InitContainersItem {
1219
+ /** Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */
1220
+ "args"?: string[];
1221
+ /** Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */
1222
+ "command"?: string[];
1223
+ /** List of environment variables to set in the container. Cannot be updated. */
1224
+ "env"?: EnvItem[];
1225
+ /** List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */
1226
+ "envFrom"?: EnvFromItem[];
1227
+ /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */
1228
+ "image"?: string;
1229
+ /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */
1230
+ "imagePullPolicy"?: string;
1231
+ /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */
1232
+ "lifecycle"?: Lifecycle;
1233
+ /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1234
+ "livenessProbe"?: LivenessProbe;
1235
+ /** Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. */
1236
+ "name": string;
1237
+ /** List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. */
1238
+ "ports"?: PortsItem[];
1239
+ /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1240
+ "readinessProbe"?: ReadinessProbe;
1241
+ /** Resources resize policy for the container. This field cannot be set on ephemeral containers. */
1242
+ "resizePolicy"?: ResizePolicyItem[];
1243
+ /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */
1244
+ "resources"?: Resources;
1245
+ /** RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Additionally, setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. */
1246
+ "restartPolicy"?: string;
1247
+ /** Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod's RestartPolicy. */
1248
+ "restartPolicyRules"?: RestartPolicyRulesItem[];
1249
+ /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */
1250
+ "securityContext"?: SecurityContext;
1251
+ /** StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
1252
+ "startupProbe"?: StartupProbe;
1253
+ /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */
1254
+ "stdin"?: boolean;
1255
+ /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */
1256
+ "stdinOnce"?: boolean;
1257
+ /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */
1258
+ "terminationMessagePath"?: string;
1259
+ /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */
1260
+ "terminationMessagePolicy"?: string;
1261
+ /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */
1262
+ "tty"?: boolean;
1263
+ /** volumeDevices is the list of block devices to be used by the container. */
1264
+ "volumeDevices"?: VolumeDevicesItem[];
1265
+ /** Pod volumes to mount into the container's filesystem. Cannot be updated. */
1266
+ "volumeMounts"?: VolumeMountsItem[];
1267
+ /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */
1268
+ "workingDir"?: string;
1269
+ }
1270
+ export interface EnvoyDeployment {
1271
+ /** Container defines the desired specification of main container. */
1272
+ "container"?: Container;
1273
+ /** List of initialization containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ */
1274
+ "initContainers"?: InitContainersItem[];
1275
+ /** Name of the deployment. When unset, this defaults to an autogenerated name. */
1276
+ "name"?: string;
1277
+ /** Patch defines how to perform the patch operation to deployment */
1278
+ "patch"?: Patch;
1279
+ /** Pod defines the desired specification of pod. */
1280
+ "pod"?: Pod;
1281
+ /** Replicas is the number of desired pods. Defaults to 1. */
1282
+ "replicas"?: number;
1283
+ /** The deployment strategy to use to replace existing pods with new ones. */
1284
+ "strategy"?: Strategy;
1285
+ }
1286
+ export interface PoliciesItem {
1287
+ /** periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). */
1288
+ "periodSeconds": number;
1289
+ /** type is used to specify the scaling policy. */
1290
+ "type": string;
1291
+ /** value contains the amount of change which is permitted by the policy. It must be greater than zero */
1292
+ "value": number;
1293
+ }
1294
+ export interface ScaleDown {
1295
+ /** policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window. */
1296
+ "policies"?: PoliciesItem[];
1297
+ /** selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. */
1298
+ "selectPolicy"?: string;
1299
+ /** stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). */
1300
+ "stabilizationWindowSeconds"?: number;
1301
+ /** tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%). For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi. This is an beta field and requires the HPAConfigurableTolerance feature gate to be enabled. */
1302
+ "tolerance"?: number | string;
1303
+ }
1304
+ export interface ScaleUp {
1305
+ /** policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window. */
1306
+ "policies"?: PoliciesItem[];
1307
+ /** selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. */
1308
+ "selectPolicy"?: string;
1309
+ /** stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). */
1310
+ "stabilizationWindowSeconds"?: number;
1311
+ /** tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%). For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi. This is an beta field and requires the HPAConfigurableTolerance feature gate to be enabled. */
1312
+ "tolerance"?: number | string;
1313
+ }
1314
+ export interface Behavior {
1315
+ /** scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). */
1316
+ "scaleDown"?: ScaleDown;
1317
+ /** scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used. */
1318
+ "scaleUp"?: ScaleUp;
1319
+ }
1320
+ export interface Target {
1321
+ /** averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type */
1322
+ "averageUtilization"?: number;
1323
+ /** averageValue is the target value of the average of the metric across all relevant pods (as a quantity) */
1324
+ "averageValue"?: number | string;
1325
+ /** type represents whether the metric type is Utilization, Value, or AverageValue */
1326
+ "type": string;
1327
+ /** value is the target value of the metric (as a quantity). */
1328
+ "value"?: number | string;
1329
+ }
1330
+ export interface ContainerResource {
1331
+ /** container is the name of the container in the pods of the scaling target */
1332
+ "container": string;
1333
+ /** name is the name of the resource in question. */
1334
+ "name": string;
1335
+ /** target specifies the target value for the given metric */
1336
+ "target": Target;
1337
+ }
1338
+ export interface Metric {
1339
+ /** name is the name of the given metric */
1340
+ "name": string;
1341
+ /** selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. */
1342
+ "selector"?: Selector;
1343
+ }
1344
+ export interface External {
1345
+ /** metric identifies the target metric by name and selector */
1346
+ "metric": Metric;
1347
+ /** target specifies the target value for the given metric */
1348
+ "target": Target;
1349
+ }
1350
+ export interface DescribedObject {
1351
+ /** apiVersion is the API version of the referent */
1352
+ "apiVersion"?: string;
1353
+ /** kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */
1354
+ "kind": string;
1355
+ /** name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
1356
+ "name": string;
1357
+ }
1358
+ export interface Object {
1359
+ /** describedObject specifies the descriptions of a object,such as kind,name apiVersion */
1360
+ "describedObject": DescribedObject;
1361
+ /** metric identifies the target metric by name and selector */
1362
+ "metric": Metric;
1363
+ /** target specifies the target value for the given metric */
1364
+ "target": Target;
1365
+ }
1366
+ export interface Pods {
1367
+ /** metric identifies the target metric by name and selector */
1368
+ "metric": Metric;
1369
+ /** target specifies the target value for the given metric */
1370
+ "target": Target;
1371
+ }
1372
+ export interface Resource {
1373
+ /** name is the name of the resource in question. */
1374
+ "name": string;
1375
+ /** target specifies the target value for the given metric */
1376
+ "target": Target;
1377
+ }
1378
+ export interface MetricsItem {
1379
+ /** containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */
1380
+ "containerResource"?: ContainerResource;
1381
+ /** external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). */
1382
+ "external"?: External;
1383
+ /** object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). */
1384
+ "object"?: Object;
1385
+ /** pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. */
1386
+ "pods"?: Pods;
1387
+ /** resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */
1388
+ "resource"?: Resource;
1389
+ /** type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. */
1390
+ "type": string;
1391
+ }
1392
+ export interface EnvoyHpa {
1393
+ /** 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. See k8s.io.autoscaling.v2.HorizontalPodAutoScalerBehavior. */
1394
+ "behavior"?: Behavior;
1395
+ /** maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. */
1396
+ "maxReplicas": number;
1397
+ /** metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). If left empty, it defaults to being based on CPU utilization with average on 80% usage. */
1398
+ "metrics"?: MetricsItem[];
1399
+ /** minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 replica. */
1400
+ "minReplicas"?: number;
1401
+ /** Name of the horizontalPodAutoScaler. When unset, this defaults to an autogenerated name. */
1402
+ "name"?: string;
1403
+ /** Patch defines how to perform the patch operation to the HorizontalPodAutoscaler */
1404
+ "patch"?: Patch;
1405
+ }
1406
+ export interface EnvoyPDB {
1407
+ /** MaxUnavailable specifies the maximum amount of pods (can be expressed as integers or as a percentage) that can be unavailable at all times during voluntary disruptions, such as node drains or updates. This setting ensures that your envoy proxy maintains a certain level of availability and resilience during maintenance operations. Cannot be combined with minAvailable. */
1408
+ "maxUnavailable"?: number | string;
1409
+ /** MinAvailable specifies the minimum amount of pods (can be expressed as integers or as a percentage) that must be available at all times during voluntary disruptions, such as node drains or updates. This setting ensures that your envoy proxy maintains a certain level of availability and resilience during maintenance operations. Cannot be combined with maxUnavailable. */
1410
+ "minAvailable"?: number | string;
1411
+ /** Name of the podDisruptionBudget. When unset, this defaults to an autogenerated name. */
1412
+ "name"?: string;
1413
+ /** Patch defines how to perform the patch operation to the PodDisruptionBudget */
1414
+ "patch"?: Patch;
1415
+ }
1416
+ export interface EnvoyService {
1417
+ /** AllocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */
1418
+ "allocateLoadBalancerNodePorts"?: boolean;
1419
+ /** Annotations that should be appended to the service. By default, no annotations are appended. */
1420
+ "annotations"?: Record<string, unknown>;
1421
+ /** ExternalTrafficPolicy determines the externalTrafficPolicy for the Envoy Service. Valid options are Local and Cluster. Default is "Local". "Local" means traffic will only go to pods on the node receiving the traffic. "Cluster" means connections are loadbalanced to all pods in the cluster. */
1422
+ "externalTrafficPolicy"?: "Local" | "Cluster";
1423
+ /** Labels that should be appended to the service. By default, no labels are appended. */
1424
+ "labels"?: Record<string, unknown>;
1425
+ /** LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider implementation if more than one are available or is otherwise expected to be specified */
1426
+ "loadBalancerClass"?: string;
1427
+ /** LoadBalancerIP defines the IP Address of the underlying load balancer service. This field may be ignored if the load balancer provider does not support this feature. This field has been deprecated in Kubernetes, but it is still used for setting the IP Address in some cloud providers such as GCP. */
1428
+ "loadBalancerIP"?: string;
1429
+ /** LoadBalancerSourceRanges defines a list of allowed IP addresses which will be configured as firewall rules on the platform providers load balancer. This is not guaranteed to be working as it happens outside of kubernetes and has to be supported and handled by the platform provider. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */
1430
+ "loadBalancerSourceRanges"?: string[];
1431
+ /** Name of the service. When unset, this defaults to an autogenerated name. */
1432
+ "name"?: string;
1433
+ /** Patch defines how to perform the patch operation to the service */
1434
+ "patch"?: Patch;
1435
+ /** Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP, LoadBalancer and NodePort. "LoadBalancer" means a service will be exposed via an external load balancer (if the cloud provider supports it). "ClusterIP" means a service will only be accessible inside the cluster, via the cluster IP. "NodePort" means a service will be exposed on a static Port on all Nodes of the cluster. */
1436
+ "type"?: "ClusterIP" | "LoadBalancer" | "NodePort";
1437
+ }
1438
+ export interface EnvoyServiceAccount {
1439
+ /** Name of the Service Account. When unset, this defaults to an autogenerated name. */
1440
+ "name"?: string;
1441
+ }
1442
+ export interface Kubernetes {
1443
+ /** EnvoyDaemonSet defines the desired state of the Envoy daemonset resource. Disabled by default, a deployment resource is used instead to provision the Envoy Proxy fleet */
1444
+ "envoyDaemonSet"?: EnvoyDaemonSet;
1445
+ /** EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied. */
1446
+ "envoyDeployment"?: EnvoyDeployment;
1447
+ /** EnvoyHpa defines the Horizontal Pod Autoscaler settings for Envoy Proxy Deployment. */
1448
+ "envoyHpa"?: EnvoyHpa;
1449
+ /** EnvoyPDB allows to control the pod disruption budget of an Envoy Proxy. */
1450
+ "envoyPDB"?: EnvoyPDB;
1451
+ /** EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied. */
1452
+ "envoyService"?: EnvoyService;
1453
+ /** EnvoyServiceAccount defines the desired state of the Envoy service account resource. */
1454
+ "envoyServiceAccount"?: EnvoyServiceAccount;
1455
+ /** UseListenerPortAsContainerPort disables the port shifting feature in the Envoy Proxy. When set to false (default value), if the service port is a privileged port (1-1023), add a constant to the value converting it into an ephemeral port. This allows the container to bind to the port without needing a CAP_NET_BIND_SERVICE capability. */
1456
+ "useListenerPortAsContainerPort"?: boolean;
1457
+ }
1458
+ export interface Provider {
1459
+ /** Host provides runtime deployment of the data plane as a child process on the host environment. If unspecified and type is "Host", default settings for the custom provider are applied. */
1460
+ "host"?: Host;
1461
+ /** Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is "Kubernetes", default settings for managed Kubernetes resources are applied. */
1462
+ "kubernetes"?: Kubernetes;
1463
+ /** Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are "Kubernetes"and "Host". */
1464
+ "type": "Kubernetes" | "Host";
1465
+ }
1466
+ export interface Shutdown {
1467
+ /** DrainTimeout defines the graceful drain timeout. This should be less than the pod's terminationGracePeriodSeconds. If unspecified, defaults to 60 seconds. */
1468
+ "drainTimeout"?: string;
1469
+ /** MinDrainDuration defines the minimum drain duration allowing time for endpoint deprogramming to complete. If unspecified, defaults to 10 seconds. */
1470
+ "minDrainDuration"?: string;
1471
+ }
1472
+ export interface Format {
1473
+ /** JSON is additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used as values for fields within the Struct. It's required when the format type is "JSON". */
1474
+ "json"?: Record<string, unknown>;
1475
+ /** Text defines the text accesslog format, following Envoy accesslog formatting, It's required when the format type is "Text". Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) may be used in the format. The [format string documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-strings) provides more information. */
1476
+ "text"?: string;
1477
+ /** Type defines the type of accesslog format. When unset, both text and json can be specified. */
1478
+ "type"?: "Text" | "JSON";
1479
+ }
1480
+ export interface BackendRef {
1481
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
1482
+ "group"?: string;
1483
+ /** Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName) */
1484
+ "kind"?: string;
1485
+ /** Name is the name of the referent. */
1486
+ "name": string;
1487
+ /** Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core */
1488
+ "namespace"?: string;
1489
+ /** Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field. */
1490
+ "port"?: number;
1491
+ }
1492
+ export interface BackendRefsItem {
1493
+ /** Fallback indicates whether the backend is designated as a fallback. Multiple fallback backends can be configured. It is highly recommended to configure active or passive health checks to ensure that failover can be detected when the active backends become unhealthy and to automatically readjust once the primary backends are healthy again. The overprovisioning factor is set to 1.4, meaning the fallback backends will only start receiving traffic when the health of the active backends falls below 72%. */
1494
+ "fallback"?: boolean;
1495
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
1496
+ "group"?: string;
1497
+ /** Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName) */
1498
+ "kind"?: string;
1499
+ /** Name is the name of the referent. */
1500
+ "name": string;
1501
+ /** Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core */
1502
+ "namespace"?: string;
1503
+ /** Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field. */
1504
+ "port"?: number;
1505
+ /** Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used. */
1506
+ "weight"?: number;
1507
+ }
1508
+ export interface PerEndpoint {
1509
+ /** MaxConnections configures the maximum number of connections that Envoy will establish per-endpoint to the referenced backend defined within a xRoute rule. */
1510
+ "maxConnections"?: number;
1511
+ }
1512
+ export interface CircuitBreaker {
1513
+ /** The maximum number of connections that Envoy will establish to the referenced backend defined within a xRoute rule. */
1514
+ "maxConnections"?: number;
1515
+ /** The maximum number of parallel requests that Envoy will make to the referenced backend defined within a xRoute rule. */
1516
+ "maxParallelRequests"?: number;
1517
+ /** The maximum number of parallel retries that Envoy will make to the referenced backend defined within a xRoute rule. */
1518
+ "maxParallelRetries"?: number;
1519
+ /** The maximum number of pending requests that Envoy will queue to the referenced backend defined within a xRoute rule. */
1520
+ "maxPendingRequests"?: number;
1521
+ /** The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule. Default: unlimited. */
1522
+ "maxRequestsPerConnection"?: number;
1523
+ /** PerEndpoint defines Circuit Breakers that will apply per-endpoint for an upstream cluster */
1524
+ "perEndpoint"?: PerEndpoint;
1525
+ }
1526
+ export interface Preconnect {
1527
+ /** PerEndpointPercent configures how many additional connections to maintain per upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a percentage of the connections required by active streams (e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×). Allowed value range is between 100-300. When both PerEndpointPercent and PredictivePercent are set, Envoy ensures both are satisfied (max of the two). */
1528
+ "perEndpointPercent"?: number;
1529
+ /** PredictivePercent configures how many additional connections to maintain across the cluster by anticipating which upstream endpoint the load balancer will select next, useful for low-QPS services. Relies on deterministic loadbalancing and is only supported with Random or RoundRobin. Expressed as a percentage of the connections required by active streams (e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×). Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are set Envoy ensures both are satisfied per host (max of the two). */
1530
+ "predictivePercent"?: number;
1531
+ }
1532
+ export interface Connection {
1533
+ /** BufferLimit Soft limit on size of the cluster’s connections read and write buffers. BufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space. If unspecified, an implementation defined default is applied (32768 bytes). For example, 20Mi, 1Gi, 256Ki etc. Note: that when the suffix is not provided, the value is interpreted as bytes. */
1534
+ "bufferLimit"?: number | string;
1535
+ /** Preconnect configures proactive upstream connections to reduce latency by establishing connections before they’re needed and avoiding connection establishment overhead. If unset, Envoy will fetch connections as needed to serve in-flight requests. */
1536
+ "preconnect"?: Preconnect;
1537
+ /** SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket to backend. SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space. For example, 20Mi, 1Gi, 256Ki etc. Note that when the suffix is not provided, the value is interpreted as bytes. */
1538
+ "socketBufferLimit"?: number | string;
1539
+ }
1540
+ export interface Dns {
1541
+ /** DNSRefreshRate specifies the rate at which DNS records should be refreshed. Defaults to 30 seconds. */
1542
+ "dnsRefreshRate"?: string;
1543
+ /** LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN). If set, this configuration overrides other defaults. */
1544
+ "lookupFamily"?: "IPv4" | "IPv6" | "IPv4Preferred" | "IPv6Preferred" | "IPv4AndIPv6";
1545
+ /** RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected. If the value is set to true, the DNS refresh rate will be set to the resource record’s TTL. Defaults to true. */
1546
+ "respectDnsTtl"?: boolean;
1547
+ }
1548
+ export interface Grpc2 {
1549
+ /** Service to send in the health check request. If this is not specified, then the health check request applies to the entire server and not to a specific service. */
1550
+ "service"?: string;
1551
+ }
1552
+ export interface ExpectedResponse {
1553
+ /** Binary payload base64 encoded. */
1554
+ "binary"?: string;
1555
+ /** Text payload in plain text. */
1556
+ "text"?: string;
1557
+ /** Type defines the type of the payload. */
1558
+ "type": string;
1559
+ }
1560
+ export interface Http {
1561
+ /** ExpectedResponse defines a list of HTTP expected responses to match. */
1562
+ "expectedResponse"?: ExpectedResponse;
1563
+ /** ExpectedStatuses defines a list of HTTP response statuses considered healthy. Defaults to 200 only */
1564
+ "expectedStatuses"?: number[];
1565
+ /** Hostname defines the HTTP host that will be requested during health checking. Default: HTTPRoute or GRPCRoute hostname. */
1566
+ "hostname"?: string;
1567
+ /** Method defines the HTTP method used for health checking. Defaults to GET */
1568
+ "method"?: string;
1569
+ /** Path defines the HTTP path that will be requested during health checking. */
1570
+ "path": string;
1571
+ }
1572
+ export interface Receive {
1573
+ /** Binary payload base64 encoded. */
1574
+ "binary"?: string;
1575
+ /** Text payload in plain text. */
1576
+ "text"?: string;
1577
+ /** Type defines the type of the payload. */
1578
+ "type": string;
1579
+ }
1580
+ export interface Send {
1581
+ /** Binary payload base64 encoded. */
1582
+ "binary"?: string;
1583
+ /** Text payload in plain text. */
1584
+ "text"?: string;
1585
+ /** Type defines the type of the payload. */
1586
+ "type": string;
1587
+ }
1588
+ export interface Tcp {
1589
+ /** Receive defines the expected response payload. */
1590
+ "receive"?: Receive;
1591
+ /** Send defines the request payload. */
1592
+ "send"?: Send;
1593
+ }
1594
+ export interface Active {
1595
+ /** GRPC defines the configuration of the GRPC health checker. It's optional, and can only be used if the specified type is GRPC. */
1596
+ "grpc"?: Grpc2;
1597
+ /** HealthyThreshold defines the number of healthy health checks required before a backend host is marked healthy. */
1598
+ "healthyThreshold"?: number;
1599
+ /** HTTP defines the configuration of http health checker. It's required while the health checker type is HTTP. */
1600
+ "http"?: Http;
1601
+ /** InitialJitter defines the maximum time Envoy will wait before the first health check. Envoy will randomly select a value between 0 and the initial jitter value. */
1602
+ "initialJitter"?: string;
1603
+ /** Interval defines the time between active health checks. */
1604
+ "interval"?: string;
1605
+ /** TCP defines the configuration of tcp health checker. It's required while the health checker type is TCP. */
1606
+ "tcp"?: Tcp;
1607
+ /** Timeout defines the time to wait for a health check response. */
1608
+ "timeout"?: string;
1609
+ /** Type defines the type of health checker. */
1610
+ "type": string;
1611
+ /** UnhealthyThreshold defines the number of unhealthy health checks required before a backend host is marked unhealthy. */
1612
+ "unhealthyThreshold"?: number;
1613
+ }
1614
+ export interface Passive {
1615
+ /** BaseEjectionTime defines the base duration for which a host will be ejected on consecutive failures. */
1616
+ "baseEjectionTime"?: string;
1617
+ /** Consecutive5xxErrors sets the number of consecutive 5xx errors triggering ejection. */
1618
+ "consecutive5XxErrors"?: number;
1619
+ /** ConsecutiveGatewayErrors sets the number of consecutive gateway errors triggering ejection. */
1620
+ "consecutiveGatewayErrors"?: number;
1621
+ /** ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection. Parameter takes effect only when split_external_local_origin_errors is set to true. */
1622
+ "consecutiveLocalOriginFailures"?: number;
1623
+ /** FailurePercentageThreshold sets the failure percentage threshold for outlier detection. If the failure percentage of a given host is greater than or equal to this value, it will be ejected. Defaults to 85. */
1624
+ "failurePercentageThreshold"?: number;
1625
+ /** Interval defines the time between passive health checks. */
1626
+ "interval"?: string;
1627
+ /** MaxEjectionPercent sets the maximum percentage of hosts in a cluster that can be ejected. */
1628
+ "maxEjectionPercent"?: number;
1629
+ /** SplitExternalLocalOriginErrors enables splitting of errors between external and local origin. */
1630
+ "splitExternalLocalOriginErrors"?: boolean;
1631
+ }
1632
+ export interface HealthCheck {
1633
+ /** Active health check configuration */
1634
+ "active"?: Active;
1635
+ /** When number of unhealthy endpoints for a backend reaches this threshold Envoy will disregard health status and balance across all endpoints. It's designed to prevent a situation in which host failures cascade throughout the cluster as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`. */
1636
+ "panicThreshold"?: number;
1637
+ /** Passive passive check configuration */
1638
+ "passive"?: Passive;
1639
+ }
1640
+ export interface Http2 {
1641
+ /** InitialConnectionWindowSize sets the initial window size for HTTP/2 connections. If not set, the default value is 1 MiB. */
1642
+ "initialConnectionWindowSize"?: number | string;
1643
+ /** InitialStreamWindowSize sets the initial window size for HTTP/2 streams. If not set, the default value is 64 KiB(64*1024). */
1644
+ "initialStreamWindowSize"?: number | string;
1645
+ /** MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection. If not set, the default value is 100. */
1646
+ "maxConcurrentStreams"?: number;
1647
+ /** OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error It's recommended for L2 Envoy deployments to set this value to TerminateStream. https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two Default: TerminateConnection */
1648
+ "onInvalidMessage"?: string;
1649
+ }
1650
+ export interface Cookie {
1651
+ /** Additional Attributes to set for the generated cookie. */
1652
+ "attributes"?: Record<string, unknown>;
1653
+ /** Name of the cookie to hash. If this cookie does not exist in the request, Envoy will generate a cookie and set the TTL on the response back to the client based on Layer 4 attributes of the backend endpoint, to ensure that these future requests go to the same backend endpoint. Make sure to set the TTL field for this case. */
1654
+ "name": string;
1655
+ /** TTL of the generated cookie if the cookie is not present. This value sets the Max-Age attribute value. */
1656
+ "ttl"?: string;
1657
+ }
1658
+ export interface Header {
1659
+ /** Name of the header to hash. */
1660
+ "name": string;
1661
+ }
1662
+ export interface HeadersItem {
1663
+ /** Name of the header to hash. */
1664
+ "name": string;
1665
+ }
1666
+ export interface QueryParamsItem {
1667
+ /** Name of the query param to hash. */
1668
+ "name": string;
1669
+ }
1670
+ export interface ConsistentHash {
1671
+ /** Cookie configures the cookie hash policy when the consistent hash type is set to Cookie. */
1672
+ "cookie"?: Cookie;
1673
+ /** Header configures the header hash policy when the consistent hash type is set to Header. Deprecated: use Headers instead */
1674
+ "header"?: Header;
1675
+ /** Headers configures the header hash policy for each header, when the consistent hash type is set to Headers. */
1676
+ "headers"?: HeadersItem[];
1677
+ /** QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams. */
1678
+ "queryParams"?: QueryParamsItem[];
1679
+ /** The table size for consistent hashing, must be prime number limited to 5000011. */
1680
+ "tableSize"?: number;
1681
+ /** ConsistentHashType defines the type of input to hash on. Valid Type values are "SourceIP", "Header", "Headers", "Cookie". "QueryParams". */
1682
+ "type": "SourceIP" | "Header" | "Headers" | "Cookie" | "QueryParams";
1683
+ }
1684
+ export interface ExtractFromItem {
1685
+ /** Header defines the header to get the override endpoint addresses. The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format. For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`. The IPv6 address is enclosed in square brackets. */
1686
+ "header"?: string;
1687
+ }
1688
+ export interface EndpointOverride {
1689
+ /** ExtractFrom defines the sources to extract endpoint override information from. */
1690
+ "extractFrom": ExtractFromItem[];
1691
+ }
1692
+ export interface SlowStart {
1693
+ /** Window defines the duration of the warm up period for newly added host. During slow start window, traffic sent to the newly added hosts will gradually increase. Currently only supports linear growth of traffic. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig */
1694
+ "window": string;
1695
+ }
1696
+ export interface Force {
1697
+ /** MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone override. This is useful for protecting zones with fewer endpoints. */
1698
+ "minEndpointsInZoneThreshold"?: number;
1699
+ }
1700
+ export interface PreferLocal {
1701
+ /** ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally. */
1702
+ "force"?: Force;
1703
+ /** MinEndpointsThreshold is the minimum number of total upstream endpoints across all zones required to enable zone-aware routing. */
1704
+ "minEndpointsThreshold"?: number;
1705
+ /** Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured. If not specified, Envoy defaults to 100%. */
1706
+ "percentageEnabled"?: number;
1707
+ }
1708
+ export interface ZoneAware {
1709
+ /** PreferLocalZone configures zone-aware routing to prefer sending traffic to the local locality zone. */
1710
+ "preferLocal"?: PreferLocal;
1711
+ }
1712
+ export interface LoadBalancer {
1713
+ /** ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash */
1714
+ "consistentHash"?: ConsistentHash;
1715
+ /** EndpointOverride defines the configuration for endpoint override. When specified, the load balancer will attempt to route requests to endpoints based on the override information extracted from request headers or metadata. If the override endpoints are not available, the configured load balancer policy will be used as fallback. */
1716
+ "endpointOverride"?: EndpointOverride;
1717
+ /** SlowStart defines the configuration related to the slow start load balancer policy. If set, during slow start window, traffic sent to the newly added hosts will gradually increase. Currently this is only supported for RoundRobin and LeastRequest load balancers */
1718
+ "slowStart"?: SlowStart;
1719
+ /** Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin". */
1720
+ "type": "ConsistentHash" | "LeastRequest" | "Random" | "RoundRobin";
1721
+ /** ZoneAware defines the configuration related to the distribution of requests between locality zones. */
1722
+ "zoneAware"?: ZoneAware;
1723
+ }
1724
+ export interface ProxyProtocol {
1725
+ /** Version of ProxyProtol Valid ProxyProtocolVersion values are "V1" "V2" */
1726
+ "version": "V1" | "V2";
1727
+ }
1728
+ export interface BackOff {
1729
+ /** BaseInterval is the base interval between retries. */
1730
+ "baseInterval"?: string;
1731
+ /** MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set. The default is 10 times the base_interval */
1732
+ "maxInterval"?: string;
1733
+ }
1734
+ export interface PerRetry {
1735
+ /** Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential back-off algorithm for retries. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries */
1736
+ "backOff"?: BackOff;
1737
+ /** Timeout is the timeout per retry attempt. */
1738
+ "timeout"?: string;
1739
+ }
1740
+ export interface RetryOn {
1741
+ /** HttpStatusCodes specifies the http status codes to be retried. The retriable-status-codes trigger must also be configured for these status codes to trigger a retry. */
1742
+ "httpStatusCodes"?: number[];
1743
+ /** Triggers specifies the retry trigger condition(Http/Grpc). */
1744
+ "triggers"?: ("5xx" | "gateway-error" | "reset" | "reset-before-request" | "connect-failure" | "retriable-4xx" | "refused-stream" | "retriable-status-codes" | "cancelled" | "deadline-exceeded" | "internal" | "resource-exhausted" | "unavailable")[];
1745
+ }
1746
+ export interface Retry {
1747
+ /** NumAttemptsPerPriority defines the number of requests (initial attempt + retries) that should be sent to the same priority before switching to a different one. If not specified or set to 0, all requests are sent to the highest priority that is healthy. */
1748
+ "numAttemptsPerPriority"?: number;
1749
+ /** NumRetries is the number of retries to be attempted. Defaults to 2. */
1750
+ "numRetries"?: number;
1751
+ /** PerRetry is the retry policy to be applied per retry attempt. */
1752
+ "perRetry"?: PerRetry;
1753
+ /** RetryOn specifies the retry trigger condition. If not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503). */
1754
+ "retryOn"?: RetryOn;
1755
+ }
1756
+ export interface TcpKeepalive {
1757
+ /** The duration a connection needs to be idle before keep-alive probes start being sent. The duration format is Defaults to `7200s`. */
1758
+ "idleTime"?: string;
1759
+ /** The duration between keep-alive probes. Defaults to `75s`. */
1760
+ "interval"?: string;
1761
+ /** The total number of unacknowledged probes to send before deciding the connection is dead. Defaults to 9. */
1762
+ "probes"?: number;
1763
+ }
1764
+ export interface Http3 {
1765
+ /** The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection. Default: 1 hour. */
1766
+ "connectionIdleTimeout"?: string;
1767
+ /** The maximum duration of an HTTP connection. Default: unlimited. */
1768
+ "maxConnectionDuration"?: string;
1769
+ /** MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time from when the request is sent until the response stream is fully consumed and does not apply to non-streaming requests. When set to "0s", no max duration is applied and streams can run indefinitely. */
1770
+ "maxStreamDuration"?: string;
1771
+ /** RequestTimeout is the time until which entire response is received from the upstream. */
1772
+ "requestTimeout"?: string;
1773
+ }
1774
+ export interface Tcp2 {
1775
+ /** The timeout for network connection establishment, including TCP and TLS handshakes. Default: 10 seconds. */
1776
+ "connectTimeout"?: string;
1777
+ }
1778
+ export interface Timeout {
1779
+ /** Timeout settings for HTTP. */
1780
+ "http"?: Http3;
1781
+ /** Timeout settings for TCP. */
1782
+ "tcp"?: Tcp2;
1783
+ }
1784
+ export interface BackendSettings {
1785
+ /** Circuit Breaker settings for the upstream connections and requests. If not set, circuit breakers will be enabled with the default thresholds */
1786
+ "circuitBreaker"?: CircuitBreaker;
1787
+ /** Connection includes backend connection settings. */
1788
+ "connection"?: Connection;
1789
+ /** DNS includes dns resolution settings. */
1790
+ "dns"?: Dns;
1791
+ /** HealthCheck allows gateway to perform active health checking on backends. */
1792
+ "healthCheck"?: HealthCheck;
1793
+ /** HTTP2 provides HTTP/2 configuration for backend connections. */
1794
+ "http2"?: Http2;
1795
+ /** LoadBalancer policy to apply when routing traffic from the gateway to the backend endpoints. Defaults to `LeastRequest`. */
1796
+ "loadBalancer"?: LoadBalancer;
1797
+ /** ProxyProtocol enables the Proxy Protocol when communicating with the backend. */
1798
+ "proxyProtocol"?: ProxyProtocol;
1799
+ /** Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions. If not set, retry will be disabled. */
1800
+ "retry"?: Retry;
1801
+ /** TcpKeepalive settings associated with the upstream client connection. Disabled by default. */
1802
+ "tcpKeepalive"?: TcpKeepalive;
1803
+ /** Timeout settings for the backend connections. */
1804
+ "timeout"?: Timeout;
1805
+ }
1806
+ export interface Http4 {
1807
+ /** RequestHeaders defines request headers to include in log entries sent to the access log service. */
1808
+ "requestHeaders"?: string[];
1809
+ /** ResponseHeaders defines response headers to include in log entries sent to the access log service. */
1810
+ "responseHeaders"?: string[];
1811
+ /** ResponseTrailers defines response trailers to include in log entries sent to the access log service. */
1812
+ "responseTrailers"?: string[];
1813
+ }
1814
+ export interface Als {
1815
+ /** BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead. */
1816
+ "backendRef"?: BackendRef;
1817
+ /** BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent. */
1818
+ "backendRefs"?: BackendRefsItem[];
1819
+ /** BackendSettings holds configuration for managing the connection to the backend. */
1820
+ "backendSettings"?: BackendSettings;
1821
+ /** HTTP defines additional configuration specific to HTTP access logs. */
1822
+ "http"?: Http4;
1823
+ /** LogName defines the friendly name of the access log to be returned in StreamAccessLogsMessage.Identifier. This allows the access log server to differentiate between different access logs coming from the same Envoy. */
1824
+ "logName"?: string;
1825
+ /** Type defines the type of accesslog. Supported types are "HTTP" and "TCP". */
1826
+ "type": "HTTP" | "TCP";
1827
+ }
1828
+ export interface File {
1829
+ /** Path defines the file path used to expose envoy access log(e.g. /dev/stdout). */
1830
+ "path"?: string;
1831
+ }
1832
+ export interface HeadersItem2 {
1833
+ /** Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2). If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. */
1834
+ "name": string;
1835
+ /** Value is the value of HTTP Header to be matched. */
1836
+ "value": string;
1837
+ }
1838
+ export interface OpenTelemetry {
1839
+ /** BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead. */
1840
+ "backendRef"?: BackendRef;
1841
+ /** BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent. */
1842
+ "backendRefs"?: BackendRefsItem[];
1843
+ /** BackendSettings holds configuration for managing the connection to the backend. */
1844
+ "backendSettings"?: BackendSettings;
1845
+ /** Headers is a list of additional headers to send with OTLP export requests. These headers are added as gRPC initial metadata for the OTLP gRPC service. */
1846
+ "headers"?: HeadersItem2[];
1847
+ /** Host define the extension service hostname. Deprecated: Use BackendRefs instead. */
1848
+ "host"?: string;
1849
+ /** Port defines the port the extension service is exposed on. Deprecated: Use BackendRefs instead. */
1850
+ "port"?: number;
1851
+ /** ResourceAttributes is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/). */
1852
+ "resourceAttributes"?: Record<string, unknown>;
1853
+ /** Resources is a set of labels that describe the source of a log entry, including envoy node info. It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/). Deprecated: Use ResourceAttributes instead. */
1854
+ "resources"?: Record<string, unknown>;
1855
+ }
1856
+ export interface SinksItem {
1857
+ /** ALS defines the gRPC Access Log Service (ALS) sink. */
1858
+ "als"?: Als;
1859
+ /** File defines the file accesslog sink. */
1860
+ "file"?: File;
1861
+ /** OpenTelemetry defines the OpenTelemetry accesslog sink. */
1862
+ "openTelemetry"?: OpenTelemetry;
1863
+ /** Type defines the type of accesslog sink. */
1864
+ "type"?: "ALS" | "File" | "OpenTelemetry";
1865
+ }
1866
+ export interface SettingsItem {
1867
+ /** Format defines the format of accesslog. This will be ignored if sink type is ALS. */
1868
+ "format"?: Format;
1869
+ /** Matches defines the match conditions for accesslog in CEL expression. An accesslog will be emitted only when one or more match conditions are evaluated to true. Invalid [CEL](https://www.envoyproxy.io/docs/envoy/latest/xds/type/v3/cel.proto.html#common-expression-language-cel-proto) expressions will be ignored. */
1870
+ "matches"?: string[];
1871
+ /** Sinks defines the sinks of accesslog. */
1872
+ "sinks": SinksItem[];
1873
+ /** Type defines the component emitting the accesslog, such as Listener and Route. If type not defined, the setting would apply to: (1) All Routes. (2) Listeners if and only if Envoy does not find a matching route for a request. If type is defined, the accesslog settings would apply to the relevant component (as-is). */
1874
+ "type"?: "Listener" | "Route";
1875
+ }
1876
+ export interface AccessLog {
1877
+ /** Disable disables access logging for managed proxies if set to true. */
1878
+ "disable"?: boolean;
1879
+ /** Settings defines accesslog settings for managed proxies. If unspecified, will send default format to stdout. */
1880
+ "settings"?: SettingsItem[];
1881
+ }
1882
+ export interface MatchesItem {
1883
+ /** Type specifies how to match against a string. */
1884
+ "type"?: "Exact" | "Prefix" | "Suffix" | "RegularExpression";
1885
+ /** Value specifies the string value that the match must have. */
1886
+ "value": string;
1887
+ }
1888
+ export interface Compression {
1889
+ /** The configuration for Brotli compressor. */
1890
+ "brotli"?: Record<string, unknown>;
1891
+ /** The configuration for GZIP compressor. */
1892
+ "gzip"?: Record<string, unknown>;
1893
+ /** MinContentLength defines the minimum response size in bytes to apply compression. Responses smaller than this threshold will not be compressed. Must be at least 30 bytes as enforced by Envoy Proxy. Note that when the suffix is not provided, the value is interpreted as bytes. Default: 30 bytes */
1894
+ "minContentLength"?: number | string;
1895
+ /** CompressorType defines the compressor type to use for compression. */
1896
+ "type": "Gzip" | "Brotli" | "Zstd";
1897
+ /** The configuration for Zstd compressor. */
1898
+ "zstd"?: Record<string, unknown>;
1899
+ }
1900
+ export interface Prometheus {
1901
+ /** Configure the compression on Prometheus endpoint. Compression is useful in situations when bandwidth is scarce and large payloads can be effectively compressed at the expense of higher CPU load. */
1902
+ "compression"?: Compression;
1903
+ /** Disable the Prometheus endpoint. */
1904
+ "disable"?: boolean;
1905
+ }
1906
+ export interface OpenTelemetry2 {
1907
+ /** BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead. */
1908
+ "backendRef"?: BackendRef;
1909
+ /** BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent. */
1910
+ "backendRefs"?: BackendRefsItem[];
1911
+ /** BackendSettings holds configuration for managing the connection to the backend. */
1912
+ "backendSettings"?: BackendSettings;
1913
+ /** Headers is a list of additional headers to send with OTLP export requests. These headers are added as gRPC initial metadata for the OTLP gRPC service. */
1914
+ "headers"?: HeadersItem2[];
1915
+ /** Host define the service hostname. Deprecated: Use BackendRefs instead. */
1916
+ "host"?: string;
1917
+ /** Port defines the port the service is exposed on. Deprecated: Use BackendRefs instead. */
1918
+ "port"?: number;
1919
+ /** ReportCountersAsDeltas configures the OpenTelemetry sink to report counters as delta temporality instead of cumulative. */
1920
+ "reportCountersAsDeltas"?: boolean;
1921
+ /** ReportHistogramsAsDeltas configures the OpenTelemetry sink to report histograms as delta temporality instead of cumulative. Required for backends like Elastic that drop cumulative histograms. */
1922
+ "reportHistogramsAsDeltas"?: boolean;
1923
+ /** ResourceAttributes is a set of labels that describe the source of metrics. It's recommended to follow semantic conventions: https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/ */
1924
+ "resourceAttributes"?: Record<string, unknown>;
1925
+ }
1926
+ export interface SinksItem2 {
1927
+ /** OpenTelemetry defines the configuration for OpenTelemetry sink. It's required if the sink type is OpenTelemetry. */
1928
+ "openTelemetry"?: OpenTelemetry2;
1929
+ /** Type defines the metric sink type. EG currently only supports OpenTelemetry. */
1930
+ "type": "OpenTelemetry";
1931
+ }
1932
+ export interface Metrics {
1933
+ /** ClusterStatName defines the value of cluster alt_stat_name, determining how cluster stats are named. For more details, see envoy docs: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html The supported operators for this pattern are: `%ROUTE_NAME%`: name of Gateway API xRoute resource `%ROUTE_NAMESPACE%`: namespace of Gateway API xRoute resource `%ROUTE_KIND%`: kind of Gateway API xRoute resource `%ROUTE_RULE_NAME%`: name of the Gateway API xRoute section `%ROUTE_RULE_NUMBER%`: name of the Gateway API xRoute section `%BACKEND_REFS%`: names of all backends referenced in `<NAMESPACE>/<NAME>|<NAMESPACE>/<NAME>|...` format Only xDS Clusters created for HTTPRoute and GRPCRoute are currently supported. Default: `%ROUTE_KIND%/%ROUTE_NAMESPACE%/%ROUTE_NAME%/rule/%ROUTE_RULE_NUMBER%` Example: `httproute/my-ns/my-route/rule/0` */
1934
+ "clusterStatName"?: string;
1935
+ /** EnablePerEndpointStats enables per endpoint envoy stats metrics. Please use with caution. */
1936
+ "enablePerEndpointStats"?: boolean;
1937
+ /** EnableRequestResponseSizesStats enables publishing of histograms tracking header and body sizes of requests and responses. */
1938
+ "enableRequestResponseSizesStats"?: boolean;
1939
+ /** EnableVirtualHostStats enables envoy stat metrics for virtual hosts. */
1940
+ "enableVirtualHostStats"?: boolean;
1941
+ /** Matches defines configuration for selecting specific metrics instead of generating all metrics stats that are enabled by default. This helps reduce CPU and memory overhead in Envoy, but eliminating some stats may after critical functionality. Here are the stats that we strongly recommend not disabling: `cluster_manager.warming_clusters`, `cluster.<cluster_name>.membership_total`,`cluster.<cluster_name>.membership_healthy`, `cluster.<cluster_name>.membership_degraded`,reference https://github.com/envoyproxy/envoy/issues/9856, https://github.com/envoyproxy/envoy/issues/14610 */
1942
+ "matches"?: MatchesItem[];
1943
+ /** Prometheus defines the configuration for Admin endpoint `/stats/prometheus`. */
1944
+ "prometheus"?: Prometheus;
1945
+ /** Sinks defines the metric sinks where metrics are sent to. */
1946
+ "sinks"?: SinksItem2[];
1947
+ }
1948
+ export interface RequestID {
1949
+ /** Tracing configures Envoy's behavior for the UUID request ID extension, including whether the trace sampling decision is packed into the UUID and whether `X-Request-ID` is used for trace sampling decisions. When omitted, the default behavior is `PackAndSample`, which alters the UUID to contain the trace sampling decision and uses `X-Request-ID` for stable trace sampling. */
1950
+ "tracing"?: "PackAndSample" | "Sample" | "Pack" | "Disable";
1951
+ }
1952
+ export interface OpenTelemetry3 {
1953
+ /** Headers is a list of additional headers to send with OTLP export requests. These headers are added as gRPC initial metadata for the OTLP gRPC service. */
1954
+ "headers"?: HeadersItem2[];
1955
+ /** ResourceAttributes is a set of labels that describe the source of traces. It's recommended to follow semantic conventions: https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/ */
1956
+ "resourceAttributes"?: Record<string, unknown>;
1957
+ }
1958
+ export interface Zipkin {
1959
+ /** DisableSharedSpanContext determines whether the default Envoy behaviour of client and server spans sharing the same span context should be disabled. */
1960
+ "disableSharedSpanContext"?: boolean;
1961
+ /** Enable128BitTraceID determines whether a 128bit trace id will be used when creating a new trace instance. If set to false, a 64bit trace id will be used. */
1962
+ "enable128BitTraceId"?: boolean;
1963
+ }
1964
+ export interface Provider2 {
1965
+ /** BackendRef references a Kubernetes object that represents the backend server to which the authorization request will be sent. Deprecated: Use BackendRefs instead. */
1966
+ "backendRef"?: BackendRef;
1967
+ /** BackendRefs references a Kubernetes object that represents the backend server to which the authorization request will be sent. */
1968
+ "backendRefs"?: BackendRefsItem[];
1969
+ /** BackendSettings holds configuration for managing the connection to the backend. */
1970
+ "backendSettings"?: BackendSettings;
1971
+ /** Host define the provider service hostname. Deprecated: Use BackendRefs instead. */
1972
+ "host"?: string;
1973
+ /** OpenTelemetry defines the OpenTelemetry tracing provider configuration */
1974
+ "openTelemetry"?: OpenTelemetry3;
1975
+ /** Port defines the port the provider service is exposed on. Deprecated: Use BackendRefs instead. */
1976
+ "port"?: number;
1977
+ /** ServiceName defines the service name to use in tracing configuration. If not set, Envoy Gateway will use a default service name set as "name.namespace" (e.g., "my-gateway.default"). Note: This field is only supported for OpenTelemetry and Datadog tracing providers. For Zipkin, the service name in traces is always derived from the Envoy --service-cluster flag (typically "namespace/name" format). Setting this field has no effect for Zipkin. */
1978
+ "serviceName"?: string;
1979
+ /** Type defines the tracing provider type. */
1980
+ "type": "OpenTelemetry" | "Zipkin" | "Datadog";
1981
+ /** Zipkin defines the Zipkin tracing provider configuration */
1982
+ "zipkin"?: Zipkin;
1983
+ }
1984
+ export interface SamplingFraction {
1985
+ "denominator"?: number;
1986
+ "numerator": number;
1987
+ }
1988
+ export interface SpanName {
1989
+ /** Client defines operation name of the span which will be used for tracing. */
1990
+ "client": string;
1991
+ /** Server defines the operation name of the upstream span which will be used for tracing. */
1992
+ "server": string;
1993
+ }
1994
+ export interface Tracing {
1995
+ /** CustomTags defines the custom tags to add to each span. If provider is kubernetes, pod name and namespace are added by default. Deprecated: Use Tags instead. */
1996
+ "customTags"?: Record<string, unknown>;
1997
+ /** Provider defines the tracing provider. */
1998
+ "provider": Provider2;
1999
+ /** SamplingFraction represents the fraction of requests that should be selected for tracing if no prior sampling decision has been made. */
2000
+ "samplingFraction"?: SamplingFraction;
2001
+ /** SamplingRate controls the rate at which traffic will be selected for tracing if no prior sampling decision has been made. Defaults to 100, valid values [0-100]. 100 indicates 100% sampling. Only one of SamplingRate or SamplingFraction may be specified. If neither field is specified, all requests will be sampled. */
2002
+ "samplingRate"?: number;
2003
+ /** SpanName defines the name of the span which will be used for tracing. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) may be used in the value. The [format string documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-strings) provides more information. If not set, the span name is provider specific. e.g. Datadog use `ingress` as the default client span name, and `router <UPSTREAM_CLUSTER> egress` as the server span name. */
2004
+ "spanName"?: SpanName;
2005
+ /** Tags defines the custom tags to add to each span. Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) may be used in the value. The [format string documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-strings) provides more information. If provider is kubernetes, pod name and namespace are added by default. Same keys take precedence over CustomTags. */
2006
+ "tags"?: Record<string, unknown>;
2007
+ }
2008
+ export interface Telemetry {
2009
+ /** AccessLogs defines accesslog parameters for managed proxies. If unspecified, will send default format to stdout. */
2010
+ "accessLog"?: AccessLog;
2011
+ /** Metrics defines metrics configuration for managed proxies. */
2012
+ "metrics"?: Metrics;
2013
+ /** RequestID configures Envoy request ID behavior. */
2014
+ "requestID"?: RequestID;
2015
+ /** Tracing defines tracing configuration for managed proxies. If unspecified, will not send tracing data. */
2016
+ "tracing"?: Tracing;
2017
+ }
2018
+ export interface EnvoyProxySpec {
2019
+ /** BackendTLS is the TLS configuration for the Envoy proxy to use when connecting to backends. These settings are applied on backends for which TLS policies are specified. */
2020
+ "backendTLS"?: BackendTLS;
2021
+ /** Bootstrap defines the Envoy Bootstrap as a YAML string. Visit https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-msg-config-bootstrap-v3-bootstrap to learn more about the syntax. If set, this is the Bootstrap configuration used for the managed Envoy Proxy fleet instead of the default Bootstrap configuration set by Envoy Gateway. Some fields within the Bootstrap that are required to communicate with the xDS Server (Envoy Gateway) and receive xDS resources from it are not configurable and will result in the `EnvoyProxy` resource being rejected. Backward compatibility across minor versions is not guaranteed. We strongly recommend using `egctl x translate` to generate a `EnvoyProxy` resource with the `Bootstrap` field set to the default Bootstrap configuration used. You can edit this configuration, and rerun `egctl x translate` to ensure there are no validation errors. */
2022
+ "bootstrap"?: Bootstrap;
2023
+ /** Concurrency defines the number of worker threads to run. If unset, it defaults to the number of cpuset threads on the platform. */
2024
+ "concurrency"?: number;
2025
+ /** ExtraArgs defines additional command line options that are provided to Envoy. More info: https://www.envoyproxy.io/docs/envoy/latest/operations/cli#command-line-options Note: some command line options are used internally(e.g. --log-level) so they cannot be provided here. */
2026
+ "extraArgs"?: string[];
2027
+ /** FilterOrder defines the order of filters in the Envoy proxy's HTTP filter chain. The FilterPosition in the list will be applied in the order they are defined. If unspecified, the default filter order is applied. Default filter order is: - envoy.filters.http.custom_response - envoy.filters.http.health_check - envoy.filters.http.fault - envoy.filters.http.cors - envoy.filters.http.header_mutation - envoy.filters.http.ext_authz - envoy.filters.http.api_key_auth - envoy.filters.http.basic_auth - envoy.filters.http.oauth2 - envoy.filters.http.jwt_authn - envoy.filters.http.stateful_session - envoy.filters.http.buffer - envoy.filters.http.lua - envoy.filters.http.ext_proc - envoy.filters.http.wasm - envoy.filters.http.rbac - envoy.filters.http.local_ratelimit - envoy.filters.http.ratelimit - envoy.filters.http.grpc_web - envoy.filters.http.grpc_stats - envoy.filters.http.credential_injector - envoy.filters.http.compressor - envoy.filters.http.dynamic_forward_proxy - envoy.filters.http.router Note: "envoy.filters.http.router" cannot be reordered, it's always the last filter in the chain. */
2028
+ "filterOrder"?: FilterOrderItem[];
2029
+ /** IPFamily specifies the IP family for the EnvoyProxy fleet. This setting only affects the Gateway listener port and does not impact other aspects of the Envoy proxy configuration. If not specified, the system will operate as follows: - It defaults to IPv4 only. - IPv6 and dual-stack environments are not supported in this default configuration. Note: To enable IPv6 or dual-stack functionality, explicit configuration is required. */
2030
+ "ipFamily"?: "IPv4" | "IPv6" | "DualStack";
2031
+ /** Logging defines logging parameters for managed proxies. */
2032
+ "logging"?: Logging;
2033
+ /** LuaValidation determines strictness of the Lua script validation for Lua EnvoyExtensionPolicies Default: Strict */
2034
+ "luaValidation"?: "Strict" | "InsecureSyntax" | "Disabled";
2035
+ /** MergeGateways defines if Gateway resources should be merged onto the same Envoy Proxy Infrastructure. Setting this field to true would merge all Gateway Listeners under the parent Gateway Class. This means that the port, protocol and hostname tuple must be unique for every listener. If a duplicate listener is detected, the newer listener (based on timestamp) will be rejected and its status will be updated with a "Accepted=False" condition. */
2036
+ "mergeGateways"?: boolean;
2037
+ /** PreserveRouteOrder determines if the order of matching for HTTPRoutes is determined by Gateway-API specification (https://gateway-api.sigs.k8s.io/reference/1.4/spec/#httprouterule) or preserves the order defined by users in the HTTPRoute's HTTPRouteRule list. Default: False */
2038
+ "preserveRouteOrder"?: boolean;
2039
+ /** Provider defines the desired resource provider and provider-specific configuration. If unspecified, the "Kubernetes" resource provider is used with default configuration parameters. */
2040
+ "provider"?: Provider;
2041
+ /** RoutingType can be set to "Service" to use the Service Cluster IP for routing to the backend, or it can be set to "Endpoint" to use Endpoint routing. The default is "Endpoint". */
2042
+ "routingType"?: string;
2043
+ /** Shutdown defines configuration for graceful envoy shutdown process. */
2044
+ "shutdown"?: Shutdown;
2045
+ /** Telemetry defines telemetry parameters for managed proxies. */
2046
+ "telemetry"?: Telemetry;
2047
+ }
2048
+ export interface AncestorRef {
2049
+ /** Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). Support: Core */
2050
+ "group"?: string;
2051
+ /** Kind is kind of the referent. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) Support for other resources is Implementation-Specific. */
2052
+ "kind"?: string;
2053
+ /** Name is the name of the referent. Support: Core */
2054
+ "name": string;
2055
+ /** Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. <gateway:experimental:description> ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. </gateway:experimental:description> Support: Core */
2056
+ "namespace"?: string;
2057
+ /** Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. <gateway:experimental:description> When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. </gateway:experimental:description> Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended */
2058
+ "port"?: number;
2059
+ /** SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core */
2060
+ "sectionName"?: string;
2061
+ }
2062
+ export interface ConditionsItem {
2063
+ /** lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. */
2064
+ "lastTransitionTime": string;
2065
+ /** message is a human readable message indicating details about the transition. This may be an empty string. */
2066
+ "message": string;
2067
+ /** observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. */
2068
+ "observedGeneration"?: number;
2069
+ /** reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. */
2070
+ "reason": string;
2071
+ /** status of the condition, one of True, False, Unknown. */
2072
+ "status": "True" | "False" | "Unknown";
2073
+ /** type of condition in CamelCase or in foo.example.com/CamelCase. */
2074
+ "type": string;
2075
+ }
2076
+ export interface AncestorsItem {
2077
+ /** AncestorRef corresponds a GatewayClass or Gateway use this EnvoyProxy with ParametersReference. */
2078
+ "ancestorRef": AncestorRef;
2079
+ /** Conditions describes the status of the Policy with respect to the given Ancestor. */
2080
+ "conditions"?: ConditionsItem[];
2081
+ }
2082
+ export interface EnvoyProxyStatus {
2083
+ /** Ancestors represent the status information for all the GatewayClass or Gateway reference this EnvoyProxy with ParametersReference. */
2084
+ "ancestors"?: AncestorsItem[];
2085
+ }
2086
+ export interface AddressesItem {
2087
+ /** Type of the address. */
2088
+ "type"?: string;
2089
+ /** When a value is unspecified, an implementation SHOULD automatically assign an address matching the requested type if possible. If an implementation does not support an empty value, they MUST set the "Programmed" condition in status to False with a reason of "AddressNotAssigned". Examples: `1.2.3.4`, `128::1`, `my-ip-address`. */
2090
+ "value"?: string;
2091
+ }
2092
+ export interface ParametersRef {
2093
+ /** Group is the group of the referent. */
2094
+ "group": string;
2095
+ /** Kind is kind of the referent. */
2096
+ "kind": string;
2097
+ /** Name is the name of the referent. */
2098
+ "name": string;
2099
+ }
2100
+ export interface Infrastructure {
2101
+ /** Annotations that SHOULD be applied to any resources created in response to this Gateway. For implementations creating other Kubernetes objects, this should be the `metadata.annotations` field on resources. For other implementations, this refers to any relevant (implementation specific) "annotations" concepts. An implementation may chose to add additional implementation-specific annotations as they see fit. Support: Extended */
2102
+ "annotations"?: Record<string, unknown>;
2103
+ /** Labels that SHOULD be applied to any resources created in response to this Gateway. For implementations creating other Kubernetes objects, this should be the `metadata.labels` field on resources. For other implementations, this refers to any relevant (implementation specific) "labels" concepts. An implementation may chose to add additional implementation-specific labels as they see fit. If an implementation maps these labels to Pods, or any other resource that would need to be recreated when labels change, it SHOULD clearly warn about this behavior in documentation. Support: Extended */
2104
+ "labels"?: Record<string, unknown>;
2105
+ /** ParametersRef is a reference to a resource that contains the configuration parameters corresponding to the Gateway. This is optional if the controller does not require any additional configuration. This follows the same semantics as GatewayClass's `parametersRef`, but on a per-Gateway basis The Gateway's GatewayClass may provide its own `parametersRef`. When both are specified, the merging behavior is implementation specific. It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway. If the referent cannot be found, refers to an unsupported kind, or when the data within that resource is malformed, the Gateway SHOULD be rejected with the "Accepted" status condition set to "False" and an "InvalidParameters" reason. Support: Implementation-specific */
2106
+ "parametersRef"?: ParametersRef;
2107
+ }
2108
+ export interface KindsItem {
2109
+ /** Group is the group of the Route. */
2110
+ "group"?: string;
2111
+ /** Kind is the kind of the Route. */
2112
+ "kind": string;
2113
+ }
2114
+ export interface Namespaces {
2115
+ /** From indicates where Routes will be selected for this Gateway. Possible values are: * All: Routes in all namespaces may be used by this Gateway. * Selector: Routes in namespaces selected by the selector may be used by this Gateway. * Same: Only Routes in the same namespace may be used by this Gateway. Support: Core */
2116
+ "from"?: "All" | "Selector" | "Same";
2117
+ /** Selector must be specified when From is set to "Selector". In that case, only Routes in Namespaces matching this Selector will be selected by this Gateway. This field is ignored for other values of "From". Support: Core */
2118
+ "selector"?: Selector;
2119
+ }
2120
+ export interface AllowedRoutes {
2121
+ /** Kinds specifies the groups and kinds of Routes that are allowed to bind to this Gateway Listener. When unspecified or empty, the kinds of Routes selected are determined using the Listener protocol. A RouteGroupKind MUST correspond to kinds of Routes that are compatible with the application protocol specified in the Listener's Protocol field. If an implementation does not support or recognize this resource type, it MUST set the "ResolvedRefs" condition to False for this Listener with the "InvalidRouteKinds" reason. Support: Core */
2122
+ "kinds"?: KindsItem[];
2123
+ /** Namespaces indicates namespaces from which Routes may be attached to this Listener. This is restricted to the namespace of this Gateway by default. Support: Core */
2124
+ "namespaces"?: Namespaces;
2125
+ }
2126
+ export interface CertificateRefsItem {
2127
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
2128
+ "group"?: string;
2129
+ /** Kind is kind of the referent. For example "Secret". */
2130
+ "kind"?: string;
2131
+ /** Name is the name of the referent. */
2132
+ "name": string;
2133
+ /** Namespace is the namespace of the referenced object. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core */
2134
+ "namespace"?: string;
2135
+ }
2136
+ export interface Tls {
2137
+ /** CertificateRefs contains a series of references to Kubernetes objects that contains TLS certificates and private keys. These certificates are used to establish a TLS handshake for requests that match the hostname of the associated listener. A single CertificateRef to a Kubernetes Secret has "Core" support. Implementations MAY choose to support attaching multiple certificates to a Listener, but this behavior is implementation-specific. References to a resource in different namespace are invalid UNLESS there is a ReferenceGrant in the target namespace that allows the certificate to be attached. If a ReferenceGrant does not allow this reference, the "ResolvedRefs" condition MUST be set to False for this listener with the "RefNotPermitted" reason. This field is required to have at least one element when the mode is set to "Terminate" (default) and is optional otherwise. CertificateRefs can reference to standard Kubernetes resources, i.e. Secret, or implementation-specific custom resources. Support: Core - A single reference to a Kubernetes Secret of type kubernetes.io/tls Support: Implementation-specific (More than one reference or other resource types) */
2138
+ "certificateRefs"?: CertificateRefsItem[];
2139
+ /** Mode defines the TLS behavior for the TLS session initiated by the client. There are two possible modes: - Terminate: The TLS session between the downstream client and the Gateway is terminated at the Gateway. This mode requires certificates to be specified in some way, such as populating the certificateRefs field. - Passthrough: The TLS session is NOT terminated by the Gateway. This implies that the Gateway can't decipher the TLS stream except for the ClientHello message of the TLS protocol. The certificateRefs field is ignored in this mode. Support: Core */
2140
+ "mode"?: "Terminate" | "Passthrough";
2141
+ /** Options are a list of key/value pairs to enable extended TLS configuration for each implementation. For example, configuring the minimum TLS version or supported cipher suites. A set of common keys MAY be defined by the API in the future. To avoid any ambiguity, implementation-specific definitions MUST use domain-prefixed names, such as `example.com/my-custom-option`. Un-prefixed names are reserved for key names defined by Gateway API. Support: Implementation-specific */
2142
+ "options"?: Record<string, unknown>;
2143
+ }
2144
+ export interface ListenersItem {
2145
+ /** AllowedRoutes defines the types of routes that MAY be attached to a Listener and the trusted namespaces where those Route resources MAY be present. Although a client request may match multiple route rules, only one rule may ultimately receive the request. Matching precedence MUST be determined in order of the following criteria: * The most specific match as defined by the Route type. * The oldest Route based on creation timestamp. For example, a Route with a creation timestamp of "2020-09-08 01:02:03" is given precedence over a Route with a creation timestamp of "2020-09-08 01:02:04". * If everything else is equivalent, the Route appearing first in alphabetical order (namespace/name) should be given precedence. For example, foo/bar is given precedence over foo/baz. All valid rules within a Route attached to this Listener should be implemented. Invalid Route rules can be ignored (sometimes that will mean the full Route). If a Route rule transitions from valid to invalid, support for that Route rule should be dropped to ensure consistency. For example, even if a filter specified by a Route rule is invalid, the rest of the rules within that Route should still be supported. Support: Core */
2146
+ "allowedRoutes"?: AllowedRoutes;
2147
+ /** Hostname specifies the virtual hostname to match for protocol types that define this concept. When unspecified, all hostnames are matched. This field is ignored for protocols that don't require hostname based matching. Implementations MUST apply Hostname matching appropriately for each of the following protocols: * TLS: The Listener Hostname MUST match the SNI. * HTTP: The Listener Hostname MUST match the Host header of the request. * HTTPS: The Listener Hostname SHOULD match both the SNI and Host header. Note that this does not require the SNI and Host header to be the same. The semantics of this are described in more detail below. To ensure security, Section 11.1 of RFC-6066 emphasizes that server implementations that rely on SNI hostname matching MUST also verify hostnames within the application protocol. Section 9.1.2 of RFC-7540 provides a mechanism for servers to reject the reuse of a connection by responding with the HTTP 421 Misdirected Request status code. This indicates that the origin server has rejected the request because it appears to have been misdirected. To detect misdirected requests, Gateways SHOULD match the authority of the requests with all the SNI hostname(s) configured across all the Gateway Listeners on the same port and protocol: * If another Listener has an exact match or more specific wildcard entry, the Gateway SHOULD return a 421. * If the current Listener (selected by SNI matching during ClientHello) does not match the Host: * If another Listener does match the Host the Gateway SHOULD return a 421. * If no other Listener matches the Host, the Gateway MUST return a 404. For HTTPRoute and TLSRoute resources, there is an interaction with the `spec.hostnames` array. When both listener and route specify hostnames, there MUST be an intersection between the values for a Route to be accepted. For more information, refer to the Route specific Hostnames documentation. Hostnames that are prefixed with a wildcard label (`*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. Support: Core */
2148
+ "hostname"?: string;
2149
+ /** Name is the name of the Listener. This name MUST be unique within a Gateway. Support: Core */
2150
+ "name": string;
2151
+ /** Port is the network port. Multiple listeners may use the same port, subject to the Listener compatibility rules. Support: Core */
2152
+ "port": number;
2153
+ /** Protocol specifies the network protocol this listener expects to receive. Support: Core */
2154
+ "protocol": string;
2155
+ /** TLS is the TLS configuration for the Listener. This field is required if the Protocol field is "HTTPS" or "TLS". It is invalid to set this field if the Protocol field is "HTTP", "TCP", or "UDP". The association of SNIs to Certificate defined in ListenerTLSConfig is defined based on the Hostname field for this listener. The GatewayClass MUST use the longest matching SNI out of all available certificates for any TLS handshake. Support: Core */
2156
+ "tls"?: Tls;
2157
+ }
2158
+ export interface GatewaySpec {
2159
+ /** Addresses requested for this Gateway. This is optional and behavior can depend on the implementation. If a value is set in the spec and the requested address is invalid or unavailable, the implementation MUST indicate this in an associated entry in GatewayStatus.Conditions. The Addresses field represents a request for the address(es) on the "outside of the Gateway", that traffic bound for this Gateway will use. This could be the IP address or hostname of an external load balancer or other networking infrastructure, or some other address that traffic will be sent to. If no Addresses are specified, the implementation MAY schedule the Gateway in an implementation-specific manner, assigning an appropriate set of Addresses. The implementation MUST bind all Listeners to every GatewayAddress that it assigns to the Gateway and add a corresponding entry in GatewayStatus.Addresses. Support: Extended */
2160
+ "addresses"?: AddressesItem[];
2161
+ /** GatewayClassName used for this Gateway. This is the name of a GatewayClass resource. */
2162
+ "gatewayClassName": string;
2163
+ /** Infrastructure defines infrastructure level attributes about this Gateway instance. Support: Extended */
2164
+ "infrastructure"?: Infrastructure;
2165
+ /** Listeners associated with this Gateway. Listeners define logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. ## Distinct Listeners Each Listener in a set of Listeners (for example, in a single Gateway) MUST be _distinct_, in that a traffic flow MUST be able to be assigned to exactly one listener. (This section uses "set of Listeners" rather than "Listeners in a single Gateway" because implementations MAY merge configuration from multiple Gateways onto a single data plane, and these rules _also_ apply in that case). Practically, this means that each listener in a set MUST have a unique combination of Port, Protocol, and, if supported by the protocol, Hostname. Some combinations of port, protocol, and TLS settings are considered Core support and MUST be supported by implementations based on the objects they support: HTTPRoute 1. HTTPRoute, Port: 80, Protocol: HTTP 2. HTTPRoute, Port: 443, Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided TLSRoute 1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode: Passthrough "Distinct" Listeners have the following property: **The implementation can match inbound requests to a single distinct Listener**. When multiple Listeners share values for fields (for example, two Listeners with the same Port value), the implementation can match requests to only one of the Listeners using other Listener fields. When multiple listeners have the same value for the Protocol field, then each of the Listeners with matching Protocol values MUST have different values for other fields. The set of fields that MUST be different for a Listener differs per protocol. The following rules define the rules for what fields MUST be considered for Listeners to be distinct with each protocol currently defined in the Gateway API spec. The set of listeners that all share a protocol value MUST have _different_ values for _at least one_ of these fields to be distinct: * **HTTP, HTTPS, TLS**: Port, Hostname * **TCP, UDP**: Port One **very** important rule to call out involves what happens when an implementation: * Supports TCP protocol Listeners, as well as HTTP, HTTPS, or TLS protocol Listeners, and * sees HTTP, HTTPS, or TLS protocols with the same `port` as one with TCP Protocol. In this case all the Listeners that share a port with the TCP Listener are not distinct and so MUST NOT be accepted. If an implementation does not support TCP Protocol Listeners, then the previous rule does not apply, and the TCP Listeners SHOULD NOT be accepted. Note that the `tls` field is not used for determining if a listener is distinct, because Listeners that _only_ differ on TLS config will still conflict in all cases. ### Listeners that are distinct only by Hostname When the Listeners are distinct based only on Hostname, inbound request hostnames MUST match from the most specific to least specific Hostname values to choose the correct Listener and its associated set of Routes. Exact matches MUST be processed before wildcard matches, and wildcard matches MUST be processed before fallback (empty Hostname value) matches. For example, `"foo.example.com"` takes precedence over `"*.example.com"`, and `"*.example.com"` takes precedence over `""`. Additionally, if there are multiple wildcard entries, more specific wildcard entries must be processed before less specific wildcard entries. For example, `"*.foo.example.com"` takes precedence over `"*.example.com"`. The precise definition here is that the higher the number of dots in the hostname to the right of the wildcard character, the higher the precedence. The wildcard character will match any number of characters _and dots_ to the left, however, so `"*.example.com"` will match both `"foo.bar.example.com"` _and_ `"bar.example.com"`. ## Handling indistinct Listeners If a set of Listeners contains Listeners that are not distinct, then those Listeners are _Conflicted_, and the implementation MUST set the "Conflicted" condition in the Listener Status to "True". The words "indistinct" and "conflicted" are considered equivalent for the purpose of this documentation. Implementations MAY choose to accept a Gateway with some Conflicted Listeners only if they only accept the partial Listener set that contains no Conflicted Listeners. Specifically, an implementation MAY accept a partial Listener set subject to the following rules: * The implementation MUST NOT pick one conflicting Listener as the winner. ALL indistinct Listeners must not be accepted for processing. * At least one distinct Listener MUST be present, or else the Gateway effectively contains _no_ Listeners, and must be rejected from processing as a whole. The implementation MUST set a "ListenersNotValid" condition on the Gateway Status when the Gateway contains Conflicted Listeners whether or not they accept the Gateway. That Condition SHOULD clearly indicate in the Message which Listeners are conflicted, and which are Accepted. Additionally, the Listener status for those listeners SHOULD indicate which Listeners are conflicted and not Accepted. ## General Listener behavior Note that, for all distinct Listeners, requests SHOULD match at most one Listener. For example, if Listeners are defined for "foo.example.com" and "*.example.com", a request to "foo.example.com" SHOULD only be routed using routes attached to the "foo.example.com" Listener (and not the "*.example.com" Listener). This concept is known as "Listener Isolation", and it is an Extended feature of Gateway API. Implementations that do not support Listener Isolation MUST clearly document this, and MUST NOT claim support for the `GatewayHTTPListenerIsolation` feature. Implementations that _do_ support Listener Isolation SHOULD claim support for the Extended `GatewayHTTPListenerIsolation` feature and pass the associated conformance tests. ## Compatible Listeners A Gateway's Listeners are considered _compatible_ if: 1. They are distinct. 2. The implementation can serve them in compliance with the Addresses requirement that all Listeners are available on all assigned addresses. Compatible combinations in Extended support are expected to vary across implementations. A combination that is compatible for one implementation may not be compatible for another. For example, an implementation that cannot serve both TCP and UDP listeners on the same address, or cannot mix HTTPS and generic TLS listens on the same port would not consider those cases compatible, even though they are distinct. Implementations MAY merge separate Gateways onto a single set of Addresses if all Listeners across all Gateways are compatible. In a future release the MinItems=1 requirement MAY be dropped. Support: Core */
2166
+ "listeners": ListenersItem[];
2167
+ }
2168
+ export interface SupportedKindsItem {
2169
+ /** Group is the group of the Route. */
2170
+ "group"?: string;
2171
+ /** Kind is the kind of the Route. */
2172
+ "kind": string;
2173
+ }
2174
+ export interface ListenersItem2 {
2175
+ /** AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener. Successful attachment of a Route to a Listener is based solely on the combination of the AllowedRoutes field on the corresponding Listener and the Route's ParentRefs field. A Route is successfully attached to a Listener when it is selected by the Listener's AllowedRoutes field AND the Route has a valid ParentRef selecting the whole Gateway resource or a specific Listener as a parent resource (more detail on attachment semantics can be found in the documentation on the various Route kinds ParentRefs fields). Listener or Route status does not impact successful attachment, i.e. the AttachedRoutes field count MUST be set for Listeners with condition Accepted: false and MUST count successfully attached Routes that may themselves have Accepted: false conditions. Uses for this field include troubleshooting Route attachment and measuring blast radius/impact of changes to a Listener. */
2176
+ "attachedRoutes": number;
2177
+ /** Conditions describe the current condition of this listener. */
2178
+ "conditions": ConditionsItem[];
2179
+ /** Name is the name of the Listener that this status corresponds to. */
2180
+ "name": string;
2181
+ /** SupportedKinds is the list indicating the Kinds supported by this listener. This MUST represent the kinds an implementation supports for that Listener configuration. If kinds are specified in Spec that are not supported, they MUST NOT appear in this list and an implementation MUST set the "ResolvedRefs" condition to "False" with the "InvalidRouteKinds" reason. If both valid and invalid Route kinds are specified, the implementation MUST reference the valid Route kinds that have been specified. */
2182
+ "supportedKinds": SupportedKindsItem[];
2183
+ }
2184
+ export interface GatewayStatus {
2185
+ /** Addresses lists the network addresses that have been bound to the Gateway. This list may differ from the addresses provided in the spec under some conditions: * no addresses are specified, all addresses are dynamically assigned * a combination of specified and dynamic addresses are assigned * a specified address was unusable (e.g. already in use) */
2186
+ "addresses"?: AddressesItem[];
2187
+ /** Conditions describe the current conditions of the Gateway. Implementations should prefer to express Gateway conditions using the `GatewayConditionType` and `GatewayConditionReason` constants so that operators and tools can converge on a common vocabulary to describe Gateway state. Known condition types are: * "Accepted" * "Programmed" * "Ready" */
2188
+ "conditions"?: ConditionsItem[];
2189
+ /** Listeners provide status for each unique listener port defined in the Spec. */
2190
+ "listeners"?: ListenersItem2[];
2191
+ }
2192
+ export interface ParentRefsItem {
2193
+ /** Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). Support: Core */
2194
+ "group"?: string;
2195
+ /** Kind is kind of the referent. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) Support for other resources is Implementation-Specific. */
2196
+ "kind"?: string;
2197
+ /** Name is the name of the referent. Support: Core */
2198
+ "name": string;
2199
+ /** Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. Support: Core */
2200
+ "namespace"?: string;
2201
+ /** Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended */
2202
+ "port"?: number;
2203
+ /** SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core */
2204
+ "sectionName"?: string;
2205
+ }
2206
+ export interface ExtensionRef {
2207
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
2208
+ "group": string;
2209
+ /** Kind is kind of the referent. For example "HTTPRoute" or "Service". */
2210
+ "kind": string;
2211
+ /** Name is the name of the referent. */
2212
+ "name": string;
2213
+ }
2214
+ export interface AddItem {
2215
+ /** Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2). If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. */
2216
+ "name": string;
2217
+ /** Value is the value of HTTP Header to be matched. */
2218
+ "value": string;
2219
+ }
2220
+ export interface SetItem {
2221
+ /** Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2). If multiple entries specify equivalent header names, the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. */
2222
+ "name": string;
2223
+ /** Value is the value of HTTP Header to be matched. */
2224
+ "value": string;
2225
+ }
2226
+ export interface RequestHeaderModifier {
2227
+ /** Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" Output: GET /foo HTTP/1.1 my-header: foo,bar,baz */
2228
+ "add"?: AddItem[];
2229
+ /** Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz Config: remove: ["my-header1", "my-header3"] Output: GET /foo HTTP/1.1 my-header2: bar */
2230
+ "remove"?: string[];
2231
+ /** Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" Output: GET /foo HTTP/1.1 my-header: bar */
2232
+ "set"?: SetItem[];
2233
+ }
2234
+ export interface Fraction {
2235
+ "denominator"?: number;
2236
+ "numerator": number;
2237
+ }
2238
+ export interface RequestMirror {
2239
+ /** BackendRef references a resource where mirrored requests are sent. Mirrored requests must be sent only to a single destination endpoint within this BackendRef, irrespective of how many endpoints are present within this BackendRef. If the referent cannot be found, this BackendRef is invalid and must be dropped from the Gateway. The controller must ensure the "ResolvedRefs" condition on the Route status is set to `status: False` and not configure this backend in the underlying implementation. If there is a cross-namespace reference to an *existing* object that is not allowed by a ReferenceGrant, the controller must ensure the "ResolvedRefs" condition on the Route is set to `status: False`, with the "RefNotPermitted" reason and not configure this backend in the underlying implementation. In either error case, the Message of the `ResolvedRefs` Condition should be used to provide more detail about the problem. Support: Extended for Kubernetes Service Support: Implementation-specific for any other resource */
2240
+ "backendRef": BackendRef;
2241
+ /** Fraction represents the fraction of requests that should be mirrored to BackendRef. Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored. */
2242
+ "fraction"?: Fraction;
2243
+ /** Percent represents the percentage of requests that should be mirrored to BackendRef. Its minimum value is 0 (indicating 0% of requests) and its maximum value is 100 (indicating 100% of requests). Only one of Fraction or Percent may be specified. If neither field is specified, 100% of requests will be mirrored. */
2244
+ "percent"?: number;
2245
+ }
2246
+ export interface Path {
2247
+ /** ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. */
2248
+ "replaceFullPath"?: string;
2249
+ /** ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch of "/xyz" would be modified to "/xyz/bar". Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch. Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in the implementation setting the Accepted Condition for the Route to `status: False`. Request Path | Prefix Match | Replace Prefix | Modified Path */
2250
+ "replacePrefixMatch"?: string;
2251
+ /** Type defines the type of path modifier. Additional types may be added in a future release of the API. Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. */
2252
+ "type": "ReplaceFullPath" | "ReplacePrefixMatch";
2253
+ }
2254
+ export interface RequestRedirect {
2255
+ /** Hostname is the hostname to be used in the value of the `Location` header in the response. When empty, the hostname in the `Host` header of the request is used. Support: Core */
2256
+ "hostname"?: string;
2257
+ /** Path defines parameters used to modify the path of the incoming request. The modified path is then used to construct the `Location` header. When empty, the request path is used as-is. Support: Extended */
2258
+ "path"?: Path;
2259
+ /** Port is the port to be used in the value of the `Location` header in the response. If no port is specified, the redirect port MUST be derived using the following rules: * If redirect scheme is not-empty, the redirect port MUST be the well-known port associated with the redirect scheme. Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a well-known port, the listener port of the Gateway SHOULD be used. * If redirect scheme is empty, the redirect port MUST be the Gateway Listener port. Implementations SHOULD NOT add the port number in the 'Location' header in the following cases: * A Location header that will use HTTP (whether that is determined via the Listener protocol or the Scheme field) _and_ use port 80. * A Location header that will use HTTPS (whether that is determined via the Listener protocol or the Scheme field) _and_ use port 443. Support: Extended */
2260
+ "port"?: number;
2261
+ /** Scheme is the scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter. Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. Support: Extended */
2262
+ "scheme"?: "http" | "https";
2263
+ /** StatusCode is the HTTP status code to be used in response. Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. Support: Core */
2264
+ "statusCode"?: 301 | 302;
2265
+ }
2266
+ export interface ResponseHeaderModifier {
2267
+ /** Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name. Input: GET /foo HTTP/1.1 my-header: foo Config: add: - name: "my-header" value: "bar,baz" Output: GET /foo HTTP/1.1 my-header: foo,bar,baz */
2268
+ "add"?: AddItem[];
2269
+ /** Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz Config: remove: ["my-header1", "my-header3"] Output: GET /foo HTTP/1.1 my-header2: bar */
2270
+ "remove"?: string[];
2271
+ /** Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: - name: "my-header" value: "bar" Output: GET /foo HTTP/1.1 my-header: bar */
2272
+ "set"?: SetItem[];
2273
+ }
2274
+ export interface UrlRewrite {
2275
+ /** Hostname is the value to be used to replace the Host header value during forwarding. Support: Extended */
2276
+ "hostname"?: string;
2277
+ /** Path defines a path rewrite. Support: Extended */
2278
+ "path"?: Path;
2279
+ }
2280
+ export interface FiltersItem {
2281
+ /** ExtensionRef is an optional, implementation-specific extension to the "filter" behavior. For example, resource "myroutefilter" in group "networking.example.net"). ExtensionRef MUST NOT be used for core and extended filters. This filter can be used multiple times within the same rule. Support: Implementation-specific */
2282
+ "extensionRef"?: ExtensionRef;
2283
+ /** RequestHeaderModifier defines a schema for a filter that modifies request headers. Support: Core */
2284
+ "requestHeaderModifier"?: RequestHeaderModifier;
2285
+ /** RequestMirror defines a schema for a filter that mirrors requests. Requests are sent to the specified destination, but responses from that destination are ignored. This filter can be used multiple times within the same rule. Note that not all implementations will be able to support mirroring to multiple backends. Support: Extended */
2286
+ "requestMirror"?: RequestMirror;
2287
+ /** RequestRedirect defines a schema for a filter that responds to the request with an HTTP redirection. Support: Core */
2288
+ "requestRedirect"?: RequestRedirect;
2289
+ /** ResponseHeaderModifier defines a schema for a filter that modifies response headers. Support: Extended */
2290
+ "responseHeaderModifier"?: ResponseHeaderModifier;
2291
+ /** Type identifies the type of filter to apply. As with other API fields, types are classified into three conformance levels: - Core: Filter types and their corresponding configuration defined by "Support: Core" in this package, e.g. "RequestHeaderModifier". All implementations must support core filters. - Extended: Filter types and their corresponding configuration defined by "Support: Extended" in this package, e.g. "RequestMirror". Implementers are encouraged to support extended filters. - Implementation-specific: Filters that are defined and supported by specific vendors. In the future, filters showing convergence in behavior across multiple implementations will be considered for inclusion in extended or core conformance levels. Filter-specific configuration for such filters is specified using the ExtensionRef field. `Type` should be set to "ExtensionRef" for custom filters. Implementers are encouraged to define custom implementation types to extend the core API with implementation-specific behavior. If a reference to a custom filter type cannot be resolved, the filter MUST NOT be skipped. Instead, requests that would have been processed by that filter MUST receive a HTTP error response. Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. */
2292
+ "type": "RequestHeaderModifier" | "ResponseHeaderModifier" | "RequestMirror" | "RequestRedirect" | "URLRewrite" | "ExtensionRef";
2293
+ /** URLRewrite defines a schema for a filter that modifies a request during forwarding. Support: Extended */
2294
+ "urlRewrite"?: UrlRewrite;
2295
+ }
2296
+ export interface BackendRefsItem2 {
2297
+ /** Filters defined at this level should be executed if and only if the request is being forwarded to the backend defined here. Support: Implementation-specific (For broader support of filters, use the Filters field in HTTPRouteRule.) */
2298
+ "filters"?: FiltersItem[];
2299
+ /** Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred. */
2300
+ "group"?: string;
2301
+ /** Kind is the Kubernetes resource kind of the referent. For example "Service". Defaults to "Service" when not specified. ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services. Support: Core (Services with a type other than ExternalName) Support: Implementation-specific (Services with type ExternalName) */
2302
+ "kind"?: string;
2303
+ /** Name is the name of the referent. */
2304
+ "name": string;
2305
+ /** Namespace is the namespace of the backend. When unspecified, the local namespace is inferred. Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. Support: Core */
2306
+ "namespace"?: string;
2307
+ /** Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field. */
2308
+ "port"?: number;
2309
+ /** Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used. */
2310
+ "weight"?: number;
2311
+ }
2312
+ export interface HeadersItem3 {
2313
+ /** Name is the name of the HTTP Header to be matched. Name matching MUST be case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2). If multiple entries specify equivalent header names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent header name MUST be ignored. Due to the case-insensitivity of header names, "foo" and "Foo" are considered equivalent. When a header is repeated in an HTTP request, it is implementation-specific behavior as to how this is represented. Generally, proxies should follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2 regarding processing a repeated header, with special handling for "Set-Cookie". */
2314
+ "name": string;
2315
+ /** Type specifies how to match against the value of the header. Support: Core (Exact) Support: Implementation-specific (RegularExpression) Since RegularExpression HeaderMatchType has implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. */
2316
+ "type"?: "Exact" | "RegularExpression";
2317
+ /** Value is the value of HTTP Header to be matched. */
2318
+ "value": string;
2319
+ }
2320
+ export interface Path2 {
2321
+ /** Type specifies how to match against the path Value. Support: Core (Exact, PathPrefix) Support: Implementation-specific (RegularExpression) */
2322
+ "type"?: "Exact" | "PathPrefix" | "RegularExpression";
2323
+ /** Value of the HTTP path to match against. */
2324
+ "value"?: string;
2325
+ }
2326
+ export interface QueryParamsItem2 {
2327
+ /** Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3). If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored. If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is *recommended* that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API. Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations. */
2328
+ "name": string;
2329
+ /** Type specifies how to match against the value of the query parameter. Support: Extended (Exact) Support: Implementation-specific (RegularExpression) Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect. */
2330
+ "type"?: "Exact" | "RegularExpression";
2331
+ /** Value is the value of HTTP query param to be matched. */
2332
+ "value": string;
2333
+ }
2334
+ export interface MatchesItem2 {
2335
+ /** Headers specifies HTTP request header matchers. Multiple match values are ANDed together, meaning, a request must match all the specified headers to select the route. */
2336
+ "headers"?: HeadersItem3[];
2337
+ /** Method specifies HTTP method matcher. When specified, this route will be matched only if the request has the specified method. Support: Extended */
2338
+ "method"?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
2339
+ /** Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. */
2340
+ "path"?: Path2;
2341
+ /** QueryParams specifies HTTP query parameter matchers. Multiple match values are ANDed together, meaning, a request must match all the specified query parameters to select the route. Support: Extended */
2342
+ "queryParams"?: QueryParamsItem2[];
2343
+ }
2344
+ export interface Timeouts {
2345
+ /** BackendRequest specifies a timeout for an individual request from the gateway to a backend. This covers the time from when the request first starts being sent from the gateway to when the full response has been received from the backend. Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set. An entire client HTTP transaction with a gateway, covered by the Request timeout, may result in more than one call from the gateway to the destination backend, for example, if automatic retries are supported. The value of BackendRequest must be a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, its behavior is implementation-specific; when specified, the value of BackendRequest must be no more than the value of the Request timeout (since the Request timeout encompasses the BackendRequest timeout). Support: Extended */
2346
+ "backendRequest"?: string;
2347
+ /** Request specifies the maximum duration for a gateway to respond to an HTTP request. If the gateway has not been able to respond before this deadline is met, the gateway MUST return a timeout error. For example, setting the `rules.timeouts.request` field to the value `10s` in an `HTTPRoute` will cause a timeout if a client request is taking longer than 10 seconds to complete. Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout completely. Implementations that cannot completely disable the timeout MUST instead interpret the zero duration as the longest possible value to which the timeout can be set. This timeout is intended to cover as close to the whole request-response transaction as possible although an implementation MAY choose to start the timeout after the entire request stream has been received instead of immediately after the transaction is initiated by the client. The value of Request is a Gateway API Duration string as defined by GEP-2257. When this field is unspecified, request timeout behavior is implementation-specific. Support: Extended */
2348
+ "request"?: string;
2349
+ }
2350
+ export interface RulesItem {
2351
+ /** BackendRefs defines the backend(s) where matching requests should be sent. Failure behavior here depends on how many BackendRefs are specified and how many are invalid. If *all* entries in BackendRefs are invalid, and there are also no filters specified in this route rule, *all* traffic which matches this rule MUST receive a 500 status code. See the HTTPBackendRef definition for the rules about what makes a single HTTPBackendRef invalid. When a HTTPBackendRef is invalid, 500 status codes MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive a 500 status code. For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic must receive a 500. Implementations may choose how that 50 percent is determined. When a HTTPBackendRef refers to a Service that has no ready endpoints, implementations SHOULD return a 503 for requests to that backend instead. If an implementation chooses to do this, all of the above rules for 500 responses MUST also apply for responses that return a 503. Support: Core for Kubernetes Service Support: Extended for Kubernetes ServiceImport Support: Implementation-specific for any other resource Support for weight: Core */
2352
+ "backendRefs"?: BackendRefsItem2[];
2353
+ /** Filters define the filters that are applied to requests that match this rule. Wherever possible, implementations SHOULD implement filters in the order they are specified. Implementations MAY choose to implement this ordering strictly, rejecting any combination or order of filters that cannot be supported. If implementations choose a strict interpretation of filter ordering, they MUST clearly document that behavior. To reject an invalid combination or order of filters, implementations SHOULD consider the Route Rules with this configuration invalid. If all Route Rules in a Route are invalid, the entire Route would be considered invalid. If only a portion of Route Rules are invalid, implementations MUST set the "PartiallyInvalid" condition for the Route. Conformance-levels at this level are defined based on the type of filter: - ALL core filters MUST be supported by all implementations. - Implementers are encouraged to support extended filters. - Implementation-specific custom filters have no API guarantees across implementations. Specifying the same filter multiple times is not supported unless explicitly indicated in the filter. All filters are expected to be compatible with each other except for the URLRewrite and RequestRedirect filters, which may not be combined. If an implementation cannot support other combinations of filters, they must clearly document that limitation. In cases where incompatible or unsupported filters are specified and cause the `Accepted` condition to be set to status `False`, implementations may use the `IncompatibleFilters` reason to specify this configuration error. Support: Core */
2354
+ "filters"?: FiltersItem[];
2355
+ /** Matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. For example, take the following matches configuration: ``` matches: - path: value: "/foo" headers: - name: "version" value: "v2" - path: value: "/v2/foo" ``` For a request to match against this rule, a request must satisfy EITHER of the two conditions: - path prefixed with `/foo` AND contains the header `version: v2` - path prefix of `/v2/foo` See the documentation for HTTPRouteMatch on how to specify multiple match conditions that should be ANDed together. If no matches are specified, the default is a prefix path match on "/", which has the effect of matching every HTTP request. Proxy or Load Balancer routing configuration generated from HTTPRoutes MUST prioritize matches based on the following criteria, continuing on ties. Across all rules specified on applicable Routes, precedence must be given to the match having: * "Exact" path match. * "Prefix" path match with largest number of characters. * Method match. * Largest number of header matches. * Largest number of query param matches. Note: The precedence of RegularExpression path matches are implementation-specific. If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties: * The oldest Route based on creation timestamp. * The Route appearing first in alphabetical order by "{namespace}/{name}". If ties still exist within an HTTPRoute, matching precedence MUST be granted to the FIRST matching rule (in list order) with a match meeting the above criteria. When no rules matching a request have been successfully attached to the parent a request is coming from, a HTTP 404 status code MUST be returned. */
2356
+ "matches"?: MatchesItem2[];
2357
+ /** Name is the name of the route rule. This name MUST be unique within a Route if it is set. Support: Extended */
2358
+ "name"?: string;
2359
+ /** Timeouts defines the timeouts that can be configured for an HTTP request. Support: Extended */
2360
+ "timeouts"?: Timeouts;
2361
+ }
2362
+ export interface HTTPRouteSpec {
2363
+ /** Hostnames defines a set of hostnames that should match against the HTTP Host header to select a HTTPRoute used to process the request. Implementations MUST ignore any port value specified in the HTTP Host header while performing a match and (absent of any applicable header modification configuration) MUST forward this header unmodified to the backend. Valid values for Hostnames are determined by RFC 1123 definition of a hostname with 2 notable exceptions: 1. IPs are not allowed. 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. If a hostname is specified by both the Listener and HTTPRoute, there must be at least one intersecting hostname for the HTTPRoute to be attached to the Listener. For example: * A Listener with `test.example.com` as the hostname matches HTTPRoutes that have either not specified any hostnames, or have specified at least one of `test.example.com` or `*.example.com`. * A Listener with `*.example.com` as the hostname matches HTTPRoutes that have either not specified any hostnames or have specified at least one hostname that matches the Listener hostname. For example, `*.example.com`, `test.example.com`, and `foo.test.example.com` would all match. On the other hand, `example.com` and `test.example.net` would not match. Hostnames that are prefixed with a wildcard label (`*.`) are interpreted as a suffix match. That means that a match for `*.example.com` would match both `test.example.com`, and `foo.test.example.com`, but not `example.com`. If both the Listener and HTTPRoute have specified hostnames, any HTTPRoute hostnames that do not match the Listener hostname MUST be ignored. For example, if a Listener specified `*.example.com`, and the HTTPRoute specified `test.example.com` and `test.example.net`, `test.example.net` must not be considered for a match. If both the Listener and HTTPRoute have specified hostnames, and none match with the criteria above, then the HTTPRoute is not accepted. The implementation must raise an 'Accepted' Condition with a status of `False` in the corresponding RouteParentStatus. In the event that multiple HTTPRoutes specify intersecting hostnames (e.g. overlapping wildcard matching and exact matching hostnames), precedence must be given to rules from the HTTPRoute with the largest number of: * Characters in a matching non-wildcard hostname. * Characters in a matching hostname. If ties exist across multiple Routes, the matching precedence rules for HTTPRouteMatches takes over. Support: Core */
2364
+ "hostnames"?: string[];
2365
+ /** ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. For Services, that means the Service must either be in the same namespace for a "producer" route, or the mesh implementation must support and allow "consumer" routes for the referenced Service. ReferenceGrant is not applicable for governing ParentRefs to Services - it is not possible to create a "producer" route for a Service in a different namespace from the Route. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) This API may be extended in the future to support additional kinds of parent resources. ParentRefs must be _distinct_. This means either that: * They select different objects. If this is the case, then parentRef entries are distinct. In terms of fields, this means that the multi-part key defined by `group`, `kind`, `namespace`, and `name` must be unique across all parentRef entries in the Route. * They do not select different objects, but for each optional field used, each ParentRef that selects the same object must set the same set of optional fields to different values. If one ParentRef sets a combination of optional fields, all must set the same combination. Some examples: * If one ParentRef sets `sectionName`, all ParentRefs referencing the same object must also set `sectionName`. * If one ParentRef sets `port`, all ParentRefs referencing the same object must also set `port`. * If one ParentRef sets `sectionName` and `port`, all ParentRefs referencing the same object must also set `sectionName` and `port`. It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. Note that for ParentRefs that cross namespace boundaries, there are specific rules. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example, Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable other kinds of cross-namespace reference. */
2366
+ "parentRefs"?: ParentRefsItem[];
2367
+ /** Rules are a list of HTTP matchers, filters and actions. */
2368
+ "rules"?: RulesItem[];
2369
+ }
2370
+ export interface ParentRef {
2371
+ /** Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). Support: Core */
2372
+ "group"?: string;
2373
+ /** Kind is kind of the referent. There are two kinds of parent resources with "Core" support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, ClusterIP Services only) Support for other resources is Implementation-Specific. */
2374
+ "kind"?: string;
2375
+ /** Name is the name of the referent. Support: Core */
2376
+ "name": string;
2377
+ /** Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. Support: Core */
2378
+ "namespace"?: string;
2379
+ /** Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended */
2380
+ "port"?: number;
2381
+ /** SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core */
2382
+ "sectionName"?: string;
2383
+ }
2384
+ export interface ParentsItem {
2385
+ /** Conditions describes the status of the route with respect to the Gateway. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. If the Route's ParentRef specifies an existing Gateway that supports Routes of this kind AND that Gateway's controller has sufficient access, then that Gateway's controller MUST set the "Accepted" condition on the Route, to indicate whether the route has been accepted or rejected by the Gateway, and why. A Route MUST be considered "Accepted" if at least one of the Route's rules is implemented by the Gateway. There are a number of cases where the "Accepted" condition may not be set due to lack of controller visibility, that includes when: * The Route refers to a nonexistent parent. * The Route is of a type that the controller does not support. * The Route is in a namespace the controller does not have access to. */
2386
+ "conditions": ConditionsItem[];
2387
+ /** ControllerName is a domain/path string that indicates the name of the controller that wrote this status. This corresponds with the controllerName field on GatewayClass. Example: "example.net/gateway-controller". The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). Controllers MUST populate this field when writing status. Controllers should ensure that entries to status populated with their ControllerName are cleaned up when they are no longer necessary. */
2388
+ "controllerName": string;
2389
+ /** ParentRef corresponds with a ParentRef in the spec that this RouteParentStatus struct describes the status of. */
2390
+ "parentRef": ParentRef;
2391
+ }
2392
+ export interface HTTPRouteStatus {
2393
+ /** Parents is a list of parent resources (usually Gateways) that are associated with the route, and the status of the route with respect to each parent. When this route attaches to a parent, the controller that manages the parent must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route or gateway is modified. Note that parent references that cannot be resolved by an implementation of this API will not be added to this list. Implementations of this API can only populate Route status for the Gateways/parent resources they are responsible for. A maximum of 32 Gateways will be represented in this list. An empty list means the route has not been attached to any Gateway. */
2394
+ "parents": ParentsItem[];
2395
+ }
2396
+ //# sourceMappingURL=gateway.d.ts.map