arguments

Documentation

Index

• func AttachStreams(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildCommand(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildDaemonFlag(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildEntryPoint(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildEnvFile(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildEnvVars(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildIP(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildImage(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildImpersonation(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildInteractiveFlag(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildLinks(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildNetwork(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildPorts(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildPortsFromParams(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildRemoveContainerFlag(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildTerminalContext(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildVolumes(commandDef *config.CommandDefinition, builder builder.Builder) error
• func BuildWorkDir(commandDef *config.CommandDefinition, builder builder.Builder) error
• func LabelContainer(commandDef *config.CommandDefinition, builder builder.Builder) error
• type ArgumentBuilderInterface
  • func NewNameArgumentBuilder() ArgumentBuilderInterface
  • func NewUserGroupsArgumentBuilder() ArgumentBuilderInterface

Functions

func AttachStreams

func AttachStreams(commandDef *config.CommandDefinition, builder builder.Builder) error

AttachStreams attaches STDIN, STDOUT and STDERR to docker run call

func BuildCommand

func BuildCommand(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildCommand sets the docker command (aka CMD)

func BuildDaemonFlag

func BuildDaemonFlag(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildDaemonFlag sets the daemon flag, which starts the container in background

func BuildEntryPoint

func BuildEntryPoint(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildEntryPoint sets the docker entrypoint

func BuildEnvFile

func BuildEnvFile(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildEnvFile maps the given env file into the container

func BuildEnvVars

func BuildEnvVars(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildEnvVars adds environment variable mappings

func BuildIP

func BuildIP(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildIP maps the given Ip file into the container

func BuildImage

func BuildImage(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildImage sets the docker image

func BuildImpersonation

func BuildImpersonation(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildImpersonation uses the current user and its group inside the container. (linux only)

func BuildInteractiveFlag

func BuildInteractiveFlag(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildInteractiveFlag sets the interactive flag, which enables user interaction

func BuildLinks

func BuildLinks(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildLinks maps Links from host to container

func BuildNetwork

func BuildNetwork(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildNetwork maps the given docker network into the container

func BuildPorts

func BuildPorts(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildPorts sets mappings of host ports to container ports

func BuildPortsFromParams

func BuildPortsFromParams(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildPortsFromParams sets mappings of host ports to container ports

func BuildRemoveContainerFlag

func BuildRemoveContainerFlag(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildRemoveContainerFlag adds --rm flag to remove container after it terminated

func BuildTerminalContext

func BuildTerminalContext(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildTerminalContext sets -t if terminal context was detected

func BuildVolumes

func BuildVolumes(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildVolumes maps volumes from host to container

func BuildWorkDir

func BuildWorkDir(commandDef *config.CommandDefinition, builder builder.Builder) error

BuildWorkDir sets the working directory inside the container

func LabelContainer

func LabelContainer(commandDef *config.CommandDefinition, builder builder.Builder) error

LabelContainer labels the container

Types

type ArgumentBuilderInterface

type ArgumentBuilderInterface interface {
	BuildArgument(commandDef *config.CommandDefinition, builder builder.Builder) error
}

ArgumentBuilderInterface defines an interface for building an argument of the command line from configuration. It's intention is to convert one configuration value into one command line parameter, like for example: RemoveContainer:true will be converted into command parameter "--rm".

func NewNameArgumentBuilder

func NewNameArgumentBuilder() ArgumentBuilderInterface

NewNameArgumentBuilder has no implementation for windows, it is stubbed out

func NewUserGroupsArgumentBuilder

func NewUserGroupsArgumentBuilder() ArgumentBuilderInterface

NewUserGroupsArgumentBuilder has no implementation for windows, it is stubbed out