Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the networking v1alpha1 API group +kubebuilder:object:generate=true +groupName=networking.cloudfoundry.org
Index ¶
Constants ¶
const ( CFDomainGUIDLabelKey = "networking.cloudfoundry.org/domain-guid" CFRouteGUIDLabelKey = "networking.cloudfoundry.org/route-guid" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "networking.cloudfoundry.org", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type CFDomain ¶
type CFDomain struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CFDomainSpec `json:"spec,omitempty"`
Status CFDomainStatus `json:"status,omitempty"`
}
CFDomain is the Schema for the cfdomains API
func (*CFDomain) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFDomain.
func (*CFDomain) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CFDomain) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CFDomainList ¶
type CFDomainList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CFDomain `json:"items"`
}
CFDomainList contains a list of CFDomain
func (*CFDomainList) DeepCopy ¶
func (in *CFDomainList) DeepCopy() *CFDomainList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFDomainList.
func (*CFDomainList) DeepCopyInto ¶
func (in *CFDomainList) DeepCopyInto(out *CFDomainList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CFDomainList) DeepCopyObject ¶
func (in *CFDomainList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CFDomainSpec ¶
type CFDomainSpec struct {
// Domain name is required and conforms to RFC 1035
Name string `json:"name"`
}
CFDomainSpec defines the desired state of CFDomain
func (*CFDomainSpec) DeepCopy ¶
func (in *CFDomainSpec) DeepCopy() *CFDomainSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFDomainSpec.
func (*CFDomainSpec) DeepCopyInto ¶
func (in *CFDomainSpec) DeepCopyInto(out *CFDomainSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CFDomainStatus ¶
type CFDomainStatus struct {
}
CFDomainStatus defines the observed state of CFDomain
func (*CFDomainStatus) DeepCopy ¶
func (in *CFDomainStatus) DeepCopy() *CFDomainStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFDomainStatus.
func (*CFDomainStatus) DeepCopyInto ¶
func (in *CFDomainStatus) DeepCopyInto(out *CFDomainStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CFRoute ¶
type CFRoute struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CFRouteSpec `json:"spec,omitempty"`
Status CFRouteStatus `json:"status,omitempty"`
}
CFRoute is the Schema for the cfroutes API
func (*CFRoute) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFRoute.
func (*CFRoute) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CFRoute) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CFRouteList ¶
type CFRouteList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CFRoute `json:"items"`
}
CFRouteList contains a list of CFRoute
func (*CFRouteList) DeepCopy ¶
func (in *CFRouteList) DeepCopy() *CFRouteList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFRouteList.
func (*CFRouteList) DeepCopyInto ¶
func (in *CFRouteList) DeepCopyInto(out *CFRouteList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CFRouteList) DeepCopyObject ¶
func (in *CFRouteList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CFRouteSpec ¶
type CFRouteSpec struct {
// Host is optional, defaults to empty. For cf push default route, uses the name of the app.
Host string `json:"host,omitempty"`
// Path is optional, defaults to empty.
Path string `json:"path,omitempty"`
// Protocol is optional, defaults to http. Dependent on allow-listed protocols on domain.
Protocol Protocol `json:"protocol,omitempty"`
// Domain ref is required, provides base domain name and allowed protocol info.
DomainRef v1.ObjectReference `json:"domainRef"`
// Destinations are optional, a route can exist independently of being mapped to apps.
Destinations []Destination `json:"destinations,omitempty"`
}
CFRouteSpec defines the desired state of CFRoute
func (*CFRouteSpec) DeepCopy ¶
func (in *CFRouteSpec) DeepCopy() *CFRouteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFRouteSpec.
func (*CFRouteSpec) DeepCopyInto ¶
func (in *CFRouteSpec) DeepCopyInto(out *CFRouteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CFRouteStatus ¶
type CFRouteStatus struct {
CurrentStatus CurrentStatus `json:"currentStatus"`
Description string `json:"description"`
// FQDN captures the fully-qualified domain name for the route
FQDN string `json:"fqdn,omitempty"`
// URI captures the URI (FQDN + path) for the route
URI string `json:"uri,omitempty"`
// Destinations capture the observed state of the destinations
// mainly for recording the target port of the underlying service
Destinations []Destination `json:"destinations,omitempty"`
// Conditions capture the current status of the route
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
CFRouteStatus defines the observed state of CFRoute
func (*CFRouteStatus) DeepCopy ¶
func (in *CFRouteStatus) DeepCopy() *CFRouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CFRouteStatus.
func (*CFRouteStatus) DeepCopyInto ¶
func (in *CFRouteStatus) DeepCopyInto(out *CFRouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CurrentStatus ¶
type CurrentStatus string
CurrentStatus declares whether the CFRoute is currently valid or invalid +kubebuilder:validation:Enum=valid;invalid
const ( ValidStatus CurrentStatus = "valid" InvalidStatus CurrentStatus = "invalid" )
type Destination ¶
type Destination struct {
// GUID is required to support CF V3 Destination endpoints
GUID string `json:"guid"`
// Port is optional, defaults to ProcessModel::DEFAULT_HTTP_PORT
Port int `json:"port,omitempty"`
// App ref is required, part of the identity of a running process to which traffic may be routed
// We use a ref because the app must exist
AppRef v1.LocalObjectReference `json:"appRef"`
// Process type is required, part of the identity of a running process to which traffic may be routed
// We use process type instead of processRef because a process of the type may not exist at time of destination creation
ProcessType string `json:"processType"`
// Protocol is required, must be "http1"
// +kubebuilder:validation:Enum=http1
Protocol string `json:"protocol"`
}
Destination defines a target for a CFRoute, does not carry meaning outside of a CF context
func (*Destination) DeepCopy ¶
func (in *Destination) DeepCopy() *Destination
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Destination.
func (*Destination) DeepCopyInto ¶
func (in *Destination) DeepCopyInto(out *Destination)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files