models

Documentation

Index

• Constants
• type DockerEngineBuilder
  • func NewDockerEngineBuilder(image string) *DockerEngineBuilder
  • func (b *DockerEngineBuilder) Build() *models.SpecConfig
  • func (b *DockerEngineBuilder) WithEntrypoint(e ...string) *DockerEngineBuilder
  • func (b *DockerEngineBuilder) WithEnvironmentVariables(e ...string) *DockerEngineBuilder
  • func (b *DockerEngineBuilder) WithParameters(e ...string) *DockerEngineBuilder
  • func (b *DockerEngineBuilder) WithWorkingDirectory(e string) *DockerEngineBuilder
• type EngineSpec
  • func DecodeSpec(spec *models.SpecConfig) (EngineSpec, error)
  • func (c EngineSpec) ToMap() map[string]interface{}
  • func (c EngineSpec) Validate() error

Constants

const (
	EngineKeyImageDocker                = "Image"
	EngineKeyEntrypointDocker           = "Entrypoint"
	EngineKeyParametersDocker           = "Parameters"
	EngineKeyEnvironmentVariablesDocker = "EnvironmentVariables"
	EngineKeyWorkingDirectoryDocker     = "WorkingDirectory"
)

Types

type DockerEngineBuilder

type DockerEngineBuilder struct {
	// contains filtered or unexported fields
}

DockerEngineBuilder is a struct that is used for constructing an EngineSpec object specifically for Docker engines using the Builder pattern. It embeds an EngineBuilder object for handling the common builder methods.

func NewDockerEngineBuilder

func NewDockerEngineBuilder(image string) *DockerEngineBuilder

NewDockerEngineBuilder function initializes a new DockerEngineBuilder instance. It sets the engine type to model.EngineDocker.String() and image as per the input argument.

func (*DockerEngineBuilder) Build

func (b *DockerEngineBuilder) Build() *models.SpecConfig

Build method constructs the final SpecConfig object by calling the embedded EngineBuilder's Build method.

func (*DockerEngineBuilder) WithEntrypoint

func (b *DockerEngineBuilder) WithEntrypoint(e ...string) *DockerEngineBuilder

WithEntrypoint is a builder method that sets the Docker engine entrypoint. It returns the DockerEngineBuilder for further chaining of builder methods.

func (*DockerEngineBuilder) WithEnvironmentVariables

func (b *DockerEngineBuilder) WithEnvironmentVariables(e ...string) *DockerEngineBuilder

WithEnvironmentVariables is a builder method that sets the Docker engine's environment variables. It returns the DockerEngineBuilder for further chaining of builder methods.

func (*DockerEngineBuilder) WithParameters

func (b *DockerEngineBuilder) WithParameters(e ...string) *DockerEngineBuilder

WithParameters is a builder method that sets the Docker engine's parameters. It returns the DockerEngineBuilder for further chaining of builder methods.

func (*DockerEngineBuilder) WithWorkingDirectory

func (b *DockerEngineBuilder) WithWorkingDirectory(e string) *DockerEngineBuilder

WithWorkingDirectory is a builder method that sets the Docker engine's working directory. It returns the DockerEngineBuilder for further chaining of builder methods.

type EngineSpec

type EngineSpec struct {
	// Image this should be pullable by docker
	Image string `json:"Image,omitempty"`
	// Entrypoint optionally override the default entrypoint
	Entrypoint []string `json:"Entrypoint,omitempty"`
	// Parameters holds additional commandline arguments
	Parameters []string `json:"Parameters,omitempty"`
	// EnvironmentVariables is a slice of env to run the container with
	EnvironmentVariables []string `json:"EnvironmentVariables,omitempty"`
	// WorkingDirectory inside the container
	WorkingDirectory string `json:"WorkingDirectory,omitempty"`
}

EngineSpec contains necessary parameters to execute a docker job.

func DecodeSpec

func DecodeSpec(spec *models.SpecConfig) (EngineSpec, error)

func (EngineSpec) ToMap

func (c EngineSpec) ToMap() map[string]interface{}

func (EngineSpec) Validate

func (c EngineSpec) Validate() error