util

Documentation

Index

• Variables
• func ActivateLibStorage(ctx apitypes.Context, config gofig.Config) (apitypes.Context, gofig.Config, <-chan error, error)
• func AddKnownHost(ctx apitypes.Context, knownHostPath, host, algo string, fingerprint []byte) error
• func AssertTrustedHost(ctx apitypes.Context, host, algo string, fingerprint []byte) bool
• func CreateSelfCert(ctx apitypes.Context, certPath, keyPath, host string) error
• func EnvFilePath(ctx apitypes.Context) string
• func EtcFilePath(ctx apitypes.Context, fileName string) string
• func FindFlagVal(name string, args ...string) (string, []int)
• func GetPrefix(ctx apitypes.Context) string
• func Install(args ...string)
• func InstallChownRoot(args ...string)
• func InstallDirChownRoot(dirPath string)
• func IsAddressActive(proto, addr string) bool
• func IsLocalServerActive(ctx apitypes.Context, config gofig.Config) (host string, running bool)
• func IsPrefixed(ctx apitypes.Context) bool
• func IsTerminal(w io.Writer) bool
• func LogFile(ctx apitypes.Context, fileName string) (io.Writer, error)
• func LogFilePath(ctx apitypes.Context, fileName string) string
• func NewClient(ctx apitypes.Context, config gofig.Config) (apitypes.Client, error)
• func NewConfig(ctx apitypes.Context) (config gofig.Config)
• func NewWriterFor(f func(msg string, args ...interface{})) io.Writer
• func PidFilePath(ctx apitypes.Context) string
• func PrintVersion(out io.Writer)
• func ReadPidFile(ctx apitypes.Context) (int, error)
• func ReadSpecFile(ctx apitypes.Context) (string, error)
• func RunFilePath(ctx apitypes.Context, fileName string) string
• func ScriptDirPath(ctx apitypes.Context) string
• func ScriptFilePath(ctx apitypes.Context, fileName string) string
• func SpecFilePath(ctx apitypes.Context) string
• func StdOutAndLogFile(ctx apitypes.Context, fileName string) (io.Writer, error)
• func ValidateConfig(path string)
• func WaitUntilLibStorageStopped(ctx apitypes.Context, errs <-chan error)
• func WritePidFile(ctx apitypes.Context, pid int) error
• func WriteSpecFile(ctx apitypes.Context, host string) error

Variables

var (

	// BinFileName is the name of the executing binary.
	BinFileName string

	// BinFilePath is the full path of the executing binary.
	BinFilePath string

	// BinFileDirPath is the full path of the executing binary's parent
	// directory.
	BinFileDirPath string

	// UnitFileName is the name of the SystemD service's unit file.
	UnitFileName string

	// UnitFilePath is the path to the SystemD service's unit file.
	UnitFilePath string

	// InitFileName is the name of the SystemV service's unit file.
	InitFileName string

	// InitFilePath is the path to the SystemV service's init script.
	InitFilePath string

	// PIDFileName is the name of the PID file.
	PIDFileName string

	// DotDirName is the name of the hidden app directory.
	DotDirName string
)

var ErrHostDetectionFailed = errors.New("host detection failed")

ErrHostDetectionFailed is returned when ActivateLibStorage is invoked and the there is no host specified in the configuration file and no existing host was detected locally.

var ErrMissingService = goof.New("client must specify service")

ErrMissingService occurs when the client configuration is missing the property "libstorage.service" either at the root or as part of a module definition.

Functions

func ActivateLibStorage

func ActivateLibStorage(
	ctx apitypes.Context,
	config gofig.Config) (apitypes.Context, gofig.Config, <-chan error, error)

ActivateLibStorage activates libStorage and returns a possibly mutated context.

func AddKnownHost

func AddKnownHost(
	ctx apitypes.Context,
	knownHostPath,
	host, algo string,
	fingerprint []byte) error

AddKnownHost adds unknown host to know_hosts file

func AssertTrustedHost

func AssertTrustedHost(
	ctx apitypes.Context,
	host,
	algo string,
	fingerprint []byte,
) bool

AssertTrustedHost presents the user with a onscreen prompt to accept orreject a host as a trusted, known host.

func CreateSelfCert

func CreateSelfCert(
	ctx apitypes.Context,
	certPath, keyPath, host string) error

CreateSelfCert creates a self-signed certificate and a private key pair.

func EnvFilePath

func EnvFilePath(ctx apitypes.Context) string

EnvFilePath returns the path to the REX-Ray env file.

func EtcFilePath

func EtcFilePath(ctx apitypes.Context, fileName string) string

EtcFilePath returns the path to a file inside the REX-Ray etc directory with the provided file name.

func FindFlagVal

func FindFlagVal(name string, args ...string) (string, []int)

FindFlagVal looks at the provided list of arguments and attempts to find the value for the specified flag. The indicies of the arguments that are the flag and its value are also returned. If the flag is specified as --flag=val then only a single index will be returned.

func GetPrefix

func GetPrefix(ctx apitypes.Context) string

GetPrefix gets the root path to the REX-Ray data.

func Install

func Install(args ...string)

Install executes the system install command.

func InstallChownRoot

func InstallChownRoot(args ...string)

InstallChownRoot executes the system install command and chowns the target to the root user and group.

func InstallDirChownRoot

func InstallDirChownRoot(dirPath string)

InstallDirChownRoot executes the system install command with a -d flag and chowns the target to the root user and group.

func IsAddressActive

func IsAddressActive(proto, addr string) bool

IsAddressActive returns a flag indicating whether or not a an address is responding to connection attempts. This does not validate whether the address is using TLS or such a connection is possible.

func IsLocalServerActive

func IsLocalServerActive(
	ctx apitypes.Context, config gofig.Config) (host string, running bool)

IsLocalServerActive returns a flag indicating whether or not a local libStorage is already running.

func IsPrefixed

func IsPrefixed(ctx apitypes.Context) bool

IsPrefixed determines whether REX-Ray is prefixed.

func IsTerminal

func IsTerminal(w io.Writer) bool

IsTerminal returns a flag indicating whether or not the provided writer is connected to a terminal device.

func LogFile

func LogFile(ctx apitypes.Context, fileName string) (io.Writer, error)

LogFile returns a writer to a file inside the REX-Ray log directory with the provided file name.

func LogFilePath

func LogFilePath(ctx apitypes.Context, fileName string) string

LogFilePath returns the path to a file inside the REX-Ray log directory with the provided file name.

func NewClient

func NewClient(
	ctx apitypes.Context, config gofig.Config) (apitypes.Client, error)

NewClient returns a new libStorage client.

func NewConfig

func NewConfig(ctx apitypes.Context) (config gofig.Config)

NewConfig returns a new config object.

func NewWriterFor

func NewWriterFor(f func(msg string, args ...interface{})) io.Writer

NewWriterFor returns an io.Writer that will write data using the provided function.

func PidFilePath

func PidFilePath(ctx apitypes.Context) string

PidFilePath returns the path to the REX-Ray PID file.

func PrintVersion

func PrintVersion(out io.Writer)

PrintVersion prints the current version information to the provided writer.

func ReadPidFile

func ReadPidFile(ctx apitypes.Context) (int, error)

ReadPidFile reads the REX-Ray PID from the PID file.

func ReadSpecFile

func ReadSpecFile(ctx apitypes.Context) (string, error)

ReadSpecFile reads the REX-Ray host address from the spec file.

func RunFilePath

func RunFilePath(ctx apitypes.Context, fileName string) string

RunFilePath returns the path to a file inside the REX-Ray run directory with the provided file name.

func ScriptDirPath

func ScriptDirPath(ctx apitypes.Context) string

ScriptDirPath returns the path to the REX-Ray script directory.

func ScriptFilePath

func ScriptFilePath(ctx apitypes.Context, fileName string) string

ScriptFilePath returns the path to a file inside the REX-Ray script directory with the provided file name.

func SpecFilePath

func SpecFilePath(ctx apitypes.Context) string

SpecFilePath returns the path to the REX-Ray spec file.

func StdOutAndLogFile

func StdOutAndLogFile(ctx apitypes.Context, fileName string) (io.Writer, error)

StdOutAndLogFile returns a mutltiplexed writer for the current process's stdout descriptor and a REX-Ray log file with the provided name.

func ValidateConfig

func ValidateConfig(path string)

ValidateConfig validates a provided configuration file.

func WaitUntilLibStorageStopped

func WaitUntilLibStorageStopped(ctx apitypes.Context, errs <-chan error)

WaitUntilLibStorageStopped blocks until libStorage is stopped.

func WritePidFile

func WritePidFile(ctx apitypes.Context, pid int) error

WritePidFile writes the current process ID to the REX-Ray PID file.

func WriteSpecFile

func WriteSpecFile(ctx apitypes.Context, host string) error

WriteSpecFile writes the current host address to the REX-Ray spec file.