placement

type InventoryUsage struct {
	ResourceProviderUUID       string `db:"resource_provider_uuid,primarykey"`
	ResourceProviderGeneration int    `db:"resource_provider_generation"`

	// Something like: DISK_GB, VCPU, MEMORY_MB.
	InventoryClassName string `db:"inventory_class_name,primarykey"`
	// Overcommit factor for the inventory class.
	AllocationRatio float32 `db:"allocation_ratio"`
	// A maximum amount any single allocation against an inventory can have.
	MaxUnit int `db:"max_unit"`
	// A minimum amount any single allocation against an inventory can have.
	MinUnit int `db:"min_unit"`
	// The amount of the resource a provider has reserved for its own use.
	Reserved int `db:"reserved"`
	// A representation of the divisible amount of the resource that may be
	// requested. For example, step_size = 5 means that only values divisible by
	// 5 (5, 10, 15, etc.) can be requested.
	StepSize int `db:"step_size"`
	// The actual amount of the resource that the provider can accommodate.
	Total int `db:"total"`

	// The amount of the resource that is currently in use.
	Used int `db:"used"`
}

type PlacementAPI interface {
	// Init the placement API.
	Init(ctx context.Context) error
	// Fetch all resource providers from the placement API.
	GetAllResourceProviders(ctx context.Context) ([]ResourceProvider, error)
	// Fetch all traits for the given resource providers from the placement API.
	GetAllTraits(ctx context.Context, providers []ResourceProvider) ([]Trait, error)
	// Fetch all inventories + usages for the given resource providers from the placement API.
	GetAllInventoryUsages(ctx context.Context, providers []ResourceProvider) ([]InventoryUsage, error)
}

type PlacementSyncer struct {
	// Database to store the placement objects in.
	DB db.DB
	// Monitor to track the syncer.
	Mon datasources.Monitor
	// Configuration for the placement syncer.
	Conf v1alpha1.PlacementDatasource
	// Placement API client to fetch the data.
	API PlacementAPI
}

type ResourceProvider struct {
	UUID                       string `json:"uuid" db:"uuid,primarykey"`
	Name                       string `json:"name" db:"name"`
	ParentProviderUUID         string `json:"parent_provider_uuid" db:"parent_provider_uuid"`
	RootProviderUUID           string `json:"root_provider_uuid" db:"root_provider_uuid"`
	ResourceProviderGeneration int    `json:"resource_provider_generation" db:"resource_provider_generation"`
}

type Trait struct {
	// Corresponds to the hypervisor uuid in the nova hypervisors table.
	ResourceProviderUUID       string `db:"resource_provider_uuid,primarykey"`
	Name                       string `db:"name,primarykey"`
	ResourceProviderGeneration int    `db:"resource_provider_generation"`
}