Documentation
¶
Overview ¶
Package v1 is the OpenFaaS v1alpha2 version of the API. +groupName=openfaas.com
Index ¶
Constants ¶
This section is empty.
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: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
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"`
}
Function describes an OpenFaaS function
func (*Function) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Function.
func (*Function) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Function) DeepCopyObject ¶
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,omitempty"`
CPU string `json:"cpu,omitempty"`
}
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"`
// +optional
Handler string `json:"handler,omitempty"`
// +optional
Annotations *map[string]string `json:"annotations,omitempty"`
// +optional
Labels *map[string]string `json:"labels,omitempty"`
// +optional
Environment *map[string]string `json:"environment,omitempty"`
// +optional
Constraints []string `json:"constraints,omitempty"`
// +optional
Secrets []string `json:"secrets,omitempty"`
// +optional
Limits *FunctionResources `json:"limits,omitempty"`
// +optional
Requests *FunctionResources `json:"requests,omitempty"`
// +optional
ReadOnlyRootFilesystem bool `json:"readOnlyRootFilesystem"`
}
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 Profile ¶
type Profile struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ProfileSpec `json:"spec"`
}
Profile and ProfileSpec are used to customise the Pod template for functions
func (*Profile) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Profile.
func (*Profile) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Profile) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ProfileList ¶
type ProfileList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []Profile `json:"items"`
}
ProfileList is a list of Profiles
func (*ProfileList) DeepCopy ¶
func (in *ProfileList) DeepCopy() *ProfileList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProfileList.
func (*ProfileList) DeepCopyInto ¶
func (in *ProfileList) DeepCopyInto(out *ProfileList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProfileList) DeepCopyObject ¶
func (in *ProfileList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ProfileSpec ¶
type ProfileSpec struct {
// If specified, the function's pod tolerations.
//
// merged into the Pod Tolerations
//
// +optional
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
// RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used
// to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.
// If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an
// empty definition that uses the default runtime handler.
// More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
// This is a beta feature as of Kubernetes v1.14.
//
// copied to the Pod RunTimeClass, this will replace any existing value or previously
// applied Profile.
//
// +optional
RuntimeClassName *string `json:"runtimeClassName,omitempty"`
// If specified, the pod's scheduling constraints
//
// copied to the Pod Affinity, this will replace any existing value or previously
// applied Profile. We use a replacement strategy because it is not clear that merging
// affinities will actually produce a meaning Affinity definition, it would likely result in
// an impossible to satisfy constraint
//
// +optional
Affinity *corev1.Affinity `json:"affinity,omitempty"`
// SecurityContext holds pod-level security attributes and common container settings.
// Optional: Defaults to empty. See type description for default values of each field.
//
// each non-nil value will be merged into the function's PodSecurityContext, the value will
// replace any existing value or previously applied Profile
//
// +optional
PodSecurityContext *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
}
ProfileSpec is an openfaas api extensions that can be predefined and applied to functions by annotating them with `com.openfaas/profile: name1,name2`
func (*ProfileSpec) DeepCopy ¶
func (in *ProfileSpec) DeepCopy() *ProfileSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProfileSpec.
func (*ProfileSpec) DeepCopyInto ¶
func (in *ProfileSpec) DeepCopyInto(out *ProfileSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files