server

Documentation

Index

• Variables
• func GetConfigDir() (string, error)
• func GetWorkspaceLogsDir(configDir string) (string, error)
• func IsLogFileNotFound(err error) bool
• func Save(c Config) error
• type Config
  • func GetConfig() (*Config, error)
• type FRPSConfig
• type ILocalContainerRegistry
• type LogFileConfig
• 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
  • func (s *Server) Purge(ctx context.Context, force bool) []error
  • func (s *Server) Start() error
• type ServerInstanceConfig
• type TailscaleServer

Variables

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

Functions

func GetConfigDir

func GetConfigDir() (string, error)

func GetWorkspaceLogsDir

func GetWorkspaceLogsDir(configDir string) (string, error)

func IsLogFileNotFound

func IsLogFileNotFound(err error) bool

func Save

func Save(c Config) error

Types

type Config

type Config struct {
	ProvidersDir              string         `json:"providersDir" validate:"required"`
	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                   *LogFileConfig `json:"logFile" validate:"required"`
	DefaultProjectImage       string         `json:"defaultProjectImage" validate:"required"`
	DefaultProjectUser        string         `json:"defaultProjectUser" validate:"required"`
	BuilderImage              string         `json:"builderImage" 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"`
	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 LogFileConfig

type LogFileConfig struct {
	Path       string `json:"path" validate:"required"`
	MaxSize    int    `json:"maxSize" validate:"required"`
	MaxBackups int    `json:"maxBackups" validate:"required"`
	MaxAge     int    `json:"maxAge" validate:"required"`
	LocalTime  bool   `json:"localTime" validate:"optional"`
	Compress   bool   `json:"compress" validate:"optional"`

} // @name LogFileConfig

type NetworkKey

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

} // @name NetworkKey

type Server

type Server struct {
	Id string

	Version                  string
	TailscaleServer          TailscaleServer
	ProviderTargetService    providertargets.IProviderTargetService
	ContainerRegistryService containerregistries.IContainerRegistryService
	BuildService             builds.IBuildService
	ProjectConfigService     projectconfig.IProjectConfigService
	LocalContainerRegistry   ILocalContainerRegistry
	WorkspaceService         workspaces.IWorkspaceService
	ApiKeyService            apikeys.IApiKeyService
	GitProviderService       gitproviders.IGitProviderService
	ProviderManager          manager.IProviderManager
	ProfileDataService       profiledata.IProfileDataService
	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

func (*Server) Purge

func (s *Server) Purge(ctx context.Context, force bool) []error

func (*Server) Start

func (s *Server) Start() error

type ServerInstanceConfig

type ServerInstanceConfig struct {
	Config                   Config
	Version                  string
	TailscaleServer          TailscaleServer
	ProviderTargetService    providertargets.IProviderTargetService
	ContainerRegistryService containerregistries.IContainerRegistryService
	BuildService             builds.IBuildService
	ProjectConfigService     projectconfig.IProjectConfigService
	LocalContainerRegistry   ILocalContainerRegistry
	WorkspaceService         workspaces.IWorkspaceService
	ApiKeyService            apikeys.IApiKeyService
	GitProviderService       gitproviders.IGitProviderService
	ProviderManager          manager.IProviderManager
	ProfileDataService       profiledata.IProfileDataService
	TelemetryService         telemetry.TelemetryService
}

type TailscaleServer

type TailscaleServer interface {
	Connect() error
	CreateAuthKey() (string, error)
	CreateUser() error
	HTTPClient() *http.Client
	Start(errChan chan error) error
	Stop() error
	Purge() error
}