v1

Documentation

Overview

Package v1 is the OpenFaaS v1 version of the API. +groupName=tensorchord.ai

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type InferenceIngress
  • func (in *InferenceIngress) DeepCopy() *InferenceIngress
  • func (in *InferenceIngress) DeepCopyInto(out *InferenceIngress)
  • func (in *InferenceIngress) DeepCopyObject() runtime.Object
• type InferenceIngressList
  • func (in *InferenceIngressList) DeepCopy() *InferenceIngressList
  • func (in *InferenceIngressList) DeepCopyInto(out *InferenceIngressList)
  • func (in *InferenceIngressList) DeepCopyObject() runtime.Object
• type InferenceIngressSpec
  • func (in *InferenceIngressSpec) DeepCopy() *InferenceIngressSpec
  • func (in *InferenceIngressSpec) DeepCopyInto(out *InferenceIngressSpec)
  • func (f *InferenceIngressSpec) UseTLS() bool
• type InferenceIngressTLS
  • func (in *InferenceIngressTLS) DeepCopy() *InferenceIngressTLS
  • func (in *InferenceIngressTLS) DeepCopyInto(out *InferenceIngressTLS)
• type ObjectReference
  • func (in *ObjectReference) DeepCopy() *ObjectReference
  • func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

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 InferenceIngress

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

	Spec InferenceIngressSpec `json:"spec"`
}

InferenceIngress describes an OpenFaaS function

func (*InferenceIngress) DeepCopy

func (in *InferenceIngress) DeepCopy() *InferenceIngress

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

func (*InferenceIngress) DeepCopyInto

func (in *InferenceIngress) DeepCopyInto(out *InferenceIngress)

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

func (*InferenceIngress) DeepCopyObject

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

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

type InferenceIngressList

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

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

InferenceIngress is a list of Function resources

func (*InferenceIngressList) DeepCopy

func (in *InferenceIngressList) DeepCopy() *InferenceIngressList

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

func (*InferenceIngressList) DeepCopyInto

func (in *InferenceIngressList) DeepCopyInto(out *InferenceIngressList)

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

func (*InferenceIngressList) DeepCopyObject

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

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

type InferenceIngressSpec

type InferenceIngressSpec struct {
	// Domain such as "api.example.com"
	Domain string `json:"domain"`

	// Function such as "nodeinfo"
	Function string `json:"function"`

	Framework string `json:"framework"`

	// Path such as "/v1/profiles/view/(.*)", or leave empty for default
	// +optional
	Path string `json:"path"`

	// IngressType such as "nginx"
	// +optional
	IngressType string `json:"ingressType,omitempty"`

	// Enable TLS via cert-manager
	// +optional
	TLS *InferenceIngressTLS `json:"tls,omitempty"`

	// BypassGateway, when true creates an Ingress record
	// directly for the Function name without using the gateway
	// in the hot path
	// +optional
	BypassGateway bool `json:"bypassGateway,omitempty"`
}

InferenceIngressSpec is the spec for a InferenceIngressSpec resource. It must be created in the same namespace as the gateway, i.e. openfaas.

func (*InferenceIngressSpec) DeepCopy

func (in *InferenceIngressSpec) DeepCopy() *InferenceIngressSpec

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

func (*InferenceIngressSpec) DeepCopyInto

func (in *InferenceIngressSpec) DeepCopyInto(out *InferenceIngressSpec)

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

func (*InferenceIngressSpec) UseTLS

func (f *InferenceIngressSpec) UseTLS() bool

UseTLS if TLS is enabled

type InferenceIngressTLS

type InferenceIngressTLS struct {
	// +optional
	Enabled bool `json:"enabled"`

	// +optional
	IssuerRef ObjectReference `json:"issuerRef"`
}

InferenceIngressSpec TLS options

func (*InferenceIngressTLS) DeepCopy

func (in *InferenceIngressTLS) DeepCopy() *InferenceIngressTLS

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

func (*InferenceIngressTLS) DeepCopyInto

func (in *InferenceIngressTLS) DeepCopyInto(out *InferenceIngressTLS)

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

type ObjectReference

type ObjectReference struct {
	Name string `json:"name"`

	// +optional
	Kind string `json:"kind,omitempty"`
}

ObjectReference is a reference to an object with a given name and kind.

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.