Documentation
¶
Index ¶
- func CronDisable(s scope.Scope, g cfg.Configuration, keys []string) error
- func CronEnable(s scope.Scope, g cfg.Configuration, keys []string) error
- func CronStatus(s scope.Scope, g cfg.Configuration, keys []string) error
- func Deploy(s scope.Scope, g cfg.Configuration, rel *Release, environ string, setup bool, ...) error
- func Df(s scope.Scope, g cfg.Configuration, options distro.DfOptions) error
- func EnvironPush(s scope.Scope, g cfg.Configuration, filename string, restart bool) error
- func Forward(s scope.Scope, g cfg.Configuration, port string) error
- func Htop(s scope.Scope, g cfg.Configuration) error
- func Log(s scope.Scope, g cfg.Configuration, key string, no int) error
- func Prune(s scope.Scope, g cfg.Configuration) error
- func Restart(s scope.Scope, g cfg.Configuration) error
- func Run(s scope.Scope, g cfg.Configuration, key string) error
- func SSH(s scope.Scope, g cfg.Configuration) error
- func Scale(s scope.Scope, g cfg.Configuration, comp *Composition) error
- func SentinelInstall(s scope.Scope, g cfg.Configuration, binaryFn SentinelBinaryFunc) error
- func Setup(s scope.Scope, g cfg.Configuration, environ string) error
- func Shell(s scope.Scope, g cfg.Configuration) error
- func Status(s scope.Scope, g cfg.Configuration) error
- func Top(s scope.Scope, g cfg.Configuration) error
- type Composition
- type Release
- type SentinelBinaryFunc
- type Tarball
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CronDisable ¶
CronDisable disables the specified cron jobs on all selected nodes.
func CronEnable ¶
CronEnable enables the specified cron jobs on all selected nodes.
func CronStatus ¶ added in v0.9.0
CronStatus prints the status of all cron jobs on the selected nodes.
func Deploy ¶
func Deploy(s scope.Scope, g cfg.Configuration, rel *Release, environ string, setup bool, scale bool) error
Deploy uploads and deploys a release to all nodes in scope.
func EnvironPush ¶ added in v0.14.1
EnvironPush uploads an environment file to the selected nodes. If the file has changed and restart is true, all running containers are recreated so that they pick up the new environment.
func Forward ¶ added in v0.10.0
Forward sets up port forwarding from the local machine to the selected node.
func Htop ¶ added in v0.18.0
func Htop(s scope.Scope, g cfg.Configuration) error
Htop runs the htop command interactively on the selected node.
func Prune ¶
func Prune(s scope.Scope, g cfg.Configuration) error
Prune removes old releases, keeping the 5 most recent.
func Restart ¶
func Restart(s scope.Scope, g cfg.Configuration) error
Restart restarts all application containers on the selected nodes.
func SSH ¶ added in v0.14.1
func SSH(s scope.Scope, g cfg.Configuration) error
SSH opens an interactive SSH session to the selected node.
func Scale ¶
func Scale(s scope.Scope, g cfg.Configuration, comp *Composition) error
Scale adjusts the number of container instances on each node to match the composition.
func SentinelInstall ¶ added in v0.17.0
func SentinelInstall(s scope.Scope, g cfg.Configuration, binaryFn SentinelBinaryFunc) error
SentinelInstall pushes the embedded sentinel binary and systemd unit to each selected node and starts the service.
func Setup ¶
Setup prepares servers for deployment by installing Docker and creating the application directory.
func Shell ¶ added in v0.14.1
func Shell(s scope.Scope, g cfg.Configuration) error
Shell opens an interactive bash session on the selected node.
Types ¶
type Composition ¶
Composition maps program keys to their desired instance counts.
func DefaultComposition ¶ added in v0.10.0
DefaultComposition evaluates the scaling rules from the spec against a node's properties.
func NewComposition ¶
func NewComposition(args []string) (*Composition, error)
NewComposition parses "key=count" arguments into a Composition.
type Release ¶
Release represents a deployable release, identified by timestamp and content hash.
func NewRelease ¶
NewRelease creates a Release from a tarball path, computing its SHA256 hash.
type SentinelBinaryFunc ¶ added in v0.17.0
SentinelBinaryFunc returns the embedded sentinel binary for the given architecture (e.g. "amd64", "arm64"). Implemented by the main package, which owns the embed directives.