config

package
v0.71.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2023 License: MIT Imports: 10 Imported by: 1

Documentation

Index

Constants

View Source
const (
	RunConfigFileName  = "run-config.toml"
	VegaBinaryName     = "vega"
	DataNodeBinaryName = "data-node"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AssetsConfig

type AssetsConfig struct {
	// description: Name of the asset on Github.
	Name string `toml:"name"`
	/*
		description: |
			Binary name definition can be used if the asset is a zip file and the binary is included inside of it.
	*/
	BinaryName *string `toml:"binaryName"`
}

description: Allows you to define the name of the asset to be downloaded.

func (AssetsConfig) GetBinaryPath added in v0.71.0

func (a AssetsConfig) GetBinaryPath() string

type AutoInstallConfig

type AutoInstallConfig struct {
	/*
		description: Whether or not autoinstall should be used
		default: true
	*/
	Enabled bool `toml:"enabled"`
	/*
		description: Owner of the repository from where the assets should be downloaded.
		default: vegaprotocol
	*/
	GithubRepositoryOwner string `toml:"repositoryOwner"`
	/*
		description: Name of the repository from where the assets should be downloaded.
		default: vega
	*/
	GithubRepository string `toml:"repository"`
	/*
		description: Definitions of the asset that should be downloaded from the GitHub repository.
		example:
			type: toml
			value: |
				[autoInstall.asset]
					name = "vega-darwin-amd64.zip"
					binaryName = "vega"
	*/
	Asset AssetsConfig `toml:"asset"`
}

description: Allows you to define the assets that should be automatically downloaded from GitHub for a specific release.

example:

type: toml
value: |
	[autoInstall]
		enabled = true
		repositoryOwner = "vegaprotocol"
		repository = "vega"
		[autoInstall.asset]
			name = "vega-darwin-amd64.zip"
			binaryName = "vega"

type BinaryConfig

type BinaryConfig struct {
	/*
		description: Path to the binary.
		note: |
			The absolute or relative path can be used.
			Relative path is relative to a parent folder of this config file.
	*/
	Path string `toml:"path"`
	/*
		description: Arguments that will be applied to the binary.
		note: |
			Each element the list represents one space separated argument.
	*/
	Args []string `toml:"args"`
}

description: Allows you to configure a binary and its arguments. example:

type: toml
value: |
	path = "/path/binary"
	args = ["--arg1", "val1", "--arg2"]

type DataNodeConfig

type DataNodeConfig struct {
	Binary BinaryConfig `toml:"binary"`
}

description: Allows you to configure a data node binary and its arguments. example:

type: toml
value: |
	[data_node]
		[data_node.binary]
			path = "/path/data-node-binary"
			args = ["--arg1", "val1", "--arg2"]

type RPCConfig

type RPCConfig struct {
	/*
		description: Path of the mounted socket.
		note: This path can be configured in Vega core node configuration.
	*/
	SocketPath string `toml:"socketPath"`
	/*
		description: HTTP path of the socket path.
		note: This path can be configured in Vega core node configuration.
	*/
	HTTPPath string `toml:"httpPath"`
}

description: Allows you to configure a connection to a core node's exposed UNIX socket RPC API. example:

type: toml
value: |
	[vega.rpc]
		socketPath = "/path/socket.sock"
		httpPath = "/rpc"

type RunConfig

type RunConfig struct {
	/*
		description: Name of the upgrade.
		note: It is recommended that you use the upgrade version as the name.
	*/
	Name string `toml:"name"`
	// description: Configuration of a Vega node.
	Vega VegaConfig `toml:"vega"`
	// description: Configuration of a data node.
	DataNode *DataNodeConfig `toml:"data_node"`
}

description: Root of the config file example:

type: toml
value: |
	name = "v1.65.0"

	[vega]
		[vega.binary]
			path = "/path/vega-binary"
			args = ["--arg1", "val1", "--arg2"]
		[vega.rpc]
			socketPath = "/path/socket.sock"
			httpPath = "/rpc"

func ExampleRunConfig

func ExampleRunConfig(name string, withDataNode bool) *RunConfig

func ParseRunConfig

func ParseRunConfig(path string) (*RunConfig, error)

func (*RunConfig) WriteToFile

func (rc *RunConfig) WriteToFile(path string) error

type VegaConfig

type VegaConfig struct {
	/*
		description: Configuration of Vega binary to be run.
		example:
			type: toml
			value: |
				[vega.binary]
					path = "/path/vega-binary"
					args = ["--arg1", "val1", "--arg2"]
	*/
	Binary BinaryConfig `toml:"binary"`

	/*
		description: |
			Visor communicates with the core node via RPC API that runs over UNIX socket.
			This parameter allows you to configure the UNIX socket to match the core node configuration.
		example:
			type: toml
			value: |
				[vega.binary]
					path = "/path/vega-binary"
					args = ["--arg1", "val1", "--arg2"]
	*/
	RCP RPCConfig `toml:"rpc"`
}

description: Allows you to configure the Vega binary and its arguments. example:

type: toml
value: |
	[vega]
		[vega.binary]
			path = "/path/vega-binary"
			args = ["--arg1", "val1", "--arg2"]
		[vega.rpc]
			socketPath = "/path/socket.sock"
			httpPath = "/rpc"

type VisorConfig

type VisorConfig struct {
	// contains filtered or unexported fields
}

func DefaultVisorConfig

func DefaultVisorConfig(log *logging.Logger, homePath string) *VisorConfig

func NewVisorConfig

func NewVisorConfig(log *logging.Logger, homePath string) (*VisorConfig, error)

func (*VisorConfig) AutoInstall

func (pc *VisorConfig) AutoInstall() AutoInstallConfig

func (*VisorConfig) CurrentFolder

func (pc *VisorConfig) CurrentFolder() string

func (*VisorConfig) CurrentRunConfigPath

func (pc *VisorConfig) CurrentRunConfigPath() string

func (*VisorConfig) GenesisFolder

func (pc *VisorConfig) GenesisFolder() string

func (*VisorConfig) MaxNumberOfFirstConnectionRetries added in v0.62.0

func (pc *VisorConfig) MaxNumberOfFirstConnectionRetries() int

func (*VisorConfig) MaxNumberOfRestarts

func (pc *VisorConfig) MaxNumberOfRestarts() int

func (*VisorConfig) RestartsDelaySeconds

func (pc *VisorConfig) RestartsDelaySeconds() int

func (*VisorConfig) StopDelaySeconds added in v0.71.0

func (pc *VisorConfig) StopDelaySeconds() int

func (*VisorConfig) StopSignalTimeoutSeconds

func (pc *VisorConfig) StopSignalTimeoutSeconds() int

func (*VisorConfig) UpgradeFolder

func (pc *VisorConfig) UpgradeFolder(releaseTag string) string

func (*VisorConfig) WatchForUpdate

func (pc *VisorConfig) WatchForUpdate(ctx context.Context) error

func (*VisorConfig) WriteToFile

func (pc *VisorConfig) WriteToFile() error