spec

Documentation

Index

• type AlertingSpec
• type Alertmanager
• type AlertmanagerEndpoints
• type AlertmanagerList
• type AlertmanagerSpec
• type Endpoint
• type Prometheus
• type PrometheusList
• type PrometheusSpec
• type PrometheusStatus
• type Selector
• type ServiceMonitor
• type ServiceMonitorList
• type ServiceMonitorSpec
• type StorageSpec

Types

type AlertingSpec

type AlertingSpec struct {
	Alertmanagers []AlertmanagerEndpoints `json:"alertmanagers"`
}

AlertingSpec defines paramters for alerting configuration of Prometheus servers.

type Alertmanager

type Alertmanager struct {
	metav1.TypeMeta `json:",inline"`
	v1.ObjectMeta   `json:"metadata,omitempty"`
	Spec            AlertmanagerSpec `json:"spec"`
}

type AlertmanagerEndpoints

type AlertmanagerEndpoints struct {
	Namespace string             `json:"namespace"`
	Name      string             `json:"name"`
	Port      intstr.IntOrString `json:"port"`
	Scheme    string             `json:"scheme"`
}

AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against.

type AlertmanagerList

type AlertmanagerList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is a list of third party objects
	Items []Alertmanager `json:"items"`
}

type AlertmanagerSpec

type AlertmanagerSpec struct {
	// Version the cluster should be on.
	Version string `json:"version"`
	// Base image that is used to deploy pods.
	BaseImage string `json:"baseImage"`
	// Size is the expected size of the alertmanager cluster. The controller will
	// eventually make the size of the running cluster equal to the expected
	// size.
	Replicas int32 `json:"replicas"`
	// Storage is the definition of how storage will be used by the Alertmanager
	// instances.
	Storage *StorageSpec `json:"storage"`
	// ExternalURL is the URL under which Alertmanager is externally reachable
	// (for example, if Alertmanager is served via a reverse proxy). Used for
	// generating relative and absolute links back to Alertmanager itself. If the
	// URL has a path portion, it will be used to prefix all HTTP endpoints
	// served by Alertmanager. If omitted, relevant URL components will be
	// derived automatically.
	ExternalURL string `json:"externalUrl,omitempty"`
}

type Endpoint

type Endpoint struct {
	Port       string             `json:"port"`
	TargetPort intstr.IntOrString `json:"targetPort"`
	Path       string             `json:"path"`
	Scheme     string             `json:"scheme"`
	Interval   string             `json:"interval"`
}

Endpoint defines a scrapeable endpoint serving Prometheus metrics.

type Prometheus

type Prometheus struct {
	metav1.TypeMeta `json:",inline"`
	v1.ObjectMeta   `json:"metadata,omitempty"`
	Spec            PrometheusSpec   `json:"spec"`
	Status          PrometheusStatus `json:"status,omitempty"`
}

Prometheus defines a Prometheus deployment.

type PrometheusList

type PrometheusList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []*Prometheus `json:"items"`
}

PrometheusList is a list of Prometheuses.

type PrometheusSpec

type PrometheusSpec struct {
	ServiceMonitorSelector *metav1.LabelSelector   `json:"serviceMonitorSelector"`
	Version                string                  `json:"version"`
	Paused                 bool                    `json:"paused"`
	BaseImage              string                  `json:"baseImage"`
	Replicas               int32                   `json:"replicas"`
	Retention              string                  `json:"retention"`
	ExternalURL            string                  `json:"externalUrl"`
	Storage                *StorageSpec            `json:"storage"`
	Alerting               AlertingSpec            `json:"alerting"`
	Resources              v1.ResourceRequirements `json:"resources"`
}

PrometheusSpec holds specification parameters of a Prometheus deployment.

type PrometheusStatus

type PrometheusStatus struct {
	// Total number of non-terminated pods targeted by this Prometheus deployment
	// (their labels match the selector).
	Replicas int32 `json:"replicas"`

	// Total number of non-terminated pods targeted by this Prometheus deployment
	// that have the desired version spec.
	UpdatedReplicas int32 `json:"updatedReplicas"`

	// Total number of available pods (ready for at least minReadySeconds)
	// targeted by this Prometheus deployment.
	AvailableReplicas int32 `json:"availableReplicas"`

	// Total number of unavailable pods targeted by this Prometheus deployment.
	UnavailableReplicas int32 `json:"unavailableReplicas"`
}

type Selector

type Selector struct {
	Any        bool     `json:"any,omitempty"`
	MatchNames []string `json:"matchNames,omitempty"`
}

type ServiceMonitor

type ServiceMonitor struct {
	metav1.TypeMeta `json:",inline"`
	v1.ObjectMeta   `json:"metadata,omitempty"`
	Spec            ServiceMonitorSpec `json:"spec"`
}

ServiceMonitor defines monitoring for a set of services.

type ServiceMonitorList

type ServiceMonitorList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []*ServiceMonitor `json:"items"`
}

ServiceMonitorList is a list of ServiceMonitors.

type ServiceMonitorSpec

type ServiceMonitorSpec struct {
	JobLabel          string               `json:"jobLabel"`
	Endpoints         []Endpoint           `json:"endpoints"`
	Selector          metav1.LabelSelector `json:"selector"`
	NamespaceSelector Selector             `json:"namespaceSelector"`
}

ServiceMonitorSpec contains specification parameters for a ServiceMonitor.

type StorageSpec

type StorageSpec struct {
	Class     string                  `json:"class"`
	Selector  *metav1.LabelSelector   `json:"selector"`
	Resources v1.ResourceRequirements `json:"resources"`
}

StorageSpec defines the configured storage for a group Prometheus servers.