v1alpha1

package
v1.38.0 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=keda.sh

Index

Constants

View Source 
const (
	// ScaledObjectConditionReadySucccesReason defines the default Reason for correct ScaledObject
	ScaledObjectConditionReadySucccesReason = "ScaledObjectReady"
	// ScaledObjectConditionReadySuccessMessage defines the default Message for correct ScaledObject
	ScaledObjectConditionReadySuccessMessage = "ScaledObject is defined correctly and is ready for scaling"
)
View Source 
const PausedReplicasAnnotation = "autoscaling.keda.sh/paused-replicas"

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: keda.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is the GroupVersion for the Kuma API

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource gets a Kuma GroupResource for a specified resource

Types

type AdvancedConfig 

type AdvancedConfig struct {
	// +optional
	HorizontalPodAutoscalerConfig *HorizontalPodAutoscalerConfig `json:"horizontalPodAutoscalerConfig,omitempty"`
	// +optional
	RestoreToOriginalReplicaCount bool `json:"restoreToOriginalReplicaCount,omitempty"`
}

AdvancedConfig specifies advance scaling options

func (*AdvancedConfig) DeepCopy 

func (in *AdvancedConfig) DeepCopy() *AdvancedConfig

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

func (*AdvancedConfig) DeepCopyInto 

func (in *AdvancedConfig) DeepCopyInto(out *AdvancedConfig)

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

type Condition 

type Condition struct {
	// Type of condition
	// +required
	Type ConditionType `json:"type" description:"type of status condition"`

	// Status of the condition, one of True, False, Unknown.
	// +required
	Status metav1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// The reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`

	// A human readable message indicating details about the transition.
	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

Condition to store the condition state

func (*Condition) DeepCopy 

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto 

func (in *Condition) DeepCopyInto(out *Condition)

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

type ConditionType 

type ConditionType string

ConditionType specifies the available conditions for the resource 

const (
	// ConditionReady specifies that the resource is ready.
	// For long-running resources.
	ConditionReady ConditionType = "Ready"
	// ConditionActive specifies that the resource has finished.
	// For resource which run to completion.
	ConditionActive ConditionType = "Active"
	// ConditionFallback specifies that the resource has a fallback active.
	ConditionFallback ConditionType = "Fallback"
)

type Conditions 

type Conditions []Condition

Conditions an array representation to store multiple Conditions

func (Conditions) DeepCopy 

func (in Conditions) DeepCopy() Conditions

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

func (Conditions) DeepCopyInto 

func (in Conditions) DeepCopyInto(out *Conditions)

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

type Fallback 

type Fallback struct {
	FailureThreshold int32 `json:"failureThreshold"`
	Replicas         int32 `json:"replicas"`
}

Fallback is the spec for fallback options

func (*Fallback) DeepCopy 

func (in *Fallback) DeepCopy() *Fallback

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

func (*Fallback) DeepCopyInto 

func (in *Fallback) DeepCopyInto(out *Fallback)

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

type GroupVersionKindResource 

type GroupVersionKindResource struct {
	Group    string `json:"group"`
	Version  string `json:"version"`
	Kind     string `json:"kind"`
	Resource string `json:"resource"`
}

GroupVersionKindResource provides unified structure for schema.GroupVersionKind and Resource

func (*GroupVersionKindResource) DeepCopy 

func (in *GroupVersionKindResource) DeepCopy() *GroupVersionKindResource

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

func (*GroupVersionKindResource) DeepCopyInto 

func (in *GroupVersionKindResource) DeepCopyInto(out *GroupVersionKindResource)

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

type HealthStatus 

type HealthStatus struct {
	// +optional
	NumberOfFailures *int32 `json:"numberOfFailures,omitempty"`
	// +optional
	Status HealthStatusType `json:"status,omitempty"`
}

HealthStatus is the status for a ScaledObject's health

func (*HealthStatus) DeepCopy 

func (in *HealthStatus) DeepCopy() *HealthStatus

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

func (*HealthStatus) DeepCopyInto 

func (in *HealthStatus) DeepCopyInto(out *HealthStatus)

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

type HealthStatusType 

type HealthStatusType string

HealthStatusType is an indication of whether the health status is happy or failing 

const (
	// HealthStatusHappy means the status of the health object is happy
	HealthStatusHappy HealthStatusType = "Happy"

	// HealthStatusFailing means the status of the health object is failing
	HealthStatusFailing HealthStatusType = "Failing"
)

type HorizontalPodAutoscalerConfig 

type HorizontalPodAutoscalerConfig struct {
	// +optional
	Behavior *autoscalingv2beta2.HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`
}

HorizontalPodAutoscalerConfig specifies horizontal scale config

func (*HorizontalPodAutoscalerConfig) DeepCopy 

func (in *HorizontalPodAutoscalerConfig) DeepCopy() *HorizontalPodAutoscalerConfig

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

func (*HorizontalPodAutoscalerConfig) DeepCopyInto 

func (in *HorizontalPodAutoscalerConfig) DeepCopyInto(out *HorizontalPodAutoscalerConfig)

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

type ScaleTarget 

type ScaleTarget struct {
	Name string `json:"name"`
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
	// +optional
	Kind string `json:"kind,omitempty"`
	// +optional
	EnvSourceContainerName string `json:"envSourceContainerName,omitempty"`
}

ScaleTarget holds the a reference to the scale target Object

func (*ScaleTarget) DeepCopy 

func (in *ScaleTarget) DeepCopy() *ScaleTarget

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

func (*ScaleTarget) DeepCopyInto 

func (in *ScaleTarget) DeepCopyInto(out *ScaleTarget)

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

type ScaleTriggers 

type ScaleTriggers struct {
	Type string `json:"type"`
	// +optional
	Name     string            `json:"name,omitempty"`
	Metadata map[string]string `json:"metadata"`
	// +optional
	AuthenticationRef *ScaledObjectAuthRef `json:"authenticationRef,omitempty"`
	// +optional
	MetricType autoscalingv2beta2.MetricTargetType `json:"metricType,omitempty"`
}

ScaleTriggers reference the scaler that will be used

func (*ScaleTriggers) DeepCopy 

func (in *ScaleTriggers) DeepCopy() *ScaleTriggers

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

func (*ScaleTriggers) DeepCopyInto 

func (in *ScaleTriggers) DeepCopyInto(out *ScaleTriggers)

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

type ScaledObject 

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

	Spec ScaledObjectSpec `json:"spec"`
	// +optional
	Status ScaledObjectStatus `json:"status,omitempty"`
}

ScaledObject is a specification for a ScaledObject resource

func (*ScaledObject) DeepCopy 

func (in *ScaledObject) DeepCopy() *ScaledObject

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

func (*ScaledObject) DeepCopyInto 

func (in *ScaledObject) DeepCopyInto(out *ScaledObject)

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

func (*ScaledObject) DeepCopyObject 

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

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

type ScaledObjectAuthRef 

type ScaledObjectAuthRef struct {
	Name string `json:"name"`
	// Kind of the resource being referred to. Defaults to TriggerAuthentication.
	// +optional
	Kind string `json:"kind,omitempty"`
}

ScaledObjectAuthRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment

func (*ScaledObjectAuthRef) DeepCopy 

func (in *ScaledObjectAuthRef) DeepCopy() *ScaledObjectAuthRef

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

func (*ScaledObjectAuthRef) DeepCopyInto 

func (in *ScaledObjectAuthRef) DeepCopyInto(out *ScaledObjectAuthRef)

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

type ScaledObjectList 

type ScaledObjectList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []ScaledObject `json:"items"`
}

ScaledObjectList is a list of ScaledObject resources

func (*ScaledObjectList) DeepCopy 

func (in *ScaledObjectList) DeepCopy() *ScaledObjectList

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

func (*ScaledObjectList) DeepCopyInto 

func (in *ScaledObjectList) DeepCopyInto(out *ScaledObjectList)

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

func (*ScaledObjectList) DeepCopyObject 

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

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

type ScaledObjectSpec 

type ScaledObjectSpec struct {
	ScaleTargetRef *ScaleTarget `json:"scaleTargetRef"`
	// +optional
	PollingInterval *int32 `json:"pollingInterval,omitempty"`
	// +optional
	CooldownPeriod *int32 `json:"cooldownPeriod,omitempty"`
	// +optional
	IdleReplicaCount *int32 `json:"idleReplicaCount,omitempty"`
	// +optional
	MinReplicaCount *int32 `json:"minReplicaCount,omitempty"`
	// +optional
	MaxReplicaCount *int32 `json:"maxReplicaCount,omitempty"`
	// +optional
	Advanced *AdvancedConfig `json:"advanced,omitempty"`

	Triggers []ScaleTriggers `json:"triggers"`
	// +optional
	Fallback *Fallback `json:"fallback,omitempty"`
}

ScaledObjectSpec is the spec for a ScaledObject resource

func (*ScaledObjectSpec) DeepCopy 

func (in *ScaledObjectSpec) DeepCopy() *ScaledObjectSpec

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

func (*ScaledObjectSpec) DeepCopyInto 

func (in *ScaledObjectSpec) DeepCopyInto(out *ScaledObjectSpec)

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

type ScaledObjectStatus 

type ScaledObjectStatus struct {
	// +optional
	ScaleTargetKind string `json:"scaleTargetKind,omitempty"`
	// +optional
	ScaleTargetGVKR *GroupVersionKindResource `json:"scaleTargetGVKR,omitempty"`
	// +optional
	OriginalReplicaCount *int32 `json:"originalReplicaCount,omitempty"`
	// +optional
	LastActiveTime *metav1.Time `json:"lastActiveTime,omitempty"`
	// +optional
	ExternalMetricNames []string `json:"externalMetricNames,omitempty"`
	// +optional
	ResourceMetricNames []string `json:"resourceMetricNames,omitempty"`
	// +optional
	Conditions Conditions `json:"conditions,omitempty"`
	// +optional
	Health map[string]HealthStatus `json:"health,omitempty"`
	// +optional
	PausedReplicaCount *int32 `json:"pausedReplicaCount,omitempty"`
}

ScaledObjectStatus is the status for a ScaledObject resource +optional

func (*ScaledObjectStatus) DeepCopy 

func (in *ScaledObjectStatus) DeepCopy() *ScaledObjectStatus

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

func (*ScaledObjectStatus) DeepCopyInto 

func (in *ScaledObjectStatus) DeepCopyInto(out *ScaledObjectStatus)

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

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.