repositories

Documentation

Index

• type Configuration
• type Service
  • func New() *Service
  • func (s *Service) ApplyConfiguration(config interface{}) error
  • func (s *Service) CheckConfiguration(config interface{}) error
  • func (s *Service) ClearLocalCacheHandler() service.Handler
  • func (s *Service) GetLocalCacheHandler() service.Handler
  • func (s *Service) Init(config interface{}) (cdsclient.ServiceConfig, error)
  • func (s Service) Repo(op sdk.Operation) *sdk.OperationRepo
  • func (s *Service) Serve(c context.Context) error
  • func (s *Service) Status(ctx context.Context) *sdk.MonitoringStatus

Types

type Configuration

type Configuration struct {
	Name                  string                          `toml:"name" comment:"Name of this CDS Repositories Service\n Enter a name to enable this service" json:"name"`
	Basedir               string                          `toml:"basedir" comment:"Root directory where the service will store all checked-out repositories" json:"basedir"`
	OperationRetention    int                             `toml:"operationRetention" comment:"Operation retention in redis store (in days)" default:"5" json:"operationRetention"`
	RepositoriesRetention int                             `toml:"repositoriesRetention" comment:"Re retention on the filesystem (in days)" default:"10" json:"repositoriesRetention"`
	HTTP                  service.HTTPRouterConfiguration `toml:"http" comment:"######################\n CDS Repositories HTTP Configuration \n######################" json:"http"`
	URL                   string                          `default:"http://localhost:8085" json:"url"`
	API                   service.APIServiceConfiguration `toml:"api" comment:"######################\n CDS API Settings \n######################" json:"api"`
	Cache                 struct {
		TTL   int           `toml:"ttl" default:"60" json:"ttl"`
		Redis sdk.RedisConf `toml:"redis" json:"redis"`
	} `toml:"cache" comment:"######################\n CDS Repositories Cache Settings \n######################" json:"cache"`
	MaxWorkers int `toml:"maxWorkers" comment:"Maximum of operations that can be done in parallel" default:"10" json:"maxWorkers"`
}

Configuration is the vcs configuration structure

type Service

type Service struct {
	service.Common
	Cfg    Configuration
	Router *api.Router
	Cache  cache.Store
	// contains filtered or unexported fields
}

Service is the repostories service

func New

func New() *Service

New returns a new service

func (*Service) ApplyConfiguration

func (s *Service) ApplyConfiguration(config interface{}) error

ApplyConfiguration apply an object of type repositories.Configuration after checking it

func (*Service) CheckConfiguration

func (s *Service) CheckConfiguration(config interface{}) error

CheckConfiguration checks the validity of the configuration object

func (*Service) ClearLocalCacheHandler

func (s *Service) ClearLocalCacheHandler() service.Handler

func (*Service) GetLocalCacheHandler

func (s *Service) GetLocalCacheHandler() service.Handler

func (*Service) Init

func (s *Service) Init(config interface{}) (cdsclient.ServiceConfig, error)

func (Service) Repo

func (s Service) Repo(op sdk.Operation) *sdk.OperationRepo

Repo retiens a sdk.OperationRepo from an sdk.Operation

func (*Service) Serve

func (s *Service) Serve(c context.Context) error

Serve will start the http api server

func (*Service) Status

func (s *Service) Status(ctx context.Context) *sdk.MonitoringStatus

Status returns sdk.MonitoringStatus, implements interface service.Service