configurator

package
v3.3.0-alpha Latest Latest
Warning

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

 Go to latest Published: Oct 30, 2020 License: Apache-2.0 Imports: 12 Imported by: 29

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_ligato_configurator_configurator_proto protoreflect.FileDescriptor
View Source 
var File_ligato_configurator_statspoller_proto protoreflect.FileDescriptor

Functions

func RegisterConfiguratorServiceServer 

func RegisterConfiguratorServiceServer(s *grpc.Server, srv ConfiguratorServiceServer)

func RegisterStatsPollerServiceServer 

func RegisterStatsPollerServiceServer(s *grpc.Server, srv StatsPollerServiceServer)

Types

type Config 

type Config struct {
	VppConfig      *vpp.ConfigData      `protobuf:"bytes,1,opt,name=vpp_config,json=vppConfig,proto3" json:"vpp_config,omitempty"`
	LinuxConfig    *linux.ConfigData    `protobuf:"bytes,2,opt,name=linux_config,json=linuxConfig,proto3" json:"linux_config,omitempty"`
	NetallocConfig *netalloc.ConfigData `protobuf:"bytes,3,opt,name=netalloc_config,json=netallocConfig,proto3" json:"netalloc_config,omitempty"`
	// contains filtered or unexported fields
}

Config describes all supported configs into a single config message.

func (*Config) Descriptor deprecated 

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

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetLinuxConfig 

func (x *Config) GetLinuxConfig() *linux.ConfigData

func (*Config) GetNetallocConfig 

func (x *Config) GetNetallocConfig() *netalloc.ConfigData

func (*Config) GetVppConfig 

func (x *Config) GetVppConfig() *vpp.ConfigData

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) ProtoReflect added in v3.2.0 

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

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) String 

func (x *Config) String() string

type ConfiguratorServiceClient 

type ConfiguratorServiceClient interface {
	// Get is used for listing desired config.
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Update is used for updating desired config.
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*UpdateResponse, error)
	// Delete is used for deleting desired config.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// Dump is used for dumping running config.
	Dump(ctx context.Context, in *DumpRequest, opts ...grpc.CallOption) (*DumpResponse, error)
	// Notify is used for subscribing to notifications.
	Notify(ctx context.Context, in *NotifyRequest, opts ...grpc.CallOption) (ConfiguratorService_NotifyClient, error)
}

ConfiguratorServiceClient is the client API for ConfiguratorService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConfiguratorServiceClient 

func NewConfiguratorServiceClient(cc grpc.ClientConnInterface) ConfiguratorServiceClient

type ConfiguratorServiceServer 

type ConfiguratorServiceServer interface {
	// Get is used for listing desired config.
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// Update is used for updating desired config.
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)
	// Delete is used for deleting desired config.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// Dump is used for dumping running config.
	Dump(context.Context, *DumpRequest) (*DumpResponse, error)
	// Notify is used for subscribing to notifications.
	Notify(*NotifyRequest, ConfiguratorService_NotifyServer) error
	// contains filtered or unexported methods
}

ConfiguratorServiceServer is the server API for ConfiguratorService service. All implementations must embed UnimplementedConfiguratorServiceServer for forward compatibility

type ConfiguratorService_NotifyClient 

type ConfiguratorService_NotifyClient interface {
	Recv() (*NotifyResponse, error)
	grpc.ClientStream
}

type ConfiguratorService_NotifyServer 

type ConfiguratorService_NotifyServer interface {
	Send(*NotifyResponse) error
	grpc.ServerStream
}

type DeleteRequest 

type DeleteRequest struct {

	// Delete is a config data to be deleted.
	Delete *Config `protobuf:"bytes,1,opt,name=delete,proto3" json:"delete,omitempty"`
	// WaitDone option can be used to block until either
	// config delete is done (non-pending) or request times out.
	//
	// NOTE: WaitDone is intended to be used for config updates
	// that depend on some event from dataplane to fully configure.
	// Using this with incomplete config updates will require
	// another update request to unblock.
	WaitDone bool `protobuf:"varint,3,opt,name=wait_done,json=waitDone,proto3" json:"wait_done,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetDelete 

func (x *DeleteRequest) GetDelete() *Config

func (*DeleteRequest) GetWaitDone added in v3.2.0 

func (x *DeleteRequest) GetWaitDone() bool

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect added in v3.2.0 

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

func (*DeleteRequest) Reset 

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String 

func (x *DeleteRequest) String() string

type DeleteResponse 

type DeleteResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteResponse) Descriptor deprecated 

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect added in v3.2.0 

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

func (*DeleteResponse) Reset 

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String 

func (x *DeleteResponse) String() string

type DumpRequest 

type DumpRequest struct {
	// contains filtered or unexported fields
}

func (*DumpRequest) Descriptor deprecated 

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

Deprecated: Use DumpRequest.ProtoReflect.Descriptor instead.

func (*DumpRequest) ProtoMessage 

func (*DumpRequest) ProtoMessage()

func (*DumpRequest) ProtoReflect added in v3.2.0 

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

func (*DumpRequest) Reset 

func (x *DumpRequest) Reset()

func (*DumpRequest) String 

func (x *DumpRequest) String() string

type DumpResponse 

type DumpResponse struct {

	// Dump describes running config dumped from southbound.
	Dump *Config `protobuf:"bytes,1,opt,name=dump,proto3" json:"dump,omitempty"`
	// contains filtered or unexported fields
}

func (*DumpResponse) Descriptor deprecated 

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

Deprecated: Use DumpResponse.ProtoReflect.Descriptor instead.

func (*DumpResponse) GetDump 

func (x *DumpResponse) GetDump() *Config

func (*DumpResponse) ProtoMessage 

func (*DumpResponse) ProtoMessage()

func (*DumpResponse) ProtoReflect added in v3.2.0 

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

func (*DumpResponse) Reset 

func (x *DumpResponse) Reset()

func (*DumpResponse) String 

func (x *DumpResponse) String() string

type GetRequest 

type GetRequest struct {
	// contains filtered or unexported fields
}

func (*GetRequest) Descriptor deprecated 

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

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) ProtoMessage 

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect added in v3.2.0 

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

func (*GetRequest) Reset 

func (x *GetRequest) Reset()

func (*GetRequest) String 

func (x *GetRequest) String() string

type GetResponse 

type GetResponse struct {

	// Config describes desired config retrieved from agent.
	Config *Config `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*GetResponse) Descriptor deprecated 

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

Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.

func (*GetResponse) GetConfig 

func (x *GetResponse) GetConfig() *Config

func (*GetResponse) ProtoMessage 

func (*GetResponse) ProtoMessage()

func (*GetResponse) ProtoReflect added in v3.2.0 

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

func (*GetResponse) Reset 

func (x *GetResponse) Reset()

func (*GetResponse) String 

func (x *GetResponse) String() string

type Notification 

type Notification struct {

	// Types that are assignable to Notification:
	//	*Notification_VppNotification
	//	*Notification_LinuxNotification
	Notification isNotification_Notification `protobuf_oneof:"notification"`
	// contains filtered or unexported fields
}

Notification describes all known notifications into a single message.

func (*Notification) Descriptor deprecated 

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

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

func (*Notification) GetLinuxNotification 

func (x *Notification) GetLinuxNotification() *linux.Notification

func (*Notification) GetNotification 

func (m *Notification) GetNotification() isNotification_Notification

func (*Notification) GetVppNotification 

func (x *Notification) GetVppNotification() *vpp.Notification

func (*Notification) ProtoMessage 

func (*Notification) ProtoMessage()

func (*Notification) ProtoReflect added in v3.2.0 

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

func (*Notification) Reset 

func (x *Notification) Reset()

func (*Notification) String 

func (x *Notification) String() string

type Notification_LinuxNotification 

type Notification_LinuxNotification struct {
	LinuxNotification *linux.Notification `protobuf:"bytes,2,opt,name=linux_notification,json=linuxNotification,proto3,oneof"`
}

type Notification_VppNotification 

type Notification_VppNotification struct {
	VppNotification *vpp.Notification `protobuf:"bytes,1,opt,name=vpp_notification,json=vppNotification,proto3,oneof"`
}

type NotifyRequest 

type NotifyRequest struct {
	Idx uint32 `protobuf:"varint,1,opt,name=idx,proto3" json:"idx,omitempty"`
	// contains filtered or unexported fields
}

func (*NotifyRequest) Descriptor deprecated 

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

Deprecated: Use NotifyRequest.ProtoReflect.Descriptor instead.

func (*NotifyRequest) GetIdx 

func (x *NotifyRequest) GetIdx() uint32

func (*NotifyRequest) ProtoMessage 

func (*NotifyRequest) ProtoMessage()

func (*NotifyRequest) ProtoReflect added in v3.2.0 

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

func (*NotifyRequest) Reset 

func (x *NotifyRequest) Reset()

func (*NotifyRequest) String 

func (x *NotifyRequest) String() string

type NotifyResponse 

type NotifyResponse struct {

	// Index of following notification
	NextIdx uint32 `protobuf:"varint,1,opt,name=next_idx,json=nextIdx,proto3" json:"next_idx,omitempty"`
	// Notification data
	Notification *Notification `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
	// contains filtered or unexported fields
}

func (*NotifyResponse) Descriptor deprecated 

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

Deprecated: Use NotifyResponse.ProtoReflect.Descriptor instead.

func (*NotifyResponse) GetNextIdx 

func (x *NotifyResponse) GetNextIdx() uint32

func (*NotifyResponse) GetNotification 

func (x *NotifyResponse) GetNotification() *Notification

func (*NotifyResponse) ProtoMessage 

func (*NotifyResponse) ProtoMessage()

func (*NotifyResponse) ProtoReflect added in v3.2.0 

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

func (*NotifyResponse) Reset 

func (x *NotifyResponse) Reset()

func (*NotifyResponse) String 

func (x *NotifyResponse) String() string

type PollStatsRequest 

type PollStatsRequest struct {

	// PeriodSec defines polling period (in seconds). Set to zero to
	// return just single polling.
	PeriodSec uint32 `protobuf:"varint,1,opt,name=period_sec,json=periodSec,proto3" json:"period_sec,omitempty"`
	// NumPolls defines number of pollings. Set to non-zero number to
	// stop the polling after specified number of pollings is reached.
	NumPolls uint32 `protobuf:"varint,2,opt,name=num_polls,json=numPolls,proto3" json:"num_polls,omitempty"`
	// contains filtered or unexported fields
}

func (*PollStatsRequest) Descriptor deprecated 

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

Deprecated: Use PollStatsRequest.ProtoReflect.Descriptor instead.

func (*PollStatsRequest) GetNumPolls added in v3.1.0 

func (x *PollStatsRequest) GetNumPolls() uint32

func (*PollStatsRequest) GetPeriodSec 

func (x *PollStatsRequest) GetPeriodSec() uint32

func (*PollStatsRequest) ProtoMessage 

func (*PollStatsRequest) ProtoMessage()

func (*PollStatsRequest) ProtoReflect added in v3.2.0 

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

func (*PollStatsRequest) Reset 

func (x *PollStatsRequest) Reset()

func (*PollStatsRequest) String 

func (x *PollStatsRequest) String() string

type PollStatsResponse 

type PollStatsResponse struct {

	// PollSeq defines the sequence number of this polling response.
	PollSeq uint32 `protobuf:"varint,1,opt,name=poll_seq,json=pollSeq,proto3" json:"poll_seq,omitempty"`
	// Stats contains polled stats data.
	Stats *Stats `protobuf:"bytes,2,opt,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

func (*PollStatsResponse) Descriptor deprecated 

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

Deprecated: Use PollStatsResponse.ProtoReflect.Descriptor instead.

func (*PollStatsResponse) GetPollSeq 

func (x *PollStatsResponse) GetPollSeq() uint32

func (*PollStatsResponse) GetStats 

func (x *PollStatsResponse) GetStats() *Stats

func (*PollStatsResponse) ProtoMessage 

func (*PollStatsResponse) ProtoMessage()

func (*PollStatsResponse) ProtoReflect added in v3.2.0 

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

func (*PollStatsResponse) Reset 

func (x *PollStatsResponse) Reset()

func (*PollStatsResponse) String 

func (x *PollStatsResponse) String() string

type Stats 

type Stats struct {

	// Types that are assignable to Stats:
	//	*Stats_VppStats
	Stats isStats_Stats `protobuf_oneof:"stats"`
	// contains filtered or unexported fields
}

Stats defines stats data returned by StatsPollerService.

func (*Stats) Descriptor deprecated 

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

Deprecated: Use Stats.ProtoReflect.Descriptor instead.

func (*Stats) GetStats 

func (m *Stats) GetStats() isStats_Stats

func (*Stats) GetVppStats 

func (x *Stats) GetVppStats() *vpp.Stats

func (*Stats) ProtoMessage 

func (*Stats) ProtoMessage()

func (*Stats) ProtoReflect added in v3.2.0 

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

func (*Stats) Reset 

func (x *Stats) Reset()

func (*Stats) String 

func (x *Stats) String() string

type StatsPollerServiceClient 

type StatsPollerServiceClient interface {
	// PollStats is used for polling stats with specific period and number of pollings.
	PollStats(ctx context.Context, in *PollStatsRequest, opts ...grpc.CallOption) (StatsPollerService_PollStatsClient, error)
}

StatsPollerServiceClient is the client API for StatsPollerService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewStatsPollerServiceClient 

func NewStatsPollerServiceClient(cc grpc.ClientConnInterface) StatsPollerServiceClient

type StatsPollerServiceServer 

type StatsPollerServiceServer interface {
	// PollStats is used for polling stats with specific period and number of pollings.
	PollStats(*PollStatsRequest, StatsPollerService_PollStatsServer) error
	// contains filtered or unexported methods
}

StatsPollerServiceServer is the server API for StatsPollerService service. All implementations must embed UnimplementedStatsPollerServiceServer for forward compatibility

type StatsPollerService_PollStatsClient 

type StatsPollerService_PollStatsClient interface {
	Recv() (*PollStatsResponse, error)
	grpc.ClientStream
}

type StatsPollerService_PollStatsServer 

type StatsPollerService_PollStatsServer interface {
	Send(*PollStatsResponse) error
	grpc.ServerStream
}

type Stats_VppStats 

type Stats_VppStats struct {
	VppStats *vpp.Stats `protobuf:"bytes,1,opt,name=vpp_stats,json=vppStats,proto3,oneof"`
}

type UnimplementedConfiguratorServiceServer 

type UnimplementedConfiguratorServiceServer struct {
}

UnimplementedConfiguratorServiceServer must be embedded to have forward compatible implementations.

func (*UnimplementedConfiguratorServiceServer) Delete 

func (*UnimplementedConfiguratorServiceServer) Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)

func (*UnimplementedConfiguratorServiceServer) Dump 

func (*UnimplementedConfiguratorServiceServer) Dump(context.Context, *DumpRequest) (*DumpResponse, error)

func (*UnimplementedConfiguratorServiceServer) Get 

func (*UnimplementedConfiguratorServiceServer) Get(context.Context, *GetRequest) (*GetResponse, error)

func (*UnimplementedConfiguratorServiceServer) Notify 

func (*UnimplementedConfiguratorServiceServer) Notify(*NotifyRequest, ConfiguratorService_NotifyServer) error

func (*UnimplementedConfiguratorServiceServer) Update 

func (*UnimplementedConfiguratorServiceServer) Update(context.Context, *UpdateRequest) (*UpdateResponse, error)

type UnimplementedStatsPollerServiceServer 

type UnimplementedStatsPollerServiceServer struct {
}

UnimplementedStatsPollerServiceServer must be embedded to have forward compatible implementations.

func (*UnimplementedStatsPollerServiceServer) PollStats 

func (*UnimplementedStatsPollerServiceServer) PollStats(*PollStatsRequest, StatsPollerService_PollStatsServer) error

type UpdateRequest 

type UpdateRequest struct {

	// Update is a config data to be updated.
	Update *Config `protobuf:"bytes,1,opt,name=update,proto3" json:"update,omitempty"`
	// FullResync option can be used to overwrite
	// all existing config with config update.
	//
	// NOTE: Using FullResync with empty config update will
	// remove all existing config.
	FullResync bool `protobuf:"varint,2,opt,name=full_resync,json=fullResync,proto3" json:"full_resync,omitempty"`
	// WaitDone option can be used to block until either
	// config update is done (non-pending) or request times out.
	//
	// NOTE: WaitDone is intended to be used for config updates
	// that depend on some event from dataplane to fully configure.
	// Using this with incomplete config updates will require
	// another update request to unblock.
	WaitDone bool `protobuf:"varint,3,opt,name=wait_done,json=waitDone,proto3" json:"wait_done,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateRequest) Descriptor deprecated 

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

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetFullResync 

func (x *UpdateRequest) GetFullResync() bool

func (*UpdateRequest) GetUpdate 

func (x *UpdateRequest) GetUpdate() *Config

func (*UpdateRequest) GetWaitDone added in v3.2.0 

func (x *UpdateRequest) GetWaitDone() bool

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect added in v3.2.0 

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

func (*UpdateRequest) Reset 

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String 

func (x *UpdateRequest) String() string

type UpdateResponse 

type UpdateResponse struct {
	// contains filtered or unexported fields
}

func (*UpdateResponse) Descriptor deprecated 

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

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) ProtoMessage 

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect added in v3.2.0 

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

func (*UpdateResponse) Reset 

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String 

func (x *UpdateResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.