configure

Documentation

Index

• Constants
• Variables
• func Cli(cmdCtx *cmdcontext.CmdCtx) error
• func ExternalCmd(rootCmd *cobra.Command, cmdCtx *cmdcontext.CmdCtx, ...)
• func GetCliOpts(configurePath string) (*config.CliOpts, string, error)
• func GetDaemonOpts(configurePath string) (*config.DaemonOpts, error)
• func GetDefaultCliOpts() *config.CliOpts
• func ValidateCliOpts(cliCtx *cmdcontext.CliCtx) error

Constants

const (
	ConfigName = "tt.yaml"

	// instancesEnabledDirName is a default instances enabled directory name.
	InstancesEnabledDirName = "instances.enabled"
)

const (
	VarPath       = "var"
	LogPath       = "log"
	RunPath       = "run"
	DataPath      = "lib"
	BinPath       = "bin"
	IncludePath   = "include"
	ModulesPath   = "modules"
	DistfilesPath = "distfiles"
	SnapPath      = "snap"
	VinylPath     = "vinyl"
	WalPath       = "wal"
)

Variables

var (
	VarDataPath  = filepath.Join(VarPath, DataPath)
	VarWalPath   = filepath.Join(VarPath, WalPath)
	VarMemtxPath = filepath.Join(VarPath, SnapPath)
	VarVinylPath = filepath.Join(VarPath, VinylPath)
	VarLogPath   = filepath.Join(VarPath, LogPath)
	VarRunPath   = filepath.Join(VarPath, RunPath)
)

Functions

func Cli

func Cli(cmdCtx *cmdcontext.CmdCtx) error

Cli performs initial CLI configuration.

func ExternalCmd

func ExternalCmd(rootCmd *cobra.Command, cmdCtx *cmdcontext.CmdCtx,
	modulesInfo *modules.ModulesInfo, args []string)

ExternalCmd configures external commands.

func GetCliOpts

func GetCliOpts(configurePath string) (*config.CliOpts, string, error)

GetCliOpts returns Tarantool CLI options from the config file located at path configurePath.

func GetDaemonOpts

func GetDaemonOpts(configurePath string) (*config.DaemonOpts, error)

GetDaemonOpts returns tt daemon options from the config file located at path configurePath.

func GetDefaultCliOpts

func GetDefaultCliOpts() *config.CliOpts

GetDefaultCliOpts returns `CliOpts` filled with default values.

func ValidateCliOpts

func ValidateCliOpts(cliCtx *cmdcontext.CliCtx) error

ValidateCliOpts checks for ambiguous config options.