Documentation
¶
Index ¶
- type CurrentGDM
- type DetectedOTPLDeploySpecs
- type ErrOut
- type ErrWriter
- type GitSourceContext
- type LocalDockerClient
- type LocalGitClient
- type LocalGitRepo
- type LocalSousConfig
- type LocalStateReader
- type LocalStateWriter
- type LocalUser
- type LocalWorkDir
- type LocalWorkDirShell
- type Out
- type OutWriter
- type ScratchDirShell
- type SousGraph
- type StateReader
- type StateWriter
- type TargetManifest
- type TargetManifestID
- type UserSelectedOTPLDeploySpecs
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CurrentGDM ¶
type CurrentGDM struct{ sous.Deployments }
CurrentGDM is a snapshot of the GDM at application start. In a CLI context, which this is, that is all we need to simply read the GDM.
type DetectedOTPLDeploySpecs ¶
type DetectedOTPLDeploySpecs struct{ sous.DeploySpecs }
DetectedOTPLDeploySpecs is a set of otpl-deploy configured deployments that have been detected.
type ErrOut ¶
ErrOut is an output used for logging from a Command. This should only be used when a Command needs to write a lot of data to stderr, using the formatting options that come with and Output. Usually you should use and ErrorResult to return error messages.
type GitSourceContext ¶
type GitSourceContext struct{ *sous.SourceContext }
GitSourceContext is the source context according to the local git repo.
type LocalDockerClient ¶
type LocalDockerClient struct{ docker_registry.Client }
LocalDockerClient is a docker client object
type LocalGitClient ¶
LocalGitClient is a git client rooted in WorkdirShell.Dir.
type LocalGitRepo ¶
LocalGitRepo is the git repository containing WorkDir.
type LocalSousConfig ¶
LocalSousConfig is the configuration for Sous.
func (*LocalSousConfig) Bytes ¶
func (c *LocalSousConfig) Bytes() []byte
Bytes marshals the config to a []byte
func (*LocalSousConfig) GetValue ¶
func (c *LocalSousConfig) GetValue(name string) (string, error)
GetValue retreives and returns a particular value from the configuration
func (*LocalSousConfig) Save ¶
func (c *LocalSousConfig) Save(path string) error
Save the configuration to the configuration path (by default: $HOME/.config/sous/config)
func (*LocalSousConfig) SetValue ¶
func (c *LocalSousConfig) SetValue(path, name, value string) error
SetValue stores a particular value on the config
func (*LocalSousConfig) String ¶
func (c *LocalSousConfig) String() string
type LocalStateReader ¶
type LocalStateReader struct{ StateReader }
LocalStateReader wraps a storage.StateReader, and should be configured to use the current user's local storage.
type LocalStateWriter ¶
type LocalStateWriter struct{ StateWriter }
LocalStateWriter wraps a storage.StateWriter, and should be configured to use the current user's local storage.
type LocalWorkDir ¶
type LocalWorkDir string
LocalWorkDir is the user's current working directory when they invoke Sous.
type LocalWorkDirShell ¶
LocalWorkDirShell is a shell for working in the user's current working directory.
type Out ¶
Out is an output used for real data a Command returns. This should only be used when a command needs to write directly to stdout, using the formatting options that come with an output. Usually, you should use a SuccessResult with Data to return data.
type ScratchDirShell ¶
ScratchDirShell is a shell for working in the scratch area where things like artefacts, and build metadata are stored. It is a new, empty directory, and should be cleaned up eventually.
type SousGraph ¶
SousGraph is a dependency injector used to flesh out Sous commands with their dependencies.
func BuildGraph ¶
BuildGraph builds the dependency injection graph, used to populate commands invoked by the user.
type StateReader ¶
type StateReader interface {
ReadState() (*sous.State, error)
}
StateReader knows how to read state.
type StateWriter ¶
type StateWriter interface {
WriteState(*sous.State) error
}
StateWriter knows how to write state.
type TargetManifest ¶
type TargetManifest struct{ *sous.Manifest }
TargetManifest is a specific manifest for the current ManifestID. If the named manifest does not exist, it is created.
type TargetManifestID ¶
type TargetManifestID sous.ManifestID
TargetManifestID is the manifest ID being targeted, after resolving all context and flags.
type UserSelectedOTPLDeploySpecs ¶
type UserSelectedOTPLDeploySpecs struct{ sous.DeploySpecs }
UserSelectedOTPLDeploySpecs is a set of otpl-deploy configured deploy specs that the user has explicitly selected. (May be empty.)
Source Files