container

Documentation

Overview

Package container provides container-related API handlers.

Index

• func Handler(logger *slog.Logger, jobClient client.JobClient, signingKey string, ...) []func(e *echo.Echo)
• type Container
  • func New(logger *slog.Logger, jobClient client.JobClient) *Container
  • func (s *Container) DeleteNodeContainerDockerByID(ctx context.Context, request gen.DeleteNodeContainerDockerByIDRequestObject) (gen.DeleteNodeContainerDockerByIDResponseObject, error)
  • func (s *Container) DeleteNodeContainerDockerImage(ctx context.Context, request gen.DeleteNodeContainerDockerImageRequestObject) (gen.DeleteNodeContainerDockerImageResponseObject, error)
  • func (s *Container) GetNodeContainerDocker(ctx context.Context, request gen.GetNodeContainerDockerRequestObject) (gen.GetNodeContainerDockerResponseObject, error)
  • func (s *Container) GetNodeContainerDockerByID(ctx context.Context, request gen.GetNodeContainerDockerByIDRequestObject) (gen.GetNodeContainerDockerByIDResponseObject, error)
  • func (s *Container) PostNodeContainerDocker(ctx context.Context, request gen.PostNodeContainerDockerRequestObject) (gen.PostNodeContainerDockerResponseObject, error)
  • func (s *Container) PostNodeContainerDockerExec(ctx context.Context, request gen.PostNodeContainerDockerExecRequestObject) (gen.PostNodeContainerDockerExecResponseObject, error)
  • func (s *Container) PostNodeContainerDockerPull(ctx context.Context, request gen.PostNodeContainerDockerPullRequestObject) (gen.PostNodeContainerDockerPullResponseObject, error)
  • func (s *Container) PostNodeContainerDockerStart(ctx context.Context, request gen.PostNodeContainerDockerStartRequestObject) (gen.PostNodeContainerDockerStartResponseObject, error)
  • func (s *Container) PostNodeContainerDockerStop(ctx context.Context, request gen.PostNodeContainerDockerStopRequestObject) (gen.PostNodeContainerDockerStopResponseObject, error)

Functions

func Handler

func Handler(
	logger *slog.Logger,
	jobClient client.JobClient,
	signingKey string,
	customRoles map[string][]string,
) []func(e *echo.Echo)

Handler returns Docker route registration functions.

Types

type Container

type Container struct {
	// JobClient provides job-based operations for container management.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

Container implementation of the Container APIs operations.

func New

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *Container

New factory to create a new instance.

func (*Container) DeleteNodeContainerDockerByID

func (s *Container) DeleteNodeContainerDockerByID(
	ctx context.Context,
	request gen.DeleteNodeContainerDockerByIDRequestObject,
) (gen.DeleteNodeContainerDockerByIDResponseObject, error)

DeleteNodeContainerDockerByID removes a container from a target node.

func (*Container) DeleteNodeContainerDockerImage

func (s *Container) DeleteNodeContainerDockerImage(
	ctx context.Context,
	request gen.DeleteNodeContainerDockerImageRequestObject,
) (gen.DeleteNodeContainerDockerImageResponseObject, error)

DeleteNodeContainerDockerImage removes a container image from a target node.

func (*Container) GetNodeContainerDocker

func (s *Container) GetNodeContainerDocker(
	ctx context.Context,
	request gen.GetNodeContainerDockerRequestObject,
) (gen.GetNodeContainerDockerResponseObject, error)

GetNodeContainerDocker lists containers on a target node.

func (*Container) GetNodeContainerDockerByID

func (s *Container) GetNodeContainerDockerByID(
	ctx context.Context,
	request gen.GetNodeContainerDockerByIDRequestObject,
) (gen.GetNodeContainerDockerByIDResponseObject, error)

GetNodeContainerDockerByID inspects a container on a target node.

func (*Container) PostNodeContainerDocker

func (s *Container) PostNodeContainerDocker(
	ctx context.Context,
	request gen.PostNodeContainerDockerRequestObject,
) (gen.PostNodeContainerDockerResponseObject, error)

PostNodeContainerDocker creates a container on a target node.

func (*Container) PostNodeContainerDockerExec

func (s *Container) PostNodeContainerDockerExec(
	ctx context.Context,
	request gen.PostNodeContainerDockerExecRequestObject,
) (gen.PostNodeContainerDockerExecResponseObject, error)

PostNodeContainerDockerExec executes a command in a container on a target node.

func (*Container) PostNodeContainerDockerPull

func (s *Container) PostNodeContainerDockerPull(
	ctx context.Context,
	request gen.PostNodeContainerDockerPullRequestObject,
) (gen.PostNodeContainerDockerPullResponseObject, error)

PostNodeContainerDockerPull pulls a container image on a target node.

func (*Container) PostNodeContainerDockerStart

func (s *Container) PostNodeContainerDockerStart(
	ctx context.Context,
	request gen.PostNodeContainerDockerStartRequestObject,
) (gen.PostNodeContainerDockerStartResponseObject, error)

PostNodeContainerDockerStart starts a container on a target node.

func (*Container) PostNodeContainerDockerStop

func (s *Container) PostNodeContainerDockerStop(
	ctx context.Context,
	request gen.PostNodeContainerDockerStopRequestObject,
) (gen.PostNodeContainerDockerStopResponseObject, error)

PostNodeContainerDockerStop stops a container on a target node.