aks

README

AKS Module

This module is responsible for collecting pricing information for AKS clusters.

Pricing Map

Because Azure has not yet implemented the pricing API into it's SDK :shame:, this packages uses the 3rd party Azure Retail Prices SDK to grab the prices.

This is based on Azure's pricing model, where different prices are determined by a combination of those factors.

Price Stratification

The PricingMap is built out with the following structure:

root -> {
  regionName -> {
    machinePriority -> {
      operatingSystem -> {
        skuName -> information
      }
    }
  }
}

That way, in order to uniquely identify a price, we will have to have the following attributes of any VM:

• the region it is deployed into
• it's priority (spot or on-demand)
• the operating system it is running
• it's SKU (e.g. E8-4as_v4)

Future Work

• (Pricing Map) - implement background job to populate pricing map every 24 hours
• (Pricing Map) - clear and repopulate Price Map and cache with backgroud job
• (Pricing Map) - implement retry mechanism to pricing map, crash program if it doesn't populate after 5 tries
• (Pricing Map) - implement VM lookup by machine ID
• (VMs) - implement VM list
• connect VM list with Pricing Map
• Prometheus metrics

Documentation

Index

• Constants
• Variables
• type Collector
  • func New(ctx context.Context, cfg *Config) (*Collector, error)
  • func (c *Collector) Collect(ch chan<- prometheus.Metric) error
  • func (c *Collector) CollectMetrics(_ chan<- prometheus.Metric) float64
  • func (c *Collector) Describe(ch chan<- *prometheus.Desc) error
  • func (c *Collector) Name() string
  • func (c *Collector) Register(_ provider.Registry) error
• type Config
• type MachineOperatingSystem
  • func (o MachineOperatingSystem) String() string
• type MachinePriority
  • func (v MachinePriority) String() string
• type PriceByOperatingSystem
• type PriceByPriority
• type PriceBySku
• type PriceStore
  • func NewPricingStore(subId string, priceClient *retailPriceSdk.RetailPricesClient, ...) *PriceStore
  • func (p *PriceStore) GetVmPrice()
  • func (p *PriceStore) PopulatePriceStore(locationList []string) error

Constants

const (
	AZ_API_VERSION string = "2023-01-01-preview" // using latest API Version https://learn.microsoft.com/en-us/rest/api/cost-management/retail-prices/azure-retail-prices
)

Variables

var (
	ErrClientCreationFailure = errors.New("failed to create client")
	ErrPageAdvanceFailure    = errors.New("failed to advance page")
)

Errors

Types

type Collector

type Collector struct {
	PriceStore *PriceStore
	// contains filtered or unexported fields
}

Collector is a prometheus collector that collects metrics from AKS clusters.

func New

func New(ctx context.Context, cfg *Config) (*Collector, error)

func (*Collector) Collect

func (c *Collector) Collect(ch chan<- prometheus.Metric) error

Collect satisfies the provider.Collector interface.

func (*Collector) CollectMetrics

func (c *Collector) CollectMetrics(_ chan<- prometheus.Metric) float64

CollectMetrics is a no-op function that satisfies the provider.Collector interface. Deprecated: CollectMetrics is deprecated and will be removed in a future release.

func (*Collector) Describe

func (c *Collector) Describe(ch chan<- *prometheus.Desc) error

func (*Collector) Name

func (c *Collector) Name() string

func (*Collector) Register

func (c *Collector) Register(_ provider.Registry) error

type Config

type Config struct {
	Logger      *slog.Logger
	Credentials *azidentity.DefaultAzureCredential

	SubscriptionId string
}

type MachineOperatingSystem

type MachineOperatingSystem int

const (
	Linux MachineOperatingSystem = iota
	Windows
)

func (MachineOperatingSystem) String

func (o MachineOperatingSystem) String() string

type MachinePriority

type MachinePriority int

const (
	OnDemand MachinePriority = iota
	Spot
)

func (MachinePriority) String

func (v MachinePriority) String() string

type PriceByOperatingSystem

type PriceByOperatingSystem map[MachineOperatingSystem]PriceBySku

type PriceByPriority

type PriceByPriority map[MachinePriority]PriceByOperatingSystem

type PriceBySku

type PriceBySku map[string]retailPriceSdk.ResourceSKU

type PriceStore

type PriceStore struct {
	RegionMap map[string]PriceByPriority
	Cache     map[string]*retailPriceSdk.ResourceSKU
	// contains filtered or unexported fields
}

func NewPricingStore

func NewPricingStore(subId string, priceClient *retailPriceSdk.RetailPricesClient, parentLogger *slog.Logger, parentContext context.Context) *PriceStore

func (*PriceStore) GetVmPrice

func (p *PriceStore) GetVmPrice()

TODO - implement ability to lookup a certain VM's Price by it's ID

func (*PriceStore) PopulatePriceStore

func (p *PriceStore) PopulatePriceStore(locationList []string) error