ratio

package

v0.12.2 Latest Latest Go to latest Published: Mar 18, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrorDisabled error = errors.New("request ratio validation disabled")

ErrorDisabled is returned if the request ratio validation is disabled

View Source

var RatioValidatiorDisableAnnotation = "validate-request-ratio.appuio.io/disable"

RatioValidatiorDisableAnnotation is the key for an annotion on a namespace to disable request ratio warnings

This section is empty.

type Fetcher struct {
	Client client.Client

	OrganizationLabel string
}

Fetcher collects the CPU to memory request ratio

func (f Fetcher) FetchRatios(ctx context.Context, name string) (map[string]*Ratio, error)

FetchRatios collects the CPU to memory request ratio for the given namespace grouped by `.spec.nodeSelector`.

type Ratio struct {
	CPU    *inf.Dec
	Memory *inf.Dec
}

Ratio records resource requests and can calculate the current memory to CPU request ratio

func NewRatio() *Ratio

NewRatio returns an initialized Ratio

func (r Ratio) Below(limit resource.Quantity) bool

Below returns if the memory to CPU ratio of the recorded objects is below the given limit. Always returns false if no CPU is requested.

func (r Ratio) Ratio() *resource.Quantity

Ratio returns the memory to CPU ratio of the recorded objects. Returns nil if there are no CPU requests. Ratio rounds up to the nearest MiB

func (r *Ratio) RecordDeployment(deps ...appsv1.Deployment) *Ratio

RecordDeployment collects all requests in the given deployment(s) and adds it to the ratio

func (r *Ratio) RecordPod(pods ...corev1.Pod) *Ratio

RecordPod collects all requests in the given Pod(s), and adds it to the ratio The function only considers pods in phase `Running`.

func (r *Ratio) RecordStatefulSet(stss ...appsv1.StatefulSet) *Ratio

RecordStatefulSet collects all requests in the given StatefulSet(s) and adds it to the ratio

func (r Ratio) String() string

String implements Stringer to print ratio

func (r Ratio) Warn(limit *resource.Quantity, nodeSelector string) string

Warn returns a warning string explaining that the ratio is not considered fair use