Navigation :
Getting Started
What is Gloo Gateway?
Setup
Guides
Operations
Reference
-
Open Source Attribution
-
API Reference
-- address.proto
-- address.proto
-- advanced_http.proto
-- advanced_http.proto
-- ai.proto
-- als.proto
-- annotations.proto
-- any.proto
-- api.proto
-- apple_dns_resolver.proto
-- artifact.proto
-- authority.proto
-- aws.proto
-- aws_ec2.proto
-- azure.proto
-- backoff.proto
-- base.proto
-- base.proto
-- buffer.proto
-- caching.proto
-- cares_dns_resolver.proto
-- cidr.proto
-- cipher_detection_input.proto
-- circuit_breaker.proto
-- cluster.proto
-- config.proto
-- config.proto
-- connection.proto
-- connection_limit.proto
-- consul.proto
-- context_params.proto
-- core.proto
-- cors.proto
-- csrf.proto
-- custom_tag.proto
-- datadog.proto
-- deprecation.proto
-- descriptor.proto
-- discovery.proto
-- dlp.proto
-- domain.proto
-- duration.proto
-- dynamic_forward_proxy.proto
-- empty.proto
-- endpoint.proto
-- envoy.glooe.solo.io.project
-- envoy_glooe_solo_io.project
-- event_service_config.proto
-- ext.proto
-- extauth.proto
-- extension.proto
-- extension.proto
-- extensions.proto
-- external_options.proto
-- external_processor.proto
-- extproc.proto
-- failover.proto
-- failover.proto
-- fault.proto
-- field_mask.proto
-- filter.proto
-- gateway.proto
-- gateway.solo.io.project
-- gateway_solo_io.project
-- gcp.proto
-- gloo.solo.io.project
-- gloo_solo_io.project
-- gloo_validation.proto
-- glooe.solo.io.project
-- glooe_solo_io.project
-- graphql.proto
-- graphql.proto
-- graphql.proto
-- grpc.proto
-- grpc_json.proto
-- grpc_output_sink.proto
-- grpc_service.proto
-- grpc_web.proto
-- gzip.proto
-- hcm.proto
-- header_validation.proto
-- headers.proto
-- health_check.proto
-- health_check.proto
-- healthcheck.proto
-- http.proto
-- http.proto
-- http_gateway.proto
-- http_inputs.proto
-- http_output_sink.proto
-- http_path.proto
-- http_status.proto
-- http_uri.proto
-- http_uri.proto
-- ingress.proto
-- instance.proto
-- ip.proto
-- jwt.proto
-- kubernetes.proto
-- lbhash.proto
-- load_balancer.proto
-- local_ratelimit.proto
-- matchable_http_gateway.proto
-- matchable_tcp_gateway.proto
-- matcher.proto
-- matchers.proto
-- metadata.proto
-- metadata.proto
-- metrics.proto
-- migrate.proto
-- migrate.proto
-- mutation_rules.proto
-- opencensus.proto
-- opentelemetry.proto
-- options.proto
-- orca.proto
-- outlier_detection.proto
-- parameters.proto
-- percent.proto
-- percent.proto
-- pipe.proto
-- placement.proto
-- processing_mode.proto
-- protocol.proto
-- protocol_upgrade.proto
-- proxy.proto
-- proxy_endpoint.proto
-- proxy_protocol.proto
-- proxy_protocol.proto
-- proxy_protocol.proto
-- proxylatency.proto
-- proxyprotocol.proto
-- query_options.proto
-- query_options.proto
-- range.proto
-- range.proto
-- range.proto
-- range.proto
-- ratelimit.proto
-- ratelimit.proto
-- ratelimit.proto
-- rbac.proto
-- ref.proto
-- regex.proto
-- regex.proto
-- resolver.proto
-- resource.proto
-- resource_locator.proto
-- resource_name.proto
-- rest.proto
-- retries.proto
-- route.proto
-- route_components.proto
-- route_table.proto
-- router.proto
-- sanitize.proto
-- secret.proto
-- security.proto
-- selectors.proto
-- semantic_version.proto
-- semantic_version.proto
-- sensitive.proto
-- sensitive.proto
-- server_name_matcher.proto
-- service.proto
-- service_spec.proto
-- settings.proto
-- shadowing.proto
-- snap.proto
-- socket_option.proto
-- socket_option.proto
-- solo-discovery-service.proto
-- solo-kit.proto
-- solo_jwt_authn.proto
-- solo_xff_offset_filter.proto
-- source_context.proto
-- ssl.proto
-- ssl.proto
-- stages.proto
-- stateful_session.proto
-- statefulsession.proto
-- statefulsession.proto
-- static.proto
-- stats.proto
-- status.proto
-- status.proto
-- status.proto
-- status.proto
-- stitching.proto
-- string.proto
-- string.proto
-- struct.proto
-- subset.proto
-- subset_spec.proto
-- tap.proto
-- tap.proto
-- tcp.proto
-- timestamp.proto
-- tls_cipher_inspector.proto
-- trace.proto
-- tracing.proto
-- transformation.proto
-- transformation.proto
-- transformation.proto
-- type.proto
-- typed_struct.proto
-- upstream.proto
-- upstream_proxy_protocol.proto
-- upstream_wait_filter.proto
-- version.proto
-- versioning.proto
-- versioning.proto
-- virtual_service.proto
-- waf.proto
-- waf.proto
-- wasm.proto
-- wasm.proto
-- wasm.proto
-- wrappers.proto
-- xslt_transformer.proto
-- zipkin.proto
-
Command Line Reference
-
Changelog
-
Helm Chart Values
-
Security Updates
- Security Posture
- Gloo Gateway Port Reference
- Release Support
-
Cheatsheets
Contribution Guide
Get help and support
gloo_validation.proto
Package: gloo.solo.io
Types:
GlooValidationServiceRequest
"proxy": .gloo.solo.io.Proxy
"modifiedResources": .gloo.solo.io.ModifiedResources
"deletedResources": .gloo.solo.io.DeletedResources
Field
Type
Description
proxy
.gloo.solo.io.Proxy
Optional. If a proxy is provided in the request, the response will contain only the report for that proxy. If no proxy is provided, the response will contain a report for each proxy in the Gloo API snapshot.
modifiedResources
.gloo.solo.io.ModifiedResources
Resources to be created or modified. Only one of modifiedResources
or deletedResources
can be set.
deletedResources
.gloo.solo.io.DeletedResources
Resources to be deleted. Only one of deletedResources
or modifiedResources
can be set.
GlooValidationServiceResponse
"validationReports": [] gloo.solo.io.ValidationReport
Field
Type
Description
validationReports
[]gloo.solo.io.ValidationReport
This list contains a validation report for each proxy that was translated and validated with the proposed Gloo API snapshot.
ModifiedResources
"upstreams": [] gloo.solo.io.Upstream
DeletedResources
"upstreamRefs": [] core.solo.io.ResourceRef
"secretRefs": [] core.solo.io.ResourceRef
ValidationReport
A validation report represents the warnings and errors that produced during
a single translation loop of a proxy.
"proxyReport": .gloo.solo.io.ProxyReport
"upstreamReports": [] gloo.solo.io.ResourceReport
"proxy": .gloo.solo.io.Proxy
ResourceReport
"resourceRef": .core.solo.io.ResourceRef
"warnings": [] string
"errors": [] string
Field
Type
Description
resourceRef
.core.solo.io.ResourceRef
A way to refer to resources in different namespaces by including the name and namespace of the resource in this resourceRef
.
warnings
[]string
The warnings that are returned for the resource. Warnings do not necessarily prevent an operation from happening, but might require action.
errors
[]string
The errors that are returned for the resource. You cannot modify the resource until the errors are resolved. For help troubleshooting, see the Debug guide .
NotifyOnResyncRequest
NotifyOnResyncResponse
ProxyReport
The Proxy Report should contain one report for each sub-resource of the Proxy
E.g., each listener will have a corresponding report. Within each listener report is
a route report corresponding to each route on the listener.
If the report contains no errors, the (sub-)resource is valid.
"listenerReports": [] gloo.solo.io.ListenerReport
ListenerReport
"errors": [] gloo.solo.io.ListenerReport.Error
"warnings": [] gloo.solo.io.ListenerReport.Warning
"httpListenerReport": .gloo.solo.io.HttpListenerReport
"tcpListenerReport": .gloo.solo.io.TcpListenerReport
"hybridListenerReport": .gloo.solo.io.HybridListenerReport
"aggregateListenerReport": .gloo.solo.io.AggregateListenerReport
Field
Type
Description
errors
[]gloo.solo.io.ListenerReport.Error
errors on top-level config of the listener.
warnings
[]gloo.solo.io.ListenerReport.Warning
warnings on the top-levelconfig of the listener.
httpListenerReport
.gloo.solo.io.HttpListenerReport
report for the http listener. Only one of httpListenerReport
, tcpListenerReport
, hybridListenerReport
, or aggregateListenerReport
can be set.
tcpListenerReport
.gloo.solo.io.TcpListenerReport
report for the tcp listener. Only one of tcpListenerReport
, httpListenerReport
, hybridListenerReport
, or aggregateListenerReport
can be set.
hybridListenerReport
.gloo.solo.io.HybridListenerReport
report for the hybrid listener. Only one of hybridListenerReport
, httpListenerReport
, tcpListenerReport
, or aggregateListenerReport
can be set.
aggregateListenerReport
.gloo.solo.io.AggregateListenerReport
report for the aggregate listener. Only one of aggregateListenerReport
, httpListenerReport
, tcpListenerReport
, or hybridListenerReport
can be set.
Error
error types for top-level listener config
"type": .gloo.solo.io.ListenerReport.Error.Type
"reason": string
Type
Name
Description
NameNotUniqueError
BindPortNotUniqueError
SSLConfigError
ProcessingError
Warning
warning types for the given listener config
"type": .gloo.solo.io.ListenerReport.Warning.Type
"reason": string
Type
Name
Description
SSLConfigWarning
HttpListenerReport
"errors": [] gloo.solo.io.HttpListenerReport.Error
"virtualHostReports": [] gloo.solo.io.VirtualHostReport
Error
error types for top-level http listener config
"type": .gloo.solo.io.HttpListenerReport.Error.Type
"reason": string
"metadata": .gloo.solo.io.SourceMetadata
Type
Name
Description
ProcessingError
VirtualHostReport
"errors": [] gloo.solo.io.VirtualHostReport.Error
"routeReports": [] gloo.solo.io.RouteReport
Error
error types for top-level virtual host config
"type": .gloo.solo.io.VirtualHostReport.Error.Type
"reason": string
"metadata": .gloo.solo.io.SourceMetadata
Type
Name
Description
NameNotUniqueError
DomainsNotUniqueError
ProcessingError
EmptyDomainError
RouteReport
"errors": [] gloo.solo.io.RouteReport.Error
"warnings": [] gloo.solo.io.RouteReport.Warning
Error
error types for the given route config
"type": .gloo.solo.io.RouteReport.Error.Type
"reason": string
"metadata": .gloo.solo.io.SourceMetadata
Type
Name
Description
InvalidMatcherError
ProcessingError
Warning
warning types for the given route config
"type": .gloo.solo.io.RouteReport.Warning.Type
"reason": string
Type
Name
Description
InvalidDestinationWarning
TcpListenerReport
"errors": [] gloo.solo.io.TcpListenerReport.Error
"tcpHostReports": [] gloo.solo.io.TcpHostReport
Error
error types for top-level tcp listener config
"type": .gloo.solo.io.TcpListenerReport.Error.Type
"reason": string
Type
Name
Description
NameNotUniqueError
BindPortNotUniqueError
SSLConfigError
ProcessingError
TcpHostReport
"errors": [] gloo.solo.io.TcpHostReport.Error
"warnings": [] gloo.solo.io.TcpHostReport.Warning
Error
error types for tcp host config
"type": .gloo.solo.io.TcpHostReport.Error.Type
"reason": string
Type
Name
Description
NameNotUniqueError
InvalidDestinationError
ProcessingError
Warning
warning types for the given tcp host config
"type": .gloo.solo.io.TcpHostReport.Warning.Type
"reason": string
Type
Name
Description
UnknownWarning
InvalidDestinationWarning
HybridListenerReport
"matchedListenerReports": map<string, .gloo.solo.io.MatchedListenerReport>
Field
Type
Description
matchedListenerReports
map<string, .gloo.solo.io.MatchedListenerReport>
map key should uniquely identify MatchedListenerReport by matcher.
MatchedListenerReport
"httpListenerReport": .gloo.solo.io.HttpListenerReport
"tcpListenerReport": .gloo.solo.io.TcpListenerReport
AggregateListenerReport
the report for an AggregateListener
"httpListenerReports": map<string, .gloo.solo.io.HttpListenerReport>
"tcpListenerReports": map<string, .gloo.solo.io.TcpListenerReport>
Field
Type
Description
httpListenerReports
map<string, .gloo.solo.io.HttpListenerReport>
tcpListenerReports
map<string, .gloo.solo.io.TcpListenerReport>