Documentation ¶
Overview ¶
+groupName=route.openshift.io Package v1 is the v1 version of the API.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type InsecureEdgeTerminationPolicyType
- type Route
- func (in *Route) DeepCopy() *Route
- func (in *Route) DeepCopyInto(out *Route)
- func (in *Route) DeepCopyObject() runtime.Object
- func (*Route) Descriptor() ([]byte, []int)
- func (m *Route) Marshal() (dAtA []byte, err error)
- func (m *Route) MarshalTo(dAtA []byte) (int, error)
- func (m *Route) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*Route) ProtoMessage()
- func (m *Route) Reset()
- func (m *Route) Size() (n int)
- func (this *Route) String() string
- func (Route) SwaggerDoc() map[string]string
- func (m *Route) Unmarshal(dAtA []byte) error
- func (m *Route) XXX_DiscardUnknown()
- func (m *Route) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Route) XXX_Merge(src proto.Message)
- func (m *Route) XXX_Size() int
- func (m *Route) XXX_Unmarshal(b []byte) error
- type RouteIngress
- func (in *RouteIngress) DeepCopy() *RouteIngress
- func (in *RouteIngress) DeepCopyInto(out *RouteIngress)
- func (*RouteIngress) Descriptor() ([]byte, []int)
- func (m *RouteIngress) Marshal() (dAtA []byte, err error)
- func (m *RouteIngress) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteIngress) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteIngress) ProtoMessage()
- func (m *RouteIngress) Reset()
- func (m *RouteIngress) Size() (n int)
- func (this *RouteIngress) String() string
- func (RouteIngress) SwaggerDoc() map[string]string
- func (m *RouteIngress) Unmarshal(dAtA []byte) error
- func (m *RouteIngress) XXX_DiscardUnknown()
- func (m *RouteIngress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteIngress) XXX_Merge(src proto.Message)
- func (m *RouteIngress) XXX_Size() int
- func (m *RouteIngress) XXX_Unmarshal(b []byte) error
- type RouteIngressCondition
- func (in *RouteIngressCondition) DeepCopy() *RouteIngressCondition
- func (in *RouteIngressCondition) DeepCopyInto(out *RouteIngressCondition)
- func (*RouteIngressCondition) Descriptor() ([]byte, []int)
- func (m *RouteIngressCondition) Marshal() (dAtA []byte, err error)
- func (m *RouteIngressCondition) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteIngressCondition) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteIngressCondition) ProtoMessage()
- func (m *RouteIngressCondition) Reset()
- func (m *RouteIngressCondition) Size() (n int)
- func (this *RouteIngressCondition) String() string
- func (RouteIngressCondition) SwaggerDoc() map[string]string
- func (m *RouteIngressCondition) Unmarshal(dAtA []byte) error
- func (m *RouteIngressCondition) XXX_DiscardUnknown()
- func (m *RouteIngressCondition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteIngressCondition) XXX_Merge(src proto.Message)
- func (m *RouteIngressCondition) XXX_Size() int
- func (m *RouteIngressCondition) XXX_Unmarshal(b []byte) error
- type RouteIngressConditionType
- type RouteList
- func (in *RouteList) DeepCopy() *RouteList
- func (in *RouteList) DeepCopyInto(out *RouteList)
- func (in *RouteList) DeepCopyObject() runtime.Object
- func (*RouteList) Descriptor() ([]byte, []int)
- func (m *RouteList) Marshal() (dAtA []byte, err error)
- func (m *RouteList) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteList) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteList) ProtoMessage()
- func (m *RouteList) Reset()
- func (m *RouteList) Size() (n int)
- func (this *RouteList) String() string
- func (RouteList) SwaggerDoc() map[string]string
- func (m *RouteList) Unmarshal(dAtA []byte) error
- func (m *RouteList) XXX_DiscardUnknown()
- func (m *RouteList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteList) XXX_Merge(src proto.Message)
- func (m *RouteList) XXX_Size() int
- func (m *RouteList) XXX_Unmarshal(b []byte) error
- type RoutePort
- func (in *RoutePort) DeepCopy() *RoutePort
- func (in *RoutePort) DeepCopyInto(out *RoutePort)
- func (*RoutePort) Descriptor() ([]byte, []int)
- func (m *RoutePort) Marshal() (dAtA []byte, err error)
- func (m *RoutePort) MarshalTo(dAtA []byte) (int, error)
- func (m *RoutePort) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RoutePort) ProtoMessage()
- func (m *RoutePort) Reset()
- func (m *RoutePort) Size() (n int)
- func (this *RoutePort) String() string
- func (RoutePort) SwaggerDoc() map[string]string
- func (m *RoutePort) Unmarshal(dAtA []byte) error
- func (m *RoutePort) XXX_DiscardUnknown()
- func (m *RoutePort) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RoutePort) XXX_Merge(src proto.Message)
- func (m *RoutePort) XXX_Size() int
- func (m *RoutePort) XXX_Unmarshal(b []byte) error
- type RouteSpec
- func (in *RouteSpec) DeepCopy() *RouteSpec
- func (in *RouteSpec) DeepCopyInto(out *RouteSpec)
- func (*RouteSpec) Descriptor() ([]byte, []int)
- func (m *RouteSpec) Marshal() (dAtA []byte, err error)
- func (m *RouteSpec) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteSpec) ProtoMessage()
- func (m *RouteSpec) Reset()
- func (m *RouteSpec) Size() (n int)
- func (this *RouteSpec) String() string
- func (RouteSpec) SwaggerDoc() map[string]string
- func (m *RouteSpec) Unmarshal(dAtA []byte) error
- func (m *RouteSpec) XXX_DiscardUnknown()
- func (m *RouteSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteSpec) XXX_Merge(src proto.Message)
- func (m *RouteSpec) XXX_Size() int
- func (m *RouteSpec) XXX_Unmarshal(b []byte) error
- type RouteStatus
- func (in *RouteStatus) DeepCopy() *RouteStatus
- func (in *RouteStatus) DeepCopyInto(out *RouteStatus)
- func (*RouteStatus) Descriptor() ([]byte, []int)
- func (m *RouteStatus) Marshal() (dAtA []byte, err error)
- func (m *RouteStatus) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteStatus) ProtoMessage()
- func (m *RouteStatus) Reset()
- func (m *RouteStatus) Size() (n int)
- func (this *RouteStatus) String() string
- func (RouteStatus) SwaggerDoc() map[string]string
- func (m *RouteStatus) Unmarshal(dAtA []byte) error
- func (m *RouteStatus) XXX_DiscardUnknown()
- func (m *RouteStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteStatus) XXX_Merge(src proto.Message)
- func (m *RouteStatus) XXX_Size() int
- func (m *RouteStatus) XXX_Unmarshal(b []byte) error
- type RouteTargetReference
- func (in *RouteTargetReference) DeepCopy() *RouteTargetReference
- func (in *RouteTargetReference) DeepCopyInto(out *RouteTargetReference)
- func (*RouteTargetReference) Descriptor() ([]byte, []int)
- func (m *RouteTargetReference) Marshal() (dAtA []byte, err error)
- func (m *RouteTargetReference) MarshalTo(dAtA []byte) (int, error)
- func (m *RouteTargetReference) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouteTargetReference) ProtoMessage()
- func (m *RouteTargetReference) Reset()
- func (m *RouteTargetReference) Size() (n int)
- func (this *RouteTargetReference) String() string
- func (RouteTargetReference) SwaggerDoc() map[string]string
- func (m *RouteTargetReference) Unmarshal(dAtA []byte) error
- func (m *RouteTargetReference) XXX_DiscardUnknown()
- func (m *RouteTargetReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteTargetReference) XXX_Merge(src proto.Message)
- func (m *RouteTargetReference) XXX_Size() int
- func (m *RouteTargetReference) XXX_Unmarshal(b []byte) error
- type RouterShard
- func (in *RouterShard) DeepCopy() *RouterShard
- func (in *RouterShard) DeepCopyInto(out *RouterShard)
- func (*RouterShard) Descriptor() ([]byte, []int)
- func (m *RouterShard) Marshal() (dAtA []byte, err error)
- func (m *RouterShard) MarshalTo(dAtA []byte) (int, error)
- func (m *RouterShard) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RouterShard) ProtoMessage()
- func (m *RouterShard) Reset()
- func (m *RouterShard) Size() (n int)
- func (this *RouterShard) String() string
- func (RouterShard) SwaggerDoc() map[string]string
- func (m *RouterShard) Unmarshal(dAtA []byte) error
- func (m *RouterShard) XXX_DiscardUnknown()
- func (m *RouterShard) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouterShard) XXX_Merge(src proto.Message)
- func (m *RouterShard) XXX_Size() int
- func (m *RouterShard) XXX_Unmarshal(b []byte) error
- type TLSConfig
- func (in *TLSConfig) DeepCopy() *TLSConfig
- func (in *TLSConfig) DeepCopyInto(out *TLSConfig)
- func (*TLSConfig) Descriptor() ([]byte, []int)
- func (m *TLSConfig) Marshal() (dAtA []byte, err error)
- func (m *TLSConfig) MarshalTo(dAtA []byte) (int, error)
- func (m *TLSConfig) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*TLSConfig) ProtoMessage()
- func (m *TLSConfig) Reset()
- func (m *TLSConfig) Size() (n int)
- func (this *TLSConfig) String() string
- func (TLSConfig) SwaggerDoc() map[string]string
- func (m *TLSConfig) Unmarshal(dAtA []byte) error
- func (m *TLSConfig) XXX_DiscardUnknown()
- func (m *TLSConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TLSConfig) XXX_Merge(src proto.Message)
- func (m *TLSConfig) XXX_Size() int
- func (m *TLSConfig) XXX_Unmarshal(b []byte) error
- type TLSTerminationType
- type WildcardPolicyType
Constants ¶
const ( // TLSTerminationEdge terminate encryption at the edge router. TLSTerminationEdge TLSTerminationType = "edge" // TLSTerminationPassthrough terminate encryption at the destination, the destination is responsible for decrypting traffic TLSTerminationPassthrough TLSTerminationType = "passthrough" // TLSTerminationReencrypt terminate encryption at the edge router and re-encrypt it with a new certificate supplied by the destination TLSTerminationReencrypt TLSTerminationType = "reencrypt" // InsecureEdgeTerminationPolicyNone disables insecure connections for an edge-terminated route. InsecureEdgeTerminationPolicyNone InsecureEdgeTerminationPolicyType = "None" // InsecureEdgeTerminationPolicyAllow allows insecure connections for an edge-terminated route. InsecureEdgeTerminationPolicyAllow InsecureEdgeTerminationPolicyType = "Allow" // InsecureEdgeTerminationPolicyRedirect redirects insecure connections for an edge-terminated route. // As an example, for routers that support HTTP and HTTPS, the // insecure HTTP connections will be redirected to use HTTPS. InsecureEdgeTerminationPolicyRedirect InsecureEdgeTerminationPolicyType = "Redirect" )
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
var ( GroupName = "route.openshift.io" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
var (
DeprecatedInstallWithoutGroup = legacySchemeBuilder.AddToScheme
)
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type InsecureEdgeTerminationPolicyType ¶
type InsecureEdgeTerminationPolicyType string
InsecureEdgeTerminationPolicyType dictates the behavior of insecure connections to an edge-terminated route.
type Route ¶
type Route struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // spec is the desired state of the route Spec RouteSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"` // status is the current state of the route // +optional Status RouteStatus `json:"status" protobuf:"bytes,3,opt,name=status"` }
A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints.
Once a route is created, the `host` field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.
Routers are subject to additional customization and may support additional controls via the annotations field.
Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.
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) Descriptor ¶
func (*Route) ProtoMessage ¶
func (*Route) ProtoMessage()
func (Route) SwaggerDoc ¶
func (*Route) XXX_DiscardUnknown ¶
func (m *Route) XXX_DiscardUnknown()
func (*Route) XXX_Marshal ¶
func (*Route) XXX_Unmarshal ¶
type RouteIngress ¶
type RouteIngress struct { // Host is the host string under which the route is exposed; this value is required Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"` // Name is a name chosen by the router to identify itself; this value is required RouterName string `json:"routerName,omitempty" protobuf:"bytes,2,opt,name=routerName"` // Conditions is the state of the route, may be empty. Conditions []RouteIngressCondition `json:"conditions,omitempty" protobuf:"bytes,3,rep,name=conditions"` // Wildcard policy is the wildcard policy that was allowed where this route is exposed. WildcardPolicy WildcardPolicyType `json:"wildcardPolicy,omitempty" protobuf:"bytes,4,opt,name=wildcardPolicy"` // CanonicalHostname is the external host name for the router that can be used as a CNAME // for the host requested for this route. This value is optional and may not be set in all cases. RouterCanonicalHostname string `json:"routerCanonicalHostname,omitempty" protobuf:"bytes,5,opt,name=routerCanonicalHostname"` }
RouteIngress holds information about the places where a route is exposed.
func (*RouteIngress) DeepCopy ¶
func (in *RouteIngress) DeepCopy() *RouteIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteIngress.
func (*RouteIngress) DeepCopyInto ¶
func (in *RouteIngress) DeepCopyInto(out *RouteIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteIngress) Descriptor ¶
func (*RouteIngress) Descriptor() ([]byte, []int)
func (*RouteIngress) Marshal ¶
func (m *RouteIngress) Marshal() (dAtA []byte, err error)
func (*RouteIngress) MarshalToSizedBuffer ¶
func (m *RouteIngress) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RouteIngress) ProtoMessage ¶
func (*RouteIngress) ProtoMessage()
func (*RouteIngress) Reset ¶
func (m *RouteIngress) Reset()
func (*RouteIngress) Size ¶
func (m *RouteIngress) Size() (n int)
func (*RouteIngress) String ¶
func (this *RouteIngress) String() string
func (RouteIngress) SwaggerDoc ¶
func (RouteIngress) SwaggerDoc() map[string]string
func (*RouteIngress) Unmarshal ¶
func (m *RouteIngress) Unmarshal(dAtA []byte) error
func (*RouteIngress) XXX_DiscardUnknown ¶
func (m *RouteIngress) XXX_DiscardUnknown()
func (*RouteIngress) XXX_Marshal ¶
func (m *RouteIngress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteIngress) XXX_Merge ¶
func (m *RouteIngress) XXX_Merge(src proto.Message)
func (*RouteIngress) XXX_Size ¶
func (m *RouteIngress) XXX_Size() int
func (*RouteIngress) XXX_Unmarshal ¶
func (m *RouteIngress) XXX_Unmarshal(b []byte) error
type RouteIngressCondition ¶
type RouteIngressCondition struct { // Type is the type of the condition. // Currently only Ready. Type RouteIngressConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=RouteIngressConditionType"` // Status is the status of the condition. // Can be True, False, Unknown. Status corev1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` // (brief) reason for the condition's last transition, and is usually a machine and human // readable constant Reason string `json:"reason,omitempty" protobuf:"bytes,3,opt,name=reason"` // Human readable message indicating details about last transition. Message string `json:"message,omitempty" protobuf:"bytes,4,opt,name=message"` // RFC 3339 date and time when this condition last transitioned LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,5,opt,name=lastTransitionTime"` }
RouteIngressCondition contains details for the current condition of this route on a particular router.
func (*RouteIngressCondition) DeepCopy ¶
func (in *RouteIngressCondition) DeepCopy() *RouteIngressCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteIngressCondition.
func (*RouteIngressCondition) DeepCopyInto ¶
func (in *RouteIngressCondition) DeepCopyInto(out *RouteIngressCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteIngressCondition) Descriptor ¶
func (*RouteIngressCondition) Descriptor() ([]byte, []int)
func (*RouteIngressCondition) Marshal ¶
func (m *RouteIngressCondition) Marshal() (dAtA []byte, err error)
func (*RouteIngressCondition) MarshalTo ¶
func (m *RouteIngressCondition) MarshalTo(dAtA []byte) (int, error)
func (*RouteIngressCondition) MarshalToSizedBuffer ¶
func (m *RouteIngressCondition) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RouteIngressCondition) ProtoMessage ¶
func (*RouteIngressCondition) ProtoMessage()
func (*RouteIngressCondition) Reset ¶
func (m *RouteIngressCondition) Reset()
func (*RouteIngressCondition) Size ¶
func (m *RouteIngressCondition) Size() (n int)
func (*RouteIngressCondition) String ¶
func (this *RouteIngressCondition) String() string
func (RouteIngressCondition) SwaggerDoc ¶
func (RouteIngressCondition) SwaggerDoc() map[string]string
func (*RouteIngressCondition) Unmarshal ¶
func (m *RouteIngressCondition) Unmarshal(dAtA []byte) error
func (*RouteIngressCondition) XXX_DiscardUnknown ¶
func (m *RouteIngressCondition) XXX_DiscardUnknown()
func (*RouteIngressCondition) XXX_Marshal ¶
func (m *RouteIngressCondition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteIngressCondition) XXX_Merge ¶
func (m *RouteIngressCondition) XXX_Merge(src proto.Message)
func (*RouteIngressCondition) XXX_Size ¶
func (m *RouteIngressCondition) XXX_Size() int
func (*RouteIngressCondition) XXX_Unmarshal ¶
func (m *RouteIngressCondition) XXX_Unmarshal(b []byte) error
type RouteIngressConditionType ¶
type RouteIngressConditionType string
RouteIngressConditionType is a valid value for RouteCondition
const ( // RouteAdmitted means the route is able to service requests for the provided Host RouteAdmitted RouteIngressConditionType = "Admitted" )
These are valid conditions of pod.
type RouteList ¶
type RouteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // items is a list of routes Items []Route `json:"items" protobuf:"bytes,2,rep,name=items"` }
RouteList is a collection of Routes.
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.
func (*RouteList) Descriptor ¶
func (*RouteList) MarshalToSizedBuffer ¶
func (*RouteList) ProtoMessage ¶
func (*RouteList) ProtoMessage()
func (RouteList) SwaggerDoc ¶
func (*RouteList) XXX_DiscardUnknown ¶
func (m *RouteList) XXX_DiscardUnknown()
func (*RouteList) XXX_Marshal ¶
func (*RouteList) XXX_Unmarshal ¶
type RoutePort ¶
type RoutePort struct { // The target port on pods selected by the service this route points to. // If this is a string, it will be looked up as a named port in the target // endpoints port list. Required TargetPort intstr.IntOrString `json:"targetPort" protobuf:"bytes,1,opt,name=targetPort"` }
RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
func (*RoutePort) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RoutePort.
func (*RoutePort) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RoutePort) Descriptor ¶
func (*RoutePort) MarshalToSizedBuffer ¶
func (*RoutePort) ProtoMessage ¶
func (*RoutePort) ProtoMessage()
func (RoutePort) SwaggerDoc ¶
func (*RoutePort) XXX_DiscardUnknown ¶
func (m *RoutePort) XXX_DiscardUnknown()
func (*RoutePort) XXX_Marshal ¶
func (*RoutePort) XXX_Unmarshal ¶
type RouteSpec ¶
type RouteSpec struct { // host is an alias/DNS that points to the service. Optional. // If not specified a route name will typically be automatically // chosen. // Must follow DNS952 subdomain conventions. // +optional Host string `json:"host" protobuf:"bytes,1,opt,name=host"` // subdomain is a DNS subdomain that is requested within the ingress controller's // domain (as a subdomain). If host is set this field is ignored. An ingress // controller may choose to ignore this suggested name, in which case the controller // will report the assigned name in the status.ingress array or refuse to admit the // route. If this value is set and the server does not support this field host will // be populated automatically. Otherwise host is left empty. The field may have // multiple parts separated by a dot, but not all ingress controllers may honor // the request. This field may not be changed after creation except by a user with // the update routes/custom-host permission. // // Example: subdomain `frontend` automatically receives the router subdomain // `apps.mycluster.com` to have a full hostname `frontend.apps.mycluster.com`. // // +optional Subdomain string `json:"subdomain,omitempty" protobuf:"bytes,8,opt,name=subdomain"` // path that the router watches for, to route traffic for to the service. Optional Path string `json:"path,omitempty" protobuf:"bytes,2,opt,name=path"` // to is an object the route should use as the primary backend. Only the Service kind // is allowed, and it will be defaulted to Service. If the weight field (0-256 default 100) // is set to zero, no traffic will be sent to this backend. To RouteTargetReference `json:"to" protobuf:"bytes,3,opt,name=to"` // alternateBackends allows up to 3 additional backends to be assigned to the route. // Only the Service kind is allowed, and it will be defaulted to Service. // Use the weight field in RouteTargetReference object to specify relative preference. AlternateBackends []RouteTargetReference `json:"alternateBackends,omitempty" protobuf:"bytes,4,rep,name=alternateBackends"` // If specified, the port to be used by the router. Most routers will use all // endpoints exposed by the service by default - set this value to instruct routers // which port to use. Port *RoutePort `json:"port,omitempty" protobuf:"bytes,5,opt,name=port"` // The tls field provides the ability to configure certificates and termination for the route. TLS *TLSConfig `json:"tls,omitempty" protobuf:"bytes,6,opt,name=tls"` // Wildcard policy if any for the route. // Currently only 'Subdomain' or 'None' is allowed. WildcardPolicy WildcardPolicyType `json:"wildcardPolicy,omitempty" protobuf:"bytes,7,opt,name=wildcardPolicy"` }
RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 100. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response.
The `tls` field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate.
func (*RouteSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteSpec.
func (*RouteSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteSpec) Descriptor ¶
func (*RouteSpec) MarshalToSizedBuffer ¶
func (*RouteSpec) ProtoMessage ¶
func (*RouteSpec) ProtoMessage()
func (RouteSpec) SwaggerDoc ¶
func (*RouteSpec) XXX_DiscardUnknown ¶
func (m *RouteSpec) XXX_DiscardUnknown()
func (*RouteSpec) XXX_Marshal ¶
func (*RouteSpec) XXX_Unmarshal ¶
type RouteStatus ¶
type RouteStatus struct { // ingress describes the places where the route may be exposed. The list of // ingress points may contain duplicate Host or RouterName values. Routes // are considered live once they are `Ready` Ingress []RouteIngress `json:"ingress" protobuf:"bytes,1,rep,name=ingress"` }
RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.
func (*RouteStatus) DeepCopy ¶
func (in *RouteStatus) DeepCopy() *RouteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteStatus.
func (*RouteStatus) DeepCopyInto ¶
func (in *RouteStatus) DeepCopyInto(out *RouteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteStatus) Descriptor ¶
func (*RouteStatus) Descriptor() ([]byte, []int)
func (*RouteStatus) Marshal ¶
func (m *RouteStatus) Marshal() (dAtA []byte, err error)
func (*RouteStatus) MarshalToSizedBuffer ¶
func (m *RouteStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RouteStatus) ProtoMessage ¶
func (*RouteStatus) ProtoMessage()
func (*RouteStatus) Reset ¶
func (m *RouteStatus) Reset()
func (*RouteStatus) Size ¶
func (m *RouteStatus) Size() (n int)
func (*RouteStatus) String ¶
func (this *RouteStatus) String() string
func (RouteStatus) SwaggerDoc ¶
func (RouteStatus) SwaggerDoc() map[string]string
func (*RouteStatus) Unmarshal ¶
func (m *RouteStatus) Unmarshal(dAtA []byte) error
func (*RouteStatus) XXX_DiscardUnknown ¶
func (m *RouteStatus) XXX_DiscardUnknown()
func (*RouteStatus) XXX_Marshal ¶
func (m *RouteStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteStatus) XXX_Merge ¶
func (m *RouteStatus) XXX_Merge(src proto.Message)
func (*RouteStatus) XXX_Size ¶
func (m *RouteStatus) XXX_Size() int
func (*RouteStatus) XXX_Unmarshal ¶
func (m *RouteStatus) XXX_Unmarshal(b []byte) error
type RouteTargetReference ¶
type RouteTargetReference struct { // The kind of target that the route is referring to. Currently, only 'Service' is allowed Kind string `json:"kind" protobuf:"bytes,1,opt,name=kind"` // name of the service/target that is being referred to. e.g. name of the service Name string `json:"name" protobuf:"bytes,2,opt,name=name"` // weight as an integer between 0 and 256, default 100, that specifies the target's relative weight // against other target reference objects. 0 suppresses requests to this backend. // +optional Weight *int32 `json:"weight" protobuf:"varint,3,opt,name=weight"` }
RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.
func (*RouteTargetReference) DeepCopy ¶
func (in *RouteTargetReference) DeepCopy() *RouteTargetReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteTargetReference.
func (*RouteTargetReference) DeepCopyInto ¶
func (in *RouteTargetReference) DeepCopyInto(out *RouteTargetReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouteTargetReference) Descriptor ¶
func (*RouteTargetReference) Descriptor() ([]byte, []int)
func (*RouteTargetReference) Marshal ¶
func (m *RouteTargetReference) Marshal() (dAtA []byte, err error)
func (*RouteTargetReference) MarshalTo ¶
func (m *RouteTargetReference) MarshalTo(dAtA []byte) (int, error)
func (*RouteTargetReference) MarshalToSizedBuffer ¶
func (m *RouteTargetReference) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RouteTargetReference) ProtoMessage ¶
func (*RouteTargetReference) ProtoMessage()
func (*RouteTargetReference) Reset ¶
func (m *RouteTargetReference) Reset()
func (*RouteTargetReference) Size ¶
func (m *RouteTargetReference) Size() (n int)
func (*RouteTargetReference) String ¶
func (this *RouteTargetReference) String() string
func (RouteTargetReference) SwaggerDoc ¶
func (RouteTargetReference) SwaggerDoc() map[string]string
func (*RouteTargetReference) Unmarshal ¶
func (m *RouteTargetReference) Unmarshal(dAtA []byte) error
func (*RouteTargetReference) XXX_DiscardUnknown ¶
func (m *RouteTargetReference) XXX_DiscardUnknown()
func (*RouteTargetReference) XXX_Marshal ¶
func (m *RouteTargetReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteTargetReference) XXX_Merge ¶
func (m *RouteTargetReference) XXX_Merge(src proto.Message)
func (*RouteTargetReference) XXX_Size ¶
func (m *RouteTargetReference) XXX_Size() int
func (*RouteTargetReference) XXX_Unmarshal ¶
func (m *RouteTargetReference) XXX_Unmarshal(b []byte) error
type RouterShard ¶
type RouterShard struct { // shardName uniquely identifies a router shard in the "set" of // routers used for routing traffic to the services. ShardName string `json:"shardName" protobuf:"bytes,1,opt,name=shardName"` // dnsSuffix for the shard ala: shard-1.v3.openshift.com DNSSuffix string `json:"dnsSuffix" protobuf:"bytes,2,opt,name=dnsSuffix"` }
RouterShard has information of a routing shard and is used to generate host names and routing table entries when a routing shard is allocated for a specific route. Caveat: This is WIP and will likely undergo modifications when sharding
support is added.
func (*RouterShard) DeepCopy ¶
func (in *RouterShard) DeepCopy() *RouterShard
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouterShard.
func (*RouterShard) DeepCopyInto ¶
func (in *RouterShard) DeepCopyInto(out *RouterShard)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RouterShard) Descriptor ¶
func (*RouterShard) Descriptor() ([]byte, []int)
func (*RouterShard) Marshal ¶
func (m *RouterShard) Marshal() (dAtA []byte, err error)
func (*RouterShard) MarshalToSizedBuffer ¶
func (m *RouterShard) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*RouterShard) ProtoMessage ¶
func (*RouterShard) ProtoMessage()
func (*RouterShard) Reset ¶
func (m *RouterShard) Reset()
func (*RouterShard) Size ¶
func (m *RouterShard) Size() (n int)
func (*RouterShard) String ¶
func (this *RouterShard) String() string
func (RouterShard) SwaggerDoc ¶
func (RouterShard) SwaggerDoc() map[string]string
func (*RouterShard) Unmarshal ¶
func (m *RouterShard) Unmarshal(dAtA []byte) error
func (*RouterShard) XXX_DiscardUnknown ¶
func (m *RouterShard) XXX_DiscardUnknown()
func (*RouterShard) XXX_Marshal ¶
func (m *RouterShard) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouterShard) XXX_Merge ¶
func (m *RouterShard) XXX_Merge(src proto.Message)
func (*RouterShard) XXX_Size ¶
func (m *RouterShard) XXX_Size() int
func (*RouterShard) XXX_Unmarshal ¶
func (m *RouterShard) XXX_Unmarshal(b []byte) error
type TLSConfig ¶
type TLSConfig struct { // termination indicates termination type. Termination TLSTerminationType `json:"termination" protobuf:"bytes,1,opt,name=termination,casttype=TLSTerminationType"` // certificate provides certificate contents Certificate string `json:"certificate,omitempty" protobuf:"bytes,2,opt,name=certificate"` // key provides key file contents Key string `json:"key,omitempty" protobuf:"bytes,3,opt,name=key"` // caCertificate provides the cert authority certificate contents CACertificate string `json:"caCertificate,omitempty" protobuf:"bytes,4,opt,name=caCertificate"` // destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt // termination this file should be provided in order to have routers use it for health checks on the secure connection. // If this field is not specified, the router may provide its own destination CA and perform hostname validation using // the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically // verify. DestinationCACertificate string `json:"destinationCACertificate,omitempty" protobuf:"bytes,5,opt,name=destinationCACertificate"` // insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While // each router may make its own decisions on which ports to expose, this is normally port 80. // // * Allow - traffic is sent to the server on the insecure port (default) // * Disable - no traffic is allowed on the insecure port. // * Redirect - clients are redirected to the secure port. InsecureEdgeTerminationPolicy InsecureEdgeTerminationPolicyType `` /* 147-byte string literal not displayed */ }
TLSConfig defines config used to secure a route and provide termination
func (*TLSConfig) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSConfig.
func (*TLSConfig) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TLSConfig) Descriptor ¶
func (*TLSConfig) MarshalToSizedBuffer ¶
func (*TLSConfig) ProtoMessage ¶
func (*TLSConfig) ProtoMessage()
func (TLSConfig) SwaggerDoc ¶
func (*TLSConfig) XXX_DiscardUnknown ¶
func (m *TLSConfig) XXX_DiscardUnknown()
func (*TLSConfig) XXX_Marshal ¶
func (*TLSConfig) XXX_Unmarshal ¶
type TLSTerminationType ¶
type TLSTerminationType string
TLSTerminationType dictates where the secure communication will stop TODO: Reconsider this type in v2
type WildcardPolicyType ¶
type WildcardPolicyType string
WildcardPolicyType indicates the type of wildcard support needed by routes.
const ( // WildcardPolicyNone indicates no wildcard support is needed. WildcardPolicyNone WildcardPolicyType = "None" // WildcardPolicySubdomain indicates the host needs wildcard support for the subdomain. // Example: For host = "www.acme.test", indicates that the router // should support requests for *.acme.test // Note that this will not match acme.test only *.acme.test WildcardPolicySubdomain WildcardPolicyType = "Subdomain" )