instance.proto

Package: fed.solo.io

Types:

Source File: github.com/solo-io/solo-apis/api/fed/v1/instance.proto

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

Field Type Description Default
cluster string The cluster on which this Gloo instance is located.
isEnterprise bool
controlPlane .fed.solo.io.GlooInstanceSpec.ControlPlane
proxies []fed.solo.io.GlooInstanceSpec.Proxy
region string Geographical region in which this gloo instance is located. Each proxy may potentially live in 1 or more zones, so zonal information is stored on the proxy.
admin .fed.solo.io.GlooInstanceSpec.Admin
check .fed.solo.io.GlooInstanceSpec.Check

ControlPlane

"version": string
"namespace": string
"watchedNamespaces": []string

Field Type Description Default
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
"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 Default
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.
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

Field Type Description Default
address string
ports []fed.solo.io.GlooInstanceSpec.Proxy.IngressEndpoint.Port
serviceName string Kubernetes service name, will be populated only if applicable.

Port

"port": int
"name": string

Field Type Description Default
port int
name string

WorkloadController

Name Description
UNDEFINED
DEPLOYMENT
DAEMON_SET

Admin

"writeNamespace": string
"proxyId": .core.skv2.solo.io.ObjectRef

Field Type Description Default
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
"deployments": .fed.solo.io.GlooInstanceSpec.Check.Summary
"pods": .fed.solo.io.GlooInstanceSpec.Check.Summary

Field Type Description Default
gateways .fed.solo.io.GlooInstanceSpec.Check.Summary Gateways describes the Gateways configuring the GlooInstance.
virtualServices .fed.solo.io.GlooInstanceSpec.Check.Summary VirtualServices describes the VirtualServices configuring the GlooInstance.
routeTables .fed.solo.io.GlooInstanceSpec.Check.Summary Route Tables describes the RouteTables available the GlooInstance.
authConfigs .fed.solo.io.GlooInstanceSpec.Check.Summary Auth Configs describes the AuthConfigs available to the GlooInstance.
settings .fed.solo.io.GlooInstanceSpec.Check.Summary Settings describes the Settings configuring the GlooInstance.
upstreams .fed.solo.io.GlooInstanceSpec.Check.Summary Upstreams describes the Upstreams available to the GlooInstance.
upstreamGroups .fed.solo.io.GlooInstanceSpec.Check.Summary UpstreamGroups describes the UpstreamGroups available to the GlooInstance.
proxies .fed.solo.io.GlooInstanceSpec.Check.Summary Proxies describes the Proxies configuring the GlooInstance.
deployments .fed.solo.io.GlooInstanceSpec.Check.Summary Deployments describes the Deployments in the GlooInstance’s install namespace.
pods .fed.solo.io.GlooInstanceSpec.Check.Summary Pods describes the pods in the GlooInstance’s install namespace.

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

Field Type Description Default
total int The total number of resources in any state.
errors []fed.solo.io.GlooInstanceSpec.Check.Summary.ResourceReport Errors is a list of resource refs and their associated error messages.
warnings []fed.solo.io.GlooInstanceSpec.Check.Summary.ResourceReport Warnings is a list of resource refs and their associated warning messages.

ResourceReport

A ResourceReport references an object and provides a status message.

"ref": .core.skv2.solo.io.ObjectRef
"message": string

Field Type Description Default
ref .core.skv2.solo.io.ObjectRef
message string

GlooInstanceStatus


Field Type Description Default