v1

Documentation

Overview

Package v1 is the v1 version of the API.

+k8s:deepcopy-gen=package +groupName=metrics.prometheus.io

Index

• Constants
• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• func NewResourceRuleCRD() *apiextensions.CustomResourceDefinition
• func Resource(resource string) schema.GroupResource
• type CustomMetric
  • func (in *CustomMetric) DeepCopy() *CustomMetric
  • func (in *CustomMetric) DeepCopyInto(out *CustomMetric)
  • func (in *CustomMetric) DeepCopyObject() runtime.Object
• type GroupResource
  • func (in *GroupResource) DeepCopy() *GroupResource
  • func (in *GroupResource) DeepCopyInto(out *GroupResource)
• type Queries
  • func (in *Queries) DeepCopy() *Queries
  • func (in *Queries) DeepCopyInto(out *Queries)
• type ResourceMetrics
  • func (in *ResourceMetrics) DeepCopy() *ResourceMetrics
  • func (in *ResourceMetrics) DeepCopyInto(out *ResourceMetrics)
  • func (in *ResourceMetrics) DeepCopyObject() runtime.Object
• type ResourceMetricsRule
  • func (in *ResourceMetricsRule) DeepCopy() *ResourceMetricsRule
  • func (in *ResourceMetricsRule) DeepCopyInto(out *ResourceMetricsRule)
• type ResourceMetricsRules
  • func (in *ResourceMetricsRules) DeepCopy() *ResourceMetricsRules
  • func (in *ResourceMetricsRules) DeepCopyInto(out *ResourceMetricsRules)
• type ResourceMetricsSpec
  • func (in *ResourceMetricsSpec) DeepCopy() *ResourceMetricsSpec
  • func (in *ResourceMetricsSpec) DeepCopyInto(out *ResourceMetricsSpec)

Constants

const (
	ResourceRuleSpecName = "github.com/s-urbaniak/prometheus-adapter/pkg/apis/metrics/v1.CustomMetric"
	ResourceRulesKind    = "CustomMetric"
	ResourceRules        = "resourcerules"
)

const GroupName = "metrics.prometheus.io"

GroupName specifies the group name used to register the objects.

Variables

var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Depreciated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)

var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1"}

GroupVersion specifies the group and the version used to register the objects.

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func NewResourceRuleCRD

func NewResourceRuleCRD() *apiextensions.CustomResourceDefinition

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CustomMetric

type CustomMetric struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
}

CustomMetric describes a custom metrics query. The name of the resource rule reflects the target metric name.

+genclient +genclient:nonNamespaced +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true

func (*CustomMetric) DeepCopy

func (in *CustomMetric) DeepCopy() *CustomMetric

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomMetric.

func (*CustomMetric) DeepCopyInto

func (in *CustomMetric) DeepCopyInto(out *CustomMetric)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CustomMetric) DeepCopyObject

func (in *CustomMetric) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GroupResource

type GroupResource struct {
	Group    string `json:"group,omitempty"`
	Resource string `json:"resource"`
}

+k8s:openapi-gen=true

func (*GroupResource) DeepCopy

func (in *GroupResource) DeepCopy() *GroupResource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupResource.

func (*GroupResource) DeepCopyInto

func (in *GroupResource) DeepCopyInto(out *GroupResource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Queries

type Queries struct {
	Node string `json:"node"`
	Pod  string `json:"pod"`
}

+k8s:openapi-gen=true

func (*Queries) DeepCopy

func (in *Queries) DeepCopy() *Queries

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Queries.

func (*Queries) DeepCopyInto

func (in *Queries) DeepCopyInto(out *Queries)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceMetrics

type ResourceMetrics struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ResourceMetricsSpec `json:"spec"`
}

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

func (*ResourceMetrics) DeepCopy

func (in *ResourceMetrics) DeepCopy() *ResourceMetrics

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetrics.

func (*ResourceMetrics) DeepCopyInto

func (in *ResourceMetrics) DeepCopyInto(out *ResourceMetrics)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceMetrics) DeepCopyObject

func (in *ResourceMetrics) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceMetricsRule

type ResourceMetricsRule struct {
	Queries        Queries                  `json:"queries"`
	Labels         map[string]GroupResource `json:"labels"`
	ContainerLabel string                   `json:"containerLabel"`
}

+k8s:openapi-gen=true

func (*ResourceMetricsRule) DeepCopy

func (in *ResourceMetricsRule) DeepCopy() *ResourceMetricsRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsRule.

func (*ResourceMetricsRule) DeepCopyInto

func (in *ResourceMetricsRule) DeepCopyInto(out *ResourceMetricsRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceMetricsRules

type ResourceMetricsRules struct {
	CPU    ResourceMetricsRule `json:"cpu"`
	Memory ResourceMetricsRule `json:"memory"`
}

+k8s:openapi-gen=true

func (*ResourceMetricsRules) DeepCopy

func (in *ResourceMetricsRules) DeepCopy() *ResourceMetricsRules

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsRules.

func (*ResourceMetricsRules) DeepCopyInto

func (in *ResourceMetricsRules) DeepCopyInto(out *ResourceMetricsRules)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceMetricsSpec

type ResourceMetricsSpec struct {
	Rules  ResourceMetricsRules `json:"rules"`
	Window metav1.Duration      `json:"window"`
}

+k8s:openapi-gen=true

func (*ResourceMetricsSpec) DeepCopy

func (in *ResourceMetricsSpec) DeepCopy() *ResourceMetricsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsSpec.

func (*ResourceMetricsSpec) DeepCopyInto

func (in *ResourceMetricsSpec) DeepCopyInto(out *ResourceMetricsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.