value

type AutobenchConfig struct {
	SSHConfig       *SSHConfig       `yaml:"ssh,omitempty"`
	Blueprint       *Blueprint       `yaml:"blueprint,omitempty"`
	BenchmarkConfig *BenchmarkConfig `yaml:"benchmark,omitempty"`
}

type BackupClientBlueprint struct {
	// Host is the hostname/address of the node
	Host string `yaml:"host,omitempty"`

	// PackagePath is the path to a local package. This package will be secure copied to the backup client and installed
	// instead of downloading the build from latest builds.
	//
	// NOTE: No validation takes place to ensure the package is valid for the current distribution; that's on you...
	PackagePath string `yaml:"package_path,omitempty"`
}

type BackupInfo struct {
	BackupSize uint64
	ItemsNum   uint64
}

type BenchmarkConfig struct {
	// Iterations is the number of times a benchmark will be run, more iterations will result in more accurate data.
	Iterations int `json:"iterations,omitempty" yaml:"iterations,omitempty"`

	// CBMConfig is the configuration which will be passed to 'cbbackupmgr' when run on the remote machine.
	CBMConfig *CBMConfig `json:"cbbackupmgr_config,omitempty" yaml:"cbbackupmgr_config,omitempty"`
}

type BenchmarkResult struct {
	// Duration is the how long the benchmark took to complete (this does not include setup/cleanup).
	Duration time.Duration

	// AIN is the actual number of data items that was backed up. This will be used to determine if a workload
	// generation tool (e.g. cbc-pillowfight) has managed to generate enough mutations during each granularity period
	// (relevant to Point-In-Time backup testing).
	AIN uint64

	// ADS is the actual size of the data that was backed up. This will be used to calculate how much data is
	// transferred for backup/restore benchmarks.
	ADS uint64
}

type BenchmarkResults []*BenchmarkResult

type Blueprint struct {
	Cluster      *ClusterBlueprint      `yaml:"cluster,omitempty"`
	BackupClient *BackupClientBlueprint `yaml:"backup_client,omitempty"`
}

type BucketBlueprint struct {
	VBuckets          uint16         `json:"vbuckets,omitempty" yaml:"vbuckets,omitempty"`
	Type              string         `json:"type,omitempty" yaml:"type,omitempty"`
	EvictionPolicy    string         `json:"eviction_policy,omitempty" yaml:"eviction_policy,omitempty"`
	Compact           bool           `json:"compact,omitempty" yaml:"compact,omitempty"`
	PiTREnabled       bool           `json:"pitr_enabled,omitempty" yaml:"pitr_enabled,omitempty"`
	PiTRGranularity   uint64         `json:"pitr_granularity,omitempty" yaml:"pitr_granularity,omitempty"`
	PiTRMaxHistoryAge uint64         `json:"pitr_max_history_age,omitempty" yaml:"pitr_max_history_age,omitempty"`
	Data              *DataBlueprint `json:"data,omitempty" yaml:"data,omitempty"`
}

type CBMConfig struct {
	// EnvVars is the environment that will be passed to 'cbbackupmgr'.
	EnvVars CBMEnvironment `json:"environment_variables,omitempty" yaml:"environment_variables,omitempty"`

	// Archive/repository that 'cbbackupmgr' will use.
	Archive    string `json:"archive,omitempty" yaml:"archive,omitempty"`
	Repository string `json:"repository,omitempty" yaml:"repository,omitempty"`

	// Storage is the storage type that will be used. This is a hidden command in 'cbbackupmgr' and is unsupported.
	Storage string `json:"storage,omitempty" yaml:"storage,omitempty"`

	// Cloud related arguments.
	ObjStagingDirectory       string `json:"obj_staging_directory,omitempty" yaml:"obj_staging_directory,omitempty"`
	ObjAccessKeyID            string `json:"-" yaml:"obj_access_key_id,omitempty"`
	ObjSecretAccessKey        string `json:"-" yaml:"obj_secret_access_key,omitempty"`
	ObjRegion                 string `json:"obj_region,omitempty" yaml:"obj_region,omitempty"`
	ObjEndpoint               string `json:"obj_endpoint,omitempty" yaml:"obj_endpoint,omitempty"`
	ObjAuthByInstanceMetadata bool   `json:"obj_auth_by_instance_metadata,omitempty" yaml:"obj_auth_by_instance_metadata,omitempty"` //nolint:lll
	ObjNoSSLVerify            bool   `json:"obj_no_ssl_verify,omitempty" yaml:"obj_no_ssl_verify,omitempty"`
	S3LogLevel                string `json:"s3_log_level,omitempty" yaml:"s3_log_level,omitempty"`
	S3ForcePathStyle          bool   `json:"s3_force_path_style,omitempty" yaml:"s3_force_path_style,omitempty"`

	// Encrypted related arguments
	Encrypted      bool   `json:"encrypted,omitempty" yaml:"encrypted,omitempty"`
	Passphrase     string `json:"passphrase,omitempty" yaml:"passphrase,omitempty"`
	EncryptionAlgo string `json:"encryption_algo,omitempty" yaml:"encryption_algo,omitempty"`

	// NumThreads is the default of threads which will be used by 'cbbackupmgr'. A zero value will allow 'cbbackupmgr'
	// to automatically determine the number of threads.
	Threads int `json:"threads,omitempty" yaml:"threads,omitempty"`

	// PiTR indicates whether the backup repository should be configured for Point-In-Time backups.
	PiTR bool `json:"pitr,omitempty" yaml:"pitr,omitempty"`

	// Blackhole indicates whether the benchmarks should actually backup any data or just pull it from the cluster and
	// then discard it immediately.
	Blackhole bool `json:"blackhole,omitempty" yaml:"blackhole,omitempty"`
}

type CBMEnvironment map[string]string

type ClusterBlueprint struct {
	// PackagePath is the path to a local package. This package will be secure copied to each cluster node and installed
	// instead of downloading the build from latest builds.
	//
	// NOTE: No validation takes place to ensure the package is valid for the current distribution; that's on you...
	PackagePath string `yaml:"package_path,omitempty"`

	// Nodes is the list of node blueprints which will be used to create the cluster.
	Nodes []*NodeBlueprint `yaml:"nodes,omitempty"`

	// Bucket is the blueprint for the bucket that will be created once the cluster is provisioned.
	Bucket *BucketBlueprint `yaml:"bucket,omitempty"`

	// DeveloperPreview is a boolean which indicates whether or not developer preview should be enabled on the
	// cluster.
	DeveloperPreview bool `yaml:"developer_preview,omitempty"`
}

type Command string

type DataBlueprint struct {
	DataLoader   DataLoaderType `json:"data_loader,omitempty" yaml:"data_loader,omitempty"`
	Items        int            `json:"items,omitempty" yaml:"items,omitempty"`
	ActiveItems  int            `json:"active_items,omitempty" yaml:"active_items,omitempty"`
	Size         int            `json:"size,omitempty" yaml:"size,omitempty"`
	Compressible bool           `json:"compressible,omitempty" yaml:"compressible,omitempty"`
	LoadThreads  int            `json:"load_threads,omitempty" yaml:"load_threads,omitempty"`
}

type DataLoaderType string

type NodeBlueprint struct {
	Host     string `json:"host,omitempty" yaml:"host,omitempty"`
	DataPath string `json:"-" yaml:"data_path,omitempty"`
}

type Platform string

type SSHConfig struct {
	Username             string `yaml:"username,omitempty"`
	PrivateKey           string `yaml:"private_key,omitempty"`
	PrivateKeyPassphrase string `yaml:"private_key_passphrase,omitempty"`
}

type Stats struct {
	ItemCount              uint64 `json:"itemCount"`
	DiskUsed               uint64 `json:"diskUsed"`
	MemUsed                uint64 `json:"memUsed"`
	VBActiveNumNonResident uint64 `json:"vbActiveNumNonResident"`
}