Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=serving.knative.dev
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type Configuration
- func (sink *Configuration) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *Configuration) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *Configuration) DeepCopy() *Configuration
- func (in *Configuration) DeepCopyInto(out *Configuration)
- func (in *Configuration) DeepCopyObject() runtime.Object
- func (*Configuration) GetGroupVersionKind() schema.GroupVersionKind
- func (c *Configuration) IsFailed() bool
- func (c *Configuration) IsReady() bool
- func (c *Configuration) SetDefaults(ctx context.Context)
- func (c *Configuration) Validate(ctx context.Context) (errs *apis.FieldError)
- type ConfigurationList
- type Revision
- func (sink *Revision) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *Revision) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *Revision) DeepCopy() *Revision
- func (in *Revision) DeepCopyInto(out *Revision)
- func (in *Revision) DeepCopyObject() runtime.Object
- func (r *Revision) GetGroupVersionKind() schema.GroupVersionKind
- func (r *Revision) IsFailed() bool
- func (r *Revision) IsReady() bool
- func (r *Revision) SetDefaults(ctx context.Context)
- func (r *Revision) Validate(ctx context.Context) *apis.FieldError
- func (r *Revision) ValidateLabels() (errs *apis.FieldError)
- type RevisionList
- type Route
- func (sink *Route) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *Route) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *Route) DeepCopy() *Route
- func (in *Route) DeepCopyInto(out *Route)
- func (in *Route) DeepCopyObject() runtime.Object
- func (r *Route) GetGroupVersionKind() schema.GroupVersionKind
- func (r *Route) IsFailed() bool
- func (r *Route) IsReady() bool
- func (r *Route) SetDefaults(ctx context.Context)
- func (r *Route) Validate(ctx context.Context) *apis.FieldError
- type RouteList
- type Service
- func (sink *Service) ConvertFrom(ctx context.Context, obj apis.Convertible) error
- func (source *Service) ConvertTo(ctx context.Context, obj apis.Convertible) error
- func (in *Service) DeepCopy() *Service
- func (in *Service) DeepCopyInto(out *Service)
- func (in *Service) DeepCopyObject() runtime.Object
- func (*Service) GetGroupVersionKind() schema.GroupVersionKind
- func (s *Service) IsFailed() bool
- func (s *Service) IsReady() bool
- func (s *Service) SetDefaults(ctx context.Context)
- func (s *Service) Validate(ctx context.Context) (errs *apis.FieldError)
- type ServiceList
Constants ¶
const ( // ConfigurationConditionReady is set when the configuration's latest // underlying revision has reported readiness. ConfigurationConditionReady = apis.ConditionReady )
const (
// DefaultUserPort is the system default port value exposed on the user-container.
DefaultUserPort = 8080
)
const ( // RevisionConditionReady is set when the revision is starting to materialize // runtime resources, and becomes true when those resources are ready. RevisionConditionReady = apis.ConditionReady )
const ( // RouteConditionReady is set when the service is configured // and has available backends ready to receive traffic. RouteConditionReady = apis.ConditionReady )
const ( // ServiceConditionReady is set when the service is configured // and has available backends ready to receive traffic. ServiceConditionReady = apis.ConditionReady )
ConditionType represents a Service condition value
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: serving.GroupName, Version: "v1beta1"}
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 Configuration ¶
type Configuration struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // +optional Spec v1.ConfigurationSpec `json:"spec,omitempty"` // +optional Status v1.ConfigurationStatus `json:"status,omitempty"` }
Configuration represents the "floating HEAD" of a linear history of Revisions. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration
func (*Configuration) ConvertFrom ¶ added in v0.13.0
func (sink *Configuration) ConvertFrom(ctx context.Context, obj apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*Configuration) ConvertTo ¶ added in v0.13.0
func (source *Configuration) ConvertTo(ctx context.Context, obj apis.Convertible) error
ConvertTo implements apis.Convertible
func (*Configuration) DeepCopy ¶
func (in *Configuration) DeepCopy() *Configuration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.
func (*Configuration) DeepCopyInto ¶
func (in *Configuration) DeepCopyInto(out *Configuration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Configuration) DeepCopyObject ¶
func (in *Configuration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Configuration) GetGroupVersionKind ¶
func (*Configuration) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns the GroupVersionKind.
func (*Configuration) IsFailed ¶ added in v0.16.0
func (c *Configuration) IsFailed() bool
IsFailed returns true if the resource has observed the latest generation and ready is false.
func (*Configuration) IsReady ¶ added in v0.16.0
func (c *Configuration) IsReady() bool
IsReady returns if the configuration is ready to serve the requested configuration and the configuration resource has been observed.
func (*Configuration) SetDefaults ¶
func (c *Configuration) SetDefaults(ctx context.Context)
SetDefaults implements apis.Defaultable
func (*Configuration) Validate ¶
func (c *Configuration) Validate(ctx context.Context) (errs *apis.FieldError)
Validate makes sure that Configuration is properly configured.
type ConfigurationList ¶
type ConfigurationList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Configuration `json:"items"` }
ConfigurationList is a list of Configuration resources
func (*ConfigurationList) DeepCopy ¶
func (in *ConfigurationList) DeepCopy() *ConfigurationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationList.
func (*ConfigurationList) DeepCopyInto ¶
func (in *ConfigurationList) DeepCopyInto(out *ConfigurationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConfigurationList) DeepCopyObject ¶
func (in *ConfigurationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Revision ¶
type Revision struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // +optional Spec v1.RevisionSpec `json:"spec,omitempty"` // +optional Status v1.RevisionStatus `json:"status,omitempty"` }
Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration.
See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
func (*Revision) ConvertFrom ¶ added in v0.13.0
ConvertFrom implements apis.Convertible
func (*Revision) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Revision.
func (*Revision) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Revision) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Revision) GetGroupVersionKind ¶
func (r *Revision) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns the GroupVersionKind.
func (*Revision) IsFailed ¶ added in v0.16.0
IsFailed returns true if the resource has observed the latest generation and ready is false.
func (*Revision) IsReady ¶ added in v0.16.0
IsReady returns if the revision is ready to serve the requested revision and the revision resource has been observed.
func (*Revision) SetDefaults ¶
SetDefaults implements apis.Defaultable
func (*Revision) Validate ¶
func (r *Revision) Validate(ctx context.Context) *apis.FieldError
Validate ensures Revision is properly configured.
func (*Revision) ValidateLabels ¶ added in v0.8.0
func (r *Revision) ValidateLabels() (errs *apis.FieldError)
ValidateLabels function validates service labels
type RevisionList ¶
type RevisionList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Revision `json:"items"` }
RevisionList is a list of Revision resources
func (*RevisionList) DeepCopy ¶
func (in *RevisionList) DeepCopy() *RevisionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RevisionList.
func (*RevisionList) DeepCopyInto ¶
func (in *RevisionList) DeepCopyInto(out *RevisionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RevisionList) DeepCopyObject ¶
func (in *RevisionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Route ¶
type Route struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Spec holds the desired state of the Route (from the client). // +optional Spec v1.RouteSpec `json:"spec,omitempty"` // Status communicates the observed state of the Route (from the controller). // +optional Status v1.RouteStatus `json:"status,omitempty"` }
Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready revision" changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route
func (*Route) ConvertFrom ¶ added in v0.13.0
ConvertFrom implements apis.Convertible
func (*Route) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route.
func (*Route) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Route) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Route) GetGroupVersionKind ¶
func (r *Route) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns the GroupVersionKind.
func (*Route) IsFailed ¶ added in v0.16.0
IsFailed returns true if the resource has observed the latest generation and ready is false.
func (*Route) IsReady ¶ added in v0.16.0
IsReady returns if the revision is ready to serve the requested revision and the revision resource has been observed.
func (*Route) SetDefaults ¶
SetDefaults implements apis.Defaultable
type RouteList ¶
type RouteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Route `json:"items"` }
RouteList is a list of Route resources
func (*RouteList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteList.
func (*RouteList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Service ¶
type Service struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // +optional Spec v1.ServiceSpec `json:"spec,omitempty"` // +optional Status v1.ServiceStatus `json:"status,omitempty"` }
Service acts as a top-level container that manages a Route and Configuration which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets), and its usage is optional but recommended.
The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.
See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service
func (*Service) ConvertFrom ¶ added in v0.13.0
ConvertFrom implements apis.Convertible
func (*Service) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Service.
func (*Service) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Service) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Service) GetGroupVersionKind ¶
func (*Service) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns the GroupVersionKind.
func (*Service) IsFailed ¶ added in v0.16.0
IsFailed returns true if the resource has observed the latest generation and ready is false.
func (*Service) IsReady ¶ added in v0.16.0
IsReady returns if the service is ready to serve the requested service and the service resource has been observed.
func (*Service) SetDefaults ¶
SetDefaults implements apis.Defaultable
type ServiceList ¶
type ServiceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Service `json:"items"` }
ServiceList is a list of Service resources
func (*ServiceList) DeepCopy ¶
func (in *ServiceList) DeepCopy() *ServiceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceList.
func (*ServiceList) DeepCopyInto ¶
func (in *ServiceList) DeepCopyInto(out *ServiceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ServiceList) DeepCopyObject ¶
func (in *ServiceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
Source Files ¶
- configuration_conversion.go
- configuration_defaults.go
- configuration_lifecycle.go
- configuration_types.go
- configuration_validation.go
- doc.go
- register.go
- revision_conversion.go
- revision_defaults.go
- revision_lifecycle.go
- revision_types.go
- revision_validation.go
- route_conversion.go
- route_defaults.go
- route_lifecycle.go
- route_types.go
- route_validation.go
- service_conversion.go
- service_defaults.go
- service_lifecycle.go
- service_types.go
- service_validation.go
- zz_generated.deepcopy.go