deployment

Documentation

Index

• type Config
  • func ReadConfig(filePath string) (*Config, error)
  • func (c *Config) IsValid() error

Types

type Config

type Config struct {
	ClusterName         string // Name of the cluster.
	AppInstanceCount    int    // Number of application instances.
	AppInstanceType     string // Type of the EC2 instance for app.
	AgentInstanceCount  int    // Number of agents, first agent and coordinator will share the same instance.
	AgentInstanceType   string // Type of the EC2 instance for agent.
	EnableAgentFullLogs bool   // Logs the command output (stdout & stderr) to home directory.
	ProxyInstanceType   string // Type of the EC2 instance for proxy.
	SSHPublicKey        string // Path to the SSH public key.
	DBInstanceCount     int    // Number of DB instances.
	DBInstanceType      string // Type of the DB instance.
	DBInstanceEngine    string // Type of the DB instance - postgres or mysql.
	DBUserName          string // Username to connect to the DB.
	DBPassword          string // Password to connect to the DB.
	// URL from where to download Mattermost release.
	// This can also point to a local binary path if the user wants to run loadtest
	// on a custom build. The path should be prefixed with "file://". In that case,
	// only the binary gets replaced, and the rest of the build comes from the latest
	// stable release.
	MattermostDownloadURL string
	MattermostLicenseFile string // Path to the Mattermost EE license file.
	AdminEmail            string // Mattermost instance sysadmin e-mail.
	AdminUsername         string // Mattermost instance sysadmin user name.
	AdminPassword         string // Mattermost instance sysadmin password.
	// URL from where to download load-test-ng binaries and configuration files.
	// The configuration files provided in the package will be overridden in
	// the deployment process.
	LoadTestDownloadURL string
	LogSettings         logger.Settings
}

Config contains the necessary data to deploy and provision a load test environment.

func ReadConfig

func ReadConfig(filePath string) (*Config, error)

ReadConfig reads the configuration file from the given string. If the string is empty, it will search a config file in predefined folders.

func (*Config) IsValid

func (c *Config) IsValid() error

IsValid reports whether a given deployment config is valid or not.