Documentation
¶
Index ¶
- func BuildChainGroup(chainName string, services []*definitions.ServiceDefinition) (servicesAndChains []*definitions.ServiceDefinition, err error)
- func BuildServicesGroup(srvName string, cNum int, services ...*definitions.ServiceDefinition) ([]*definitions.ServiceDefinition, error)
- func CatService(do *definitions.Do) error
- func ConnectChainToService(chainFlag, chainNameAndOpts string, srv *definitions.ServiceDefinition) (*definitions.ServiceDefinition, error)
- func EditService(do *definitions.Do) error
- func EnsureRunning(do *definitions.Do) error
- func ExecService(do *definitions.Do) error
- func ExecServiceByService(srvMain *definitions.Service, ops *definitions.Operation, cmd []string, ...) error
- func ExportService(do *definitions.Do) error
- func FindServiceDefinitionFile(name string) string
- func ImportService(do *definitions.Do) error
- func InspectService(do *definitions.Do) error
- func InspectServiceByService(srv *definitions.Service, ops *definitions.Operation, field string) error
- func IsServiceExisting(service *definitions.Service, ops *definitions.Operation) bool
- func IsServiceKnown(service *definitions.Service, ops *definitions.Operation) bool
- func IsServiceRunning(service *definitions.Service, ops *definitions.Operation) bool
- func KillService(do *definitions.Do) error
- func KillServiceByService(srvMain *definitions.Service, ops *definitions.Operation, timeout uint) error
- func ListExisting(do *definitions.Do) error
- func ListKnown(do *definitions.Do) error
- func ListRunning(do *definitions.Do) error
- func LogsService(do *definitions.Do) error
- func LogsServiceByService(srv *definitions.Service, ops *definitions.Operation, follow bool, tail string) error
- func NewService(do *definitions.Do) error
- func PortsService(do *definitions.Do) error
- func RenameService(do *definitions.Do) error
- func RmService(do *definitions.Do) error
- func StartGroup(group []*definitions.ServiceDefinition) error
- func StartService(do *definitions.Do) (err error)
- func StartServiceByService(srvMain *definitions.Service, ops *definitions.Operation) error
- func UpdateService(do *definitions.Do) error
- func WriteServiceDefinitionFile(serviceDef *def.ServiceDefinition, fileName string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildChainGroup ¶
func BuildChainGroup(chainName string, services []*definitions.ServiceDefinition) (servicesAndChains []*definitions.ServiceDefinition, err error)
BuildChainGroup adds the chain specified in each service definition to the service group. If chainName is not empty, it will overwrite chains specified in the defs. Service defs which don't specify a chain or $chain won't connect to a chain. NOTE: chains have to be started before services that depend on them.
func BuildServicesGroup ¶
func BuildServicesGroup(srvName string, cNum int, services ...*definitions.ServiceDefinition) ([]*definitions.ServiceDefinition, error)
TODO: test this recursion and service deps generally
func CatService ¶
func CatService(do *definitions.Do) error
func ConnectChainToService ¶ added in v0.10.2
func ConnectChainToService(chainFlag, chainNameAndOpts string, srv *definitions.ServiceDefinition) (*definitions.ServiceDefinition, error)
func EditService ¶
func EditService(do *definitions.Do) error
func EnsureRunning ¶
func EnsureRunning(do *definitions.Do) error
EnsureRunning checks if a service is running and starts it if not TODO: ping all exposed ports until at least one is available (issue #149) NOTE: does not accept ENV vars
func ExecService ¶ added in v0.10.2
func ExecService(do *definitions.Do) error
func ExecServiceByService ¶ added in v0.10.2
func ExecServiceByService(srvMain *definitions.Service, ops *definitions.Operation, cmd []string, attach bool) error
func ExportService ¶
func ExportService(do *definitions.Do) error
func ImportService ¶
func ImportService(do *definitions.Do) error
func InspectService ¶
func InspectService(do *definitions.Do) error
func InspectServiceByService ¶
func InspectServiceByService(srv *definitions.Service, ops *definitions.Operation, field string) error
func IsServiceExisting ¶
func IsServiceExisting(service *definitions.Service, ops *definitions.Operation) bool
func IsServiceKnown ¶
func IsServiceKnown(service *definitions.Service, ops *definitions.Operation) bool
func IsServiceRunning ¶
func IsServiceRunning(service *definitions.Service, ops *definitions.Operation) bool
func KillService ¶
func KillService(do *definitions.Do) error
func KillServiceByService ¶
func KillServiceByService(srvMain *definitions.Service, ops *definitions.Operation, timeout uint) error
func ListExisting ¶
func ListExisting(do *definitions.Do) error
func ListKnown ¶
func ListKnown(do *definitions.Do) error
func ListRunning ¶
func ListRunning(do *definitions.Do) error
func LogsService ¶
func LogsService(do *definitions.Do) error
func LogsServiceByService ¶
func LogsServiceByService(srv *definitions.Service, ops *definitions.Operation, follow bool, tail string) error
func NewService ¶
func NewService(do *definitions.Do) error
func PortsService ¶ added in v0.10.2
func PortsService(do *definitions.Do) error
func RenameService ¶
func RenameService(do *definitions.Do) error
func RmService ¶
func RmService(do *definitions.Do) error
func StartGroup ¶
func StartGroup(group []*definitions.ServiceDefinition) error
start a group of chains or services. catch errors on a channel so we can stop as soon as something goes wrong
func StartService ¶
func StartService(do *definitions.Do) (err error)
func StartServiceByService ¶
func StartServiceByService(srvMain *definitions.Service, ops *definitions.Operation) error
func UpdateService ¶
func UpdateService(do *definitions.Do) error
func WriteServiceDefinitionFile ¶
func WriteServiceDefinitionFile(serviceDef *def.ServiceDefinition, fileName string) error
if given empty string for fileName will use Service Definition Name
Types ¶
This section is empty.