config

package
v0.78.0-preview.3 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2024 License: AGPL-3.0 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 file on Github.
	Name string `toml:"name"`
	/*
		description: |
			Name of the binary if the asset is a zip file and the binary is included inside of it.
	*/
	BinaryName *string `toml:"binaryName"`
}

description: Defines 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: Auto Install flag
		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: |
			Definition of the asset that should be downloaded from the GitHub repository.
			If the asset is contained in a zip file, the name of the binary is given.
		example:
			type: toml
			value: |
				[autoInstall.asset]
					name = "vega-darwin-amd64.zip"
					binaryName = "vega"
	*/
	Asset AssetsConfig `toml:"asset"`
}

description: Determines if the assets should be automatically downloaded and installed. If so this defines the assets that should be 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 Vega 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: Configuration options for the Vega 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: Configures 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 the Vega core node configuration and can be found in the [Admin.Server] section.
	*/
	SocketPath string `toml:"socketPath"`
	/*
		description: HTTP path of the socket path.
		note: This path can be configured in the Vega core node configuration and can be found in the [Admin.Server] section.
	*/
	HTTPPath string `toml:"httpPath"`
}

description: Configures 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 to use the Vega version you wish to upgrade to as the name. These can be found in the releases list of the Vega Github repository
			(https://github.com/vegaprotocol/vega/releases).

	*/
	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 and the arguments to run it.
		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 a UNIX socket.
			This parameter configures the UNIX socket to match the core node configuration.
			This value can be found in the config.toml file used by the core node under the heading [Admin.Server]
		example:
			type: toml
			value: |
				[vega.binary]
					path = "/path/vega-binary"
					args = ["--arg1", "val1", "--arg2"]
	*/
	RCP RPCConfig `toml:"rpc"`
}

description: Configuration options for 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) MaxNumberOfRestartConnectionRetries added in v0.77.0 

func (pc *VisorConfig) MaxNumberOfRestartConnectionRetries() 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

type VisorConfigFile 

type VisorConfigFile struct {
	/*
		description: |
			Visor communicates with the core node via RPC API.
			This variable allows a validator to specify how many times Visor should try to establish a connection to the core node before the Visor process fails.
			The `maxNumberOfFirstConnectionRetries` is only taken into account during the first start up of the Core node process - not restarts.
		note: |
			There is a 2 second delay between each attempt. Setting the max retry number to 5 means Visor will try to establish a connection 5 times in 10 seconds.
		default: 175000
	*/
	MaxNumberOfFirstConnectionRetries int `toml:"maxNumberOfFirstConnectionRetries,optional"`
	/*
		description: |
			Visor communicates with the core node via RPC API.
			This variable allows a validator to specify how many times Visor should try to establish a connection to the core node before the Visor process fails.
			The `MaxNumberOfRestartConnectionRetries` is only taken into account after the first start up of the Core node process where it is expected that the
			time to restart will be much shorter than when originally started.
		note: |
			There is a 2 second delay between each attempt. Setting the max retry number to 5 means Visor will try to establish a connection 5 times in 10 seconds.
		default: 10
	*/
	MaxNumberOfRestartConnectionRetries int `toml:"maxNumberOfRestartConnectionRetries,optional"`
	/*
		description: |
			Defines the maximum number of restarts in case any of
			the processes have failed before the Visor process fails.
		note: |
			The amount of time Visor waits between restarts can be set by `restartsDelaySeconds`.
		default: 3
	*/
	MaxNumberOfRestarts int `toml:"maxNumberOfRestarts,optional"`
	/*
		description: |
			Number of seconds that Visor waits before it tries to re-start the processes.
		default: 5
	*/
	RestartsDelaySeconds int `toml:"restartsDelaySeconds,optional"`
	/*
		description: |
			Number of seconds that Visor waits before it sends a termination signal (SIGTERM) to running processes
			that are ready for upgrade.
			After the time has elapsed Visor stops the running binaries (SIGTERM).
		default: 0
	*/
	StopDelaySeconds int `toml:"stopDelaySeconds,optional"`
	/*
		description: |
			Number of seconds that Visor waits after it sends termination signal (SIGTERM) to running processes.
			After the time has elapsed Visor force-kills (SIGKILL) any running processes.
		default: 15
	*/
	StopSignalTimeoutSeconds int `toml:"stopSignalTimeoutSeconds,optional"`

	/*
		description: |
			During the upgrade, by default Visor looks for a folder with a name identical to the upgrade version.
			The default behaviour can be changed by providing mapping between `version` and `custom_folder_name`.
			If a custom mapping is provided, during the upgrade Visor uses the folder given in the mapping for specific version.

		example:
			type: toml
			value: |
				[upgradeFolders]
					"v99.9.9" = "custom_upgrade_folder_name"
	*/
	UpgradeFolders map[string]string `toml:"upgradeFolders,optional"`

	/*
		description: |
			Defines 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.assets]
						[autoInstall.assets.vega]
							asset_name = "vega-darwin-amd64.zip"
							binary_name = "vega"

	*/
	AutoInstall AutoInstallConfig `toml:"autoInstall"`
}

description: Root of the config file example: 

type: toml
value: |
	maxNumberOfRestarts = 3
	restartsDelaySeconds = 5

	[upgradeFolders]
		"vX.X.X" = "vX.X.X"

	[autoInstall]
		enabled = false

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.