v1alpha2

Documentation

Overview

Package v1alpha2 is the OpenFaaS v1alpha2 version of the API. +groupName=openfaas.com

Index

• Variables
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type Function
  • func (in *Function) DeepCopy() *Function
  • func (in *Function) DeepCopyInto(out *Function)
  • func (in *Function) DeepCopyObject() runtime.Object
• type FunctionList
  • func (in *FunctionList) DeepCopy() *FunctionList
  • func (in *FunctionList) DeepCopyInto(out *FunctionList)
  • func (in *FunctionList) DeepCopyObject() runtime.Object
• type FunctionResources
  • func (in *FunctionResources) DeepCopy() *FunctionResources
  • func (in *FunctionResources) DeepCopyInto(out *FunctionResources)
• type FunctionSpec
  • func (in *FunctionSpec) DeepCopy() *FunctionSpec
  • func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)
• type FunctionStatus
  • func (in *FunctionStatus) DeepCopy() *FunctionStatus
  • func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)

Variables

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

	AddToScheme = localSchemeBuilder.AddToScheme
)

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

SchemeGroupVersion is group version used to register these objects

Functions

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

Deprecated: deepcopy registration will go away when static deepcopy is fully implemented.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Function

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

	Spec   FunctionSpec   `json:"spec"`
	Status FunctionStatus `json:"status"`
}

Function describes an OpenFaaS function

func (*Function) DeepCopy

func (in *Function) DeepCopy() *Function

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

func (*Function) DeepCopyInto

func (in *Function) DeepCopyInto(out *Function)

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

func (*Function) DeepCopyObject

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

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

type FunctionList

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

	Items []Function `json:"items"`
}

FunctionList is a list of Function resources

func (*FunctionList) DeepCopy

func (in *FunctionList) DeepCopy() *FunctionList

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

func (*FunctionList) DeepCopyInto

func (in *FunctionList) DeepCopyInto(out *FunctionList)

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

func (*FunctionList) DeepCopyObject

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

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

type FunctionResources

type FunctionResources struct {
	Memory string `json:"memory"`
	CPU    string `json:"cpu"`
}

FunctionResources is used to set CPU and memory limits and requests

func (*FunctionResources) DeepCopy

func (in *FunctionResources) DeepCopy() *FunctionResources

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

func (*FunctionResources) DeepCopyInto

func (in *FunctionResources) DeepCopyInto(out *FunctionResources)

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

type FunctionSpec

type FunctionSpec struct {
	Name        string             `json:"name"`
	Image       string             `json:"image"`
	Replicas    *int32             `json:"replicas"`
	Handler     string             `json:"handler"`
	Labels      *map[string]string `json:"labels"`
	Environment *map[string]string `json:"environment"`
	Constraints []string           `json:"constraints"`
	Secrets     []string           `json:"secrets"`
	Limits      *FunctionResources `json:"limits"`
	Requests    *FunctionResources `json:"requests"`
}

FunctionSpec is the spec for a Function resource

func (*FunctionSpec) DeepCopy

func (in *FunctionSpec) DeepCopy() *FunctionSpec

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

func (*FunctionSpec) DeepCopyInto

func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)

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

type FunctionStatus

type FunctionStatus struct {
	AvailableReplicas int32 `json:"availableReplicas"`
}

FunctionStatus is the status for a Function resource

func (*FunctionStatus) DeepCopy

func (in *FunctionStatus) DeepCopy() *FunctionStatus

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

func (*FunctionStatus) DeepCopyInto

func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)

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