advise

Documentation

Index

• Constants
• func Advise(ctx context.Context, cfg *scout.Config, pod v1.Pod) error
• func CheckUsage(usage float64, resourceType string, container string) scout.Advice
• func K8s(ctx context.Context, k8sClient *kubernetes.Clientset, ...) error
• func OutputToFile(ctx context.Context, cfg *scout.Config, name string, advice []scout.Advice) error
• type Option
  • func WithNamespace(namespace string) Option
  • func WithOutput(pathToFile string) Option
  • func WithPod(podname string) Option
  • func WithWarnings(includeWarnings bool) Option

Constants

const (
	UNDER_PROVISIONED = "%s %s: %s is under-provisioned (%.2f%% usage). Add resources."
	WELL_PROVISIONED  = "%s %s: %s is well-provisioned (%.2f%% usage). No action needed."
	OVER_PROVISIONED  = "%s %s: %s is over-provisioned (%.2f%% usage). Trim resources."
)

Functions

func Advise

func Advise(ctx context.Context, cfg *scout.Config, pod v1.Pod) error

Advise generates resource allocation advice for a Kubernetes pod. The function fetches usage metrics for each container in the pod. It then checks the usage percentages against thresholds to determine if more or less of a resource is needed. Advice is generated and either printed to the console or output to a file depending on the cfg.Output field.

func CheckUsage

func CheckUsage(usage float64, resourceType string, container string) scout.Advice

func K8s

func K8s(
	ctx context.Context,
	k8sClient *kubernetes.Clientset,
	metricsClient *metricsv.Clientset,
	restConfig *rest.Config,
	opts ...Option,
) error

func OutputToFile

func OutputToFile(ctx context.Context, cfg *scout.Config, name string, advice []scout.Advice) error

outputToFile writes resource allocation advice for a Kubernetes pod to a file.

Types

type Option

type Option = func(config *scout.Config)

func WithNamespace

func WithNamespace(namespace string) Option

func WithOutput

func WithOutput(pathToFile string) Option

func WithPod

func WithPod(podname string) Option

func WithWarnings

func WithWarnings(includeWarnings bool) Option