modserver

package
v14.3.3 Latest Latest
Warning

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

 Go to latest Published: Sep 21, 2021 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// RoutingHopPrefix is a metadata key prefix that is used for metadata keys that should be consumed by
	// the gateway kas instances and not passed along to agentk.
	RoutingHopPrefix = "kas-hop-"
	// RoutingAgentIdMetadataKey is used to pass destination agent id in request metadata
	// from the routing kas instance, that is handling the incoming request, to the gateway kas instance,
	// that is forwarding the request to an agentk.
	RoutingAgentIdMetadataKey = RoutingHopPrefix + "routing-agent-id"

	// CorrelationIdSentryField is the name of the Sentry field for correlation ID.
	// LabKit uses 'gitlab.CorrelationID', but GitLab and Gitaly use 'correlation_id'.
	CorrelationIdSentryField = "correlation_id"
	GrpcServiceSentryField   = "grpc.service"
	GrpcMethodSentryField    = "grpc.method"
)

Variables

View Source 
var File_internal_module_modserver_modserver_proto protoreflect.FileDescriptor

Functions

func InjectAgentRpcApi added in v14.3.0 

func InjectAgentRpcApi(ctx context.Context, rpcApi AgentRpcApi) context.Context

func InjectRpcApi added in v14.2.0 

func InjectRpcApi(ctx context.Context, rpcApi RpcApi) context.Context

func RoutingMetadata 

func RoutingMetadata(agentId int64) metadata.MD

func StreamAgentRpcApiInterceptor added in v14.3.0 

func StreamAgentRpcApiInterceptor(factory AgentRpcApiFactory) grpc.StreamServerInterceptor

StreamAgentRpcApiInterceptor returns a new stream server interceptor that augments connection context with a AgentRpcApi.

func StreamRpcApiInterceptor added in v14.2.0 

func StreamRpcApiInterceptor(factory RpcApiFactory) grpc.StreamServerInterceptor

StreamRpcApiInterceptor returns a new stream server interceptor that augments connection context with a RpcApi.

func UnaryAgentRpcApiInterceptor added in v14.3.0 

func UnaryAgentRpcApiInterceptor(factory AgentRpcApiFactory) grpc.UnaryServerInterceptor

UnaryAgentRpcApiInterceptor returns a new unary server interceptor that augments connection context with a AgentRpcApi.

func UnaryRpcApiInterceptor added in v14.2.0 

func UnaryRpcApiInterceptor(factory RpcApiFactory) grpc.UnaryServerInterceptor

UnaryRpcApiInterceptor returns a new unary server interceptor that augments connection context with a RpcApi.

Types

type AgentRpcApi added in v14.3.0 

type AgentRpcApi interface {
	modshared.RpcApi
	// AgentToken returns the token of an agent making the RPC.
	AgentToken() api.AgentToken
	// AgentInfo returns information about the agent making the RPC.
	// Returns a gRPC-compatible error.
	// Returns an error with the Unavailable code if there was a retriable error.
	// If there was an error, it takes care of tracking it via HandleProcessingError().
	AgentInfo(ctx context.Context, log *zap.Logger) (*api.AgentInfo, error)
}

AgentRpcApi provides the API for the module's gRPC handlers to use. It should be used only by modules, that handle requests from agents.

func AgentRpcApiFromContext added in v14.3.0 

func AgentRpcApiFromContext(ctx context.Context) AgentRpcApi

type AgentRpcApiFactory added in v14.3.0 

type AgentRpcApiFactory func(ctx context.Context, fullMethodName string) (AgentRpcApi, error)

type Api added in v14.2.0 

type Api interface {
	modshared.Api
}

Api provides the API for the module to use.

type ApplyDefaults 

type ApplyDefaults func(*kascfg.ConfigurationFile)

ApplyDefaults is a signature of a public function, exposed by modules to perform defaulting. The function should be called ApplyDefaults.

type Config 

type Config struct {
	// Log can be used for logging from the module.
	// It should not be used for logging from gRPC Api methods. Use grpctool.LoggerFromContext(ctx) instead.
	Log          *zap.Logger
	Api          Api
	Config       *kascfg.ConfigurationFile
	GitLabClient gitlab.ClientInterface
	// Registerer allows to register metrics.
	// Metrics should be registered in Run and unregistered before Run returns.
	Registerer   prometheus.Registerer
	UsageTracker usage_metrics.UsageTrackerRegisterer
	// AgentServer is the gRPC server agentk is talking to.
	// This can be used to add endpoints in Factory.New.
	// Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext).
	AgentServer *grpc.Server
	// ApiServer is the gRPC server GitLab is talking to.
	// This can be used to add endpoints in Factory.New.
	// Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext).
	ApiServer *grpc.Server
	// RegisterAgentApi allows to register a gRPC Api endpoint that kas proxies to agentk.
	RegisterAgentApi func(*grpc.ServiceDesc)
	// AgentConn is a gRPC connection that can be used to send requests to an agentk instance.
	// Agent Id must be specified in the request metadata in RoutingAgentIdMetadataKey field.
	AgentConn grpc.ClientConnInterface
	Gitaly    gitaly.PoolInterface
	// KasName is a string "gitlab-kas". Can be used as a user agent, server name, service name, etc.
	KasName string
	// Version is gitlab-kas version.
	Version string
	// CommitId is gitlab-kas commit sha.
	CommitId string
}

Config holds configuration for a Module.

type Factory 

type Factory interface {
	// New creates a new instance of a Module.
	New(*Config) (Module, error)
	// Name returns module's name.
	Name() string
}

type GitalyAddress 

type GitalyAddress struct {
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	Token   string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*GitalyAddress) Descriptor deprecated 

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

Deprecated: Use GitalyAddress.ProtoReflect.Descriptor instead.

func (*GitalyAddress) GetAddress 

func (x *GitalyAddress) GetAddress() string

func (*GitalyAddress) GetToken 

func (x *GitalyAddress) GetToken() string

func (*GitalyAddress) ProtoMessage 

func (*GitalyAddress) ProtoMessage()

func (*GitalyAddress) ProtoReflect 

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

func (*GitalyAddress) Reset 

func (x *GitalyAddress) Reset()

func (*GitalyAddress) String 

func (x *GitalyAddress) String() string

type Module 

type Module interface {
	// Run starts the module.
	// Run can block until the context is canceled or exit with nil if there is nothing to do.
	Run(context.Context) error
	// Name returns module's name.
	Name() string
}

type Repository 

type Repository struct {
	StorageName                   string   `protobuf:"bytes,2,opt,name=storage_name,json=storageName,proto3" json:"storage_name,omitempty"`
	RelativePath                  string   `protobuf:"bytes,3,opt,name=relative_path,json=relativePath,proto3" json:"relative_path,omitempty"`
	GitObjectDirectory            string   `protobuf:"bytes,4,opt,name=git_object_directory,json=gitObjectDirectory,proto3" json:"git_object_directory,omitempty"`
	GitAlternateObjectDirectories []string `` /* 152-byte string literal not displayed */
	GlRepository                  string   `protobuf:"bytes,6,opt,name=gl_repository,json=glRepository,proto3" json:"gl_repository,omitempty"`
	GlProjectPath                 string   `protobuf:"bytes,8,opt,name=gl_project_path,json=glProjectPath,proto3" json:"gl_project_path,omitempty"`
	// contains filtered or unexported fields
}

func (*Repository) Descriptor deprecated 

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

Deprecated: Use Repository.ProtoReflect.Descriptor instead.

func (*Repository) GetGitAlternateObjectDirectories 

func (x *Repository) GetGitAlternateObjectDirectories() []string

func (*Repository) GetGitObjectDirectory 

func (x *Repository) GetGitObjectDirectory() string

func (*Repository) GetGlProjectPath 

func (x *Repository) GetGlProjectPath() string

func (*Repository) GetGlRepository 

func (x *Repository) GetGlRepository() string

func (*Repository) GetRelativePath 

func (x *Repository) GetRelativePath() string

func (*Repository) GetStorageName 

func (x *Repository) GetStorageName() string

func (*Repository) ProtoMessage 

func (*Repository) ProtoMessage()

func (*Repository) ProtoReflect 

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

func (*Repository) Reset 

func (x *Repository) Reset()

func (*Repository) String 

func (x *Repository) String() string

type RpcApi added in v14.2.0 

type RpcApi interface {
	modshared.RpcApi
}

RpcApi provides the API for the module's gRPC handlers to use.

func RpcApiFromContext added in v14.2.0 

func RpcApiFromContext(ctx context.Context) RpcApi

type RpcApiFactory added in v14.2.0 

type RpcApiFactory func(ctx context.Context, fullMethodName string) RpcApi

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.