Documentation
¶
Index ¶
Constants ¶
const ( DEPLOY_METHOD_UNKNOWN int = 0 DEPLOY_METHOD_DOCKER int = 1 DEPLOY_METHOD_SHELL int = 2 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Deployment Deployment `yaml:"deployment"`
Global Global `yaml:"global"`
Environments []*Environment `yaml:"environments"`
// contains filtered or unexported fields
}
Config is the root structure for the deployment configuration
type Deploy ¶
type Deploy struct {
// contains filtered or unexported fields
}
Deploy is the primary type for the stim deploy subcommand
func (*Deploy) Command ¶
Command is required for every stimpack This function sets up the cli command parameters and returns the command
func (*Deploy) Deploy ¶
func (d *Deploy) Deploy(environment *Environment, instance *Instance)
Deploy runs the deployment in the way that the user wants
func (*Deploy) DetermineDeployMethod ¶ added in v0.1.3
DetermineDeployMethod figures out the deploy method based on user input and availability
type Deployment ¶
type Deployment struct {
Directory string `yaml:"directory"`
Script string `yaml:"script"`
Container Container `yaml:"container"`
RequiredVersion string `yaml:"requiredVersion"`
MinimumVersion string `yaml:"minimumVersion"`
// contains filtered or unexported fields
}
Deployment describes details about the deployment assets (directories, files, etc)
type Environment ¶
type Environment struct {
Name string `yaml:"name"`
Spec *Spec `yaml:"spec"`
Instances []*Instance `yaml:"instances"`
RemoveAllPrompt bool `yaml:"removeAllPrompt"`
// contains filtered or unexported fields
}
Environment describes a deployment environment (i.e. dev, stage, prod, etc.)
type EnvironmentVar ¶
EnvironmentVar describes a shell env var to be injected into the deployment environment
type Global ¶
type Global struct {
Spec *Spec `yaml:"spec"`
}
Global describes global environment specs
type Instance ¶
Instance describes an instance of a deployment within an environment (i.e. us-west-2 for env prod)
type Kubernetes ¶
type Kubernetes struct {
ServiceAccount string `yaml:"serviceAccount"`
Cluster string `yaml:"cluster"`
}
Kubernetes describes the Kubernetes configuration to use
type Spec ¶
type Spec struct {
Kubernetes Kubernetes `yaml:"kubernetes"`
Secrets []*v2e.SecretItem `yaml:"secrets"`
EnvironmentVars []*EnvironmentVar `yaml:"env"`
AddConfirmationPrompt bool `yaml:"addConfirmationPrompt"`
Tools map[string]stim.EnvTool `yaml:"tools"`
}
Spec contains the spec of a given environment/instance