calc

Documentation

Overview

Package calc provides function to calculate resource quotas for different k8s resources.

Index

• Variables
• type CalculationError
  • func (cErr CalculationError) Error() string
  • func (cErr CalculationError) Unwrap() error
• type Details
• type ResourceUsage
  • func ResourceQuotaFromYaml(yamlData []byte) (*ResourceUsage, error)

Variables

var (
	// ErrResourceNotSupported is returned if a k8s resource is not supported by kuota-calc.
	ErrResourceNotSupported = errors.New("resource not supported")
)

Types

type CalculationError

type CalculationError struct {
	Version string
	Kind    string
	// contains filtered or unexported fields
}

CalculationError is an error implementation that includes a k8s Kind/Version.

func (CalculationError) Error

func (cErr CalculationError) Error() string

func (CalculationError) Unwrap

func (cErr CalculationError) Unwrap() error

Unwrap implements the errors.Unwrap interface.

type Details

type Details struct {
	Version     string
	Kind        string
	Name        string
	Strategy    string
	Replicas    int32
	MaxReplicas int32
}

Details contains a few details of a k8s resource, which are needed to generate a detailed resource usage report.

type ResourceUsage

type ResourceUsage struct {
	CPU     *resource.Quantity
	Memory  *resource.Quantity
	Details Details
}

ResourceUsage summarizes the usage of compute resources for a k8s resource.

func ResourceQuotaFromYaml

func ResourceQuotaFromYaml(yamlData []byte) (*ResourceUsage, error)

ResourceQuotaFromYaml decodes a single yaml document into a k8s object. Then performs a type assertion on the object and calculates the resource needs of it. Currently supported: * apps/v1 - Deployment * apps/v1 - StatefulSet * apps/v1 - DaemonSet * batch/v1 - CronJob * batch/v1 - Job * v1 - Pod