server

Documentation

Index

• Variables
• func GetBuildLogsDir(configDir string) string
• func GetConfigDir() (string, error)
• func GetRunnerLogsDir(configDir string) string
• func GetTargetLogsDir(configDir string) string
• func GetWorkspaceLogsDir(configDir string) string
• func IsLogFileNotFound(err error) bool
• func Save(c Config) error
• type Config
  • func GetConfig() (*Config, error)
• type FRPSConfig
• type ILocalContainerRegistry
• type NetworkKey
• type Server
  • func GetInstance(serverConfig *ServerInstanceConfig) *Server
  • func (s *Server) FetchSamples() ([]sample.Sample, *http.Response, error)
  • func (s *Server) GetBinaryPath(binaryName, binaryVersion string) (string, error)
  • func (s *Server) GetLogFiles() ([]string, error)
  • func (s *Server) GetLogReader(logFileQuery string) (io.Reader, error)
  • func (s *Server) Initialize() error
• type ServerInstanceConfig
• type TailscaleServer

Variables

var (
	ErrLogFileNotFound = errors.New("log file not found")
)

Functions

func GetBuildLogsDir

func GetBuildLogsDir(configDir string) string

func GetConfigDir

func GetConfigDir() (string, error)

func GetRunnerLogsDir

func GetRunnerLogsDir(configDir string) string

func GetTargetLogsDir

func GetTargetLogsDir(configDir string) string

func GetWorkspaceLogsDir

func GetWorkspaceLogsDir(configDir string) string

func IsLogFileNotFound

func IsLogFileNotFound(err error) bool

func Save

func Save(c Config) error

Types

type Config

type Config struct {
	RegistryUrl               string              `json:"registryUrl" validate:"required"`
	Id                        string              `json:"id" validate:"required"`
	ServerDownloadUrl         string              `json:"serverDownloadUrl" validate:"required"`
	Frps                      *FRPSConfig         `json:"frps,omitempty" validate:"optional"`
	ApiPort                   uint32              `json:"apiPort" validate:"required"`
	HeadscalePort             uint32              `json:"headscalePort" validate:"required"`
	BinariesPath              string              `json:"binariesPath" validate:"required"`
	LogFile                   *logs.LogFileConfig `json:"logFile" validate:"required"`
	BuilderImage              string              `json:"builderImage" validate:"required"`
	DefaultWorkspaceImage     string              `json:"defaultWorkspaceImage" validate:"required"`
	DefaultWorkspaceUser      string              `json:"defaultWorkspaceUser" validate:"required"`
	LocalBuilderRegistryPort  uint32              `json:"localBuilderRegistryPort" validate:"required"`
	LocalBuilderRegistryImage string              `json:"localBuilderRegistryImage" validate:"required"`
	BuilderRegistryServer     string              `json:"builderRegistryServer" validate:"required"`
	BuildImageNamespace       string              `json:"buildImageNamespace" validate:"optional"`
	LocalRunnerDisabled       *bool               `json:"localRunnerDisabled" validate:"optional"`
	SamplesIndexUrl           string              `json:"samplesIndexUrl" validate:"optional"`

} // @name ServerConfig

func GetConfig

func GetConfig() (*Config, error)

type FRPSConfig

type FRPSConfig struct {
	Domain   string `json:"domain" validate:"required"`
	Port     uint32 `json:"port" validate:"required"`
	Protocol string `json:"protocol" validate:"required"`

} // @name FRPSConfig

type ILocalContainerRegistry

type ILocalContainerRegistry interface {
	Start() error
	Stop() error
	Purge() error
}

type NetworkKey

type NetworkKey struct {
	Key string `json:"key" validate:"required"`

} // @name NetworkKey

type Server

type Server struct {
	Id string

	Version                    string
	TailscaleServer            TailscaleServer
	TargetConfigService        services.ITargetConfigService
	BuildService               services.IBuildService
	WorkspaceTemplateService   services.IWorkspaceTemplateService
	WorkspaceService           services.IWorkspaceService
	LocalContainerRegistry     ILocalContainerRegistry
	TargetService              services.ITargetService
	ApiKeyService              services.IApiKeyService
	GitProviderService         services.IGitProviderService
	EnvironmentVariableService services.IEnvironmentVariableService
	JobService                 services.IJobService
	RunnerService              services.IRunnerService
	TelemetryService           telemetry.TelemetryService
	// contains filtered or unexported fields
}

func GetInstance

func GetInstance(serverConfig *ServerInstanceConfig) *Server

func (*Server) FetchSamples

func (s *Server) FetchSamples() ([]sample.Sample, *http.Response, error)

func (*Server) GetBinaryPath

func (s *Server) GetBinaryPath(binaryName, binaryVersion string) (string, error)

Check if the requested binary is already downloaded, if not, download it

func (*Server) GetLogFiles

func (s *Server) GetLogFiles() ([]string, error)

func (*Server) GetLogReader

func (s *Server) GetLogReader(logFileQuery string) (io.Reader, error)

func (*Server) Initialize

func (s *Server) Initialize() error

type ServerInstanceConfig

type ServerInstanceConfig struct {
	Config                     Config
	Version                    string
	TailscaleServer            TailscaleServer
	TargetConfigService        services.ITargetConfigService
	BuildService               services.IBuildService
	WorkspaceTemplateService   services.IWorkspaceTemplateService
	WorkspaceService           services.IWorkspaceService
	LocalContainerRegistry     ILocalContainerRegistry
	TargetService              services.ITargetService
	ApiKeyService              services.IApiKeyService
	GitProviderService         services.IGitProviderService
	EnvironmentVariableService services.IEnvironmentVariableService
	JobService                 services.IJobService
	RunnerService              services.IRunnerService
	TelemetryService           telemetry.TelemetryService
}

type TailscaleServer

type TailscaleServer interface {
	Connect(username string) error
	CreateAuthKey(username string) (string, error)
	CreateUser(username string) error
	HTTPClient() *http.Client
	Dial(ctx context.Context, network, address string) (net.Conn, error)
	Start(errChan chan error) error
	Stop() error
	Purge() error
}