Documentation ¶
Index ¶
- func MountDatabindController(service *goa.Service, ctrl DatabindController)
- func MountMonitoringController(service *goa.Service, ctrl MonitoringController)
- func MountSwarmController(service *goa.Service, ctrl SwarmController)
- func MountTaskController(service *goa.Service, ctrl TaskController)
- type AtqDatabindUpload
- type AtqDatabindUploadCollection
- type AtqDatabindUploadError
- type AtqDatabindUploadErrorCollection
- type AtqService
- type AtqServiceFull
- type AtqServiceMinimal
- type AtqSwarm
- type AtqSwarmError
- type AtqTask
- type AtqTaskFull
- type CreateTaskContext
- type DatabindController
- type DeleteTaskContext
- type InspectTaskContext
- func (ctx *InspectTaskContext) ErrorCreatingTheTask(r *AtqTask) error
- func (ctx *InspectTaskContext) ErrorCreatingTheTaskFull(r *AtqTaskFull) error
- func (ctx *InspectTaskContext) OK(r *AtqTask) error
- func (ctx *InspectTaskContext) OKFull(r *AtqTaskFull) error
- func (ctx *InspectTaskContext) TaskNotIdentified() error
- type JoinTokens
- type ListDatabindContext
- type MonitoringController
- type PingMonitoringContext
- type ServicePayload
- type StatusSwarmContext
- type SwarmController
- type TaskController
- type TaskPayload
- type UploadDatabindContext
- func (ctx *UploadDatabindContext) OK(r *AtqDatabindUpload) error
- func (ctx *UploadDatabindContext) OKError(r *AtqDatabindUploadError) error
- func (ctx *UploadDatabindContext) TheFileDoesnTHaveAnAcceptedCompressionError(r *AtqDatabindUploadError) error
- func (ctx *UploadDatabindContext) UploadErrorError(r *AtqDatabindUploadError) error
- type WaitCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MountDatabindController ¶
func MountDatabindController(service *goa.Service, ctrl DatabindController)
MountDatabindController "mounts" a Databind resource controller on the given service.
func MountMonitoringController ¶
func MountMonitoringController(service *goa.Service, ctrl MonitoringController)
MountMonitoringController "mounts" a Monitoring resource controller on the given service.
func MountSwarmController ¶
func MountSwarmController(service *goa.Service, ctrl SwarmController)
MountSwarmController "mounts" a Swarm resource controller on the given service.
func MountTaskController ¶
func MountTaskController(service *goa.Service, ctrl TaskController)
MountTaskController "mounts" a Task resource controller on the given service.
Types ¶
type AtqDatabindUpload ¶
type AtqDatabindUpload struct { // Upload ID ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` }
User upload files response (default view)
Identifier: application/atq.databind.upload+json; view=default
type AtqDatabindUploadCollection ¶
type AtqDatabindUploadCollection []*AtqDatabindUpload
AtqDatabindUploadCollection is the media type for an array of AtqDatabindUpload (default view)
Identifier: application/atq.databind.upload+json; type=collection; view=default
type AtqDatabindUploadError ¶
type AtqDatabindUploadError struct { // Error message if errored Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"` }
User upload files response (error view)
Identifier: application/atq.databind.upload+json; view=error
type AtqDatabindUploadErrorCollection ¶
type AtqDatabindUploadErrorCollection []*AtqDatabindUploadError
AtqDatabindUploadCollection is the media type for an array of AtqDatabindUpload (error view)
Identifier: application/atq.databind.upload+json; type=collection; view=error
type AtqService ¶
type AtqService struct { // ATQ Service internal alias Alias *string `form:"alias,omitempty" json:"alias,omitempty" xml:"alias,omitempty"` // ATQ FileID if exists FileID *string `form:"fileId,omitempty" json:"fileId,omitempty" xml:"fileId,omitempty"` // Docker Service internal identifier ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` }
Created Relevant Service Information (default view)
Identifier: application/atq.service+json; view=default
type AtqServiceFull ¶
type AtqServiceFull struct { // ATQ Service internal alias Alias *string `form:"alias,omitempty" json:"alias,omitempty" xml:"alias,omitempty"` // Arguments passed to the containers Args []string `form:"args,omitempty" json:"args,omitempty" xml:"args,omitempty"` // ATQ FileID if exists FileID *string `form:"fileId,omitempty" json:"fileId,omitempty" xml:"fileId,omitempty"` // Docker Service internal identifier ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Docker Image Name Image *string `form:"image,omitempty" json:"image,omitempty" xml:"image,omitempty"` // Amount of Replicas Replicas *int `form:"replicas,omitempty" json:"replicas,omitempty" xml:"replicas,omitempty"` // Interactive Shell Tty *bool `form:"tty,omitempty" json:"tty,omitempty" xml:"tty,omitempty"` }
Created Relevant Service Information (full view)
Identifier: application/atq.service+json; view=full
type AtqServiceMinimal ¶
type AtqServiceMinimal struct { // Docker Service internal identifier ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` }
Created Relevant Service Information (minimal view)
Identifier: application/atq.service+json; view=minimal
type AtqSwarm ¶
type AtqSwarm struct {
JoinTokens *JoinTokens `form:"joinTokens,omitempty" json:"joinTokens,omitempty" xml:"joinTokens,omitempty"`
}
Swarm Details (default view)
Identifier: application/atq.swarm+json; view=default
type AtqSwarmError ¶
type AtqSwarmError struct { // Swarm Error Message Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"` }
Swarm Details (error view)
Identifier: application/atq.swarm+json; view=error
type AtqTask ¶
type AtqTask struct { // Task ID ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Status of the Task Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"` }
Task description (default view)
Identifier: application/atq.task+json; view=default
type AtqTaskFull ¶
type AtqTaskFull struct { // Manual delay between starting Master and Worker services Delay *int `form:"delay,omitempty" json:"delay,omitempty" xml:"delay,omitempty"` // Task ID ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"` // Master Service definition Master *AtqService `form:"master,omitempty" json:"master,omitempty" xml:"master,omitempty"` // Status of the Task Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"` WaitCommand *WaitCommand `form:"waitCommand,omitempty" json:"waitCommand,omitempty" xml:"waitCommand,omitempty"` // Worker Service definition Worker *AtqService `form:"worker,omitempty" json:"worker,omitempty" xml:"worker,omitempty"` }
Task description (full view)
Identifier: application/atq.task+json; view=full
func (*AtqTaskFull) Validate ¶
func (mt *AtqTaskFull) Validate() (err error)
Validate validates the AtqTaskFull media type instance.
type CreateTaskContext ¶
type CreateTaskContext struct { context.Context *goa.ResponseData *goa.RequestData Payload *TaskPayload }
CreateTaskContext provides the task create action context.
func NewCreateTaskContext ¶
func NewCreateTaskContext(ctx context.Context, r *http.Request, service *goa.Service) (*CreateTaskContext, error)
NewCreateTaskContext parses the incoming request URL and body, performs validations and creates the context used by the task controller create action.
func (*CreateTaskContext) DefinitionError ¶
func (ctx *CreateTaskContext) DefinitionError(r *AtqTask) error
DefinitionError sends a HTTP response with status code 417.
func (*CreateTaskContext) DefinitionErrorFull ¶
func (ctx *CreateTaskContext) DefinitionErrorFull(r *AtqTaskFull) error
DefinitionErrorFull sends a HTTP response with status code 417.
func (*CreateTaskContext) OK ¶
func (ctx *CreateTaskContext) OK(r *AtqTask) error
OK sends a HTTP response with status code 200.
func (*CreateTaskContext) OKFull ¶
func (ctx *CreateTaskContext) OKFull(r *AtqTaskFull) error
OKFull sends a HTTP response with status code 200.
type DatabindController ¶
type DatabindController interface { goa.Muxer List(*ListDatabindContext) error Upload(*UploadDatabindContext) error }
DatabindController is the controller interface for the Databind actions.
type DeleteTaskContext ¶
type DeleteTaskContext struct { context.Context *goa.ResponseData *goa.RequestData ID string }
DeleteTaskContext provides the task delete action context.
func NewDeleteTaskContext ¶
func NewDeleteTaskContext(ctx context.Context, r *http.Request, service *goa.Service) (*DeleteTaskContext, error)
NewDeleteTaskContext parses the incoming request URL and body, performs validations and creates the context used by the task controller delete action.
func (*DeleteTaskContext) OK ¶
func (ctx *DeleteTaskContext) OK() error
OK sends a HTTP response with status code 204.
func (*DeleteTaskContext) TaskCouldNotBeDeleted ¶
func (ctx *DeleteTaskContext) TaskCouldNotBeDeleted() error
TaskCouldNotBeDeleted sends a HTTP response with status code 500.
func (*DeleteTaskContext) TaskNotIdentified ¶
func (ctx *DeleteTaskContext) TaskNotIdentified() error
TaskNotIdentified sends a HTTP response with status code 404.
type InspectTaskContext ¶
type InspectTaskContext struct { context.Context *goa.ResponseData *goa.RequestData ID string }
InspectTaskContext provides the task inspect action context.
func NewInspectTaskContext ¶
func NewInspectTaskContext(ctx context.Context, r *http.Request, service *goa.Service) (*InspectTaskContext, error)
NewInspectTaskContext parses the incoming request URL and body, performs validations and creates the context used by the task controller inspect action.
func (*InspectTaskContext) ErrorCreatingTheTask ¶
func (ctx *InspectTaskContext) ErrorCreatingTheTask(r *AtqTask) error
ErrorCreatingTheTask sends a HTTP response with status code 500.
func (*InspectTaskContext) ErrorCreatingTheTaskFull ¶
func (ctx *InspectTaskContext) ErrorCreatingTheTaskFull(r *AtqTaskFull) error
ErrorCreatingTheTaskFull sends a HTTP response with status code 500.
func (*InspectTaskContext) OK ¶
func (ctx *InspectTaskContext) OK(r *AtqTask) error
OK sends a HTTP response with status code 200.
func (*InspectTaskContext) OKFull ¶
func (ctx *InspectTaskContext) OKFull(r *AtqTaskFull) error
OKFull sends a HTTP response with status code 200.
func (*InspectTaskContext) TaskNotIdentified ¶
func (ctx *InspectTaskContext) TaskNotIdentified() error
TaskNotIdentified sends a HTTP response with status code 404.
type JoinTokens ¶
type JoinTokens struct { Manager *string `form:"manager,omitempty" json:"manager,omitempty" xml:"manager,omitempty"` Worker *string `form:"worker,omitempty" json:"worker,omitempty" xml:"worker,omitempty"` }
Docker Swarm Join Tokens
type ListDatabindContext ¶
type ListDatabindContext struct { context.Context *goa.ResponseData *goa.RequestData }
ListDatabindContext provides the databind list action context.
func NewListDatabindContext ¶
func NewListDatabindContext(ctx context.Context, r *http.Request, service *goa.Service) (*ListDatabindContext, error)
NewListDatabindContext parses the incoming request URL and body, performs validations and creates the context used by the databind controller list action.
func (*ListDatabindContext) NoContent ¶
func (ctx *ListDatabindContext) NoContent() error
NoContent sends a HTTP response with status code 204.
func (*ListDatabindContext) OK ¶
func (ctx *ListDatabindContext) OK(r AtqDatabindUploadCollection) error
OK sends a HTTP response with status code 200.
func (*ListDatabindContext) OKError ¶
func (ctx *ListDatabindContext) OKError(r AtqDatabindUploadErrorCollection) error
OKError sends a HTTP response with status code 200.
type MonitoringController ¶
type MonitoringController interface { goa.Muxer Ping(*PingMonitoringContext) error }
MonitoringController is the controller interface for the Monitoring actions.
type PingMonitoringContext ¶
type PingMonitoringContext struct { context.Context *goa.ResponseData *goa.RequestData }
PingMonitoringContext provides the monitoring ping action context.
func NewPingMonitoringContext ¶
func NewPingMonitoringContext(ctx context.Context, r *http.Request, service *goa.Service) (*PingMonitoringContext, error)
NewPingMonitoringContext parses the incoming request URL and body, performs validations and creates the context used by the monitoring controller ping action.
func (*PingMonitoringContext) Alive ¶
func (ctx *PingMonitoringContext) Alive(resp []byte) error
Alive sends a HTTP response with status code 200.
type ServicePayload ¶
type ServicePayload struct { // Service alias, this will identify the Service Alias string `form:"alias" json:"alias" xml:"alias"` // Arguments to be passed to the container Args []string `form:"args,omitempty" json:"args,omitempty" xml:"args,omitempty"` // Environment variables list Environment []string `form:"environment,omitempty" json:"environment,omitempty" xml:"environment,omitempty"` // ID of the Zipped contents that will be mounted and accesible inside the container, PREVIOUSLY UPLOADED Fileid *string `form:"fileid,omitempty" json:"fileid,omitempty" xml:"fileid,omitempty"` // Docker base image to attach to Service Image string `form:"image" json:"image" xml:"image"` // Amount of replicas to be deployed. (1 by default) Replicas *int `form:"replicas,omitempty" json:"replicas,omitempty" xml:"replicas,omitempty"` // Interactive shell requirement Tty *bool `form:"tty,omitempty" json:"tty,omitempty" xml:"tty,omitempty"` }
ServicePayload user type.
func (*ServicePayload) Validate ¶
func (ut *ServicePayload) Validate() (err error)
Validate validates the ServicePayload type instance.
type StatusSwarmContext ¶
type StatusSwarmContext struct { context.Context *goa.ResponseData *goa.RequestData }
StatusSwarmContext provides the swarm status action context.
func NewStatusSwarmContext ¶
func NewStatusSwarmContext(ctx context.Context, r *http.Request, service *goa.Service) (*StatusSwarmContext, error)
NewStatusSwarmContext parses the incoming request URL and body, performs validations and creates the context used by the swarm controller status action.
func (*StatusSwarmContext) OK ¶
func (ctx *StatusSwarmContext) OK(r *AtqSwarm) error
OK sends a HTTP response with status code 200.
func (*StatusSwarmContext) OKError ¶
func (ctx *StatusSwarmContext) OKError(r *AtqSwarmError) error
OKError sends a HTTP response with status code 200.
func (*StatusSwarmContext) SwarmErrorError ¶
func (ctx *StatusSwarmContext) SwarmErrorError(r *AtqSwarmError) error
SwarmErrorError sends a HTTP response with status code 503.
type SwarmController ¶
type SwarmController interface { goa.Muxer Status(*StatusSwarmContext) error }
SwarmController is the controller interface for the Swarm actions.
type TaskController ¶
type TaskController interface { goa.Muxer Create(*CreateTaskContext) error Delete(*DeleteTaskContext) error Inspect(*InspectTaskContext) error }
TaskController is the controller interface for the Task actions.
type TaskPayload ¶
type TaskPayload struct { Delay *int `form:"delay,omitempty" json:"delay,omitempty" xml:"delay,omitempty"` Master *ServicePayload `form:"master" json:"master" xml:"master"` // Task Name Identifier Name string `form:"name" json:"name" xml:"name"` WaitCommand *WaitCommand `form:"waitCommand,omitempty" json:"waitCommand,omitempty" xml:"waitCommand,omitempty"` Worker *ServicePayload `form:"worker" json:"worker" xml:"worker"` }
TaskPayload user type.
func (*TaskPayload) Validate ¶
func (ut *TaskPayload) Validate() (err error)
Validate validates the TaskPayload type instance.
type UploadDatabindContext ¶
type UploadDatabindContext struct { context.Context *goa.ResponseData *goa.RequestData }
UploadDatabindContext provides the databind upload action context.
func NewUploadDatabindContext ¶
func NewUploadDatabindContext(ctx context.Context, r *http.Request, service *goa.Service) (*UploadDatabindContext, error)
NewUploadDatabindContext parses the incoming request URL and body, performs validations and creates the context used by the databind controller upload action.
func (*UploadDatabindContext) OK ¶
func (ctx *UploadDatabindContext) OK(r *AtqDatabindUpload) error
OK sends a HTTP response with status code 200.
func (*UploadDatabindContext) OKError ¶
func (ctx *UploadDatabindContext) OKError(r *AtqDatabindUploadError) error
OKError sends a HTTP response with status code 200.
func (*UploadDatabindContext) TheFileDoesnTHaveAnAcceptedCompressionError ¶
func (ctx *UploadDatabindContext) TheFileDoesnTHaveAnAcceptedCompressionError(r *AtqDatabindUploadError) error
TheFileDoesnTHaveAnAcceptedCompressionError sends a HTTP response with status code 415.
func (*UploadDatabindContext) UploadErrorError ¶
func (ctx *UploadDatabindContext) UploadErrorError(r *AtqDatabindUploadError) error
UploadErrorError sends a HTTP response with status code 500.
type WaitCommand ¶
type WaitCommand struct { // Command to be executed Command *string `form:"command,omitempty" json:"command,omitempty" xml:"command,omitempty"` // Result expected ExpectedResult *string `form:"expectedResult,omitempty" json:"expectedResult,omitempty" xml:"expectedResult,omitempty"` // Maximum seconds to wait until succesfull response Timeout *int `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"` }
Definition of a command to be executed