internal

Documentation

Index

• Variables
• func DeployOverview(app appPkg.App, warnMessages []string, version, chaosVersion string) error
• func EnsureCommand(abraSh, recipeName, execCmd string) error
• func GetBumpType() string
• func GetMainAppImage(recipe recipe.Recipe) (string, error)
• func NewVersionOverview(app appPkg.App, warnMessages []string, ...) error
• func PostCmds(cl *dockerClient.Client, app appPkg.App, commands string) error
• func PromptBumpType(tagString, latestRelease string) error
• func RetrieveBackupBotContainer(cl *dockerClient.Client) (types.Container, error)
• func ReverseStringList(strings []string) []string
• func RunBackupCmdRemote(cl *dockerClient.Client, backupCmd string, containerID string, ...) error
• func RunCmd(cmd *exec.Cmd) error
• func RunCmdRemote(cl *dockerClient.Client, app appPkg.App, ...) error
• func SetBumpType(bumpType string)
• func ShowSubcommandHelpAndError(cmd *cli.Command, err interface{})
• func SubCommandBefore(ctx context.Context, cmd *cli.Command) error
• func ValidateApp(cmd *cli.Command) app.App
• func ValidateDomain(cmd *cli.Command) string
• func ValidateRecipe(cmd *cli.Command) recipe.Recipe
• func ValidateServer(cmd *cli.Command) string
• func ValidateSubCmdFlags(cmd *cli.Command) bool

Variables

var AllServices bool

var AllServicesFlag = &cli.BoolFlag{
	Name:        "all-services",
	Aliases:     []string{"a"},
	Usage:       "Restart all services",
	Destination: &AllServices,
}

var AllTags bool

var AllTagsFlag = &cli.BoolFlag{
	Name:        "all-tags",
	Aliases:     []string{"a"},
	Usage:       "List all tags, not just upgrades",
	Destination: &AllTags,
}

var Chaos bool

Chaos engages chaos mode.

var ChaosFlag = &cli.BoolFlag{
	Name:        "chaos",
	Aliases:     []string{"C"},
	Usage:       "Ignore uncommitted recipes changes. Use with care!",
	Destination: &Chaos,
}

ChaosFlag turns on/off chaos functionality.

var Debug bool

Debug stores the variable from DebugFlag.

var DebugFlag = &cli.BoolFlag{
	Name:        "debug",
	Aliases:     []string{"d"},
	Destination: &Debug,
	Usage:       "Show DEBUG messages",
}

DebugFlag turns on/off verbose logging down to the DEBUG level.

var Domain string

var DomainFlag = &cli.StringFlag{
	Name:        "domain",
	Aliases:     []string{"D"},
	Value:       "",
	Usage:       "Choose a domain name",
	Destination: &Domain,
}

var DontWaitConverge bool

var DontWaitConvergeFlag = &cli.BoolFlag{
	Name:        "no-converge-checks",
	Aliases:     []string{"c"},
	Usage:       "Don't wait for converge logic checks",
	Destination: &DontWaitConverge,
}

var Dry bool

var DryFlag = &cli.BoolFlag{
	Name:        "dry-run",
	Aliases:     []string{"r"},
	Usage:       "Only reports changes that would be made",
	Destination: &Dry,
}

var File bool

var FileFlag = &cli.BoolFlag{
	Name:        "file",
	Aliases:     []string{"f"},
	Usage:       "Treat input as a file",
	Destination: &File,
}

var Force bool

Force force functionality without asking.

var ForceFlag = &cli.BoolFlag{
	Name:        "force",
	Aliases:     []string{"f"},
	Usage:       "Perform action without further prompt. Use with care!",
	Destination: &Force,
}

ForceFlag turns on/off force functionality.

var GitEmail string

var GitEmailFlag = &cli.StringFlag{
	Name:        "git-email",
	Aliases:     []string{"ge"},
	Value:       "",
	Usage:       "Git email name to do commits with",
	Destination: &GitEmail,
}

var GitName string

var GitNameFlag = &cli.StringFlag{
	Name:        "git-name",
	Aliases:     []string{"gn"},
	Value:       "",
	Usage:       "Git (user) name to do commits with",
	Destination: &GitName,
}

var LocalCmd bool

var LocalCmdFlag = &cli.BoolFlag{
	Name:        "local",
	Aliases:     []string{"l"},
	Usage:       "Run command locally",
	Destination: &LocalCmd,
}

var MachineReadable bool

MachineReadable stores the variable from MachineReadableFlag

var MachineReadableFlag = &cli.BoolFlag{
	Name:        "machine",
	Aliases:     []string{"m"},
	Destination: &MachineReadable,
	Usage:       "Machine-readable output",
}

MachineReadableFlag turns on/off machine readable output where supported

var Major bool

var MajorFlag = &cli.BoolFlag{
	Name:        "major",
	Aliases:     []string{"x"},
	Usage:       "Increase the major part of the version",
	Destination: &Major,
}

var Minor bool

var MinorFlag = &cli.BoolFlag{
	Name:        "minor",
	Aliases:     []string{"y"},
	Usage:       "Increase the minor part of the version",
	Destination: &Minor,
}

var NewAppServer string

var NewAppServerFlag = &cli.StringFlag{
	Name:        "server",
	Aliases:     []string{"s"},
	Value:       "",
	Usage:       "Show apps of a specific server",
	Destination: &NewAppServer,
}

var NoDomainChecks bool

var NoDomainChecksFlag = &cli.BoolFlag{
	Name:        "no-domain-checks",
	Aliases:     []string{"D"},
	Usage:       "Disable public DNS checks",
	Destination: &NoDomainChecks,
}

var NoInput bool

var NoInputFlag = &cli.BoolFlag{
	Name:        "no-input",
	Aliases:     []string{"n"},
	Usage:       "Toggle non-interactive mode",
	Destination: &NoInput,
}

var Offline bool

Offline stores the variable from OfflineFlag.

var OfflineFlag = &cli.BoolFlag{
	Name:        "offline",
	Aliases:     []string{"o"},
	Destination: &Offline,
	Usage:       "Prefer offline & filesystem access",
}

DebugFlag turns on/off offline mode.

var OnlyErrorFlag = &cli.BoolFlag{
	Name:        "errors",
	Aliases:     []string{"e"},
	Usage:       "Only show errors",
	Destination: &OnlyErrors,
}

var OnlyErrors bool

var Pass bool

Pass stores the variable from PassFlag

var PassFlag = &cli.BoolFlag{
	Name:        "pass",
	Aliases:     []string{"p"},
	Usage:       "Store the generated secrets in a local pass store",
	Destination: &Pass,
}

PassFlag turns on/off storing generated secrets in pass

var PassRemove bool

PassRemove stores the variable for PassRemoveFlag

var PassRemoveFlag = &cli.BoolFlag{
	Name:        "pass",
	Aliases:     []string{"p"},
	Usage:       "Remove generated secrets from a local pass store",
	Destination: &PassRemove,
}

PassRemoveFlag turns on/off removing generated secrets from pass

var Patch bool

var PatchFlag = &cli.BoolFlag{
	Name:        "patch",
	Aliases:     []string{"z"},
	Usage:       "Increase the patch part of the version",
	Destination: &Patch,
}

var Publish bool

var PublishFlag = &cli.BoolFlag{
	Name:        "publish",
	Aliases:     []string{"p"},
	Usage:       "Publish changes to git.coopcloud.tech",
	Destination: &Publish,
}

var RC bool

RC signifies the latest release candidate

var RCFlag = &cli.BoolFlag{
	Name:        "rc",
	Aliases:     []string{"r"},
	Destination: &RC,
	Usage:       "Install the latest release candidate",
}

RCFlag chooses the latest release candidate for install

var ReleaseNotes bool

ReleaseNotes stores the variable from ReleaseNotesFlag.

var ReleaseNotesFlag = &cli.BoolFlag{
	Name:        "releasenotes",
	Aliases:     []string{"r"},
	Destination: &ReleaseNotes,
	Usage:       "Only show release notes",
}

ReleaseNotesFlag turns on/off printing only release notes when upgrading.

var RemoteUser string

var RemoteUserFlag = &cli.StringFlag{
	Name:        "user",
	Aliases:     []string{"u"},
	Value:       "",
	Usage:       "User to run command within a service context",
	Destination: &RemoteUser,
}

var Secrets bool

Secrets stores the variable from SecretsFlag

var SecretsFlag = &cli.BoolFlag{
	Name:        "secrets",
	Aliases:     []string{"S"},
	Usage:       "Automatically generate secrets",
	Destination: &Secrets,
}

SecretsFlag turns on/off automatically generating secrets

var SinceLogs string

var SinceLogsFlag = &cli.StringFlag{
	Name:        "since",
	Aliases:     []string{"S"},
	Value:       "",
	Usage:       "tail logs since YYYY-MM-DDTHH:MM:SSZ",
	Destination: &SinceLogs,
}

var SkipUpdates bool

var SkipUpdatesFlag = &cli.BoolFlag{
	Name:        "skip-updates",
	Aliases:     []string{"s"},
	Usage:       "Skip updating recipe repositories",
	Destination: &SkipUpdates,
}

var StdErrOnly bool

var StdErrOnlyFlag = &cli.BoolFlag{
	Name:        "stderr",
	Aliases:     []string{"s"},
	Usage:       "Only tail stderr",
	Destination: &StdErrOnly,
}

var Trim bool

var TrimFlag = &cli.BoolFlag{
	Name:        "trim",
	Aliases:     []string{"t"},
	Usage:       "Trim input",
	Destination: &Trim,
}

var Tty bool

Disable tty to run commands from script

var TtyFlag = &cli.BoolFlag{
	Name:        "tty",
	Aliases:     []string{"T"},
	Usage:       "Disables TTY mode to run this command from a script.",
	Destination: &Tty,
}

TtyFlag turns on/off tty mode.

var Watch bool

var WatchFlag = &cli.BoolFlag{
	Name:        "watch",
	Aliases:     []string{"w"},
	Usage:       "Watch status by polling repeatedly",
	Destination: &Watch,
}

Functions

func DeployOverview

func DeployOverview(app appPkg.App, warnMessages []string, version, chaosVersion string) error

DeployOverview shows a deployment overview

func EnsureCommand

func EnsureCommand(abraSh, recipeName, execCmd string) error

func GetBumpType

func GetBumpType() string

GetBumpType figures out which bump type is specified

func GetMainAppImage

func GetMainAppImage(recipe recipe.Recipe) (string, error)

GetMainAppImage retrieves the main 'app' image name

func NewVersionOverview

func NewVersionOverview(
	app appPkg.App,
	warnMessages []string,
	kind,
	currentVersion,
	chaosVersion,
	newVersion,
	releaseNotes string) error

NewVersionOverview shows an upgrade or downgrade overview

func PostCmds

func PostCmds(cl *dockerClient.Client, app appPkg.App, commands string) error

PostCmds parses a string of commands and executes them inside of the respective services the commands string must have the following format: "<service> <command> <arguments>|<service> <command> <arguments>|... "

func PromptBumpType

func PromptBumpType(tagString, latestRelease string) error

PromptBumpType prompts for version bump type

func RetrieveBackupBotContainer

func RetrieveBackupBotContainer(cl *dockerClient.Client) (types.Container, error)

RetrieveBackupBotContainer gets the deployed backupbot container.

func ReverseStringList

func ReverseStringList(strings []string) []string

ReverseStringList reverses a list of a strings. Roll on Go generics.

func RunBackupCmdRemote

func RunBackupCmdRemote(cl *dockerClient.Client, backupCmd string, containerID string, execEnv []string) error

RunBackupCmdRemote runs a backup related command on a remote backupbot container.

func RunCmd

func RunCmd(cmd *exec.Cmd) error

RunCmd runs a shell command and streams stdout/stderr in real-time.

func RunCmdRemote

func RunCmdRemote(cl *dockerClient.Client, app appPkg.App, abraSh, serviceName, cmdName, cmdArgs string) error

RunCmdRemote executes an abra.sh command in the target service

func SetBumpType

func SetBumpType(bumpType string)

SetBumpType figures out which bump type is specified

func ShowSubcommandHelpAndError

func ShowSubcommandHelpAndError(cmd *cli.Command, err interface{})

ShowSubcommandHelpAndError exits the program on error, logs the error to the terminal, and shows the help command.

func SubCommandBefore

func SubCommandBefore(ctx context.Context, cmd *cli.Command) error

SubCommandBefore wires up pre-action machinery (e.g. --debug handling).

func ValidateApp

func ValidateApp(cmd *cli.Command) app.App

ValidateApp ensures the app name arg is valid.

func ValidateDomain

func ValidateDomain(cmd *cli.Command) string

ValidateDomain ensures the domain name arg is valid.

func ValidateRecipe

func ValidateRecipe(cmd *cli.Command) recipe.Recipe

ValidateRecipe ensures the recipe arg is valid.

func ValidateServer

func ValidateServer(cmd *cli.Command) string

ValidateServer ensures the server name arg is valid.

func ValidateSubCmdFlags

func ValidateSubCmdFlags(cmd *cli.Command) bool

ValidateSubCmdFlags ensures flag order conforms to correct order