Documentation
¶
Index ¶
- Constants
- Variables
- func DontSkipValidation(opts *loader.Options)
- func GetStackServices(ctx context.Context, dockerclient client.APIClient, namespace string) ([]swarm.Service, error)
- func GetStacks(cl *dockerClient.Client) ([]*formatter.Stack, error)
- func LoadComposefile(opts Deploy, appEnv map[string]string, options ...func(*loader.Options)) (*composetypes.Config, error)
- func RunDeploy(cl *dockerClient.Client, opts Deploy, cfg *composetypes.Config, appName string, ...) error
- func RunRemove(ctx context.Context, client *apiclient.Client, opts Remove) error
- func SkipInterpolation(opts *loader.Options)
- func WaitOnServices(ctx context.Context, cl *dockerClient.Client, opts WaitOpts) error
- type Deploy
- type DeployMeta
- type Remove
- type StackStatus
- func GetAllDeployedServices(cl *dockerClient.Client, contextName string) StackStatus
- func GetDeployedServicesByLabel(cl *dockerClient.Client, contextName string, label string) StackStatus
- func GetDeployedServicesByName(ctx context.Context, cl *dockerClient.Client, stackName, serviceName string) StackStatus
- type WaitOpts
Constants ¶
const ( ResolveImageAlways = "always" ResolveImageChanged = "changed" ResolveImageNever = "never" )
Resolve image constants
Variables ¶
var WaitTimeout = 0
Timeout to wait until docker services converge. This timeout is disabled by default but can be configured by passing a TIMEOUT=... in the app .env
Functions ¶
func DontSkipValidation ¶
DontSkipValidation ensures validation is done for compose file loading
func GetStackServices ¶
func GetStacks ¶
func GetStacks(cl *dockerClient.Client) ([]*formatter.Stack, error)
Copypasta from https://github.com/docker/cli/blob/master/cli/command/stack/swarm/list.go GetStacks lists the swarm stacks.
func LoadComposefile ¶
func LoadComposefile(opts Deploy, appEnv map[string]string, options ...func(*loader.Options)) (*composetypes.Config, error)
LoadComposefile parse the composefile specified in the cli and returns its Config and version.
func RunDeploy ¶
func RunDeploy( cl *dockerClient.Client, opts Deploy, cfg *composetypes.Config, appName string, serverName string, dontWait bool, noInput bool, filters filters.Args, ) error
RunDeploy is the swarm implementation of docker stack deploy
func SkipInterpolation ¶
SkipInterpolation skip interpolating environment variables.
func WaitOnServices ¶
Types ¶
type Deploy ¶
type Deploy struct {
Composefiles []string
Namespace string
ResolveImage string
SendRegistryAuth bool
Prune bool
Detach bool
Quiet bool
}
Deploy holds docker stack deploy options
type DeployMeta ¶
type DeployMeta struct {
IsDeployed bool // whether the app is deployed or not
Version string // the deployed version
IsChaos bool // whether or not the deployment is --chaos
ChaosVersion string // the --chaos deployment version
}
DeployMeta is runtime metadata about an app deployment.
func IsDeployed ¶
func IsDeployed(ctx context.Context, cl *dockerClient.Client, stackName string) (DeployMeta, error)
IsDeployed gathers metadata about an app deployment.
func (DeployMeta) String ¶
func (d DeployMeta) String() string
type StackStatus ¶
func GetAllDeployedServices ¶
func GetAllDeployedServices(cl *dockerClient.Client, contextName string) StackStatus
func GetDeployedServicesByLabel ¶
func GetDeployedServicesByLabel(cl *dockerClient.Client, contextName string, label string) StackStatus
GetDeployedServicesByLabel filters services by label
func GetDeployedServicesByName ¶
func GetDeployedServicesByName(ctx context.Context, cl *dockerClient.Client, stackName, serviceName string) StackStatus
GetDeployedServicesByName filters services by name
Source Files