docker

Documentation

Index

• func ClearWhenInterruption(options configmanager.RawOptions) error
• func ComposeDown(options configmanager.RawOptions) error
• func ComposeStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)
• func ComposeUp(options configmanager.RawOptions) error
• func DeleteAll(options configmanager.RawOptions) error
• func GetRunningStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)
• func GetStaticStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)
• func Install(options configmanager.RawOptions) error
• func PathExist(path string) bool
• func RemoveDirs(dirs []string) []error
• func Validate(options configmanager.RawOptions) (configmanager.RawOptions, error)
• type Options
  • func NewOptions(options configmanager.RawOptions) (Options, error)
  • func (opts *Options) GetImageNameWithTag() string
  • func (opts *Options) GetRunOpts() *docker.RunOptions
• type State
  • func (s *State) ToMap() (map[string]interface{}, error)

Functions

func ClearWhenInterruption

func ClearWhenInterruption(options configmanager.RawOptions) error

ClearWhenInterruption will delete the container if the container fails to run

func ComposeDown

func ComposeDown(options configmanager.RawOptions) error

func ComposeStatus

func ComposeStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)

func ComposeUp

func ComposeUp(options configmanager.RawOptions) error

func DeleteAll

func DeleteAll(options configmanager.RawOptions) error

DeleteAll will delete the container/volumes

func GetRunningStatus

func GetRunningStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)

func GetStaticStatus

func GetStaticStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error)

func Install

func Install(options configmanager.RawOptions) error

Install runs the docker container

func PathExist

func PathExist(path string) bool

func RemoveDirs

func RemoveDirs(dirs []string) []error

RemoveDirs removes the all the directories in the given list recursively

func Validate

func Validate(options configmanager.RawOptions) (configmanager.RawOptions, error)

Types

type Options

type Options struct {
	ImageName         string `validate:"required"`
	ImageTag          string `validate:"required"`
	ContainerName     string `validate:"required"`
	RmDataAfterDelete *bool

	RunParams     []string
	Hostname      string
	PortPublishes []docker.PortPublish
	Volumes       docker.Volumes
	RestartAlways bool
}

func NewOptions

func NewOptions(options configmanager.RawOptions) (Options, error)

NewOptions create options by raw options

func (*Options) GetImageNameWithTag

func (opts *Options) GetImageNameWithTag() string

func (*Options) GetRunOpts

func (opts *Options) GetRunOpts() *docker.RunOptions

type State

type State struct {
	ContainerRunning bool
	Volumes          []string
	Hostname         string
	PortPublishes    []docker.PortPublish
}

func (*State) ToMap

func (s *State) ToMap() (map[string]interface{}, error)