Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

app

package

Go to main page

Versions in this module

v3

v3.16.4

May 7, 2024

v3.16.3

Apr 10, 2024

v3.16.2

Apr 4, 2024

v3.16.1

Mar 27, 2024

v3.16.0

Feb 26, 2024

Changes in this version

type DockerStartOptions

+ Username string

v3.15.3

Feb 7, 2024

v3.15.2

Jan 29, 2024

v3.15.1

Jan 29, 2024

v3.15.0

Jan 26, 2024

v3.14.10

Jan 25, 2024

v3.14.9

Dec 21, 2023

v3.14.8

Dec 19, 2023

v3.14.7

Oct 12, 2023

v3.14.6

Aug 11, 2023

v3.14.5

Aug 10, 2023

v3.14.4

Feb 24, 2023

v3.14.3

Feb 23, 2023

v3.14.2

Sep 30, 2022

v3.14.1

Sep 29, 2022

Changes in this version

+ const StartPhaseEventAfterInstance

+ const StartPhaseEventBeforeInstance

+ const StartPhaseEventWithInstance

+ const StartPhaseInitManager

+ const StartPhaseInitPlugins

+ const StartPhaseInstanceRunning

+ const StartPhaseShutdown

+ const StartPhaseStartup

+ var DockerClient *docker.Client

+ var ErrFailedEventPlugin = errors.New("Failed to execute event plugin")

+ var ErrFailedToAddPluginFlags = errors.New("Failed to add flags from plugin")

+ var ErrNoSuchInstance = errors.New("No such instance")

+ var ErrNotInContainer = errors.New("Not in Docker container")

+ var ErrSingleInstanceArg = errors.New("Must provide a single instance as the first argument")

+ func DockerCopy(instance *iscenv.ISCInstance, instancePath, localPath string) error

+ func DockerExec(instance *iscenv.ISCInstance, interactive bool, commandAndArgs ...string) error

+ func DockerLogs(instance *iscenv.ISCInstance, since int64, tail string, follow bool, ...) error

+ func DockerPort(port iscenv.ContainerPort) docker.Port

+ func DockerPortBinding(port int64, portOffset int64) []docker.PortBinding

+ func DockerPull(image, tag string) error

+ func DockerRemove(instance *iscenv.ISCInstance) error

+ func DockerRepoLogger(repo string) *log.Entry

+ func DockerStart(opts DockerStartOptions) (id string, err error)

+ func EnsureWithinContainer(commandName string) error

+ func ErrorLogger(logger log.FieldLogger, err error) *log.Entry

+ func FileExists(path string) bool

+ func FindInstance(instanceName string) *iscenv.ISCInstance

+ func FindInstanceAndLogger(instanceName string) (*iscenv.ISCInstance, *log.Entry)

+ func GetContainerForInstance(instance *iscenv.ISCInstance) (*docker.Container, error)

+ func GetDocker0InterfaceIP() (string, error)

+ func GetDockerBindingPort(bindings []docker.PortBinding) (iscenv.ContainerPort, error)

+ func GetInstanceStartTime(instance *iscenv.ISCInstance) (time.Time, error)

+ func GetInstances() iscenv.ISCInstances

+ func InstanceLogger(instance *iscenv.ISCInstance) *log.Entry

+ func InstanceLoggerArgs(instanceName, instanceID string) *log.Entry

+ func IsUserRoot() error

+ func NewRawTTYStdin() (tty *rawTTYStdin, err error)

+ func PluginLogger(id, method, path string) *log.Entry

+ func Relog(plog log.FieldLogger, preserveTimestamp bool, rlog map[string]interface{})

+ func RelogStream(plog log.FieldLogger, preserveTimestamp bool, r io.Reader)

+ func WaitForInstance(instance *iscenv.ISCInstance, timeout time.Duration) error

+ func WaitForInstanceForever(instance *iscenv.ISCInstance, c chan error)

+ func WaitForPort(ip string, port string, timeout time.Duration) error

+ func WaitForPortForever(ip string, port string, c chan error)

+ type DockerConfigError struct

+ ConfigPath string

+ Err error

+ Registry string

+ func NewDockerConfigError(path, registry string, err error) *DockerConfigError

+ func (dce *DockerConfigError) Error() string

+ type DockerExecError struct

+ ExitCode int

+ func (dee DockerExecError) Error() string

+ type DockerStartOptions struct

+ Command []string

+ ContainerLinks []string

+ Copies []string

+ DisablePortOffsetConflictCheck bool

+ Entrypoint []string

+ Environment []string

+ FullName string

+ Labels map[string]string

+ Name string

+ PortOffset int64

+ PortOffsetSearch bool

+ Ports []string

+ Recreate bool

+ Repository string

+ Version string

+ Volumes []string

+ VolumesFrom []string

+ func (opts *DockerStartOptions) ContainerName() string

+ func (opts *DockerStartOptions) InternalVolumes() map[string]struct{}

+ func (opts *DockerStartOptions) ToCreateContainerOptions() *docker.CreateContainerOptions

+ func (opts *DockerStartOptions) ToDockerPortBindings() map[docker.Port][]docker.PortBinding

+ func (opts *DockerStartOptions) ToExposedPorts() map[docker.Port]struct{}

+ func (opts *DockerStartOptions) ToHostConfig() *docker.HostConfig

+ func (opts *DockerStartOptions) VolumeBinds() []string

+ type ISCInstanceManager struct

+ InstanceRunningHandler InstanceStateFn

+ PrimaryCommand string

+ PrimaryCommandNamespace string

+ func NewISCInstanceManager(instanceName string, ccontrolPath string, csessionPath string, ...) (*ISCInstanceManager, error)

+ func (eim *ISCInstanceManager) Manage() error

+ type InstanceError struct

+ Err error

+ InstanceID string

+ InstanceName string

+ func NewInstanceError(name, id string, err error) *InstanceError

+ func (ie *InstanceError) Error() string

+ type InstanceStateFn func(instance *isclib.Instance)

+ type PluginError struct

+ Err error

+ Plugin string

+ PluginMethod string

+ PluginPath string

+ func NewPluginError(plugin, method, path string, err error) *PluginError

+ func (pe *PluginError) Error() string

+ type StartPhase uint

+ type StartStatus struct

+ ActivePlugins []string

+ ExecutingPlugin string

+ InstanceState *isclib.Instance

+ Phase StartPhase

+ func NewStartStatus() *StartStatus

+ func (ss *StartStatus) Update(phase StartPhase, state *isclib.Instance, executingPlugin string)

+ type TTYSizeChangeHandler func(height, width int)

Other modules containing this package

github.com/ontariosystems/iscenv