{ "description": "CiliumGatewayClassConfig is a Kubernetes third-party resource which\nis used to configure Gateways owned by GatewayClass.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": [ "string", "null" ] }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": [ "string", "null" ] }, "metadata": { "type": "object" }, "spec": { "additionalProperties": false, "description": "Spec is a human-readable of a GatewayClass configuration.", "properties": { "description": { "description": "Description helps describe a GatewayClass configuration with more details.", "maxLength": 64, "type": [ "string", "null" ] }, "envoy": { "additionalProperties": false, "description": "Envoy specifies proxy configuration options.\nThese settings control Envoy-specific behavior that is not part of the Gateway API standard.", "properties": { "serverHeaderTransformation": { "default": "OVERWRITE", "description": "ServerHeaderTransformation controls the HTTP \"Server\" response header.\nDefaults to OVERWRITE.", "enum": [ "OVERWRITE", "APPEND_IF_ABSENT", "PASS_THROUGH" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "httpOptions": { "additionalProperties": false, "description": "HTTPOptions specifies HTTP connection manager options.", "properties": { "grpcWebTranslation": { "additionalProperties": false, "description": "GRPCWebTranslation controls Envoy's gRPC-web to gRPC request translation.", "properties": { "enabled": { "default": true, "description": "Enabled controls Envoy's gRPC-web to gRPC request translation.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "service": { "additionalProperties": false, "description": "Service specifies the configuration for the generated Service.\nNote that not all fields from upstream Service.Spec are supported", "properties": { "allocateLoadBalancerNodePorts": { "description": "Sets the Service.Spec.AllocateLoadBalancerNodePorts in generated Service objects to the given value.", "type": [ "boolean", "null" ] }, "externalTrafficPolicy": { "default": "Cluster", "description": "Sets the Service.Spec.ExternalTrafficPolicy in generated Service objects to the given value.", "type": [ "string", "null" ] }, "ipFamilies": { "description": "Sets the Service.Spec.IPFamilies in generated Service objects to the given value.", "items": { "description": "IPFamily represents the IP Family (IPv4 or IPv6). This type is used\nto express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).", "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "ipFamilyPolicy": { "description": "Sets the Service.Spec.IPFamilyPolicy in generated Service objects to the given value.", "type": [ "string", "null" ] }, "loadBalancerClass": { "description": "Sets the Service.Spec.LoadBalancerClass in generated Service objects to the given value.", "type": [ "string", "null" ] }, "loadBalancerSourceRanges": { "description": "Sets the Service.Spec.LoadBalancerSourceRanges in generated Service objects to the given value.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "loadBalancerSourceRangesPolicy": { "default": "Allow", "description": "LoadBalancerSourceRangesPolicy defines the policy for the LoadBalancerSourceRanges if the incoming traffic\nis allowed or denied.", "enum": [ "Allow", "Deny" ], "type": [ "string", "null" ] }, "trafficDistribution": { "description": "Sets the Service.Spec.TrafficDistribution in generated Service objects to the given value.", "type": [ "string", "null" ] }, "type": { "default": "LoadBalancer", "description": "Sets the Service.Spec.Type in generated Service objects to the given value.\nOnly LoadBalancer and NodePort are supported.", "enum": [ "LoadBalancer", "NodePort" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "telemetry": { "additionalProperties": false, "description": "Telemetry specifies observability options for Gateways using this\nGatewayClass configuration.", "properties": { "accessLogs": { "description": "AccessLogs configures Envoy access logging for generated Gateway\nlisteners.", "items": { "additionalProperties": false, "description": "AccessLogs defines an Envoy access log configuration, including its output\nformat and the generated proxy components that should emit it.\nAccess logs are currently written to Envoy stdout.", "properties": { "format": { "description": "Format specifies the access log output format.", "enum": [ "JSON", "Text" ], "type": "string" }, "json": { "additionalProperties": { "type": "string" }, "default": { "authority": "%REQUEST_HEADER(:AUTHORITY)%", "bytes_received": "%BYTES_RECEIVED%", "bytes_sent": "%BYTES_SENT%", "duration": "%DURATION%", "method": "%REQUEST_HEADER(:METHOD)%", "path": "%REQUEST_HEADER(X-ENVOY-ORIGINAL-PATH?:PATH)%", "protocol": "%PROTOCOL%", "request_id": "%REQUEST_HEADER(X-REQUEST-ID)%", "response_code": "%RESPONSE_CODE%", "response_flags": "%RESPONSE_FLAGS%", "start_time": "%START_TIME%", "upstream_host": "%UPSTREAM_HOST%", "upstream_service_time": "%RESPONSE_HEADER(X-ENVOY-UPSTREAM-SERVICE-TIME)%", "user_agent": "%REQUEST_HEADER(USER-AGENT)%", "x_forwarded_for": "%REQUEST_HEADER(X-FORWARDED-FOR)%" }, "description": "JSON maps access log field names to Envoy command operators.\nIt is used when Format is \"JSON\".\nFor available format specifiers, see the Envoy documentation:\n- https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage\nNote: Always refer to the documentation matching the specific Envoy version you are running.\nThe following Cilium-specific formatters are also supported:\n- %CILIUM_GATEWAY_NAME% -- replaced with the Gateway resource name.\n- %CILIUM_GATEWAY_NAMESPACE% -- replaced with the Gateway resource namespace.", "maxProperties": 64, "minProperties": 1, "type": [ "object", "null" ] }, "targets": { "default": [ "HTTP" ], "description": "Targets specifies the generated Envoy proxy components where access logs\nare emitted. If omitted, access logs are emitted for HTTP traffic only.\nHTTP targets Envoy HTTP connection managers. TCP targets Envoy TCP proxies,\nincluding TLS passthrough.", "items": { "description": "AccessLogsTarget specifies where access logs are emitted.", "enum": [ "HTTP", "TCP" ], "type": "string" }, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "text": { "default": "[%START_TIME%] \"%REQUEST_HEADER(:METHOD)% %REQUEST_HEADER(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%\" %RESPONSE_CODE% %RESPONSE_FLAGS% %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESPONSE_HEADER(X-ENVOY-UPSTREAM-SERVICE-TIME)% \"%REQUEST_HEADER(X-FORWARDED-FOR)%\" \"%REQUEST_HEADER(USER-AGENT)%\" \"%REQUEST_HEADER(X-REQUEST-ID)%\" \"%REQUEST_HEADER(:AUTHORITY)%\" \"%UPSTREAM_HOST%\"", "description": "Text specifies the Envoy access log format string.\nIt is used when Format is \"Text\".\nFor available format specifiers, see the Envoy documentation:\n- https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage\nNote: Always refer to the documentation matching the specific Envoy version you are running.\nThe following Cilium-specific formatters are also supported:\n- %CILIUM_GATEWAY_NAME% -- replaced with the Gateway resource name.\n- %CILIUM_GATEWAY_NAMESPACE% -- replaced with the Gateway resource namespace.", "maxLength": 4096, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "format" ], "type": "object" }, "maxItems": 8, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "status": { "additionalProperties": false, "description": "Status is the status of the policy.", "properties": { "conditions": { "description": "Current service state", "items": { "additionalProperties": false, "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" } }, "type": [ "object", "null" ] } }, "required": [ "metadata" ], "type": "object" }