Navigation :
Getting Started
What is Gloo Gateway?
Setup
Guides
Operations
Reference
-
Open Source Attribution
-
API Reference
-- address.proto
-- advanced_http.proto
-- als.proto
-- annotations.proto
-- any.proto
-- api.proto
-- artifact.proto
-- aws.proto
-- aws_ec2.proto
-- azure.proto
-- base.proto
-- caching.proto
-- circuit_breaker.proto
-- cluster.proto
-- connection.proto
-- connection_limit.proto
-- consul.proto
-- core.proto
-- cors.proto
-- deprecation.proto
-- descriptor.proto
-- discovery.proto
-- dlp.proto
-- duration.proto
-- dynamic_forward_proxy.proto
-- empty.proto
-- endpoint.proto
-- envoy.glooe.solo.io.project
-- envoy_glooe_solo_io.project
-- ext.proto
-- extauth.proto
-- extensions.proto
-- external_options.proto
-- extproc.proto
-- failover.proto
-- failover.proto
-- fault.proto
-- field_mask.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
-- grpc.proto
-- grpc_json.proto
-- grpc_web.proto
-- hcm.proto
-- header_validation.proto
-- headers.proto
-- healthcheck.proto
-- http.proto
-- http_gateway.proto
-- http_uri.proto
-- ingress.proto
-- instance.proto
-- jwt.proto
-- kubernetes.proto
-- lbhash.proto
-- load_balancer.proto
-- local_ratelimit.proto
-- matchable_http_gateway.proto
-- matchable_tcp_gateway.proto
-- matchers.proto
-- metadata.proto
-- metrics.proto
-- options.proto
-- parameters.proto
-- percent.proto
-- pipe.proto
-- placement.proto
-- protocol.proto
-- protocol_upgrade.proto
-- proxy.proto
-- proxy_endpoint.proto
-- proxy_protocol.proto
-- proxy_protocol.proto
-- query_options.proto
-- ratelimit.proto
-- ratelimit.proto
-- ratelimit.proto
-- rbac.proto
-- ref.proto
-- rest.proto
-- retries.proto
-- route.proto
-- route_table.proto
-- router.proto
-- secret.proto
-- selectors.proto
-- semantic_version.proto
-- service.proto
-- service_spec.proto
-- settings.proto
-- shadowing.proto
-- snap.proto
-- socket_option.proto
-- solo-discovery-service.proto
-- solo-kit.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
-- struct.proto
-- subset.proto
-- subset_spec.proto
-- tap.proto
-- tap.proto
-- tcp.proto
-- timestamp.proto
-- trace.proto
-- tracing.proto
-- transformation.proto
-- type.proto
-- upstream.proto
-- version.proto
-- virtual_service.proto
-- waf.proto
-- wasm.proto
-- wrappers.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
instance.proto
Package: fed.solo.io
Types:
GlooInstanceSpec
"cluster": string
"isEnterprise": bool
"controlPlane": .fed.solo.io.GlooInstanceSpec.ControlPlane
"proxies": [] fed.solo.io.GlooInstanceSpec.Proxy
"region": string
"admin": .fed.solo.io.GlooInstanceSpec.Admin
"check": .fed.solo.io.GlooInstanceSpec.Check
ControlPlane
"version": string
"namespace": string
"watchedNamespaces": [] string
Field
Type
Description
version
string
The version.
namespace
string
Namespace in which the control-plane (Gloo) is located.
watchedNamespaces
[]string
An optional list of watched namespaces for Gloo resources. By default, if this list is empty, we look in all namespaces.
Proxy
"replicas": int
"availableReplicas": int
"readyReplicas": int
"wasmEnabled": bool
"readConfigMulticlusterEnabled": bool
"version": string
"name": string
"namespace": string
"workloadControllerType": .fed.solo.io.GlooInstanceSpec.Proxy.WorkloadController
"zones": [] string
"ingressEndpoints": [] fed.solo.io.GlooInstanceSpec.Proxy.IngressEndpoint
Field
Type
Description
replicas
int
The number of requested proxy replicas.
availableReplicas
int
The number of available proxy replicas.
readyReplicas
int
The number of ready proxy replicas.
wasmEnabled
bool
Whether or not this proxy supports wasm plugins.
readConfigMulticlusterEnabled
bool
Whether or not this proxy allows its config dumps to be read.
version
string
The version.
name
string
Name of the proxy instance, this is important to distinguish it from other proxy instances, which may be in the same namespace.
namespace
string
Namespace in which the proxy is located.
workloadControllerType
.fed.solo.io.GlooInstanceSpec.Proxy.WorkloadController
Workload controller type indicates the type of workload controller managing the Proxy’s pods (i.e. Deployment, DaemonSet).
zones
[]string
Zones in which the replicas of a given proxy deployment are running. Kubernetes supports multi zone deployments, so 1 proxy may potentially live in multiple zones.
ingressEndpoints
[]fed.solo.io.GlooInstanceSpec.Proxy.IngressEndpoint
IngressEndpoint
"address": string
"ports": [] fed.solo.io.GlooInstanceSpec.Proxy.IngressEndpoint.Port
"serviceName": string
Port
"port": int
"name": string
Field
Type
Description
port
int
name
string
WorkloadController
Name
Description
UNDEFINED
DEPLOYMENT
DAEMON_SET
Admin
"writeNamespace": string
"proxyId": .core.skv2.solo.io.ObjectRef
Field
Type
Description
writeNamespace
string
Namespace which gloo-fed will write all of its admin resources to.
proxyId
.core.skv2.solo.io.ObjectRef
name of proxy which will be used for gloo-fed by default for this instance, unless specified via: TODO.
Check
Check describes the status of the objects powering the GlooInstance.
"gateways": .fed.solo.io.GlooInstanceSpec.Check.Summary
"virtualServices": .fed.solo.io.GlooInstanceSpec.Check.Summary
"routeTables": .fed.solo.io.GlooInstanceSpec.Check.Summary
"authConfigs": .fed.solo.io.GlooInstanceSpec.Check.Summary
"settings": .fed.solo.io.GlooInstanceSpec.Check.Summary
"upstreams": .fed.solo.io.GlooInstanceSpec.Check.Summary
"upstreamGroups": .fed.solo.io.GlooInstanceSpec.Check.Summary
"proxies": .fed.solo.io.GlooInstanceSpec.Check.Summary
"rateLimitConfigs": .fed.solo.io.GlooInstanceSpec.Check.Summary
"matchableHttpGateways": .fed.solo.io.GlooInstanceSpec.Check.Summary
"matchableTcpGateways": .fed.solo.io.GlooInstanceSpec.Check.Summary
"deployments": .fed.solo.io.GlooInstanceSpec.Check.Summary
"pods": .fed.solo.io.GlooInstanceSpec.Check.Summary
Summary
Summary provides aggregate information for a given resource type.
"total": int
"errors": [] fed.solo.io.GlooInstanceSpec.Check.Summary.ResourceReport
"warnings": [] fed.solo.io.GlooInstanceSpec.Check.Summary.ResourceReport
ResourceReport
A ResourceReport references an object and provides a status message.
"ref": .core.skv2.solo.io.ObjectRef
"message": string
GlooInstanceStatus