Documentation
¶
Index ¶
- func CheckClientVersion()
- func ComposeExitCode(args ...string) int
- func ComposeResult(args ...string) string
- func ComposeStdout(args ...string)
- func ComposeStreamStdout(args ...string)
- func CreateComposerCacheVolume()
- func CreateDatabaseVolume()
- func CreateNetwork(name string)
- func CreateOrReplaceTokCompose(tokComposeYml []byte)
- func CreateSiteVolume()
- func CreateVolume(name string)
- func DeleteVolume(name string)
- func Down()
- func Exec(args []string)
- func ExecWithExitCode(args []string) (err error)
- func FindOrCreateTokCompose()
- func GetAPIClient() (dcli *client.Client)
- func GetContainer(name, project string) types.Container
- func GetContainerIP(name string) (string, error)
- func GetContainerIPFromProject(containerName, projectName string) (string, error)
- func GetContainerList() []string
- func GetContainerName(name string) (string, error)
- func GetContainers(project string) *[]types.Container
- func GetDockerHost() string
- func GetGateway(projectName string) string
- func GetNetworkName(pn string) string
- func GetTokComposePath() string
- func HardCheckTokCompose()
- func ImageExists(image string) bool
- func KillContainer(container string)
- func LocalPort(containerName string, containerPort string) string
- func MarshalledDefaults() []byte
- func PrintLogs(args []string)
- func PrintPorts(containers []string)
- func Ps()
- func PullImages()
- func StatusCheck(container, project string) (ok bool)
- func Stop()
- func StripModWarning()
- func UnmarshalledDefaults() conf.ComposeDotTok
- func Up()
- func UpContainer(container string)
- func UpMulti(args []string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckClientVersion ¶
func CheckClientVersion()
CheckClientVersion ensures that the client running on this system is supported
func ComposeExitCode ¶
ComposeExitCode - Convenience method for docker-compose shell commands returning just the bash exit code
func ComposeResult ¶
ComposeResult - Convenience method for docker-compose shell commands returning a result
func ComposeStdout ¶
func ComposeStdout(args ...string)
ComposeStdout - Convenience method for docker-compose shell commands
func ComposeStreamStdout ¶
func ComposeStreamStdout(args ...string)
ComposeStreamStdout - Convenience method for docker-compose shell commands
func CreateComposerCacheVolume ¶
func CreateComposerCacheVolume()
CreateComposerCacheVolume will create a composer cache volume if it doesn't already exist
func CreateDatabaseVolume ¶
func CreateDatabaseVolume()
CreateDatabaseVolume will create a database volume if it doesn't already exist
func CreateNetwork ¶
func CreateNetwork(name string)
CreateNetwork creates a Docker network with `name`
func CreateOrReplaceTokCompose ¶
func CreateOrReplaceTokCompose(tokComposeYml []byte)
CreateOrReplaceTokCompose ...
func CreateSiteVolume ¶
func CreateSiteVolume()
CreateSiteVolume will create a Site volume if it doesn't already exist
func CreateVolume ¶
func CreateVolume(name string)
CreateVolume - Create a new docker volume with a name
func ExecWithExitCode ¶
ExecWithExitCode - Execute a command inside the admin container and return an error if it failed to run
func GetAPIClient ¶
GetAPIClient - Returns a Docker API Client
func GetContainer ¶
GetContainer returns a docker Container object for the specified container, if it exists
func GetContainerIPFromProject ¶
GetContainerIPFromProject returns the container IP for a given containerName in a given projectName
func GetContainerList ¶
func GetContainerList() []string
GetContainerList returns a list of all configured containers in the current project context
func GetContainers ¶
GetContainers returns all containers for a project
func GetDockerHost ¶
func GetDockerHost() string
GetDockerHost - Return the value of the docker host that should be used for this system
func GetGateway ¶
GetGateway - Get the Gateway IP adress of the docker network
func GetNetworkName ¶
GetNetworkName takes a project name and returns a matching network name that complies with the same sanitisation that docker compose uses when it auto-generates networks from compose files
func KillContainer ¶
func KillContainer(container string)
KillContainer - Kill an individual container
func PrintLogs ¶
func PrintLogs(args []string)
PrintLogs - Print all logs or the container logs to the console
func PrintPorts ¶
func PrintPorts(containers []string)
PrintPorts - Print a port map of all containers, or a single container
func StatusCheck ¶
StatusCheck tests for containers 'running' state. If one container is specified and true if that container is 'running' If no container is specified, all containers must be 'running' or will return false
Types ¶
This section is empty.