Documentation
¶
Index ¶
- type Plugin
- func (*Plugin) AfterInstance(instance *isclib.Instance) error
- func (*Plugin) AfterStart(instance *iscenv.ISCInstance) error
- func (*Plugin) AfterStop(instance *iscenv.ISCInstance) error
- func (*Plugin) BeforeInstance(instance *isclib.Instance) error
- func (*Plugin) BeforeRemove(instance *iscenv.ISCInstance) error
- func (*Plugin) Copies(_ string, _ map[string]interface{}) ([]string, error)
- func (*Plugin) Environment(_ string, flags map[string]interface{}) ([]string, error)
- func (*Plugin) Flags() (iscenv.PluginFlags, error)
- func (*Plugin) Key() string
- func (plugin *Plugin) Main()
- func (*Plugin) Ports(_ string, _ map[string]interface{}) ([]string, error)
- func (*Plugin) Volumes(_ string, _ map[string]interface{}) ([]string, error)
- func (*Plugin) WithInstance(instance *isclib.Instance) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct{}
Plugin represents this plugin and serves as a place to attach functions to implement the Lifecycler interface
func (*Plugin) AfterInstance ¶
AfterInstance will run within the container after the instance stops
func (*Plugin) AfterStart ¶
func (*Plugin) AfterStart(instance *iscenv.ISCInstance) error
AfterStart will run on the host after the container instance starts, receives the same flag values as start
func (*Plugin) AfterStop ¶
func (*Plugin) AfterStop(instance *iscenv.ISCInstance) error
AfterStop will run on the host after the instance stops
func (*Plugin) BeforeInstance ¶
BeforeInstance will run within the container before the instance successfully starts
func (*Plugin) BeforeRemove ¶
func (*Plugin) BeforeRemove(instance *iscenv.ISCInstance) error
BeforeRemove will run on the host before the instance is removed
func (*Plugin) Copies ¶
Copies returns an array of items to copy to the container in the format "src:dest"
func (*Plugin) Environment ¶
Environment returns an array of docker API formatted environment variables (ENV_VAR=value) which will be added to the instance
func (*Plugin) Flags ¶
func (*Plugin) Flags() (iscenv.PluginFlags, error)
Flags returns an array of additional flags to add to the start command
func (*Plugin) Main ¶
func (plugin *Plugin) Main()
Main serves as the main entry point for the plugin
func (*Plugin) Ports ¶
Ports returns an array of additional ports to map in the format <optional hostIP>:hostPort:containerPort. You may also prefix the host port with a + to indicate it should be shifted by the port offset
func (*Plugin) Volumes ¶
Volumes returns an array of volumes to add where the string is a standard docker volume format "src:dest:flag"
func (*Plugin) WithInstance ¶
WithInstance will run within the container after the instance starts
Source Files