Documentation
¶
Index ¶
- Constants
- Variables
- func Kind(kind string) unversioned.GroupKind
- func Resource(resource string) unversioned.GroupResource
- func RouteToSelectableFields(route *Route) fields.Set
- type InsecureEdgeTerminationPolicyType
- type Route
- type RouteList
- type RoutePort
- type RouteSpec
- type RouteStatus
- type RouterShard
- type TLSConfig
- type TLSTerminationType
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 SchemeGroupVersion = unversioned.GroupVersion{Group: "", Version: ""}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Kind ¶ added in v1.1.2
func Kind(kind string) unversioned.GroupKind
Kind takes an unqualified kind and returns back a Group qualified GroupKind
func Resource ¶ added in v1.1.2
func Resource(resource string) unversioned.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
func RouteToSelectableFields ¶ added in v1.0.8
func RouteToSelectableFields(route *Route) fields.Set
RouteToSelectableFields returns a label set that represents the object
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
kapi.ObjectMeta
// Spec is the desired behavior of the route
Spec RouteSpec
// Status describes the current observed state of the route
Status RouteStatus
}
Route encapsulates the inputs needed to connect an alias to endpoints.
func (*Route) IsAnAPIObject ¶
func (*Route) IsAnAPIObject()
type RouteList ¶
type RouteList struct {
unversioned.TypeMeta
unversioned.ListMeta
// Items is a list of routes
Items []Route
}
RouteList is a collection of Routes.
func (*RouteList) IsAnAPIObject ¶
func (*RouteList) IsAnAPIObject()
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
}
RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
type RouteSpec ¶ added in v1.0.6
type RouteSpec struct {
// Host is an alias/DNS that points to the service. Optional
// Must follow DNS952 subdomain conventions.
Host string
// Path that the router watches for, to route traffic for to the service. Optional
Path string
// An object the route points to. Only the Service kind is allowed, and it will
// be defaulted to Service.
To kapi.ObjectReference
// 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
//TLS provides the ability to configure certificates and termination for the route
TLS *TLSConfig
}
RouteSpec describes the desired behavior of a route.
type RouteStatus ¶ added in v1.0.6
type RouteStatus struct {
}
RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.
type RouterShard ¶ added in v0.4.2
type RouterShard struct {
// ShardName uniquely identifies a router shard in the "set" of
// routers used for routing traffic to the services.
ShardName string
// DNSSuffix for the shard ala: shard-1.v3.openshift.com
DNSSuffix string
}
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.
type TLSConfig ¶ added in v0.2.2
type TLSConfig struct {
// Termination indicates termination type.
Termination TLSTerminationType
// Certificate provides certificate contents
Certificate string
// Key provides key file contents
Key string
// CACertificate provides the cert authority certificate contents
CACertificate string
// 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
// InsecureEdgeTerminationPolicy indicates the desired behavior for
// insecure connections to an edge-terminated route:
// disable, allow or redirect
InsecureEdgeTerminationPolicy InsecureEdgeTerminationPolicyType
}
TLSConfig defines config used to secure a route and provide termination
type TLSTerminationType ¶ added in v0.2.2
type TLSTerminationType string
TLSTerminationType dictates where the secure communication will stop TODO: Reconsider this type in v2