state

Documentation

Index

• Variables
• func GetStateDir() (stateDir string, err error)
• func GravityInstallDir(elems ...string) (path string)
• func GravityInstallDirAt(baseDir string, elems ...string) (path string)
• func GravityInstallerServicePath(baseDir string) (path string, err error)
• func GravityInstallerSocketPath(baseDir string) (path string)
• func GravityLocalDir(baseDir string) string
• func GravityRPCAgentDir(baseDir string) string
• func GravityUpdateDir(baseDir string) string
• func InEtcdDir(baseDir, filename string) string
• func InStateDir(elems ...string) (string, error)
• func LogDir(baseDir string, suffixes ...string) string
• func RegistryDir(baseDir string) string
• func Secret(baseDir, secretName string) string
• func SecretDir(baseDir string) string
• func SetStateDir(stateDir string) error
• func ShareDir(baseDir string) string
• func TeleportAuthDataDir(baseDir string) string
• func TeleportNodeDataDir(baseDir string) string

Variables

var (
	// StateLocatorPaths is a list of locations where gravity state directory pointer is written
	StateLocatorPaths = []string{
		filepath.Join(defaults.EtcDir, defaults.GravityConfigFilename),
		filepath.Join(defaults.EtcWritableDir, defaults.GravityConfigFilename),
		filepath.Join(defaults.WritableDir, defaults.GravityConfigFilename),
	}

	// GravityBinPaths is a list of possible gravity binary locations on host
	GravityBinPaths = []string{
		defaults.GravityBin,
		defaults.GravityBinAlternate,
	}

	// GravityAgentBinPaths is a list of possible gravity agent binary locations on host
	GravityAgentBinPaths = []string{
		defaults.GravityAgentBin,
		defaults.GravityAgentBinAlternate,
	}
)

Functions

func GetStateDir

func GetStateDir() (stateDir string, err error)

GetStateDir returns local gravity state directory

func GravityInstallDir

func GravityInstallDir(elems ...string) (path string)

GravityInstallDir returns the location of the temporary state directory for the install/join operation. elems are appended to resulting path

func GravityInstallDirAt

func GravityInstallDirAt(baseDir string, elems ...string) (path string)

GravityInstallDirAt returns the path to the specified elements inside the installer state directory rooted at baseDir

func GravityInstallerServicePath

func GravityInstallerServicePath(baseDir string) (path string, err error)

GravityInstallerServicePath returns the path to the installer service as configured in the state directory rooted at baseDir.

func GravityInstallerSocketPath

func GravityInstallerSocketPath(baseDir string) (path string)

GravityInstallerSocketPath returns the path to the installer socket file inside the installer state directory rooted at baseDir

func GravityLocalDir

func GravityLocalDir(baseDir string) string

GravityLocalDir returns full path to the directory with local gravity state.

func GravityRPCAgentDir

func GravityRPCAgentDir(baseDir string) string

GravityRPCAgentDir returns full path to the RPC agent directory

func GravityUpdateDir

func GravityUpdateDir(baseDir string) string

GravityUpdateDir returns full path to the update directory

func InEtcdDir

func InEtcdDir(baseDir, filename string) string

InEtcdDir returns full path to the specified file in the planet etcd data directory

func InStateDir

func InStateDir(elems ...string) (string, error)

InStateDir returns the provided path elements joined with the state dir.

func LogDir

func LogDir(baseDir string, suffixes ...string) string

LogDir returns full path to the planet log directory

func RegistryDir

func RegistryDir(baseDir string) string

RegistryDir returns full path to the planet docker registry directory

func Secret

func Secret(baseDir, secretName string) string

Secret returns a full path to a secret

func SecretDir

func SecretDir(baseDir string) string

SecretDir returns a secrets directory

func SetStateDir

func SetStateDir(stateDir string) error

SetStateDir saves the provided directory stateDir as a local gravity state directory pointer

func ShareDir

func ShareDir(baseDir string) string

ShareDir returns full path to the planet share directory

func TeleportAuthDataDir

func TeleportAuthDataDir(baseDir string) string

TeleportAuthDataDir returns full path to the directory where teleport auth server keeps its data.

func TeleportNodeDataDir

func TeleportNodeDataDir(baseDir string) string

TeleportNodeDataDir returns full path to the directory where teleport node keeps its data.