admin

Documentation

Overview

Package admin implements the northbound administrative gRPC service for the configuration subsystem.

Index

• type Server
  • func (s Server) CompactChanges(ctx context.Context, request *admin.CompactChangesRequest) (*admin.CompactChangesResponse, error)
  • func (s Server) GetConfiguration(ctx context.Context, req *admin.GetConfigurationRequest) (*admin.GetConfigurationResponse, error)
  • func (s Server) GetTransaction(ctx context.Context, req *admin.GetTransactionRequest) (*admin.GetTransactionResponse, error)
  • func (s Server) ListConfigurations(req *admin.ListConfigurationsRequest, ...) error
  • func (s Server) ListRegisteredModels(r *admin.ListModelsRequest, ...) error
  • func (s Server) ListSnapshots(r *admin.ListSnapshotsRequest, ...) error
  • func (s Server) ListTransactions(req *admin.ListTransactionsRequest, ...) error
  • func (s Server) RollbackTransaction(ctx context.Context, req *admin.RollbackRequest) (*admin.RollbackResponse, error)
  • func (s Server) UploadRegisterModel(stream admin.ConfigAdminService_UploadRegisterModelServer) error
  • func (s Server) WatchConfigurations(req *admin.WatchConfigurationsRequest, ...) error
  • func (s Server) WatchTransactions(req *admin.WatchTransactionsRequest, ...) error
• type Service
  • func NewService(transactionsStore transaction.Store, configurationsStore configuration.Store, ...) Service
  • func (s Service) Register(r *grpc.Server)

Types

type Server

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

Server implements the gRPC service for administrative facilities.

func (Server) CompactChanges

func (s Server) CompactChanges(ctx context.Context, request *admin.CompactChangesRequest) (*admin.CompactChangesResponse, error)

CompactChanges takes a snapshot of all devices

func (Server) GetConfiguration

func (s Server) GetConfiguration(ctx context.Context, req *admin.GetConfigurationRequest) (*admin.GetConfigurationResponse, error)

GetConfiguration returns response with the requested configuration

func (Server) GetTransaction

func (s Server) GetTransaction(ctx context.Context, req *admin.GetTransactionRequest) (*admin.GetTransactionResponse, error)

GetTransaction returns response with the requested transaction

func (Server) ListConfigurations

func (s Server) ListConfigurations(req *admin.ListConfigurationsRequest, stream admin.ConfigurationService_ListConfigurationsServer) error

ListConfigurations provides stream listing all configurations

func (Server) ListRegisteredModels

func (s Server) ListRegisteredModels(r *admin.ListModelsRequest, stream admin.ConfigAdminService_ListRegisteredModelsServer) error

ListRegisteredModels lists the registered models..

func (Server) ListSnapshots

func (s Server) ListSnapshots(r *admin.ListSnapshotsRequest, stream admin.ConfigAdminService_ListSnapshotsServer) error

ListSnapshots lists snapshots for all devices

func (Server) ListTransactions

func (s Server) ListTransactions(req *admin.ListTransactionsRequest, stream admin.TransactionService_ListTransactionsServer) error

ListTransactions provides stream listing all transactions

func (Server) RollbackTransaction

func (s Server) RollbackTransaction(ctx context.Context, req *admin.RollbackRequest) (*admin.RollbackResponse, error)

RollbackTransaction rolls back configuration change transaction with the specified index.

func (Server) UploadRegisterModel

func (s Server) UploadRegisterModel(stream admin.ConfigAdminService_UploadRegisterModelServer) error

UploadRegisterModel uploads and registers a new model plugin. Deprecated: models should only be loaded at startup

func (Server) WatchConfigurations

func (s Server) WatchConfigurations(req *admin.WatchConfigurationsRequest, stream admin.ConfigurationService_WatchConfigurationsServer) error

WatchConfigurations provides stream with events representing configuration changes

func (Server) WatchTransactions

func (s Server) WatchTransactions(req *admin.WatchTransactionsRequest, stream admin.TransactionService_WatchTransactionsServer) error

WatchTransactions provides stream with events representing transactions changes

type Service

type Service struct {
	northbound.Service
	// contains filtered or unexported fields
}

Service is a Service implementation for administration.

func NewService

func NewService(transactionsStore transaction.Store, configurationsStore configuration.Store, pluginRegistry pluginregistry.PluginRegistry) Service

NewService allocates a Service struct with the given parameters

func (Service) Register

func (s Service) Register(r *grpc.Server)

Register registers the Service with the gRPC server.