services

package
v0.0.68 Latest Latest
Warning

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

 Go to latest Published: Dec 26, 2023 License: MIT Imports: 28 Imported by: 6

Documentation

Index

Constants

View Source 
const (
	UnknownState       = runtimev1.InformationResponse_UNKNOWN
	InitState          = runtimev1.InformationResponse_INIT
	StartedState       = runtimev1.InformationResponse_STARTED
	RestartWantedState = runtimev1.InformationResponse_RESTART_WANTED
	SyncWantedState    = runtimev1.InformationResponse_SYNC_WANTED
	StoppedState       = runtimev1.InformationResponse_STOPPED
	ErrorState         = runtimev1.InformationResponse_ERROR
)

Variables

This section is empty.

Functions

func ConfigureError added in v0.0.26 

func ConfigureError(err error) *runtimev1.ConfigureStatus

func ConfigureSuccess added in v0.0.26 

func ConfigureSuccess() *runtimev1.ConfigureStatus

func NetworkMappingForRoute added in v0.0.28 

func NetworkMappingForRoute(ctx context.Context, route *configurations.RestRoute, mappings []*runtimev1.NetworkMapping) (*runtimev1.NetworkMapping, error)

NetworkMappingForRoute finds the proper network mapping for a given route

func NewFactoryAgent added in v0.0.26 

func NewFactoryAgent(conf *configurations.Agent, factory Factory) agents.AgentImplementation

func NewRuntimeAgent added in v0.0.26 

func NewRuntimeAgent(conf *configurations.Agent, runtime Runtime) agents.AgentImplementation

func NewServiceAgent added in v0.0.51 

func NewServiceAgent(conf *configurations.Agent, service Agent) agents.AgentImplementation

NewServiceAgent binds the agent implementation to the agent

func StartError added in v0.0.26 

func StartError(err error) *runtimev1.StartStatus

func StartSuccess added in v0.0.26 

func StartSuccess() *runtimev1.StartStatus

func UpdateAgent added in v0.0.59 

func UpdateAgent(ctx context.Context, service *configurations.Service) error

Types

type Agent added in v0.0.51 

type Agent interface {
	GetAgentInformation(ctx context.Context, req *agentv1.AgentInformationRequest) (*agentv1.AgentInformation, error)
}

type Base added in v0.0.26 

type Base struct {
	// Agent
	Agent *configurations.Agent

	Provider *wool.Provider
	Wool     *wool.Wool

	// State
	Identity *basev1.ServiceIdentity
	Location string

	// codefly configuration
	ConfigurationLocation string

	Configuration *configurations.Service

	// Information convenience
	Information *Information

	// Endpoints
	Endpoints []*basev1.Endpoint

	// Runtime
	State InformationStatus

	// Communication
	Communication *communicate.Server

	// Code Watcher
	Watcher *code.Watcher
	Events  chan code.Change
}

func NewServiceBase added in v0.0.26 

func NewServiceBase(ctx context.Context, agent *configurations.Agent) *Base

func (*Base) Communicate added in v0.0.26 

func (s *Base) Communicate(ctx context.Context, eng *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*Base) CreateResponse added in v0.0.51 

func (s *Base) CreateResponse(ctx context.Context, settings any, eps ...*basev1.Endpoint) (*factoryv1.CreateResponse, error)

func (*Base) CreateResponseError added in v0.0.51 

func (s *Base) CreateResponseError(err error) (*factoryv1.CreateResponse, error)

func (*Base) DebugMe added in v0.0.26 

func (s *Base) DebugMe(format string, args ...any)

func (*Base) Debugf added in v0.0.32 

func (s *Base) Debugf(format string, args ...any)

func (*Base) DockerImage added in v0.0.31 

func (s *Base) DockerImage() *configurations.DockerImage

func (*Base) EndpointsFromConfiguration added in v0.0.26 

func (s *Base) EndpointsFromConfiguration(ctx context.Context) ([]*basev1.Endpoint, error)

EndpointsFromConfiguration from Configuration and data from the service

func (*Base) Errorf added in v0.0.28 

func (s *Base) Errorf(format string, args ...any) error

func (*Base) FactoryInitResponse added in v0.0.31 

func (s *Base) FactoryInitResponse(es []*basev1.Endpoint, gettingStarted string) (*factoryv1.InitResponse, error)

func (*Base) FactoryInitResponseError added in v0.0.26 

func (s *Base) FactoryInitResponseError(err error) (*factoryv1.InitResponse, error)

func (*Base) Init added in v0.0.26 

func (s *Base) Init(ctx context.Context, identity *basev1.ServiceIdentity, settings any) error

func (*Base) Local added in v0.0.26 

func (s *Base) Local(f string) string

func (*Base) RuntimeConfigureResponse added in v0.0.67 

func (s *Base) RuntimeConfigureResponse(nms []*runtimev1.NetworkMapping) (*runtimev1.ConfigureResponse, error)

func (*Base) RuntimeConfigureResponseError added in v0.0.67 

func (s *Base) RuntimeConfigureResponseError(err error, _ ...*wool.LogField) (*runtimev1.ConfigureResponse, error)

func (*Base) RuntimeInitResponse added in v0.0.26 

func (s *Base) RuntimeInitResponse(endpoints []*basev1.Endpoint) (*runtimev1.InitResponse, error)

func (*Base) RuntimeInitResponseError added in v0.0.26 

func (s *Base) RuntimeInitResponseError(err error) (*runtimev1.InitResponse, error)

func (*Base) RuntimeStartResponse added in v0.0.67 

func (s *Base) RuntimeStartResponse(trackers []*runtimev1.Tracker) (*runtimev1.StartResponse, error)

func (*Base) RuntimeStartResponseError added in v0.0.67 

func (s *Base) RuntimeStartResponseError(err error, _ ...*wool.LogField) (*runtimev1.StartResponse, error)

func (*Base) SetupWatcher added in v0.0.26 

func (s *Base) SetupWatcher(ctx context.Context, conf *WatchConfiguration, handler func(event code.Change) error) error

func (*Base) Stop added in v0.0.26 

func (s *Base) Stop() error

func (*Base) Templates added in v0.0.26 

func (s *Base) Templates(ctx context.Context, obj any, ws ...TemplateWrapper) error

func (*Base) Version added in v0.0.26 

func (s *Base) Version() *basev1.Version

func (*Base) WantRestart added in v0.0.26 

func (s *Base) WantRestart()

func (*Base) WantSync added in v0.0.26 

func (s *Base) WantSync()

func (*Base) Wrapf added in v0.0.26 

func (s *Base) Wrapf(err error, format string, args ...any) error

type Factory added in v0.0.51 

type Factory interface {
	Init(ctx context.Context, req *factoryv1.InitRequest) (*factoryv1.InitResponse, error)

	Create(ctx context.Context, req *factoryv1.CreateRequest) (*factoryv1.CreateResponse, error)
	Update(ctx context.Context, req *factoryv1.UpdateRequest) (*factoryv1.UpdateResponse, error)

	Sync(ctx context.Context, req *factoryv1.SyncRequest) (*factoryv1.SyncResponse, error)

	Build(ctx context.Context, req *factoryv1.BuildRequest) (*factoryv1.BuildResponse, error)
	Deploy(ctx context.Context, req *factoryv1.DeploymentRequest) (*factoryv1.DeploymentResponse, error)

	// Communicate is a special method that is used to communicate with the agent
	communicate.Communicate
}

type FactoryAgent added in v0.0.51 

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

func LoadFactory added in v0.0.26 

func LoadFactory(ctx context.Context, conf *configurations.Service) (*FactoryAgent, error)

func (FactoryAgent) Build added in v0.0.51 

func (m FactoryAgent) Build(ctx context.Context, req *factoryv1.BuildRequest) (*factoryv1.BuildResponse, error)

func (FactoryAgent) Communicate added in v0.0.51 

func (m FactoryAgent) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

func (FactoryAgent) Create added in v0.0.51 

func (m FactoryAgent) Create(ctx context.Context, req *factoryv1.CreateRequest) (*factoryv1.CreateResponse, error)

func (FactoryAgent) Deploy added in v0.0.51 

func (m FactoryAgent) Deploy(ctx context.Context, req *factoryv1.DeploymentRequest) (*factoryv1.DeploymentResponse, error)

func (FactoryAgent) Init added in v0.0.51 

func (m FactoryAgent) Init(ctx context.Context, req *factoryv1.InitRequest) (*factoryv1.InitResponse, error)

func (FactoryAgent) Sync added in v0.0.51 

func (m FactoryAgent) Sync(ctx context.Context, req *factoryv1.SyncRequest) (*factoryv1.SyncResponse, error)

func (FactoryAgent) Update added in v0.0.51 

func (m FactoryAgent) Update(ctx context.Context, req *factoryv1.UpdateRequest) (*factoryv1.UpdateResponse, error)

type FactoryAgentGRPC added in v0.0.51 

type FactoryAgentGRPC struct {
	// GRPCAgent must still implement the ServiceAgent interface
	plugin.Plugin
	Factory Factory
}

func (*FactoryAgentGRPC) GRPCClient added in v0.0.51 

func (p *FactoryAgentGRPC) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*FactoryAgentGRPC) GRPCServer added in v0.0.51 

func (p *FactoryAgentGRPC) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

type FactoryInstance added in v0.0.51 

type FactoryInstance struct {
	*configurations.Service
	Factory
}

func (*FactoryInstance) Create added in v0.0.51 

func (instance *FactoryInstance) Create(ctx context.Context) (*factoryv1.CreateResponse, error)

func (*FactoryInstance) Init added in v0.0.51 

func (instance *FactoryInstance) Init(ctx context.Context) (*factoryv1.InitResponse, error)

type FactoryServer added in v0.0.26 

type FactoryServer struct {
	factoryv1.UnimplementedFactoryServer
	Factory Factory
}

FactoryServer wraps the gRPC protocol Request/Response

func (*FactoryServer) Build added in v0.0.26 

func (m *FactoryServer) Build(ctx context.Context, req *factoryv1.BuildRequest) (*factoryv1.BuildResponse, error)

func (*FactoryServer) Communicate added in v0.0.26 

func (m *FactoryServer) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*FactoryServer) Create added in v0.0.26 

func (m *FactoryServer) Create(ctx context.Context, req *factoryv1.CreateRequest) (*factoryv1.CreateResponse, error)

func (*FactoryServer) Deploy added in v0.0.26 

func (m *FactoryServer) Deploy(ctx context.Context, req *factoryv1.DeploymentRequest) (*factoryv1.DeploymentResponse, error)

func (*FactoryServer) Init added in v0.0.26 

func (m *FactoryServer) Init(ctx context.Context, req *factoryv1.InitRequest) (*factoryv1.InitResponse, error)

func (*FactoryServer) Sync added in v0.0.26 

func (m *FactoryServer) Sync(ctx context.Context, req *factoryv1.SyncRequest) (*factoryv1.SyncResponse, error)

func (*FactoryServer) Update added in v0.0.26 

func (m *FactoryServer) Update(ctx context.Context, req *factoryv1.UpdateRequest) (*factoryv1.UpdateResponse, error)

type Information added in v0.0.26 

type Information struct {
	Service *configurations.ServiceWithCase
	Agent   *configurations.Agent
	Domain  string
}

type InformationStatus added in v0.0.26 

type InformationStatus = runtimev1.InformationResponse_Status

type ProcessInfo added in v0.0.68 

type ProcessInfo struct {
	AgentPID int
	Trackers []*runtimev1.Tracker
}

type ProcessState 

type ProcessState int
const (
	Unknown  ProcessState = iota
	NotFound ProcessState = iota
	Running
	InterruptibleSleep
	UninterruptibleSleep
	Stopped
	Zombie
	Dead
	TracingStop
	Idle
	Parked
	Waking
)

func (ProcessState) String 

func (ps ProcessState) String() string

type Runtime added in v0.0.51 

type Runtime interface {
	Init(ctx context.Context, req *runtimev1.InitRequest) (*runtimev1.InitResponse, error)

	Configure(ctx context.Context, req *runtimev1.ConfigureRequest) (*runtimev1.ConfigureResponse, error)

	Start(ctx context.Context, req *runtimev1.StartRequest) (*runtimev1.StartResponse, error)
	Information(ctx context.Context, req *runtimev1.InformationRequest) (*runtimev1.InformationResponse, error)

	Stop(ctx context.Context, req *runtimev1.StopRequest) (*runtimev1.StopResponse, error)

	// Communicate is a special method that is used to communicate with the agent
	communicate.Communicate
}

type RuntimeAgent added in v0.0.51 

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

func LoadRuntime added in v0.0.26 

func LoadRuntime(ctx context.Context, service *configurations.Service) (*RuntimeAgent, error)

func (*RuntimeAgent) Communicate added in v0.0.51 

func (m *RuntimeAgent) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

Communicate helper

func (*RuntimeAgent) Configure added in v0.0.51 

func (m *RuntimeAgent) Configure(ctx context.Context, req *runtimev1.ConfigureRequest) (*runtimev1.ConfigureResponse, error)

Configure documents things It can be used safely anywhere: doesn't start or do anything

func (*RuntimeAgent) Information added in v0.0.51 

func (m *RuntimeAgent) Information(ctx context.Context, req *runtimev1.InformationRequest) (*runtimev1.InformationResponse, error)

Information return some useful information about the service

func (*RuntimeAgent) Init added in v0.0.51 

func (m *RuntimeAgent) Init(ctx context.Context, req *runtimev1.InitRequest) (*runtimev1.InitResponse, error)

Init initializes the service

func (*RuntimeAgent) Start added in v0.0.51 

func (m *RuntimeAgent) Start(ctx context.Context, req *runtimev1.StartRequest) (*runtimev1.StartResponse, error)

Start starts the service

func (*RuntimeAgent) Stop added in v0.0.51 

func (m *RuntimeAgent) Stop(ctx context.Context, req *runtimev1.StopRequest) (*runtimev1.StopResponse, error)

Stop stops the service

type RuntimeAgentGRPC added in v0.0.51 

type RuntimeAgentGRPC struct {
	// GRPCAgent must still implement the ServiceAgent interface
	plugin.Plugin
	Runtime Runtime
}

func (*RuntimeAgentGRPC) GRPCClient added in v0.0.51 

func (p *RuntimeAgentGRPC) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*RuntimeAgentGRPC) GRPCServer added in v0.0.51 

func (p *RuntimeAgentGRPC) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

type RuntimeInstance added in v0.0.51 

type RuntimeInstance struct {
	*configurations.Service
	Runtime
}

func (*RuntimeInstance) Init added in v0.0.51 

func (instance *RuntimeInstance) Init(ctx context.Context) (*runtimev1.InitResponse, error)

type RuntimeServer added in v0.0.26 

type RuntimeServer struct {
	runtimev1.UnimplementedRuntimeServer
	Runtime Runtime
}

RuntimeServer wraps the gRPC protocol Request/Response

func (*RuntimeServer) Communicate added in v0.0.26 

func (m *RuntimeServer) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*RuntimeServer) Configure added in v0.0.26 

func (m *RuntimeServer) Configure(ctx context.Context, req *runtimev1.ConfigureRequest) (*runtimev1.ConfigureResponse, error)

func (*RuntimeServer) Information added in v0.0.26 

func (m *RuntimeServer) Information(ctx context.Context, req *runtimev1.InformationRequest) (*runtimev1.InformationResponse, error)

func (*RuntimeServer) Init added in v0.0.26 

func (m *RuntimeServer) Init(ctx context.Context, req *runtimev1.InitRequest) (*runtimev1.InitResponse, error)

func (*RuntimeServer) Start added in v0.0.26 

func (m *RuntimeServer) Start(ctx context.Context, req *runtimev1.StartRequest) (*runtimev1.StartResponse, error)

func (*RuntimeServer) Stop added in v0.0.26 

func (m *RuntimeServer) Stop(ctx context.Context, req *runtimev1.StopRequest) (*runtimev1.StopResponse, error)

type ServiceAgent added in v0.0.51 

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

func LoadAgent added in v0.0.51 

func LoadAgent(ctx context.Context, agent *configurations.Agent) (*ServiceAgent, error)

func (*ServiceAgent) GetAgentInformation added in v0.0.51 

func (m *ServiceAgent) GetAgentInformation(ctx context.Context, req *agentv1.AgentInformationRequest) (*agentv1.AgentInformation, error)

GetAgentInformation provides - capabilities

type ServiceAgentContext added in v0.0.51 

type ServiceAgentContext struct {
}

func (ServiceAgentContext) Default added in v0.0.51 

func (m ServiceAgentContext) Default() plugin.Plugin

func (ServiceAgentContext) Key added in v0.0.51 

func (m ServiceAgentContext) Key(p *configurations.Agent, unique string) string

type ServiceAgentGRPC added in v0.0.51 

type ServiceAgentGRPC struct {
	// GRPCAgent must still implement the ServiceAgent interface
	plugin.Plugin
	Service Agent
}

func (*ServiceAgentGRPC) GRPCClient added in v0.0.51 

func (p *ServiceAgentGRPC) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*ServiceAgentGRPC) GRPCServer added in v0.0.51 

func (p *ServiceAgentGRPC) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

type ServiceAgentServer added in v0.0.51 

type ServiceAgentServer struct {
	agentv1.UnimplementedAgentServer
	Service Agent
}

ServiceAgentServer wraps the gRPC protocol Request/Response

func (*ServiceAgentServer) GetAgentInformation added in v0.0.51 

func (m *ServiceAgentServer) GetAgentInformation(ctx context.Context, req *agentv1.AgentInformationRequest) (*agentv1.AgentInformation, error)

type ServiceEvent 

type ServiceEvent struct {
	Unique string
	Event  string
}

type ServiceFactoryAgentContext added in v0.0.26 

type ServiceFactoryAgentContext struct {
}

func (ServiceFactoryAgentContext) Default added in v0.0.26 

func (m ServiceFactoryAgentContext) Default() plugin.Plugin

func (ServiceFactoryAgentContext) Key added in v0.0.26 

func (m ServiceFactoryAgentContext) Key(p *configurations.Agent, unique string) string

type ServiceInstance added in v0.0.51 

type ServiceInstance struct {
	*configurations.Service
	Agent   Agent
	Factory *FactoryInstance
	Runtime *RuntimeInstance
	ProcessInfo
}

func Load added in v0.0.51 

func Load(ctx context.Context, service *configurations.Service) (*ServiceInstance, error)

func (*ServiceInstance) LoadFactory added in v0.0.51 

func (instance *ServiceInstance) LoadFactory(ctx context.Context, service *configurations.Service) error

func (*ServiceInstance) LoadRuntime added in v0.0.51 

func (instance *ServiceInstance) LoadRuntime(ctx context.Context, service *configurations.Service) error

type ServiceRuntimeAgentContext added in v0.0.26 

type ServiceRuntimeAgentContext struct {
}

func (ServiceRuntimeAgentContext) Default added in v0.0.26 

func (m ServiceRuntimeAgentContext) Default() plugin.Plugin

func (ServiceRuntimeAgentContext) Key added in v0.0.26 

func (m ServiceRuntimeAgentContext) Key(p *configurations.Agent, unique string) string

type SingleTracker 

type SingleTracker struct {
	Tracked Tracked

	sync.RWMutex
	// contains filtered or unexported fields
}

func (*SingleTracker) Stop 

func (t *SingleTracker) Stop()

type TemplateWrapper added in v0.0.26 

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

func WithBuilder added in v0.0.26 

func WithBuilder(fs embed.FS) TemplateWrapper

func WithDeployment added in v0.0.26 

func WithDeployment(fs embed.FS) TemplateWrapper

func WithFactory added in v0.0.26 

func WithFactory(fs embed.FS, ignores ...string) TemplateWrapper

type Tracked 

type Tracked interface {
	Name() string   // For display
	Unique() string // For identification in the system
	GetStatus(ctx context.Context) (ProcessState, error)
	GetUsage(ctx context.Context) (*Usage, error)
	Kill() error
}

func NewTracked 

func NewTracked(service *configurations.Service, tracker *runtimev1.Tracker) (Tracked, error)

type TrackedContainer 

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

func (TrackedContainer) GetStatus 

func (t TrackedContainer) GetStatus(context.Context) (ProcessState, error)

func (TrackedContainer) GetUsage 

func (t TrackedContainer) GetUsage(context.Context) (*Usage, error)

func (TrackedContainer) Kill 

func (t TrackedContainer) Kill() error

func (TrackedContainer) Name 

func (t TrackedContainer) Name() string

func (TrackedContainer) Unique 

func (t TrackedContainer) Unique() string

type TrackedProcess 

type TrackedProcess struct {
	PID    int
	Killed bool
	// contains filtered or unexported fields
}

func (*TrackedProcess) GetStatus 

func (p *TrackedProcess) GetStatus(ctx context.Context) (ProcessState, error)

func (*TrackedProcess) GetUsage 

func (p *TrackedProcess) GetUsage(ctx context.Context) (*Usage, error)

func (*TrackedProcess) Kill 

func (p *TrackedProcess) Kill() error

func (*TrackedProcess) Name 

func (p *TrackedProcess) Name() string

func (*TrackedProcess) Proto 

func (p *TrackedProcess) Proto() *runtimev1.Tracker

func (*TrackedProcess) Unique 

func (p *TrackedProcess) Unique() string

type Tracker 

type Tracker interface {
	Start(events chan<- ServiceEvent) error
	Stop()
}

type Usage 

type Usage struct {
	Memory float64 // In KB
	CPU    float64
}

type WatchConfiguration added in v0.0.26 

type WatchConfiguration struct {
	Includes []string
	Excludes []string
}

func NewWatchConfiguration added in v0.0.26 

func NewWatchConfiguration(includes []string, excludes ...string) *WatchConfiguration

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.