service

type APIServiceConfiguration struct {
	HTTP struct {
		URL      string `toml:"url" default:"http://localhost:8081" json:"url"`
		Insecure bool   `toml:"insecure" commented:"true" json:"insecure"`
	} `toml:"http" json:"http"`
	Token                string `toml:"token" default:"************" json:"-"`
	RequestTimeout       int    `toml:"requestTimeout" default:"10" json:"requestTimeout"`
	MaxHeartbeatFailures int    `toml:"maxHeartbeatFailures" default:"10" json:"maxHeartbeatFailures"`
}

type AsynchronousHandler func(ctx context.Context, r *http.Request) error

type AsynchronousHandlerFunc func() AsynchronousHandler

type BeforeStart interface {
	BeforeStart(ctx context.Context) error
}

type Common struct {
	Client                cdsclient.Interface
	APIPublicKey          []byte
	ParsedAPIPublicKey    *rsa.PublicKey
	StartupTime           time.Time
	HTTPURL               string
	MaxHeartbeatFailures  int
	ServiceName           string
	ServiceType           string
	ServiceInstance       *sdk.Service
	PrivateKey            *rsa.PrivateKey
	Signer                jose.Signer
	CDNConfig             sdk.CDNConfig
	ServiceLogger         *logrus.Logger
	GoRoutines            *sdk.GoRoutines
	Region                string
	IgnoreJobWithNoRegion bool
	ModelType             string
}

type ErrorResponse struct {
	sdk.Error
	RequestID string `json:"request_id"`
}

type HTTPRouterConfiguration struct {
	Addr                string `toml:"addr" default:"" commented:"true" comment:"Listen HTTP address without port, example: 127.0.0.1" json:"addr"`
	Port                int    `toml:"port" default:"8081" json:"port"`
	HeaderXForwardedFor string `` /* 179-byte string literal not displayed */
}

type Handler func(ctx context.Context, w http.ResponseWriter, r *http.Request) error

type HandlerConfig struct {
	Name                   string
	Method                 string
	Handler                Handler
	IsDeprecated           bool
	OverrideAuthMiddleware Middleware
	MaintenanceAware       bool
	AllowedScopes          []sdk.AuthConsumerScope
	PermissionLevel        int
	CleanURL               string
	RbacCheckers           []RbacChecker
}

type HandlerConfigParam func(*HandlerConfig)

type HandlerFunc func() Handler

type HandlerFuncV2 func() ([]RbacChecker, Handler)

type HatcheryCommonConfiguration struct {
	Name          string                  `toml:"name" default:"" comment:"Name of Hatchery" json:"name"`
	RSAPrivateKey string                  `toml:"rsaPrivateKey" default:"" comment:"The RSA Private Key used by the hatchery.\nThis is mandatory." json:"-"`
	HTTP          HTTPRouterConfiguration `toml:"http" comment:"######################\n CDS Hatchery HTTP Configuration \n######################" json:"http"`
	URL           string                  `toml:"url" default:"http://localhost:8086" comment:"URL of this Hatchery" json:"url"`
	API           struct {
		HTTP struct {
			URL      string `toml:"url" default:"http://localhost:8081" comment:"CDS API URL" json:"url"`
			Insecure bool   `` /* 149-byte string literal not displayed */
		} `toml:"http" json:"http"`
		Token                string `` /* 131-byte string literal not displayed */
		TokenV2              string `toml:"tokenV2" default:"" comment:"Hatchery consumer Token. Allow to reach CDS API on /v2 routes" json:"-"`
		RequestTimeout       int    `toml:"requestTimeout" default:"10" comment:"Request CDS API: timeout in seconds" json:"requestTimeout"`
		MaxHeartbeatFailures int    `` /* 136-byte string literal not displayed */
	} `toml:"api" json:"api"`
	CDN struct {
		URL string `` /* 193-byte string literal not displayed */
		TCP struct {
			EnableTLS bool   `toml:"enableTLS" commented:"true" comment:"Enable TLS for CDN TCP connection" json:"enable_tls"`
			URL       string `` /* 185-byte string literal not displayed */
		} `toml:"tcp" json:"tcp"`
	} `toml:"cdn" json:"cdn"`
	Provision struct {
		InjectEnvVars             []string `toml:"injectEnvVars" commented:"true" comment:"Inject env variables in workers" json:"-" mapstructure:"injectEnvVars"`
		MaxWorker                 int      `toml:"maxWorker" default:"10" comment:"Maximum allowed simultaneous workers" json:"maxWorker"`
		MaxConcurrentProvisioning int      `` /* 138-byte string literal not displayed */
		MaxConcurrentRegistering  int      `` /* 178-byte string literal not displayed */
		RegisterFrequency         int      `` /* 136-byte string literal not displayed */
		Region                    string   `` /* 186-byte string literal not displayed */
		IgnoreJobWithNoRegion     bool     `` /* 154-byte string literal not displayed */
		WorkerAPIHTTP             struct {
			URL      string `` /* 188-byte string literal not displayed */
			Insecure bool   `` /* 149-byte string literal not displayed */
		} `toml:"workerApiHttp" json:"workerApiHttp"`
		WorkerCDN struct {
			URL string `` /* 178-byte string literal not displayed */
			TCP struct {
				EnableTLS bool   `toml:"enableTLS" commented:"true" comment:"Enable TLS for CDN TCP connection" json:"enable_tls"`
				URL       string `` /* 166-byte string literal not displayed */
			} `toml:"tcp" json:"tcp"`
		} `toml:"workerCdn" json:"workerCdn"`
		WorkerBasedir     string `toml:"workerBasedir" commented:"true" comment:"Worker Basedir" json:"workerBasedir"`
		WorkerLogsOptions struct {
			Level   string `toml:"level" comment:"Worker log level" json:"level"`
			Graylog struct {
				Host       string `toml:"host" comment:"Example: thot.ovh.com" json:"host"`
				Port       int    `toml:"port" comment:"Example: 12202" json:"port"`
				Protocol   string `toml:"protocol" default:"tcp" comment:"tcp or udp" json:"protocol"`
				ExtraKey   string `toml:"extraKey" comment:"Example: X-OVH-TOKEN. You can use many keys: aaa,bbb" json:"extraKey"`
				ExtraValue string `toml:"extraValue" comment:"value for extraKey field. For many keys: valueaaa,valuebbb" json:"-"`
			} `toml:"graylog" json:"graylog"`
		} `toml:"workerLogsOptions" comment:"Worker Log Configuration" json:"workerLogsOptions"`
		MaxAttemptsNumberBeforeFailure int `` /* 201-byte string literal not displayed */
	} `toml:"provision" json:"provision"`
	LogOptions struct {
		SpawnOptions struct {
			ThresholdCritical int `` /* 134-byte string literal not displayed */
			ThresholdWarning  int `` /* 131-byte string literal not displayed */
		} `toml:"spawnOptions" json:"spawnOptions"`
	} `toml:"logOptions" comment:"Hatchery Log Configuration" json:"logOptions"`
}

type Middleware func(ctx context.Context, w http.ResponseWriter, req *http.Request, rc *HandlerConfig) (context.Context, error)

type NamedService interface {
	Name() string
	Type() string
}

type RbacChecker func(ctx context.Context, auth *sdk.AuthUserConsumer, cache cache.Store, db gorp.SqlExecutor, vars map[string]string) error

type RbacCheckers []RbacChecker

type RouterConfig struct {
	Config map[string]*HandlerConfig
}

type RouterConfigParam func(rc *RouterConfig)

type Service interface {
	ApplyConfiguration(cfg interface{}) error
	Serve(ctx context.Context) error
	CheckConfiguration(cfg interface{}) error
	Start(ctx context.Context) error
	Init(cfg interface{}) (cdsclient.ServiceConfig, error)
	Signin(ctx context.Context, clientConfig cdsclient.ServiceConfig, srvConfig interface{}) error
	Unregister(ctx context.Context) error
	Heartbeat(ctx context.Context, status func(ctx context.Context) *sdk.MonitoringStatus) error
	Status(ctx context.Context) *sdk.MonitoringStatus
	NamedService
}