v1

package
v1.5.0-alpha.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API. 

Package v1 is a generated protocol buffer package.

It is generated from these files:
	github.com/openshift/origin/pkg/route/api/v1/generated.proto

It has these top-level messages:
	Route
	RouteIngress
	RouteIngressCondition
	RouteList
	RoutePort
	RouteSpec
	RouteStatus
	RouteTargetReference
	RouterShard
	TLSConfig

Index

Constants

View Source 
const GroupName = ""

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs, addDefaultingFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_api_RouteIngressCondition_To_v1_RouteIngressCondition added in v1.3.0 

func Convert_api_RouteIngressCondition_To_v1_RouteIngressCondition(in *api.RouteIngressCondition, out *RouteIngressCondition, s conversion.Scope) error

func Convert_api_RouteIngress_To_v1_RouteIngress added in v1.3.0 

func Convert_api_RouteIngress_To_v1_RouteIngress(in *api.RouteIngress, out *RouteIngress, s conversion.Scope) error

func Convert_api_RouteList_To_v1_RouteList added in v1.3.0 

func Convert_api_RouteList_To_v1_RouteList(in *api.RouteList, out *RouteList, s conversion.Scope) error

func Convert_api_RoutePort_To_v1_RoutePort added in v1.3.0 

func Convert_api_RoutePort_To_v1_RoutePort(in *api.RoutePort, out *RoutePort, s conversion.Scope) error

func Convert_api_RouteSpec_To_v1_RouteSpec added in v1.3.0 

func Convert_api_RouteSpec_To_v1_RouteSpec(in *api.RouteSpec, out *RouteSpec, s conversion.Scope) error

func Convert_api_RouteStatus_To_v1_RouteStatus added in v1.3.0 

func Convert_api_RouteStatus_To_v1_RouteStatus(in *api.RouteStatus, out *RouteStatus, s conversion.Scope) error

func Convert_api_RouteTargetReference_To_v1_RouteTargetReference added in v1.3.0 

func Convert_api_RouteTargetReference_To_v1_RouteTargetReference(in *api.RouteTargetReference, out *RouteTargetReference, s conversion.Scope) error

func Convert_api_Route_To_v1_Route added in v1.3.0 

func Convert_api_Route_To_v1_Route(in *api.Route, out *Route, s conversion.Scope) error

func Convert_api_RouterShard_To_v1_RouterShard added in v1.3.0 

func Convert_api_RouterShard_To_v1_RouterShard(in *api.RouterShard, out *RouterShard, s conversion.Scope) error

func Convert_api_TLSConfig_To_v1_TLSConfig added in v1.3.0 

func Convert_api_TLSConfig_To_v1_TLSConfig(in *api.TLSConfig, out *TLSConfig, s conversion.Scope) error

func Convert_v1_RouteIngressCondition_To_api_RouteIngressCondition added in v1.3.0 

func Convert_v1_RouteIngressCondition_To_api_RouteIngressCondition(in *RouteIngressCondition, out *api.RouteIngressCondition, s conversion.Scope) error

func Convert_v1_RouteIngress_To_api_RouteIngress added in v1.3.0 

func Convert_v1_RouteIngress_To_api_RouteIngress(in *RouteIngress, out *api.RouteIngress, s conversion.Scope) error

func Convert_v1_RouteList_To_api_RouteList added in v1.3.0 

func Convert_v1_RouteList_To_api_RouteList(in *RouteList, out *api.RouteList, s conversion.Scope) error

func Convert_v1_RoutePort_To_api_RoutePort added in v1.3.0 

func Convert_v1_RoutePort_To_api_RoutePort(in *RoutePort, out *api.RoutePort, s conversion.Scope) error

func Convert_v1_RouteSpec_To_api_RouteSpec added in v1.3.0 

func Convert_v1_RouteSpec_To_api_RouteSpec(in *RouteSpec, out *api.RouteSpec, s conversion.Scope) error

func Convert_v1_RouteStatus_To_api_RouteStatus added in v1.3.0 

func Convert_v1_RouteStatus_To_api_RouteStatus(in *RouteStatus, out *api.RouteStatus, s conversion.Scope) error

func Convert_v1_RouteTargetReference_To_api_RouteTargetReference added in v1.3.0 

func Convert_v1_RouteTargetReference_To_api_RouteTargetReference(in *RouteTargetReference, out *api.RouteTargetReference, s conversion.Scope) error

func Convert_v1_Route_To_api_Route added in v1.3.0 

func Convert_v1_Route_To_api_Route(in *Route, out *api.Route, s conversion.Scope) error

func Convert_v1_RouterShard_To_api_RouterShard added in v1.3.0 

func Convert_v1_RouterShard_To_api_RouterShard(in *RouterShard, out *api.RouterShard, s conversion.Scope) error

func Convert_v1_TLSConfig_To_api_TLSConfig added in v1.3.0 

func Convert_v1_TLSConfig_To_api_TLSConfig(in *TLSConfig, out *api.TLSConfig, s conversion.Scope) error

func DeepCopy_v1_Route added in v1.3.0 

func DeepCopy_v1_Route(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteIngress added in v1.3.0 

func DeepCopy_v1_RouteIngress(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteIngressCondition added in v1.3.0 

func DeepCopy_v1_RouteIngressCondition(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteList added in v1.3.0 

func DeepCopy_v1_RouteList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RoutePort added in v1.3.0 

func DeepCopy_v1_RoutePort(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteSpec added in v1.3.0 

func DeepCopy_v1_RouteSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteStatus added in v1.3.0 

func DeepCopy_v1_RouteStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouteTargetReference added in v1.3.0 

func DeepCopy_v1_RouteTargetReference(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_RouterShard added in v1.3.0 

func DeepCopy_v1_RouterShard(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_TLSConfig added in v1.3.0 

func DeepCopy_v1_TLSConfig(in interface{}, out interface{}, c *conversion.Cloner) error

func RegisterConversions added in v1.4.0 

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDeepCopies added in v1.4.0 

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults added in v1.5.0 

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func SetDefaults_RouteIngress added in v1.4.0 

func SetDefaults_RouteIngress(obj *RouteIngress)

func SetDefaults_RouteSpec added in v1.4.0 

func SetDefaults_RouteSpec(obj *RouteSpec)

func SetDefaults_RouteTargetReference added in v1.3.0 

func SetDefaults_RouteTargetReference(obj *RouteTargetReference)

func SetDefaults_TLSConfig added in v1.3.0 

func SetDefaults_TLSConfig(obj *TLSConfig)

func SetObjectDefaults_Route added in v1.5.0 

func SetObjectDefaults_Route(in *Route)

func SetObjectDefaults_RouteList added in v1.5.0 

func SetObjectDefaults_RouteList(in *RouteList)

Types

type InsecureEdgeTerminationPolicyType added in v1.0.8 

type InsecureEdgeTerminationPolicyType string

InsecureEdgeTerminationPolicyType dictates the behavior of insecure connections to an edge-terminated route.

type Route 

type Route struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object metadata.
	kapi.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
	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) Descriptor added in v1.4.0 

func (*Route) Descriptor() ([]byte, []int)

func (*Route) GetObjectKind added in v1.1.3 

func (obj *Route) GetObjectKind() unversioned.ObjectKind

func (*Route) Marshal added in v1.3.0 

func (m *Route) Marshal() (data []byte, err error)

func (*Route) MarshalTo added in v1.3.0 

func (m *Route) MarshalTo(data []byte) (int, error)

func (*Route) ProtoMessage added in v1.3.0 

func (*Route) ProtoMessage()

func (*Route) Reset added in v1.3.0 

func (m *Route) Reset()

func (*Route) Size added in v1.3.0 

func (m *Route) Size() (n int)

func (*Route) String added in v1.3.0 

func (this *Route) String() string

func (Route) SwaggerDoc added in v1.1.4 

func (Route) SwaggerDoc() map[string]string

func (*Route) Unmarshal added in v1.3.0 

func (m *Route) Unmarshal(data []byte) error

type RouteIngress added in v1.1.3 

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) Descriptor added in v1.4.0 

func (*RouteIngress) Descriptor() ([]byte, []int)

func (*RouteIngress) Marshal added in v1.3.0 

func (m *RouteIngress) Marshal() (data []byte, err error)

func (*RouteIngress) MarshalTo added in v1.3.0 

func (m *RouteIngress) MarshalTo(data []byte) (int, error)

func (*RouteIngress) ProtoMessage added in v1.3.0 

func (*RouteIngress) ProtoMessage()

func (*RouteIngress) Reset added in v1.3.0 

func (m *RouteIngress) Reset()

func (*RouteIngress) Size added in v1.3.0 

func (m *RouteIngress) Size() (n int)

func (*RouteIngress) String added in v1.3.0 

func (this *RouteIngress) String() string

func (RouteIngress) SwaggerDoc added in v1.1.4 

func (RouteIngress) SwaggerDoc() map[string]string

func (*RouteIngress) Unmarshal added in v1.3.0 

func (m *RouteIngress) Unmarshal(data []byte) error

type RouteIngressCondition added in v1.1.3 

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 kapi.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/kubernetes/pkg/api/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 *unversioned.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) Descriptor added in v1.4.0 

func (*RouteIngressCondition) Descriptor() ([]byte, []int)

func (*RouteIngressCondition) Marshal added in v1.3.0 

func (m *RouteIngressCondition) Marshal() (data []byte, err error)

func (*RouteIngressCondition) MarshalTo added in v1.3.0 

func (m *RouteIngressCondition) MarshalTo(data []byte) (int, error)

func (*RouteIngressCondition) ProtoMessage added in v1.3.0 

func (*RouteIngressCondition) ProtoMessage()

func (*RouteIngressCondition) Reset added in v1.3.0 

func (m *RouteIngressCondition) Reset()

func (*RouteIngressCondition) Size added in v1.3.0 

func (m *RouteIngressCondition) Size() (n int)

func (*RouteIngressCondition) String added in v1.3.0 

func (this *RouteIngressCondition) String() string

func (RouteIngressCondition) SwaggerDoc added in v1.1.4 

func (RouteIngressCondition) SwaggerDoc() map[string]string

func (*RouteIngressCondition) Unmarshal added in v1.3.0 

func (m *RouteIngressCondition) Unmarshal(data []byte) error

type RouteIngressConditionType added in v1.1.3 

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 {
	unversioned.TypeMeta `json:",inline"`
	// Standard object metadata.
	unversioned.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) Descriptor added in v1.4.0 

func (*RouteList) Descriptor() ([]byte, []int)

func (*RouteList) GetObjectKind added in v1.1.3 

func (obj *RouteList) GetObjectKind() unversioned.ObjectKind

func (*RouteList) Marshal added in v1.3.0 

func (m *RouteList) Marshal() (data []byte, err error)

func (*RouteList) MarshalTo added in v1.3.0 

func (m *RouteList) MarshalTo(data []byte) (int, error)

func (*RouteList) ProtoMessage added in v1.3.0 

func (*RouteList) ProtoMessage()

func (*RouteList) Reset added in v1.3.0 

func (m *RouteList) Reset()

func (*RouteList) Size added in v1.3.0 

func (m *RouteList) Size() (n int)

func (*RouteList) String added in v1.3.0 

func (this *RouteList) String() string

func (RouteList) SwaggerDoc added in v1.1.4 

func (RouteList) SwaggerDoc() map[string]string

func (*RouteList) Unmarshal added in v1.3.0 

func (m *RouteList) Unmarshal(data []byte) error

type RoutePort added in v1.0.7 

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) Descriptor added in v1.4.0 

func (*RoutePort) Descriptor() ([]byte, []int)

func (*RoutePort) Marshal added in v1.3.0 

func (m *RoutePort) Marshal() (data []byte, err error)

func (*RoutePort) MarshalTo added in v1.3.0 

func (m *RoutePort) MarshalTo(data []byte) (int, error)

func (*RoutePort) ProtoMessage added in v1.3.0 

func (*RoutePort) ProtoMessage()

func (*RoutePort) Reset added in v1.3.0 

func (m *RoutePort) Reset()

func (*RoutePort) Size added in v1.3.0 

func (m *RoutePort) Size() (n int)

func (*RoutePort) String added in v1.3.0 

func (this *RoutePort) String() string

func (RoutePort) SwaggerDoc added in v1.1.4 

func (RoutePort) SwaggerDoc() map[string]string

func (*RoutePort) Unmarshal added in v1.3.0 

func (m *RoutePort) Unmarshal(data []byte) error

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.
	Host string `json:"host" protobuf:"bytes,1,opt,name=host"`
	// 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 is set to zero,
	// no traffic will be sent to this service.
	To RouteTargetReference `json:"to" protobuf:"bytes,3,opt,name=to"`

	// alternateBackends is an extension of the 'to' field. If more than one service needs to be
	// pointed to, then use this field. Use the weight field in RouteTargetReference object
	// to specify relative preference. If the weight field is zero, the backend is ignored.
	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 or more backends the route points to. Weights on each backend can define the balance of traffic sent to each 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) Descriptor added in v1.4.0 

func (*RouteSpec) Descriptor() ([]byte, []int)

func (*RouteSpec) Marshal added in v1.3.0 

func (m *RouteSpec) Marshal() (data []byte, err error)

func (*RouteSpec) MarshalTo added in v1.3.0 

func (m *RouteSpec) MarshalTo(data []byte) (int, error)

func (*RouteSpec) ProtoMessage added in v1.3.0 

func (*RouteSpec) ProtoMessage()

func (*RouteSpec) Reset added in v1.3.0 

func (m *RouteSpec) Reset()

func (*RouteSpec) Size added in v1.3.0 

func (m *RouteSpec) Size() (n int)

func (*RouteSpec) String added in v1.3.0 

func (this *RouteSpec) String() string

func (RouteSpec) SwaggerDoc added in v1.1.4 

func (RouteSpec) SwaggerDoc() map[string]string

func (*RouteSpec) Unmarshal added in v1.3.0 

func (m *RouteSpec) Unmarshal(data []byte) error

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) Descriptor added in v1.4.0 

func (*RouteStatus) Descriptor() ([]byte, []int)

func (*RouteStatus) Marshal added in v1.3.0 

func (m *RouteStatus) Marshal() (data []byte, err error)

func (*RouteStatus) MarshalTo added in v1.3.0 

func (m *RouteStatus) MarshalTo(data []byte) (int, error)

func (*RouteStatus) ProtoMessage added in v1.3.0 

func (*RouteStatus) ProtoMessage()

func (*RouteStatus) Reset added in v1.3.0 

func (m *RouteStatus) Reset()

func (*RouteStatus) Size added in v1.3.0 

func (m *RouteStatus) Size() (n int)

func (*RouteStatus) String added in v1.3.0 

func (this *RouteStatus) String() string

func (RouteStatus) SwaggerDoc added in v1.1.4 

func (RouteStatus) SwaggerDoc() map[string]string

func (*RouteStatus) Unmarshal added in v1.3.0 

func (m *RouteStatus) Unmarshal(data []byte) error

type RouteTargetReference added in v1.3.0 

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 1 and 256 that specifies the target's relative weight
	// against other target reference objects
	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) Descriptor added in v1.4.0 

func (*RouteTargetReference) Descriptor() ([]byte, []int)

func (*RouteTargetReference) Marshal added in v1.3.0 

func (m *RouteTargetReference) Marshal() (data []byte, err error)

func (*RouteTargetReference) MarshalTo added in v1.3.0 

func (m *RouteTargetReference) MarshalTo(data []byte) (int, error)

func (*RouteTargetReference) ProtoMessage added in v1.3.0 

func (*RouteTargetReference) ProtoMessage()

func (*RouteTargetReference) Reset added in v1.3.0 

func (m *RouteTargetReference) Reset()

func (*RouteTargetReference) Size added in v1.3.0 

func (m *RouteTargetReference) Size() (n int)

func (*RouteTargetReference) String added in v1.3.0 

func (this *RouteTargetReference) String() string

func (RouteTargetReference) SwaggerDoc added in v1.3.0 

func (RouteTargetReference) SwaggerDoc() map[string]string

func (*RouteTargetReference) Unmarshal added in v1.3.0 

func (m *RouteTargetReference) Unmarshal(data []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) Descriptor added in v1.4.0 

func (*RouterShard) Descriptor() ([]byte, []int)

func (*RouterShard) Marshal added in v1.3.0 

func (m *RouterShard) Marshal() (data []byte, err error)

func (*RouterShard) MarshalTo added in v1.3.0 

func (m *RouterShard) MarshalTo(data []byte) (int, error)

func (*RouterShard) ProtoMessage added in v1.3.0 

func (*RouterShard) ProtoMessage()

func (*RouterShard) Reset added in v1.3.0 

func (m *RouterShard) Reset()

func (*RouterShard) Size added in v1.3.0 

func (m *RouterShard) Size() (n int)

func (*RouterShard) String added in v1.3.0 

func (this *RouterShard) String() string

func (RouterShard) SwaggerDoc added in v1.1.4 

func (RouterShard) SwaggerDoc() map[string]string

func (*RouterShard) Unmarshal added in v1.3.0 

func (m *RouterShard) Unmarshal(data []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
	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) Descriptor added in v1.4.0 

func (*TLSConfig) Descriptor() ([]byte, []int)

func (*TLSConfig) Marshal added in v1.3.0 

func (m *TLSConfig) Marshal() (data []byte, err error)

func (*TLSConfig) MarshalTo added in v1.3.0 

func (m *TLSConfig) MarshalTo(data []byte) (int, error)

func (*TLSConfig) ProtoMessage added in v1.3.0 

func (*TLSConfig) ProtoMessage()

func (*TLSConfig) Reset added in v1.3.0 

func (m *TLSConfig) Reset()

func (*TLSConfig) Size added in v1.3.0 

func (m *TLSConfig) Size() (n int)

func (*TLSConfig) String added in v1.3.0 

func (this *TLSConfig) String() string

func (TLSConfig) SwaggerDoc added in v1.1.4 

func (TLSConfig) SwaggerDoc() map[string]string

func (*TLSConfig) Unmarshal added in v1.3.0 

func (m *TLSConfig) Unmarshal(data []byte) error

type TLSTerminationType 

type TLSTerminationType string

TLSTerminationType dictates where the secure communication will stop TODO: Reconsider this type in v2 

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"
)

type WildcardPolicyType added in v1.4.0 

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"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.