statusv3

package
v1.33.0-20240426201503... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: unknown License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ConfigStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "SYNCED",
		2: "NOT_SENT",
		3: "STALE",
		4: "ERROR",
	}
	ConfigStatus_value = map[string]int32{
		"UNKNOWN":  0,
		"SYNCED":   1,
		"NOT_SENT": 2,
		"STALE":    3,
		"ERROR":    4,
	}
)

Enum value maps for ConfigStatus.

View Source
var (
	ClientConfigStatus_name = map[int32]string{
		0: "CLIENT_UNKNOWN",
		1: "CLIENT_REQUESTED",
		2: "CLIENT_ACKED",
		3: "CLIENT_NACKED",
	}
	ClientConfigStatus_value = map[string]int32{
		"CLIENT_UNKNOWN":   0,
		"CLIENT_REQUESTED": 1,
		"CLIENT_ACKED":     2,
		"CLIENT_NACKED":    3,
	}
)

Enum value maps for ClientConfigStatus.

View Source
var File_envoy_service_status_v3_csds_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ClientConfig

type ClientConfig struct {

	// Node for a particular client.
	Node *v31.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// This field is deprecated in favor of generic_xds_configs which is
	// much simpler and uniform in structure.
	//
	// Deprecated: Marked as deprecated in envoy/service/status/v3/csds.proto.
	XdsConfig []*PerXdsConfig `protobuf:"bytes,2,rep,name=xds_config,json=xdsConfig,proto3" json:"xds_config,omitempty"`
	// Represents generic xDS config and the exact config structure depends on
	// the type URL (like Cluster if it is CDS)
	GenericXdsConfigs []*ClientConfig_GenericXdsConfig `protobuf:"bytes,3,rep,name=generic_xds_configs,json=genericXdsConfigs,proto3" json:"generic_xds_configs,omitempty"`
	// For xDS clients, the scope in which the data is used.
	// For example, gRPC indicates the data plane target or that the data is
	// associated with gRPC server(s).
	ClientScope string `protobuf:"bytes,4,opt,name=client_scope,json=clientScope,proto3" json:"client_scope,omitempty"`
	// contains filtered or unexported fields
}

All xds configs for a particular client.

func (*ClientConfig) Descriptor deprecated

func (*ClientConfig) Descriptor() ([]byte, []int)

Deprecated: Use ClientConfig.ProtoReflect.Descriptor instead.

func (*ClientConfig) GetClientScope

func (x *ClientConfig) GetClientScope() string

func (*ClientConfig) GetGenericXdsConfigs

func (x *ClientConfig) GetGenericXdsConfigs() []*ClientConfig_GenericXdsConfig

func (*ClientConfig) GetNode

func (x *ClientConfig) GetNode() *v31.Node

func (*ClientConfig) GetXdsConfig deprecated

func (x *ClientConfig) GetXdsConfig() []*PerXdsConfig

Deprecated: Marked as deprecated in envoy/service/status/v3/csds.proto.

func (*ClientConfig) ProtoMessage

func (*ClientConfig) ProtoMessage()

func (*ClientConfig) ProtoReflect

func (x *ClientConfig) ProtoReflect() protoreflect.Message

func (*ClientConfig) Reset

func (x *ClientConfig) Reset()

func (*ClientConfig) String

func (x *ClientConfig) String() string

type ClientConfigStatus

type ClientConfigStatus int32

Config status from a client-side view.

const (
	// Config status is not available/unknown.
	ClientConfigStatus_CLIENT_UNKNOWN ClientConfigStatus = 0
	// Client requested the config but hasn't received any config from management
	// server yet.
	ClientConfigStatus_CLIENT_REQUESTED ClientConfigStatus = 1
	// Client received the config and replied with ACK.
	ClientConfigStatus_CLIENT_ACKED ClientConfigStatus = 2
	// Client received the config and replied with NACK. Notably, the attached
	// config dump is not the NACKed version, but the most recent accepted one. If
	// no config is accepted yet, the attached config dump will be empty.
	ClientConfigStatus_CLIENT_NACKED ClientConfigStatus = 3
)

func (ClientConfigStatus) Descriptor

func (ClientConfigStatus) Enum

func (ClientConfigStatus) EnumDescriptor deprecated

func (ClientConfigStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use ClientConfigStatus.Descriptor instead.

func (ClientConfigStatus) Number

func (ClientConfigStatus) String

func (x ClientConfigStatus) String() string

func (ClientConfigStatus) Type

type ClientConfig_GenericXdsConfig

type ClientConfig_GenericXdsConfig struct {

	// Type_url represents the fully qualified name of xDS resource type
	// like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc.
	TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// Name of the xDS resource
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// This is the :ref:`version_info <envoy_v3_api_field_service.discovery.v3.DiscoveryResponse.version_info>`
	// in the last processed xDS discovery response. If there are only
	// static bootstrap listeners, this field will be ""
	VersionInfo string `protobuf:"bytes,3,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// The xDS resource config. Actual content depends on the type
	XdsConfig *anypb.Any `protobuf:"bytes,4,opt,name=xds_config,json=xdsConfig,proto3" json:"xds_config,omitempty"`
	// Timestamp when the xDS resource was last updated
	LastUpdated *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_updated,json=lastUpdated,proto3" json:"last_updated,omitempty"`
	// Per xDS resource config status. It is generated by management servers.
	// It will not be present if the CSDS server is an xDS client.
	ConfigStatus ConfigStatus `` /* 140-byte string literal not displayed */
	// Per xDS resource status from the view of a xDS client
	ClientStatus v32.ClientResourceStatus `` /* 139-byte string literal not displayed */
	// Set if the last update failed, cleared after the next successful
	// update. The *error_state* field contains the rejected version of
	// this particular resource along with the reason and timestamp. For
	// successfully updated or acknowledged resource, this field should
	// be empty.
	// [#not-implemented-hide:]
	ErrorState *v32.UpdateFailureState `protobuf:"bytes,8,opt,name=error_state,json=errorState,proto3" json:"error_state,omitempty"`
	// Is static resource is true if it is specified in the config supplied
	// through the file at the startup.
	IsStaticResource bool `protobuf:"varint,9,opt,name=is_static_resource,json=isStaticResource,proto3" json:"is_static_resource,omitempty"`
	// contains filtered or unexported fields
}

GenericXdsConfig is used to specify the config status and the dump of any xDS resource identified by their type URL. It is the generalized version of the now deprecated ListenersConfigDump, ClustersConfigDump etc [#next-free-field: 10]

func (*ClientConfig_GenericXdsConfig) Descriptor deprecated

func (*ClientConfig_GenericXdsConfig) Descriptor() ([]byte, []int)

Deprecated: Use ClientConfig_GenericXdsConfig.ProtoReflect.Descriptor instead.

func (*ClientConfig_GenericXdsConfig) GetClientStatus

func (*ClientConfig_GenericXdsConfig) GetConfigStatus

func (x *ClientConfig_GenericXdsConfig) GetConfigStatus() ConfigStatus

func (*ClientConfig_GenericXdsConfig) GetErrorState

func (*ClientConfig_GenericXdsConfig) GetIsStaticResource

func (x *ClientConfig_GenericXdsConfig) GetIsStaticResource() bool

func (*ClientConfig_GenericXdsConfig) GetLastUpdated

func (*ClientConfig_GenericXdsConfig) GetName

func (*ClientConfig_GenericXdsConfig) GetTypeUrl

func (x *ClientConfig_GenericXdsConfig) GetTypeUrl() string

func (*ClientConfig_GenericXdsConfig) GetVersionInfo

func (x *ClientConfig_GenericXdsConfig) GetVersionInfo() string

func (*ClientConfig_GenericXdsConfig) GetXdsConfig

func (x *ClientConfig_GenericXdsConfig) GetXdsConfig() *anypb.Any

func (*ClientConfig_GenericXdsConfig) ProtoMessage

func (*ClientConfig_GenericXdsConfig) ProtoMessage()

func (*ClientConfig_GenericXdsConfig) ProtoReflect

func (*ClientConfig_GenericXdsConfig) Reset

func (x *ClientConfig_GenericXdsConfig) Reset()

func (*ClientConfig_GenericXdsConfig) String

type ClientStatusRequest

type ClientStatusRequest struct {

	// Management server can use these match criteria to identify clients.
	// The match follows OR semantics.
	NodeMatchers []*v3.NodeMatcher `protobuf:"bytes,1,rep,name=node_matchers,json=nodeMatchers,proto3" json:"node_matchers,omitempty"`
	// The node making the csds request.
	Node *v31.Node `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"`
	// If true, the server will not include the resource contents in the response
	// (i.e., the generic_xds_configs.xds_config field will not be populated).
	// [#not-implemented-hide:]
	ExcludeResourceContents bool `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request for client status of clients identified by a list of NodeMatchers.

func (*ClientStatusRequest) Descriptor deprecated

func (*ClientStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use ClientStatusRequest.ProtoReflect.Descriptor instead.

func (*ClientStatusRequest) GetExcludeResourceContents

func (x *ClientStatusRequest) GetExcludeResourceContents() bool

func (*ClientStatusRequest) GetNode

func (x *ClientStatusRequest) GetNode() *v31.Node

func (*ClientStatusRequest) GetNodeMatchers

func (x *ClientStatusRequest) GetNodeMatchers() []*v3.NodeMatcher

func (*ClientStatusRequest) ProtoMessage

func (*ClientStatusRequest) ProtoMessage()

func (*ClientStatusRequest) ProtoReflect

func (x *ClientStatusRequest) ProtoReflect() protoreflect.Message

func (*ClientStatusRequest) Reset

func (x *ClientStatusRequest) Reset()

func (*ClientStatusRequest) String

func (x *ClientStatusRequest) String() string

type ClientStatusResponse

type ClientStatusResponse struct {

	// Client configs for the clients specified in the ClientStatusRequest.
	Config []*ClientConfig `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ClientStatusResponse) Descriptor deprecated

func (*ClientStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use ClientStatusResponse.ProtoReflect.Descriptor instead.

func (*ClientStatusResponse) GetConfig

func (x *ClientStatusResponse) GetConfig() []*ClientConfig

func (*ClientStatusResponse) ProtoMessage

func (*ClientStatusResponse) ProtoMessage()

func (*ClientStatusResponse) ProtoReflect

func (x *ClientStatusResponse) ProtoReflect() protoreflect.Message

func (*ClientStatusResponse) Reset

func (x *ClientStatusResponse) Reset()

func (*ClientStatusResponse) String

func (x *ClientStatusResponse) String() string

type ConfigStatus

type ConfigStatus int32

Status of a config from a management server view.

const (
	// Status info is not available/unknown.
	ConfigStatus_UNKNOWN ConfigStatus = 0
	// Management server has sent the config to client and received ACK.
	ConfigStatus_SYNCED ConfigStatus = 1
	// Config is not sent.
	ConfigStatus_NOT_SENT ConfigStatus = 2
	// Management server has sent the config to client but hasn’t received
	// ACK/NACK.
	ConfigStatus_STALE ConfigStatus = 3
	// Management server has sent the config to client but received NACK. The
	// attached config dump will be the latest config (the rejected one), since
	// it is the persisted version in the management server.
	ConfigStatus_ERROR ConfigStatus = 4
)

func (ConfigStatus) Descriptor

func (ConfigStatus) Enum

func (x ConfigStatus) Enum() *ConfigStatus

func (ConfigStatus) EnumDescriptor deprecated

func (ConfigStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use ConfigStatus.Descriptor instead.

func (ConfigStatus) Number

func (ConfigStatus) String

func (x ConfigStatus) String() string

func (ConfigStatus) Type

type PerXdsConfig

type PerXdsConfig struct {

	// Config status generated by management servers. Will not be present if the
	// CSDS server is an xDS client.
	Status ConfigStatus `protobuf:"varint,1,opt,name=status,proto3,enum=envoy.service.status.v3.ConfigStatus" json:"status,omitempty"`
	// Client config status is populated by xDS clients. Will not be present if
	// the CSDS server is an xDS server. No matter what the client config status
	// is, xDS clients should always dump the most recent accepted xDS config.
	//
	// .. attention::
	//
	//	This field is deprecated. Use :ref:`ClientResourceStatus
	//	<envoy_v3_api_enum_admin.v3.ClientResourceStatus>` for per-resource
	//	config status instead.
	//
	// Deprecated: Marked as deprecated in envoy/service/status/v3/csds.proto.
	ClientStatus ClientConfigStatus `` /* 146-byte string literal not displayed */
	// Types that are assignable to PerXdsConfig:
	//
	//	*PerXdsConfig_ListenerConfig
	//	*PerXdsConfig_ClusterConfig
	//	*PerXdsConfig_RouteConfig
	//	*PerXdsConfig_ScopedRouteConfig
	//	*PerXdsConfig_EndpointConfig
	PerXdsConfig isPerXdsConfig_PerXdsConfig `protobuf_oneof:"per_xds_config"`
	// contains filtered or unexported fields
}

Detailed config (per xDS) with status. [#next-free-field: 8]

func (*PerXdsConfig) Descriptor deprecated

func (*PerXdsConfig) Descriptor() ([]byte, []int)

Deprecated: Use PerXdsConfig.ProtoReflect.Descriptor instead.

func (*PerXdsConfig) GetClientStatus deprecated

func (x *PerXdsConfig) GetClientStatus() ClientConfigStatus

Deprecated: Marked as deprecated in envoy/service/status/v3/csds.proto.

func (*PerXdsConfig) GetClusterConfig

func (x *PerXdsConfig) GetClusterConfig() *v32.ClustersConfigDump

func (*PerXdsConfig) GetEndpointConfig

func (x *PerXdsConfig) GetEndpointConfig() *v32.EndpointsConfigDump

func (*PerXdsConfig) GetListenerConfig

func (x *PerXdsConfig) GetListenerConfig() *v32.ListenersConfigDump

func (*PerXdsConfig) GetPerXdsConfig

func (m *PerXdsConfig) GetPerXdsConfig() isPerXdsConfig_PerXdsConfig

func (*PerXdsConfig) GetRouteConfig

func (x *PerXdsConfig) GetRouteConfig() *v32.RoutesConfigDump

func (*PerXdsConfig) GetScopedRouteConfig

func (x *PerXdsConfig) GetScopedRouteConfig() *v32.ScopedRoutesConfigDump

func (*PerXdsConfig) GetStatus

func (x *PerXdsConfig) GetStatus() ConfigStatus

func (*PerXdsConfig) ProtoMessage

func (*PerXdsConfig) ProtoMessage()

func (*PerXdsConfig) ProtoReflect

func (x *PerXdsConfig) ProtoReflect() protoreflect.Message

func (*PerXdsConfig) Reset

func (x *PerXdsConfig) Reset()

func (*PerXdsConfig) String

func (x *PerXdsConfig) String() string

type PerXdsConfig_ClusterConfig

type PerXdsConfig_ClusterConfig struct {
	ClusterConfig *v32.ClustersConfigDump `protobuf:"bytes,3,opt,name=cluster_config,json=clusterConfig,proto3,oneof"`
}

type PerXdsConfig_EndpointConfig

type PerXdsConfig_EndpointConfig struct {
	EndpointConfig *v32.EndpointsConfigDump `protobuf:"bytes,6,opt,name=endpoint_config,json=endpointConfig,proto3,oneof"`
}

type PerXdsConfig_ListenerConfig

type PerXdsConfig_ListenerConfig struct {
	ListenerConfig *v32.ListenersConfigDump `protobuf:"bytes,2,opt,name=listener_config,json=listenerConfig,proto3,oneof"`
}

type PerXdsConfig_RouteConfig

type PerXdsConfig_RouteConfig struct {
	RouteConfig *v32.RoutesConfigDump `protobuf:"bytes,4,opt,name=route_config,json=routeConfig,proto3,oneof"`
}

type PerXdsConfig_ScopedRouteConfig

type PerXdsConfig_ScopedRouteConfig struct {
	ScopedRouteConfig *v32.ScopedRoutesConfigDump `protobuf:"bytes,5,opt,name=scoped_route_config,json=scopedRouteConfig,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL