v2

package
v0.24.7 Latest Latest
Warning

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

Go to latest
Published: Jul 11, 2022 License: Apache-2.0 Imports: 21 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_github_com_solo_io_solo_kit_api_external_envoy_api_v2_discovery_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DeltaDiscoveryRequest

type DeltaDiscoveryRequest struct {

	// The node making the request.
	Node *core.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// Type of the resource that is being requested, e.g.
	// "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment".
	TypeUrl string `protobuf:"bytes,2,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// DeltaDiscoveryRequests allow the client to add or remove individual
	// resources to the set of tracked resources in the context of a stream.
	// All resource names in the resource_names_subscribe list are added to the
	// set of tracked resources and all resource names in the resource_names_unsubscribe
	// list are removed from the set of tracked resources.
	//
	// *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or
	// resource_names_unsubscribe list simply means that no resources are to be
	// added or removed to the resource list.
	// *Like* state-of-the-world xDS, the server must send updates for all tracked
	// resources, but can also send updates for resources the client has not subscribed to.
	//
	// NOTE: the server must respond with all resources listed in resource_names_subscribe,
	// even if it believes the client has the most recent version of them. The reason:
	// the client may have dropped them, but then regained interest before it had a chance
	// to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd.
	//
	// These two fields can be set in any DeltaDiscoveryRequest, including ACKs
	// and initial_resource_versions.
	//
	// A list of Resource names to add to the list of tracked resources.
	ResourceNamesSubscribe []string `` /* 129-byte string literal not displayed */
	// A list of Resource names to remove from the list of tracked resources.
	ResourceNamesUnsubscribe []string `` /* 135-byte string literal not displayed */
	// Informs the server of the versions of the resources the xDS client knows of, to enable the
	// client to continue the same logical xDS session even in the face of gRPC stream reconnection.
	// It will not be populated: [1] in the very first stream of a session, since the client will
	// not yet have any resources,  [2] in any message after the first in a stream (for a given
	// type_url), since the server will already be correctly tracking the client's state.
	// (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
	// The map's keys are names of xDS resources known to the xDS client.
	// The map's values are opaque resource versions.
	InitialResourceVersions map[string]string `` /* 220-byte string literal not displayed */
	// When the DeltaDiscoveryRequest is a ACK or NACK message in response
	// to a previous DeltaDiscoveryResponse, the response_nonce must be the
	// nonce in the DeltaDiscoveryResponse.
	// Otherwise (unlike in DiscoveryRequest) response_nonce must be omitted.
	ResponseNonce string `protobuf:"bytes,6,opt,name=response_nonce,json=responseNonce,proto3" json:"response_nonce,omitempty"`
	// This is populated when the previous `DiscoveryResponse (envoy_api_msg_DiscoveryResponse)`
	// failed to update configuration. The *message* field in *error_details*
	// provides the Envoy internal exception related to the failure.
	ErrorDetail *status.Status `protobuf:"bytes,7,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"`
	// contains filtered or unexported fields
}

DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.

With Delta xDS, the DeltaDiscoveryResponses do not need to include a full snapshot of the tracked resources. Instead, DeltaDiscoveryResponses are a diff to the state of a xDS client. In Delta XDS there are per-resource versions, which allow tracking state at the resource granularity. An xDS Delta session is always in the context of a gRPC bidirectional stream. This allows the xDS server to keep track of the state of xDS clients connected to it.

In Delta xDS the nonce field is required and used to pair DeltaDiscoveryResponse to a DeltaDiscoveryRequest ACK or NACK. Optionally, a response message level system_version_info is present for debugging purposes only.

DeltaDiscoveryRequest plays two independent roles. Any DeltaDiscoveryRequest can be either or both of: [1] informing the server of what resources the client has gained/lost interest in (using resource_names_subscribe and resource_names_unsubscribe), or [2] (N)ACKing an earlier resource update from the server (using response_nonce, with presence of error_detail making it a NACK). Additionally, the first message (for a given type_url) of a reconnected gRPC stream has a third role: informing the server of the resources (and their versions) that the client already possesses, using the initial_resource_versions field.

As with state-of-the-world, when multiple resource types are multiplexed (ADS), all requests/acknowledgments/updates are logically walled off by type_url: a Cluster ACK exists in a completely separate world from a prior Route NACK. In particular, initial_resource_versions being sent at the "start" of every gRPC stream actually entails a message for each type_url, each with its own initial_resource_versions.

func (*DeltaDiscoveryRequest) Clone added in v0.20.5

func (m *DeltaDiscoveryRequest) Clone() proto.Message

Clone function

func (*DeltaDiscoveryRequest) Descriptor deprecated

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

Deprecated: Use DeltaDiscoveryRequest.ProtoReflect.Descriptor instead.

func (*DeltaDiscoveryRequest) Equal

func (m *DeltaDiscoveryRequest) Equal(that interface{}) bool

Equal function

func (*DeltaDiscoveryRequest) GetErrorDetail

func (x *DeltaDiscoveryRequest) GetErrorDetail() *status.Status

func (*DeltaDiscoveryRequest) GetInitialResourceVersions

func (x *DeltaDiscoveryRequest) GetInitialResourceVersions() map[string]string

func (*DeltaDiscoveryRequest) GetNode

func (x *DeltaDiscoveryRequest) GetNode() *core.Node

func (*DeltaDiscoveryRequest) GetResourceNamesSubscribe

func (x *DeltaDiscoveryRequest) GetResourceNamesSubscribe() []string

func (*DeltaDiscoveryRequest) GetResourceNamesUnsubscribe

func (x *DeltaDiscoveryRequest) GetResourceNamesUnsubscribe() []string

func (*DeltaDiscoveryRequest) GetResponseNonce

func (x *DeltaDiscoveryRequest) GetResponseNonce() string

func (*DeltaDiscoveryRequest) GetTypeUrl

func (x *DeltaDiscoveryRequest) GetTypeUrl() string

func (*DeltaDiscoveryRequest) Hash

func (m *DeltaDiscoveryRequest) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*DeltaDiscoveryRequest) ProtoMessage

func (*DeltaDiscoveryRequest) ProtoMessage()

func (*DeltaDiscoveryRequest) ProtoReflect added in v0.16.0

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

func (*DeltaDiscoveryRequest) Reset

func (x *DeltaDiscoveryRequest) Reset()

func (*DeltaDiscoveryRequest) String

func (x *DeltaDiscoveryRequest) String() string

type DeltaDiscoveryResponse

type DeltaDiscoveryResponse struct {

	// The version of the response data (used for debugging).
	SystemVersionInfo string `protobuf:"bytes,1,opt,name=system_version_info,json=systemVersionInfo,proto3" json:"system_version_info,omitempty"`
	// The response resources. These are typed resources, whose types must match
	// the type_url field.
	Resources []*Resource `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"`
	// Type URL for resources. Identifies the xDS API when muxing over ADS.
	// Must be consistent with the type_url in the Any within 'resources' if 'resources' is non-empty.
	TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// Resources names of resources that have be deleted and to be removed from the xDS Client.
	// Removed resources for missing resources can be ignored.
	RemovedResources []string `protobuf:"bytes,6,rep,name=removed_resources,json=removedResources,proto3" json:"removed_resources,omitempty"`
	// The nonce provides a way for DeltaDiscoveryRequests to uniquely
	// reference a DeltaDiscoveryResponse when (N)ACKing. The nonce is required.
	Nonce string `protobuf:"bytes,5,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// contains filtered or unexported fields
}

func (*DeltaDiscoveryResponse) Clone added in v0.20.5

Clone function

func (*DeltaDiscoveryResponse) Descriptor deprecated

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

Deprecated: Use DeltaDiscoveryResponse.ProtoReflect.Descriptor instead.

func (*DeltaDiscoveryResponse) Equal

func (m *DeltaDiscoveryResponse) Equal(that interface{}) bool

Equal function

func (*DeltaDiscoveryResponse) GetNonce

func (x *DeltaDiscoveryResponse) GetNonce() string

func (*DeltaDiscoveryResponse) GetRemovedResources

func (x *DeltaDiscoveryResponse) GetRemovedResources() []string

func (*DeltaDiscoveryResponse) GetResources

func (x *DeltaDiscoveryResponse) GetResources() []*Resource

func (*DeltaDiscoveryResponse) GetSystemVersionInfo

func (x *DeltaDiscoveryResponse) GetSystemVersionInfo() string

func (*DeltaDiscoveryResponse) GetTypeUrl

func (x *DeltaDiscoveryResponse) GetTypeUrl() string

func (*DeltaDiscoveryResponse) Hash

func (m *DeltaDiscoveryResponse) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*DeltaDiscoveryResponse) ProtoMessage

func (*DeltaDiscoveryResponse) ProtoMessage()

func (*DeltaDiscoveryResponse) ProtoReflect added in v0.16.0

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

func (*DeltaDiscoveryResponse) Reset

func (x *DeltaDiscoveryResponse) Reset()

func (*DeltaDiscoveryResponse) String

func (x *DeltaDiscoveryResponse) String() string

type DiscoveryRequest

type DiscoveryRequest struct {

	// The version_info provided in the request messages will be the version_info
	// received with the most recent successfully processed response or empty on
	// the first request. It is expected that no new request is sent after a
	// response is received until the Envoy instance is ready to ACK/NACK the new
	// configuration. ACK/NACK takes place by returning the new API config version
	// as applied or the previous API config version respectively. Each type_url
	// (see below) has an independent version associated with it.
	VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// The node making the request.
	Node *core.Node `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"`
	// List of resources to subscribe to, e.g. list of cluster names or a route
	// configuration name. If this is empty, all resources for the API are
	// returned. LDS/CDS may have empty resource_names, which will cause all
	// resources for the Envoy instance to be returned. The LDS and CDS responses
	// will then imply a number of resources that need to be fetched via EDS/RDS,
	// which will be explicitly enumerated in resource_names.
	ResourceNames []string `protobuf:"bytes,3,rep,name=resource_names,json=resourceNames,proto3" json:"resource_names,omitempty"`
	// Type of the resource that is being requested, e.g.
	// "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". This is implicit
	// in requests made via singleton xDS APIs such as CDS, LDS, etc. but is
	// required for ADS.
	TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// nonce corresponding to DiscoveryResponse being ACK/NACKed. See above
	// discussion on version_info and the DiscoveryResponse nonce comment. This
	// may be empty only if 1) this is a non-persistent-stream xDS such as HTTP,
	// or 2) the client has not yet accepted an update in this xDS stream (unlike
	// delta, where it is populated only for new explicit ACKs).
	ResponseNonce string `protobuf:"bytes,5,opt,name=response_nonce,json=responseNonce,proto3" json:"response_nonce,omitempty"`
	// This is populated when the previous `DiscoveryResponse (envoy_api_msg_DiscoveryResponse)`
	// failed to update configuration. The *message* field in *error_details* provides the Envoy
	// internal exception related to the failure. It is only intended for consumption during manual
	// debugging, the string provided is not guaranteed to be stable across Envoy versions.
	ErrorDetail *status.Status `protobuf:"bytes,6,opt,name=error_detail,json=errorDetail,proto3" json:"error_detail,omitempty"`
	// contains filtered or unexported fields
}

A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API.

func (*DiscoveryRequest) Clone added in v0.20.5

func (m *DiscoveryRequest) Clone() proto.Message

Clone function

func (*DiscoveryRequest) Descriptor deprecated

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

Deprecated: Use DiscoveryRequest.ProtoReflect.Descriptor instead.

func (*DiscoveryRequest) Equal

func (m *DiscoveryRequest) Equal(that interface{}) bool

Equal function

func (*DiscoveryRequest) GetErrorDetail

func (x *DiscoveryRequest) GetErrorDetail() *status.Status

func (*DiscoveryRequest) GetNode

func (x *DiscoveryRequest) GetNode() *core.Node

func (*DiscoveryRequest) GetResourceNames

func (x *DiscoveryRequest) GetResourceNames() []string

func (*DiscoveryRequest) GetResponseNonce

func (x *DiscoveryRequest) GetResponseNonce() string

func (*DiscoveryRequest) GetTypeUrl

func (x *DiscoveryRequest) GetTypeUrl() string

func (*DiscoveryRequest) GetVersionInfo

func (x *DiscoveryRequest) GetVersionInfo() string

func (*DiscoveryRequest) Hash

func (m *DiscoveryRequest) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*DiscoveryRequest) ProtoMessage

func (*DiscoveryRequest) ProtoMessage()

func (*DiscoveryRequest) ProtoReflect added in v0.16.0

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

func (*DiscoveryRequest) Reset

func (x *DiscoveryRequest) Reset()

func (*DiscoveryRequest) String

func (x *DiscoveryRequest) String() string

type DiscoveryResponse

type DiscoveryResponse struct {

	// The version of the response data.
	VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// The response resources. These resources are typed and depend on the API being called.
	Resources []*any.Any `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"`
	// [#not-implemented-hide:]
	// Canary is used to support two Envoy command line flags:
	//
	// * --terminate-on-canary-transition-failure. When set, Envoy is able to
	//   terminate if it detects that configuration is stuck at canary. Consider
	//   this example sequence of updates:
	//   - Management server applies a canary config successfully.
	//   - Management server rolls back to a production config.
	//   - Envoy rejects the new production config.
	//   Since there is no sensible way to continue receiving configuration
	//   updates, Envoy will then terminate and apply production config from a
	//   clean slate.
	// * --dry-run-canary. When set, a canary response will never be applied, only
	//   validated via a dry run.
	Canary bool `protobuf:"varint,3,opt,name=canary,proto3" json:"canary,omitempty"`
	// Type URL for resources. Identifies the xDS API when muxing over ADS.
	// Must be consistent with the type_url in the 'resources' repeated Any (if non-empty).
	TypeUrl string `protobuf:"bytes,4,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// For gRPC based subscriptions, the nonce provides a way to explicitly ack a
	// specific DiscoveryResponse in a following DiscoveryRequest. Additional
	// messages may have been sent by Envoy to the management server for the
	// previous version on the stream prior to this DiscoveryResponse, that were
	// unprocessed at response send time. The nonce allows the management server
	// to ignore any further DiscoveryRequests for the previous version until a
	// DiscoveryRequest bearing the nonce. The nonce is optional and is not
	// required for non-stream based xDS implementations.
	Nonce string `protobuf:"bytes,5,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// [#not-implemented-hide:]
	// The control plane instance that sent the response.
	ControlPlane *core.ControlPlane `protobuf:"bytes,6,opt,name=control_plane,json=controlPlane,proto3" json:"control_plane,omitempty"`
	// contains filtered or unexported fields
}

func (*DiscoveryResponse) Clone added in v0.20.5

func (m *DiscoveryResponse) Clone() proto.Message

Clone function

func (*DiscoveryResponse) Descriptor deprecated

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

Deprecated: Use DiscoveryResponse.ProtoReflect.Descriptor instead.

func (*DiscoveryResponse) Equal

func (m *DiscoveryResponse) Equal(that interface{}) bool

Equal function

func (*DiscoveryResponse) GetCanary

func (x *DiscoveryResponse) GetCanary() bool

func (*DiscoveryResponse) GetControlPlane

func (x *DiscoveryResponse) GetControlPlane() *core.ControlPlane

func (*DiscoveryResponse) GetNonce

func (x *DiscoveryResponse) GetNonce() string

func (*DiscoveryResponse) GetResources

func (x *DiscoveryResponse) GetResources() []*any.Any

func (*DiscoveryResponse) GetTypeUrl

func (x *DiscoveryResponse) GetTypeUrl() string

func (*DiscoveryResponse) GetVersionInfo

func (x *DiscoveryResponse) GetVersionInfo() string

func (*DiscoveryResponse) Hash

func (m *DiscoveryResponse) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*DiscoveryResponse) ProtoMessage

func (*DiscoveryResponse) ProtoMessage()

func (*DiscoveryResponse) ProtoReflect added in v0.16.0

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

func (*DiscoveryResponse) Reset

func (x *DiscoveryResponse) Reset()

func (*DiscoveryResponse) String

func (x *DiscoveryResponse) String() string

type Resource

type Resource struct {

	// The resource's name, to distinguish it from others of the same type of resource.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// [#not-implemented-hide:]
	// The aliases are a list of other names that this resource can go by.
	Aliases []string `protobuf:"bytes,4,rep,name=aliases,proto3" json:"aliases,omitempty"`
	// The resource level version. It allows xDS to track the state of individual
	// resources.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// The resource being tracked.
	Resource *any.Any `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource) Clone added in v0.20.5

func (m *Resource) Clone() proto.Message

Clone function

func (*Resource) Descriptor deprecated

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) Equal

func (m *Resource) Equal(that interface{}) bool

Equal function

func (*Resource) GetAliases

func (x *Resource) GetAliases() []string

func (*Resource) GetName

func (x *Resource) GetName() string

func (*Resource) GetResource

func (x *Resource) GetResource() *any.Any

func (*Resource) GetVersion

func (x *Resource) GetVersion() string

func (*Resource) Hash

func (m *Resource) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*Resource) ProtoMessage

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect added in v0.16.0

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

func (*Resource) Reset

func (x *Resource) Reset()

func (*Resource) String

func (x *Resource) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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