descheduler/pkg/api/types.go

/*
Copyright 2017 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package api

import (
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/resource"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
)

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type DeschedulerPolicy struct {
	metav1.TypeMeta

	// Profiles
	Profiles []DeschedulerProfile

	// NodeSelector for a set of nodes to operate over
	NodeSelector *string

	// MaxNoOfPodsToEvictPerNode restricts maximum of pods to be evicted per node.
	MaxNoOfPodsToEvictPerNode *uint

	// MaxNoOfPodsToEvictPerNamespace restricts maximum of pods to be evicted per namespace.
	MaxNoOfPodsToEvictPerNamespace *uint

	// MaxNoOfPodsToTotal restricts maximum of pods to be evicted total.
	MaxNoOfPodsToEvictTotal *uint

	// EvictionFailureEventNotification should be set to true to enable eviction failure event notification.
	// Default is false.
	EvictionFailureEventNotification *bool

	// MetricsCollector configures collection of metrics about actual resource utilization
	// Deprecated. Use MetricsProviders field instead.
	MetricsCollector *MetricsCollector

	// MetricsProviders configure collection of metrics about actual resource utilization from various sources
	MetricsProviders []MetricsProvider

	// GracePeriodSeconds The duration in seconds before the object should be deleted. Value must be non-negative integer.
	// The value zero indicates delete immediately. If this value is nil, the default grace period for the
	// specified type will be used.
	// Defaults to a per object value if not specified. zero means delete immediately.
	GracePeriodSeconds *int64
}

// Namespaces carries a list of included/excluded namespaces
// for which a given strategy is applicable
type Namespaces struct {
	Include []string `json:"include,omitempty"`
	Exclude []string `json:"exclude,omitempty"`
}

// EvictionLimits limits the number of evictions per domain. E.g. node, namespace, total.
type EvictionLimits struct {
	// node restricts the maximum number of evictions per node
	Node *uint `json:"node,omitempty"`
}

type (
	Percentage         float64
	ResourceThresholds map[v1.ResourceName]Percentage
)

type PriorityThreshold struct {
	Value *int32 `json:"value"`
	Name  string `json:"name"`
}

type DeschedulerProfile struct {
	Name          string
	PluginConfigs []PluginConfig
	Plugins       Plugins
}

type PluginConfig struct {
	Name string
	Args runtime.Object
}

type Plugins struct {
	PreSort           PluginSet
	Sort              PluginSet
	Deschedule        PluginSet
	Balance           PluginSet
	Filter            PluginSet
	PreEvictionFilter PluginSet
}

type PluginSet struct {
	Enabled  []string
	Disabled []string
}

type MetricsSource string

const (
	// KubernetesMetrics enables metrics from a Kubernetes metrics server.
	// Please see https://kubernetes-sigs.github.io/metrics-server/ for more.
	KubernetesMetrics MetricsSource = "KubernetesMetrics"

	// KubernetesMetrics enables metrics from a Prometheus metrics server.
	PrometheusMetrics MetricsSource = "Prometheus"
)

// MetricsCollector configures collection of metrics about actual resource utilization
type MetricsCollector struct {
	// Enabled metrics collection from Kubernetes metrics.
	// Deprecated. Use MetricsProvider.Source field instead.
	Enabled bool
}

// MetricsProvider configures collection of metrics about actual resource utilization from a given source
type MetricsProvider struct {
	// Source enables metrics from Kubernetes metrics server.
	Source MetricsSource

	// Prometheus enables metrics collection through Prometheus
	Prometheus *Prometheus
}

// ReferencedResourceList is an adaption of v1.ResourceList with resources as references
type ReferencedResourceList = map[v1.ResourceName]*resource.Quantity

type Prometheus struct {
	URL string
	// authToken used for authentication with the prometheus server.
	// If not set the in cluster authentication token for the descheduler service
	// account is read from the container's file system.
	AuthToken *AuthToken
}

type AuthToken struct {
	// secretReference references an authentication token.
	// secrets are expected to be created under the descheduler's namespace.
	SecretReference *SecretReference
}

// SecretReference holds a reference to a Secret
type SecretReference struct {
	// namespace is the namespace of the secret.
	Namespace string
	// name is the name of the secret.
	Name string
}