Documentation
¶
Index ¶
- Variables
- type ChangeCommand
- type DeleteCommand
- type DockerLoginCommand
- type DockerLogoutCommand
- type LogsCommand
- type Metric
- type MetricFetchResult
- type Metrics
- type RestartCommand
- type RollbackCommand
- type ScaleCommand
- type ShowCommand
- type StartCommand
- type StatsCommand
- type StringMap
- type VersionCommand
Constants ¶
This section is empty.
Variables ¶
var ( // The git commit that was compiled. This will be filled in by the compiler. GitCommit string // Version number that is being run at the moment. Version string // VersionPreRelease marks the version as pre-release. If this is "" // (empty string) then it means that it is a final release. Otherwise, this // is a pre-release such as "dev" (in development), "beta", "rc1", etc. VersionPreRelease string )
Functions ¶
This section is empty.
Types ¶
type ChangeCommand ¶
type ChangeCommand struct {
UI ui.UI
Projects interface {
api.ProjectsUpdater
api.ProjectsGetter
api.ProjectsCreater
}
Apps api.AppsUpdater
}
ChangeCommand is a Command implementation that changes the configuration of a specific application on the fly.
func (*ChangeCommand) Help ¶
func (c *ChangeCommand) Help() string
Help should return long-form help text.
func (*ChangeCommand) Run ¶
func (c *ChangeCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*ChangeCommand) Synopsis ¶
func (c *ChangeCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type DeleteCommand ¶
type DeleteCommand struct {
UI ui.UI
Projects api.ProjectsDeleter
Services api.ServicesDeleter
Apps api.AppsDeleter
}
DeleteCommand is a Command implementation that is used to delete a project, a service or an application.
func (*DeleteCommand) Help ¶
func (c *DeleteCommand) Help() string
Help should return long-form help text.
func (*DeleteCommand) Run ¶
func (c *DeleteCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*DeleteCommand) Synopsis ¶
func (c *DeleteCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type DockerLoginCommand ¶
type DockerLoginCommand struct {
UI ui.UI
RegistryCredentials api.RegistryCredentialsUploader
}
DockerLoginCommand is a Command implementation that uploads the docker credentials.
func (*DockerLoginCommand) Help ¶
func (c *DockerLoginCommand) Help() string
Help should return long-form help text.
func (*DockerLoginCommand) Run ¶
func (c *DockerLoginCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*DockerLoginCommand) Synopsis ¶
func (c *DockerLoginCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type DockerLogoutCommand ¶
type DockerLogoutCommand struct {
UI ui.UI
RegistryCredentials api.RegistryCredentialsCheckDeleter
}
DockerLogoutCommand is a Command implementation that deletes the docker credentials from sloppy.io
func (*DockerLogoutCommand) Help ¶
func (c *DockerLogoutCommand) Help() string
Help should return long-form help text.
func (*DockerLogoutCommand) Run ¶
func (c *DockerLogoutCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*DockerLogoutCommand) Synopsis ¶
func (c *DockerLogoutCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type LogsCommand ¶
type LogsCommand struct {
UI ui.UI
Projects api.ProjectsLogger
Services api.ServicesLogger
Apps api.AppsLogger
}
LogsCommand is a Command implementation that is used to fetch standard output and standard error streams for a specific application, an entire project or service.
func (*LogsCommand) Help ¶
func (c *LogsCommand) Help() string
Help should return long-form help text.
func (*LogsCommand) Run ¶
func (c *LogsCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*LogsCommand) Synopsis ¶
func (c *LogsCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type MetricFetchResult ¶
type MetricFetchResult struct {
// contains filtered or unexported fields
}
type RestartCommand ¶
type RestartCommand struct {
UI ui.UI
Apps api.AppsRestarter
}
RestartCommand is a Command implementation that is used to restart a specific application.
func (*RestartCommand) Help ¶
func (c *RestartCommand) Help() string
Help should return long-form help text.
func (*RestartCommand) Run ¶
func (c *RestartCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*RestartCommand) Synopsis ¶
func (c *RestartCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type RollbackCommand ¶
type RollbackCommand struct {
UI ui.UI
Apps api.AppsRollbacker
}
RollbackCommand is a Command implementation that is used to roll back an application to a specific version.
func (*RollbackCommand) Help ¶
func (c *RollbackCommand) Help() string
Help should return long-form help text.
func (*RollbackCommand) Run ¶
func (c *RollbackCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*RollbackCommand) Synopsis ¶
func (c *RollbackCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type ScaleCommand ¶
type ScaleCommand struct {
UI ui.UI
Apps api.AppsScaler
}
ScaleCommand is a Command implementation that is used to scale the number of instances a specific application is running on.
func (*ScaleCommand) Help ¶
func (c *ScaleCommand) Help() string
Help should return long-form help text.
func (*ScaleCommand) Run ¶
func (c *ScaleCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*ScaleCommand) Synopsis ¶
func (c *ScaleCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type ShowCommand ¶
type ShowCommand struct {
UI ui.UI
Projects api.ProjectsGetLister
Services api.ServicesGetter
Apps api.AppsGetter
}
ShowCommand is a Command implementation that is used to display detailed information on either all your projects; or just one specific project, service or application.
func (*ShowCommand) Help ¶
func (c *ShowCommand) Help() string
Help should return long-form help text.
func (*ShowCommand) Run ¶
func (c *ShowCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*ShowCommand) Synopsis ¶
func (c *ShowCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type StartCommand ¶
type StartCommand struct {
UI ui.UI
Projects api.ProjectsCreater
}
StartCommand is a Command implementation that is used to create a project along with all its services and applications.
func (*StartCommand) Help ¶
func (c *StartCommand) Help() string
Help should return long-form help text.
func (*StartCommand) Run ¶
func (c *StartCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*StartCommand) Synopsis ¶
func (c *StartCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type StatsCommand ¶
type StatsCommand struct {
UI ui.UI
Projects api.ProjectsGetter
Apps api.AppsGetMetricer
// contains filtered or unexported fields
}
StatsCommand is a Command implementation that is used to display usage statistics about an entire project.
func (*StatsCommand) Help ¶
func (c *StatsCommand) Help() string
Help should return long-form help text.
func (*StatsCommand) Run ¶
func (c *StatsCommand) Run(args []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*StatsCommand) Synopsis ¶
func (c *StatsCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.
type VersionCommand ¶
VersionCommand is a Command implementation that prints the version.
func (*VersionCommand) Help ¶
func (c *VersionCommand) Help() string
Help should return long-form help text.
func (*VersionCommand) Run ¶
func (c *VersionCommand) Run(_ []string) int
Run should run the actual command with the given CLI instance and command-line args.
func (*VersionCommand) Synopsis ¶
func (c *VersionCommand) Synopsis() string
Synopsis should return a one-line, short synopsis of the command.