Documentation
¶
Index ¶
- func AppMount(appName string) host.Configurator
- func InstallImage(imageTag string) host.Configurator
- func New(name string, configurators ...Configurator) host.Configurator
- func RunImage(imageTag string, configurators ...RunImageConfigurator) host.Configurator
- type Config
- type Configurator
- type NetworkConfig
- type RunImageConfig
- type RunImageConfigurator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AppMount ¶
func AppMount(appName string) host.Configurator
AppMount returns docker volume definition for app's directory.
func InstallImage ¶
func InstallImage(imageTag string) host.Configurator
InstallImage installs image.
func New ¶
func New(name string, configurators ...Configurator) host.Configurator
New creates container.
func RunImage ¶
func RunImage(imageTag string, configurators ...RunImageConfigurator) host.Configurator
RunImage runs image.
Types ¶
type Config ¶
type Config struct {
Name string
Networks []NetworkConfig
}
Config represents container configuration.
type Configurator ¶
type Configurator func(config *Config)
Configurator defines function setting the container configuration.
func Network ¶
func Network(bridgeName, ifaceName, mac string) Configurator
Network adds network to the config.
type NetworkConfig ¶
type NetworkConfig struct {
BridgeName string
InterfaceName string
MAC net.HardwareAddr
}
NetworkConfig represents container's network configuration.
type RunImageConfig ¶
type RunImageConfig struct {
// EnvVars sets environment variables inside container.
EnvVars map[string]string
// WorkingDir specifies a path to working directory.
WorkingDir string
// Entrypoint sets entrypoint for container.
Entrypoint []string
// Cmd sets command to execute inside container.
Cmd []string
}
RunImageConfig represents container image execution configuration.
type RunImageConfigurator ¶
type RunImageConfigurator func(config *RunImageConfig)
RunImageConfigurator defines function setting the container image execution configuration.
func Cmd ¶
func Cmd(args ...string) RunImageConfigurator
Cmd sets command to execute inside container.
func Entrypoint ¶
func Entrypoint(entrypoint ...string) RunImageConfigurator
Entrypoint sets container's entrypoint.
func EnvVar ¶
func EnvVar(name, value string) RunImageConfigurator
EnvVar sets environment variable inside container.
func WorkingDir ¶
func WorkingDir(workingDir string) RunImageConfigurator
WorkingDir sets working directory inside container.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.