Documentation
¶
Index ¶
- type Dependencies
- type WorkerProvider
- func (wp *WorkerProvider) DeregisterWorker(c echo.Context) error
- func (wp *WorkerProvider) GetWorker(c echo.Context) error
- func (wp *WorkerProvider) GetWorkerRegisterSecret(c echo.Context) error
- func (wp *WorkerProvider) GetWorkerStatusOverview(c echo.Context) error
- func (wp *WorkerProvider) RegisterWorker(c echo.Context) error
- func (wp *WorkerProvider) ResetWorkerRegisterSecret(c echo.Context) error
- type WorkerProviderer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dependencies ¶
type Dependencies struct {
Scheduler service.GaiaScheduler
Certificate security.CAAPI
}
Dependencies define dependencies which this service needs.
type WorkerProvider ¶
type WorkerProvider struct {
// contains filtered or unexported fields
}
WorkerProvider has all the operations for a worker.
func NewWorkerProvider ¶
func NewWorkerProvider(deps Dependencies) *WorkerProvider
NewWorkerProvider creates a provider which provides worker related functionality.
func (*WorkerProvider) DeregisterWorker ¶
func (wp *WorkerProvider) DeregisterWorker(c echo.Context) error
DeregisterWorker deregister a registered worker. @Summary Deregister and existing worker. @Description Deregister an existing worker. @Tags workers @Accept json @Produce json @Security ApiKeyAuth @Param workerid query string true "The id of the worker to deregister." @Success 200 {string} string "Worker has been successfully deregistered." @Failure 400 {string} string "Worker id is missing or worker not registered." @Failure 500 {string} string "Cannot get memdb service from service store or failed to delete worker." @Router /worker/{workerid} [delete]
func (*WorkerProvider) GetWorker ¶
func (wp *WorkerProvider) GetWorker(c echo.Context) error
GetWorker returns all workers. @Summary Get all workers. @Description Gets all workers. @Tags workers @Produce json @Security ApiKeyAuth @Success 200 {array} gaia.Worker "A list of workers." @Failure 500 {string} string "Cannot get memdb service from service store." @Router /worker [get]
func (*WorkerProvider) GetWorkerRegisterSecret ¶
func (wp *WorkerProvider) GetWorkerRegisterSecret(c echo.Context) error
GetWorkerRegisterSecret returns the global secret for registering new worker. @Summary Get worker register secret. @Description Returns the global secret for registering new worker. @Tags workers @Produce json @Security ApiKeyAuth @Success 200 {string} string @Failure 500 {string} string "Cannot get worker secret from vault." @Router /worker/secret [get]
func (*WorkerProvider) GetWorkerStatusOverview ¶
func (wp *WorkerProvider) GetWorkerStatusOverview(c echo.Context) error
GetWorkerStatusOverview returns general status information about all workers. @Summary Get worker status overview. @Description Returns general status information about all workers. @Tags workers @Produce json @Security ApiKeyAuth @Success 200 {object} workerStatusOverviewResponse "The worker status overview response." @Failure 500 {string} string "Cannot get memdb service from service store." @Router /worker/status [get]
func (*WorkerProvider) RegisterWorker ¶
func (wp *WorkerProvider) RegisterWorker(c echo.Context) error
RegisterWorker allows new workers to register themself at this Gaia instance. It accepts a secret and returns valid certificates (base64 encoded) for further mTLS connection. @Summary Register a new worker. @Description Allows new workers to register themself at this Gaia instance. @Tags workers @Accept json @Produce json @Param RegisterWorkerRequest body registerWorker true "Worker details" @Success 200 {object} registerResponse "Details of the registered worker." @Failure 400 {string} string "Invalid arguments of the worker." @Failure 403 {string} string "Wrong global worker secret provided." @Failure 500 {string} string "Various internal services like, certs, vault and generating new secrets." @Router /worker/register [post]
func (*WorkerProvider) ResetWorkerRegisterSecret ¶
func (wp *WorkerProvider) ResetWorkerRegisterSecret(c echo.Context) error
ResetWorkerRegisterSecret generates a new global worker registration secret @Summary Reset worker register secret. @Description Generates a new global worker registration secret. @Tags workers @Produce plain @Security ApiKeyAuth @Success 200 {string} string "global worker registration secret has been successfully reset" @Failure 500 {string} string "Vault related internal problems." @Router /worker/secret [post]
type WorkerProviderer ¶
type WorkerProviderer interface {
RegisterWorker(c echo.Context) error
DeregisterWorker(c echo.Context) error
GetWorkerRegisterSecret(c echo.Context) error
GetWorkerStatusOverview(c echo.Context) error
ResetWorkerRegisterSecret(c echo.Context) error
GetWorker(c echo.Context) error
}
WorkerProviderer defines functionality which this provider provides.
Source Files