v1alpha1

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Jul 7, 2020 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the keda v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=keda.k8s.io

Package v1alpha1 contains API Schema definitions for the keda v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=keda.k8s.io

Index

Constants

View Source 
const (
	PodIdentityProviderNone    PodIdentityProvider = "none"
	PodIdentityProviderAzure                       = "azure"
	PodIdentityProviderGCP                         = "gcp"
	PodIdentityProviderSpiffe                      = "spiffe"
	PodIdentityProviderAwsEKS                      = "aws-eks"
	PodIdentityProviderAwsKiam                     = "aws-kiam"
)
View Source 
const (
	PodIdentityAnnotationEKS  = "eks.amazonaws.com/role-arn"
	PodIdentityAnnotationKiam = "iam.amazonaws.com/role"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "keda.k8s.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Functions

func GetOpenAPIDefinitions 

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

Types

type AuthEnvironment 

type AuthEnvironment struct {
	Parameter string `json:"parameter"`
	Name      string `json:"name"`

	// +optional
	ContainerName string `json:"containerName"`
}

AuthEnvironment is used to authenticate using environment variables in the destination deployment spec +k8s:openapi-gen=true

func (*AuthEnvironment) DeepCopy 

func (in *AuthEnvironment) DeepCopy() *AuthEnvironment

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

func (*AuthEnvironment) DeepCopyInto 

func (in *AuthEnvironment) DeepCopyInto(out *AuthEnvironment)

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

type AuthPodIdentity 

type AuthPodIdentity struct {
	Provider PodIdentityProvider `json:"provider"`
}

AuthPodIdentity allows users to select the platform native identity mechanism +k8s:openapi-gen=true

func (*AuthPodIdentity) DeepCopy 

func (in *AuthPodIdentity) DeepCopy() *AuthPodIdentity

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

func (*AuthPodIdentity) DeepCopyInto 

func (in *AuthPodIdentity) DeepCopyInto(out *AuthPodIdentity)

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

type AuthSecretTargetRef 

type AuthSecretTargetRef struct {
	Parameter string `json:"parameter"`
	Name      string `json:"name"`
	Key       string `json:"key"`
}

AuthSecretTargetRef is used to authenticate using a reference to a secret +k8s:openapi-gen=true

func (*AuthSecretTargetRef) DeepCopy 

func (in *AuthSecretTargetRef) DeepCopy() *AuthSecretTargetRef

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

func (*AuthSecretTargetRef) DeepCopyInto 

func (in *AuthSecretTargetRef) DeepCopyInto(out *AuthSecretTargetRef)

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

type Credential added in v1.5.0 

type Credential struct {
	// +optional
	Token string `json:"token"`

	// +optional
	ServiceAccount string `json:"serviceAccount"`
}

Credential defines the Hashicorp Vault credentials depending on the authentication method +k8s:openapi-gen=true

func (*Credential) DeepCopy added in v1.5.0 

func (in *Credential) DeepCopy() *Credential

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

func (*Credential) DeepCopyInto added in v1.5.0 

func (in *Credential) DeepCopyInto(out *Credential)

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

type HashiCorpVault added in v1.5.0 

type HashiCorpVault struct {
	Address        string              `json:"address"`
	Authentication VaultAuthentication `json:"authentication"`

	// +listType
	Secrets []VaultSecret `json:"secrets"`

	// +optional
	Credential Credential `json:"credential"`

	// +optional
	Role string `json:"role"`

	// +optional
	Mount string `json:"mount"`
}

HashiCorpVault is used to authenticate using Hashicorp Vault +k8s:openapi-gen=true

func (*HashiCorpVault) DeepCopy added in v1.5.0 

func (in *HashiCorpVault) DeepCopy() *HashiCorpVault

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

func (*HashiCorpVault) DeepCopyInto added in v1.5.0 

func (in *HashiCorpVault) DeepCopyInto(out *HashiCorpVault)

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

type ObjectReference 

type ObjectReference struct {
	DeploymentName string `json:"deploymentName"`
	// +optional
	ContainerName string `json:"containerName,omitempty"`
}

ObjectReference holds the a reference to the deployment this ScaledObject applies +k8s:openapi-gen=true

func (*ObjectReference) DeepCopy 

func (in *ObjectReference) DeepCopy() *ObjectReference

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

func (*ObjectReference) DeepCopyInto 

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

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

type PodIdentityProvider 

type PodIdentityProvider string

PodIdentityProvider contains the list of providers

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"`
}

ScaleTriggers reference the scaler that will be used +k8s:openapi-gen=true

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 +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=scaledobjects,scope=Namespaced +kubebuilder:printcolumn:name="Deployment",type="string",JSONPath=".spec.scaleTargetRef.deploymentName" +kubebuilder:printcolumn:name="Triggers",type="string",JSONPath=".spec.triggers[*].type" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"

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"`
}

ScaledObjectAuthRef points to the TriggerAuthentication object that is used to authenticate the scaler with the environment +k8s:openapi-gen=true

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 ScaledObjectScaleType 

type ScaledObjectScaleType string

ScaledObjectScaleType distinguish between Deployment based and K8s Jobs 

const (
	// ScaleTypeDeployment specifies Deployment based ScaleObject
	ScaleTypeDeployment ScaledObjectScaleType = "deployment"
	// ScaleTypeJob specifies K8s Jobs based ScaleObject
	ScaleTypeJob ScaledObjectScaleType = "job"
)

type ScaledObjectSpec 

type ScaledObjectSpec struct {
	// +optional
	ScaleType ScaledObjectScaleType `json:"scaleType,omitempty"`
	// +optional
	ScaleTargetRef *ObjectReference `json:"scaleTargetRef,omitempty"`
	// +optional
	JobTargetRef *batchv1.JobSpec `json:"jobTargetRef,omitempty"`
	// +optional
	PollingInterval *int32 `json:"pollingInterval,omitempty"`
	// +optional
	CooldownPeriod *int32 `json:"cooldownPeriod,omitempty"`
	// +optional
	MinReplicaCount *int32 `json:"minReplicaCount,omitempty"`
	// +optional
	MaxReplicaCount *int32 `json:"maxReplicaCount,omitempty"`
	// +listType
	Triggers []ScaleTriggers `json:"triggers"`
}

ScaledObjectSpec is the spec for a ScaledObject resource +k8s:openapi-gen=true

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
	LastActiveTime *metav1.Time `json:"lastActiveTime,omitempty"`
	// +optional
	// +listType
	ExternalMetricNames []string `json:"externalMetricNames,omitempty"`
}

ScaledObjectStatus is the status for a ScaledObject resource +k8s:openapi-gen=true +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.

type TriggerAuthentication 

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

	Spec TriggerAuthenticationSpec `json:"spec"`
}

TriggerAuthentication defines how a trigger can authenticate +k8s:openapi-gen=true +kubebuilder:resource:path=triggerauthentications,scope=Namespaced

func (*TriggerAuthentication) DeepCopy 

func (in *TriggerAuthentication) DeepCopy() *TriggerAuthentication

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

func (*TriggerAuthentication) DeepCopyInto 

func (in *TriggerAuthentication) DeepCopyInto(out *TriggerAuthentication)

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

func (*TriggerAuthentication) DeepCopyObject 

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

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

type TriggerAuthenticationList 

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

TriggerAuthenticationList contains a list of TriggerAuthentication

func (*TriggerAuthenticationList) DeepCopy 

func (in *TriggerAuthenticationList) DeepCopy() *TriggerAuthenticationList

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

func (*TriggerAuthenticationList) DeepCopyInto 

func (in *TriggerAuthenticationList) DeepCopyInto(out *TriggerAuthenticationList)

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

func (*TriggerAuthenticationList) DeepCopyObject 

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

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

type TriggerAuthenticationSpec 

type TriggerAuthenticationSpec struct {
	// +optional
	PodIdentity AuthPodIdentity `json:"podIdentity"`

	// +optional
	// +listType
	SecretTargetRef []AuthSecretTargetRef `json:"secretTargetRef"`

	// +optional
	// +listType
	Env []AuthEnvironment `json:"env"`

	// +optional
	HashiCorpVault HashiCorpVault `json:"hashiCorpVault"`
}

TriggerAuthenticationSpec defines the various ways to authenticate +k8s:openapi-gen=true

func (*TriggerAuthenticationSpec) DeepCopy 

func (in *TriggerAuthenticationSpec) DeepCopy() *TriggerAuthenticationSpec

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

func (*TriggerAuthenticationSpec) DeepCopyInto 

func (in *TriggerAuthenticationSpec) DeepCopyInto(out *TriggerAuthenticationSpec)

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

type VaultAuthentication added in v1.5.0 

type VaultAuthentication string

VaultAuthentication contains the list of Hashicorp Vault authentication methods 

const (
	VaultAuthenticationToken      VaultAuthentication = "token"
	VaultAuthenticationKubernetes                     = "kubernetes"
)

Client authenticating to Vault

type VaultSecret added in v1.5.0 

type VaultSecret struct {
	Parameter string `json:"parameter"`
	Path      string `json:"path"`
	Key       string `json:"key"`
}

VaultSecret defines the mapping between the path of the secret in Vault to the parameter +k8s:openapi-gen=true

func (*VaultSecret) DeepCopy added in v1.5.0 

func (in *VaultSecret) DeepCopy() *VaultSecret

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

func (*VaultSecret) DeepCopyInto added in v1.5.0 

func (in *VaultSecret) DeepCopyInto(out *VaultSecret)

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.