operator

package
v0.64.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2023 License: Apache-2.0 Imports: 45 Imported by: 5

Documentation

Index

Constants

View Source 
const (
	// DefaultAlertmanagerVersion is a default image tag for the prometheus alertmanager
	DefaultAlertmanagerVersion = "v0.25.0"
	// DefaultAlertmanagerBaseImage is a base container registry address for the prometheus alertmanager
	DefaultAlertmanagerBaseImage = "quay.io/prometheus/alertmanager"
	// DefaultAlertmanagerImage is a default image pulling address for the prometheus alertmanager
	DefaultAlertmanagerImage = DefaultAlertmanagerBaseImage + ":" + DefaultAlertmanagerVersion

	// DefaultThanosVersion is a default image tag for the Thanos long-term prometheus storage collector
	DefaultThanosVersion = "v0.31.0"
	// DefaultThanosBaseImage is a base container registry address for the Thanos long-term prometheus
	// storage collector
	DefaultThanosBaseImage = "quay.io/thanos/thanos"
	// DefaultThanosImage is a default image pulling address for the Thanos long-term prometheus storage collector
	DefaultThanosImage = DefaultThanosBaseImage + ":" + DefaultThanosVersion
)
View Source 
const (
	AddEvent    = HandlerEvent("add")
	DeleteEvent = HandlerEvent("delete")
	UpdateEvent = HandlerEvent("update")
)
View Source 
const MaxSecretDataSizeBytes = v1.MaxSecretSize - 50_000

MaxSecretDataSizeBytes is the maximum data size that a single secret shard may use. This is lower than v1.MaxSecretSize in order to reserve space for metadata and the rest of the secret k8s object.

Variables

View Source 
var (
	// DefaultPrometheusVersion is a default image tag for the prometheus
	DefaultPrometheusVersion = PrometheusCompatibilityMatrix[len(PrometheusCompatibilityMatrix)-1]
	// DefaultPrometheusBaseImage is a base container registry address for the prometheus
	DefaultPrometheusBaseImage = "quay.io/prometheus/prometheus"
	// DefaultPrometheusImage is a default image pulling address for the prometheus
	DefaultPrometheusImage = DefaultPrometheusBaseImage + ":" + DefaultPrometheusVersion

	// DefaultPrometheusConfigReloaderImage is an image that will be used as a sidecar to provide dynamic prometheus
	// configuration reloading
	DefaultPrometheusConfigReloaderImage = "quay.io/prometheus-operator/prometheus-config-reloader:v" + version.Version

	// PrometheusCompatibilityMatrix is a list of supported prometheus versions.
	// prometheus-operator end-to-end tests verify that the operator can deploy from LTS n-1 to the latest stable.
	// This list should be updated every time a new LTS is released.
	PrometheusCompatibilityMatrix = []string{
		"v2.37.0",
		"v2.37.1",
		"v2.37.2",
		"v2.37.3",
		"v2.37.4",
		"v2.37.5",
		"v2.38.0",
		"v2.39.0",
		"v2.39.1",
		"v2.39.2",
		"v2.40.0",
		"v2.40.1",
		"v2.40.2",
		"v2.40.3",
		"v2.40.4",
		"v2.40.5",
		"v2.40.6",
		"v2.40.7",
		"v2.41.0",
		"v2.42.0",
		"v2.43.0",
	}
)
View Source 
var (
	DefaultReloaderTestConfig = &Config{
		ReloaderConfig: ContainerConfig{
			CPURequest:    "100m",
			CPULimit:      "100m",
			MemoryRequest: "50Mi",
			MemoryLimit:   "50Mi",
			Image:         "quay.io/prometheus-operator/prometheus-config-reloader:latest",
		},
	}
)

Functions

func BuildArgs added in v0.63.0 

func BuildArgs(args []monitoringv1.Argument, additionalArgs []monitoringv1.Argument) ([]string, error)

BuildArgs takes a list of arguments and a list of additional arguments and returns a []string to use in a container Args

func BuildImagePath added in v0.42.0 

func BuildImagePath(specImage, baseImage, version, tag, sha string) (string, error)

BuildImagePath builds a container image path based on the given parameters. Return specImage if not empty. If image contains a tag or digest then image will be returned. Otherwise, return image suffixed by either SHA, tag or version(in that order). Inspired by kubernetes code handling of image building.

func CreateConfigReloader added in v0.43.0 

func CreateConfigReloader(name string, options ...ReloaderOption) v1.Container

CreateConfigReloader returns the definition of the config-reloader container.

func CurlProber added in v0.57.0 

func CurlProber(u string) string

func GunzipConfig added in v0.59.0 

func GunzipConfig(b []byte) (string, error)

func GzipConfig added in v0.59.0 

func GzipConfig(w io.Writer, conf []byte) error

func ListMatchingNamespaces added in v0.64.0 

func ListMatchingNamespaces(selector labels.Selector, nsInf cache.SharedIndexInformer) ([]string, error)

ListMatchingNamespaces lists all the namespaces that match the provided selector.

func MakeHostAliases added in v0.57.0 

func MakeHostAliases(input []monitoringv1.HostAlias) []v1.HostAlias

MakeHostAliases converts array of monitoringv1 HostAlias to array of corev1 HostAlias

func MakeVolumeClaimTemplate added in v0.42.0 

func MakeVolumeClaimTemplate(e monitoringv1.EmbeddedPersistentVolumeClaim) *v1.PersistentVolumeClaim

func SanitizeSTS added in v0.42.0 

func SanitizeSTS(sts *appsv1.StatefulSet)

SanitizeSTS removes values for APIVersion and Kind from the VolumeClaimTemplates. This prevents update failures due to these fields changing when applied. See https://github.com/kubernetes/kubernetes/issues/87583

func StringPtrValOrDefault added in v0.42.0 

func StringPtrValOrDefault(val *string, defaultVal string) string

StringPtrValOrDefault returns the default val if the given string pointer is nil points to an empty/whitespace string. Otherwise returns the value of the string.

func StringValOrDefault added in v0.42.0 

func StringValOrDefault(val, defaultVal string) string

StringValOrDefault returns the default val if the given string is empty/whitespace. Otherwise returns the value of the string..

func TestSidecarsResources added in v0.63.0 

func TestSidecarsResources(t *testing.T, makeStatefulSet func(reloaderConfig ContainerConfig) *appsv1.StatefulSet)

func ValidateDurationField added in v0.52.0 

func ValidateDurationField(durationField string) error

func ValidateRule added in v0.61.0 

func ValidateRule(promRule monitoringv1.PrometheusRuleSpec) []error

ValidateRule takes PrometheusRuleSpec and validates it using the upstream prometheus rule validator.

func ValidateSizeField added in v0.52.0 

func ValidateSizeField(sizeField string) error

func WaitForNamedCacheSync added in v0.43.1 

func WaitForNamedCacheSync(ctx context.Context, controllerName string, logger log.Logger, inf cache.SharedIndexInformer) bool

WaitForNamedCacheSync synchronizes the informer's cache and will log a warning every minute if the operation hasn't completed yet, until it reaches a timeout of 10 minutes. Under normal circumstances, the cache sync should be fast. If it takes more than 1 minute, it means that something is stuck and the message will indicate to the admin which informer is the culprit. See https://github.com/prometheus-operator/prometheus-operator/issues/3347.

func WgetProber added in v0.57.0 

func WgetProber(u string) string

Types

type Accessor added in v0.64.0 

type Accessor struct {
	// contains filtered or unexported fields
}

Accessor can manipulate objects returned by informers and handlers.

func NewAccessor added in v0.64.0 

func NewAccessor(l log.Logger) *Accessor

func (*Accessor) MetaNamespaceKey added in v0.64.0 

func (a *Accessor) MetaNamespaceKey(obj interface{}) (string, bool)

MetaNamespaceKey returns a key from the object's metadata. For namespaced objects, the format is `<namespace>/<name>`, otherwise `name`.

func (*Accessor) ObjectMetadata added in v0.64.0 

func (a *Accessor) ObjectMetadata(obj interface{}) (metav1.Object, bool)

ObjectMetadata returns the object's metadata and bool indicating if the conversion succeeded

type Config 

type Config struct {
	Host                         string
	ClusterDomain                string
	KubeletObject                string
	ListenAddress                string
	TLSInsecure                  bool
	TLSConfig                    rest.TLSClientConfig
	ServerTLSConfig              server.TLSServerConfig
	ReloaderConfig               ContainerConfig
	AlertmanagerDefaultBaseImage string
	PrometheusDefaultBaseImage   string
	ThanosDefaultBaseImage       string
	Namespaces                   Namespaces
	Labels                       Labels
	LocalHost                    string
	LogLevel                     string
	LogFormat                    string
	PromSelector                 string
	AlertManagerSelector         string
	ThanosRulerSelector          string
	SecretListWatchSelector      string
}

Config defines configuration parameters for the Operator.

type ConfigReloader added in v0.49.0 

type ConfigReloader struct {
	// contains filtered or unexported fields
}

ConfigReloader contains the options to configure a config-reloader container

type ContainerConfig added in v0.63.0 

type ContainerConfig struct {
	CPURequest    string
	CPULimit      string
	MemoryRequest string
	MemoryLimit   string
	Image         string
}

ContainerConfig holds some configuration for the ConfigReloader sidecar that can be set through prometheus-operator command line arguments

type HandlerEvent added in v0.61.0 

type HandlerEvent string

type Labels added in v0.43.0 

type Labels struct {
	LabelsString string
	LabelsMap    map[string]string
}

func (*Labels) Merge added in v0.43.0 

func (labels *Labels) Merge(otherLabels map[string]string) map[string]string

Merge labels create a new map with labels merged.

func (*Labels) Set added in v0.43.0 

func (labels *Labels) Set(value string) error

Set implements the flag.Set interface.

func (*Labels) SortedKeys added in v0.63.0 

func (labels *Labels) SortedKeys() []string

Returns an arrary with the keys of the label map sorted

func (*Labels) String added in v0.43.0 

func (labels *Labels) String() string

Implement the flag.Value interface

type Metrics added in v0.42.0 

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics represents metrics associated to an operator.

func NewMetrics added in v0.42.0 

func NewMetrics(r prometheus.Registerer) *Metrics

NewMetrics initializes operator metrics and registers them with the given registerer.

func (*Metrics) Collect added in v0.43.0 

func (m *Metrics) Collect(ch chan<- prometheus.Metric)

Collect implements the prometheus.Collector interface.

func (*Metrics) Describe added in v0.43.0 

func (m *Metrics) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus.Collector interface.

func (*Metrics) MustRegister added in v0.42.0 

func (m *Metrics) MustRegister(metrics ...prometheus.Collector)

MustRegister registers metrics with the Metrics registerer.

func (*Metrics) NewInstrumentedListerWatcher added in v0.42.0 

func (m *Metrics) NewInstrumentedListerWatcher(lw cache.ListerWatcher) cache.ListerWatcher

NewInstrumentedListerWatcher returns a cache.ListerWatcher with instrumentation.

func (*Metrics) Ready added in v0.43.0 

func (m *Metrics) Ready() prometheus.Gauge

Ready returns a gauge to track whether the controller is ready or not.

func (*Metrics) SetRejectedResources added in v0.43.0 

func (m *Metrics) SetRejectedResources(objKey, resource string, v int)

SetRejectedResources sets the number of resources that the controller rejected for the given object's key.

func (*Metrics) SetSelectedResources added in v0.43.0 

func (m *Metrics) SetSelectedResources(objKey, resource string, v int)

SetSelectedResources sets the number of resources that the controller selected for the given object's key.

func (*Metrics) StsDeleteCreateCounter added in v0.42.0 

func (m *Metrics) StsDeleteCreateCounter() prometheus.Counter

StsDeleteCreateCounter returns a counter to track statefulset's recreations.

func (*Metrics) TriggerByCounter added in v0.42.0 

func (m *Metrics) TriggerByCounter(triggeredBy string, action HandlerEvent) prometheus.Counter

TriggerByCounter returns a counter to track operator actions by resource type and action (add/delete/update).

type Namespaces added in v0.43.0 

type Namespaces struct {
	// Allow list/deny list for common custom resources.
	AllowList, DenyList map[string]struct{}
	// Allow list for prometheus/alertmanager custom resources.
	PrometheusAllowList, AlertmanagerAllowList, AlertmanagerConfigAllowList, ThanosRulerAllowList map[string]struct{}
}

type Pod added in v0.63.0 

type Pod v1.Pod

Pod is an alias for the Kubernetes v1.Pod type.

func (*Pod) Message added in v0.63.0 

func (p *Pod) Message() string

Message returns a human-readable and terse message about the state of the pod.

func (*Pod) Ready added in v0.63.0 

func (p *Pod) Ready() bool

Ready returns true if the pod is ready.

type PrometheusRuleSelector added in v0.64.0 

type PrometheusRuleSelector struct {
	// contains filtered or unexported fields
}

func NewPrometheusRuleSelector added in v0.64.0 

func NewPrometheusRuleSelector(ruleFormat RuleConfigurationFormat, labelSelector *metav1.LabelSelector, nsLabeler *namespacelabeler.Labeler, ruleInformer *informers.ForResource, logger log.Logger) (*PrometheusRuleSelector, error)

func (*PrometheusRuleSelector) Select added in v0.64.0 

func (pr *PrometheusRuleSelector) Select(namespaces []string) (map[string]string, int, error)

Select selects PrometheusRules and translates them into native Prometheus/Thanos configurations. The second returned value is the number of rejected PrometheusRule objects.

type ReconcilerMetrics added in v0.61.0 

type ReconcilerMetrics interface {
	TriggerByCounter(string, HandlerEvent) prometheus.Counter
}

ReconcilerMetrics tracks reconciler metrics.

type ReconciliationStatus added in v0.56.0 

type ReconciliationStatus struct {
	// contains filtered or unexported fields
}

func (ReconciliationStatus) Message added in v0.56.0 

func (rs ReconciliationStatus) Message() string

func (ReconciliationStatus) Ok added in v0.56.0 

func (rs ReconciliationStatus) Ok() bool

func (ReconciliationStatus) Reason added in v0.56.0 

func (rs ReconciliationStatus) Reason() string

type ReconciliationTracker added in v0.56.0 

type ReconciliationTracker struct {
	// contains filtered or unexported fields
}

ReconciliationTracker tracks reconciliation status per object. The zero ReconciliationTracker is ready to use.

func (*ReconciliationTracker) Collect added in v0.56.0 

func (rt *ReconciliationTracker) Collect(ch chan<- prometheus.Metric)

Collect implements the prometheus.Collector interface.

func (*ReconciliationTracker) Describe added in v0.56.0 

func (rt *ReconciliationTracker) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus.Collector interface.

func (*ReconciliationTracker) ForgetObject added in v0.56.0 

func (rt *ReconciliationTracker) ForgetObject(k string)

ForgetObject removes the given object from the tracker. It should be called when the controller detects that the object has been deleted.

func (*ReconciliationTracker) GetStatus added in v0.56.0 

func (rt *ReconciliationTracker) GetStatus(k string) (ReconciliationStatus, bool)

GetStatus returns the last reconciliation status for the given object. The second value indicates whether the object is known or not.

func (*ReconciliationTracker) SetStatus added in v0.56.0 

func (rt *ReconciliationTracker) SetStatus(k string, err error)

SetStatus updates the last reconciliation status for the given object.

type ReloaderOption added in v0.49.0 

type ReloaderOption = func(*ConfigReloader)

func ConfigEnvsubstFile added in v0.49.0 

func ConfigEnvsubstFile(configEnvsubstFile string) ReloaderOption

ConfigEnvsubstFile sets the configEnvsubstFile option for the config-reloader container

func ConfigFile added in v0.49.0 

func ConfigFile(configFile string) ReloaderOption

ConfigFile sets the configFile option for the config-reloader container

func ImagePullPolicy added in v0.62.0 

func ImagePullPolicy(imagePullPolicy v1.PullPolicy) ReloaderOption

ImagePullPolicy sets the imagePullPolicy option for the config-reloader container

func ListenLocal added in v0.49.0 

func ListenLocal(listenLocal bool) ReloaderOption

ListenLocal sets the listenLocal option for the config-reloader container

func LocalHost added in v0.49.0 

func LocalHost(localHost string) ReloaderOption

LocalHost sets the localHost option for the config-reloader container

func LogFormat added in v0.49.0 

func LogFormat(logFormat string) ReloaderOption

LogFormat sets the logFormat option for the config-reloader container

func LogLevel added in v0.49.0 

func LogLevel(logLevel string) ReloaderOption

LogLevel sets the logLevel option for the config-reloader container\

func ReloaderConfig added in v0.43.0 

func ReloaderConfig(rc ContainerConfig) ReloaderOption

ReloaderResources sets the config option for the config-reloader container

func ReloaderRunOnce added in v0.49.0 

func ReloaderRunOnce() ReloaderOption

ReloaderRunOnce sets the runOnce option for the config-reloader container

func ReloaderURL added in v0.49.0 

func ReloaderURL(reloadURL url.URL) ReloaderOption

ReloaderURL sets the reloaderURL option for the config-reloader container

func Shard added in v0.49.0 

func Shard(shard int32) ReloaderOption

Shard sets the shard option for the config-reloader container

func VolumeMounts added in v0.49.0 

func VolumeMounts(mounts []v1.VolumeMount) ReloaderOption

VolumeMounts sets the volumeMounts option for the config-reloader container

func WatchedDirectories added in v0.49.0 

func WatchedDirectories(watchedDirectories []string) ReloaderOption

WatchedDirectories sets the watchedDirectories option for the config-reloader container

type ResourceReconciler added in v0.61.0 

type ResourceReconciler struct {
	// contains filtered or unexported fields
}

ResourceReconciler reacts on changes for statefulset-based resources and triggers synchronization of the resources.

ResourceReconciler implements the cache.ResourceEventHandler interface and it can subscribe to resource events like this:

var statefulSetInformer, resourceInformer cache.SharedInformer ... rr := NewResourceReconciler(...) statefulSetInformer.AddEventHandler(rr) resourceInformer.AddEventHandler(rr)

ResourceReconciler will trigger object and status reconciliations based on the events received from the informer.

func NewResourceReconciler added in v0.61.0 

func NewResourceReconciler(
	l log.Logger,
	syncer Syncer,
	metrics ReconcilerMetrics,
	kind string,
	reg prometheus.Registerer,
) *ResourceReconciler

NewResourceReconciler returns a reconciler for the "kind" resource.

func (*ResourceReconciler) DeletionInProgress added in v0.61.0 

func (rr *ResourceReconciler) DeletionInProgress(o metav1.Object) bool

DeletionInProgress returns true if the object deletion has been requested.

func (*ResourceReconciler) EnqueueForReconciliation added in v0.61.0 

func (rr *ResourceReconciler) EnqueueForReconciliation(obj metav1.Object)

EnqueueForReconciliation asks for reconciling the object.

func (*ResourceReconciler) EnqueueForStatus added in v0.61.0 

func (rr *ResourceReconciler) EnqueueForStatus(obj metav1.Object)

EnqueueForStatus asks for updating the status of the object.

func (*ResourceReconciler) OnAdd added in v0.61.0 

func (rr *ResourceReconciler) OnAdd(obj interface{})

OnAdd implements the cache.ResourceEventHandler interface.

func (*ResourceReconciler) OnDelete added in v0.61.0 

func (rr *ResourceReconciler) OnDelete(obj interface{})

OnDelete implements the cache.ResourceEventHandler interface.

func (*ResourceReconciler) OnUpdate added in v0.61.0 

func (rr *ResourceReconciler) OnUpdate(old, cur interface{})

OnUpdate implements the cache.ResourceEventHandler interface.

func (*ResourceReconciler) Run added in v0.61.0 

func (rr *ResourceReconciler) Run(ctx context.Context)

Run the goroutines responsible for processing the reconciliation and status queues.

func (*ResourceReconciler) Stop added in v0.61.0 

func (rr *ResourceReconciler) Stop()

Stop the processing queues and wait for goroutines to exit.

type RuleConfigurationFormat added in v0.64.0 

type RuleConfigurationFormat int
const (
	PrometheusFormat RuleConfigurationFormat = iota
	ThanosFormat
)

type ShardedSecret added in v0.53.0 

type ShardedSecret struct {
	// contains filtered or unexported fields
}

ShardedSecret is k8s secret data that is sharded across multiple enumerated k8s secrets. This is used to circumvent the size limitation of k8s secrets.

func NewShardedSecret added in v0.53.0 

func NewShardedSecret(template *v1.Secret, namePrefix string) *ShardedSecret

NewShardedSecret takes a v1.Secret as template and a secret name prefix and returns a new ShardedSecret.

func (*ShardedSecret) AppendData added in v0.53.0 

func (s *ShardedSecret) AppendData(key string, data []byte)

AppendData adds data to the secrets data portion. Already existing keys get overwritten.

func (*ShardedSecret) ShardNames added in v0.53.0 

func (s *ShardedSecret) ShardNames() []string

ShardNames returns the names of the secret shards. This only returns something after StoreSecrets was called and the actual sharding took place.

func (*ShardedSecret) StoreSecrets added in v0.53.0 

func (s *ShardedSecret) StoreSecrets(ctx context.Context, sClient corev1.SecretInterface) error

StoreSecrets creates the individual secret shards and stores it via sClient.

type StatefulSetReporter added in v0.63.0 

type StatefulSetReporter struct {
	Pods []*Pod
	// contains filtered or unexported fields
}

func NewStatefulSetReporter added in v0.63.0 

func NewStatefulSetReporter(ctx context.Context, kclient kubernetes.Interface, sset *appsv1.StatefulSet) (*StatefulSetReporter, error)

NewStatefulSetReporter returns a statefulset's reporter.

func (*StatefulSetReporter) IsUpdated added in v0.63.0 

func (sr *StatefulSetReporter) IsUpdated(p *Pod) bool

IsUpdated returns true if the given pod matches with the statefulset's revision.

func (*StatefulSetReporter) ReadyPods added in v0.63.0 

func (sr *StatefulSetReporter) ReadyPods() []*Pod

ReadyPods returns the list of pods that are ready.

func (*StatefulSetReporter) UpdatedPods added in v0.63.0 

func (sr *StatefulSetReporter) UpdatedPods() []*Pod

UpdatedPods returns the list of pods that match with the statefulset's revision.

type Syncer added in v0.61.0 

type Syncer interface {
	// Sync the state of the object identified by its key.
	Sync(context.Context, string) error
	// UpdateStatus updates the status of the object identified by its key.
	UpdateStatus(context.Context, string) error
	// Resolve returns the resource associated to the statefulset.
	Resolve(*appsv1.StatefulSet) metav1.Object
}

Syncer knows how to synchronize statefulset-based resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.