graph

Documentation

Index

• Constants
• func AddConfig(graph adder)
• func AddDocker(graph adder)
• func AddFilesystem(graph adder)
• func AddInternals(graph adder)
• func AddLogs(graph adder)
• func AddNetwork(graph adder)
• func AddShells(graph adder)
• func AddSingularity(graph adder)
• func AddState(graph adder)
• func AddUser(graph adder)
• type ConfigLoader
• type CurrentGDM
• type DefaultConfig
• type DetectedOTPLDeploySpecs
• type DryrunOption
• type ErrOut
• type ErrWriter
• type InReader
• type LocalDockerClient
• type LocalGitClient
• type LocalGitRepo
• type LocalSousConfig
  • func (c *LocalSousConfig) Bytes() []byte
  • func (c *LocalSousConfig) GetValue(name string) (string, error)
  • func (c *LocalSousConfig) Save(path string) error
  • func (c *LocalSousConfig) SetValue(path, name, value string) error
  • func (c *LocalSousConfig) String() string
• type LocalUser
• type LocalWorkDir
• type LocalWorkDirShell
• type Out
• type OutWriter
• type PossiblyInvalidConfig
• type ScratchDirShell
• type SourceContextDiscovery
  • func (scd *SourceContextDiscovery) GetContext() *sous.SourceContext
  • func (scd *SourceContextDiscovery) Unwrap(mid TargetManifestID) (*sous.SourceContext, error)
• type SousGraph
  • func BuildGraph(in io.Reader, out, err io.Writer) *SousGraph
  • func BuildTestGraph(in io.Reader, out, err io.Writer) *SousGraph
  • func TestGraphWithConfig(in io.Reader, out, err io.Writer, cfg string) *SousGraph
• type StateManager
• type StateReader
• type StateWriter
• type StatusWaitStable
• type TargetManifest
• type TargetManifestID
• type UserSelectedOTPLDeploySpecs
• type Version

Constants

const (
	// DryrunBoth specifies that both the registry and scheduler should be fake.
	DryrunBoth = DryrunOption("both")
	// DryrunRegistry means the registry should be faked for this execution.
	DryrunRegistry = DryrunOption("registry")
	// DryrunScheduler means the scheduler should be faked for this execution.
	DryrunScheduler = DryrunOption("scheduler")
	// DryrunNeither means neither the registry or scheduler should be faked.
	DryrunNeither = DryrunOption("none")
)

Functions

func AddConfig

func AddConfig(graph adder)

AddConfig adds filesystem to the graph.

func AddDocker

func AddDocker(graph adder)

AddDocker adds Docker to the graph.

func AddFilesystem

func AddFilesystem(graph adder)

AddFilesystem adds filesystem to the graph.

func AddInternals

func AddInternals(graph adder)

AddInternals adds the dependency contructors that are internal to Sous.

func AddLogs

func AddLogs(graph adder)

AddLogs adds a logset to the graph.

func AddNetwork

func AddNetwork(graph adder)

AddNetwork adds features that require the network.

func AddShells

func AddShells(graph adder)

AddShells adds working shells to the graph.

func AddSingularity

func AddSingularity(graph adder)

AddSingularity adds Singularity clients to the graph.

func AddState

func AddState(graph adder)

AddState adds state reader and writers to the graph.

func AddUser

func AddUser(graph adder)

AddUser adds the OS user to the graph.

Types

type ConfigLoader

type ConfigLoader struct{ configloader.ConfigLoader }

ConfigLoader wraps the configloader.ConfigLoader interface

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 DefaultConfig

type DefaultConfig struct{ *config.Config }

DefaultConfig is the default config.

type DetectedOTPLDeploySpecs

type DetectedOTPLDeploySpecs struct{ sous.DeploySpecs }

DetectedOTPLDeploySpecs is a set of otpl-deploy configured deployments that have been detected.

type DryrunOption

type DryrunOption string

DryrunOption specifies components that should be faked in an execution.

type ErrOut

type ErrOut struct{ *cmdr.Output }

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 ErrWriter

type ErrWriter io.Writer

ErrWriter is typically set to os.Stderr.

type InReader

type InReader io.Reader

InReader is typicially set to os.Stdin

type LocalDockerClient

type LocalDockerClient struct{ docker_registry.Client }

LocalDockerClient is a docker client object

type LocalGitClient

type LocalGitClient struct{ *git.Client }

LocalGitClient is a git client rooted in WorkdirShell.Dir.

type LocalGitRepo

type LocalGitRepo struct{ *git.Repo }

LocalGitRepo is the git repository containing WorkDir.

type LocalSousConfig

type LocalSousConfig struct{ *config.Config }

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 LocalUser

type LocalUser struct{ *config.User }

LocalUser is the currently logged in user.

type LocalWorkDir

type LocalWorkDir string

LocalWorkDir is the user's current working directory when they invoke Sous.

type LocalWorkDirShell

type LocalWorkDirShell struct{ *shell.Sh }

LocalWorkDirShell is a shell for working in the user's current working directory.

type Out

type Out struct{ *cmdr.Output }

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 OutWriter

type OutWriter io.Writer

OutWriter is typically set to os.Stdout.

type PossiblyInvalidConfig

type PossiblyInvalidConfig struct{ *config.Config }

PossiblyInvalidConfig is a config that has not been validated. This is necessary for the 'sous config' command that should still work with invalid configs.

type ScratchDirShell

type ScratchDirShell struct{ *shell.Sh }

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 SourceContextDiscovery

type SourceContextDiscovery struct {
	Error error
	*sous.ManifestID
	*sous.SourceContext
}

SourceContextDiscovery captures the possiblity of not finding a SourceContext

func (*SourceContextDiscovery) GetContext

func (scd *SourceContextDiscovery) GetContext() *sous.SourceContext

GetContext returns the SourceContext discovered if there were no errors in getting it. Otherwise returns a pointer to a zero SourceContext.

func (*SourceContextDiscovery) Unwrap

func (scd *SourceContextDiscovery) Unwrap(mid TargetManifestID) (*sous.SourceContext, error)

Unwrap returns the SourceContext and the returned error in trying to create it.

type SousGraph

type SousGraph struct{ *psyringe.Psyringe }

SousGraph is a dependency injector used to flesh out Sous commands with their dependencies.

func BuildGraph

func BuildGraph(in io.Reader, out, err io.Writer) *SousGraph

BuildGraph builds the dependency injection graph, used to populate commands invoked by the user.

func BuildTestGraph

func BuildTestGraph(in io.Reader, out, err io.Writer) *SousGraph

BuildTestGraph builds a standard graph suitable for testing

func TestGraphWithConfig

func TestGraphWithConfig(in io.Reader, out, err io.Writer, cfg string) *SousGraph

TestGraphWithConfig accepts a custom Sous config string

type StateManager

type StateManager struct{ sous.StateManager }

StateManager simply wraps the sous.StateManager interface

type StateReader

type StateReader struct{ sous.StateReader }

StateReader wraps a storage.StateReader.

type StateWriter

type StateWriter struct{ sous.StateWriter }

StateWriter wraps a storage.StateWriter, and should be configured to use the current user's local storage.

type StatusWaitStable

type StatusWaitStable bool

StatusWaitStable represents if `sous plumbing status` should continue to poll until the selected t

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.)

type Version

type Version struct{ semv.Version }

Version represents a version of Sous.