v1

Documentation

Index

• Constants
• Variables
• func AddToScheme(scheme *runtime.Scheme)
• type InsecureEdgeTerminationPolicyType
• type Route
  • func (obj *Route) GetObjectKind() unversioned.ObjectKind
• type RouteIngress
• type RouteIngressCondition
• type RouteIngressConditionType
• type RouteList
  • func (obj *RouteList) GetObjectKind() unversioned.ObjectKind
• type RoutePort
• type RouteSpec
• type RouteStatus
• type RouterShard
• type TLSConfig
• type TLSTerminationType

Constants

const GroupName = ""

Variables

var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func AddToScheme

func AddToScheme(scheme *runtime.Scheme)

Types

type InsecureEdgeTerminationPolicyType

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's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the desired state of the route
	Spec RouteSpec `json:"spec" description:"desired state of the route"`
	// Status is the current state of the route
	Status RouteStatus `json:"status" description:"current state of the route"`
}

Route encapsulates the inputs needed to connect an alias to endpoints.

func (*Route) GetObjectKind

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

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" description:"the host name this route is exposed to by the specified router"`
	// Name is a name chosen by the router to identify itself; this value is required
	RouterName string `json:"routerName,omitempty" description:"the name of the router exposing this route"`
	// Conditions is the state of the route, may be empty.
	Conditions []RouteIngressCondition `json:"conditions,omitempty" description:"the conditions that apply to this router" patchStrategy:"merge" patchMergeKey:"type"`
}

RouteIngress holds information about the places where a route is exposed

type RouteIngressCondition

type RouteIngressCondition struct {
	// Type is the type of the condition.
	// Currently only Ready.
	Type RouteIngressConditionType `json:"type" description:"the type of the condition"`
	// Status is the status of the condition.
	// Can be True, False, Unknown.
	Status kapi.ConditionStatus `json:"status" description:"status is the status of the condition; True, False, or Unknown"`
	// (brief) reason for the condition's last transition, and is usually a machine and human
	// readable constant
	Reason string `json:"reason,omitempty" description:"brief reason for the condition's last transition, machine readable constant"`
	// Human readable message indicating details about last transition.
	Message string `json:"message,omitempty" description:"human readable message indicating details about this condition"`
	// RFC 3339 date and time when this condition last transitioned
	LastTransitionTime *unversioned.Time `json:"lastTransitionTime,omitempty" description:"the last time at which this condition transitioned to the current status"`
}

RouteIngressCondition contains details for the current condition of this pod. TODO: add LastTransitionTime, Reason, Message to match NodeCondition api.

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 {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`

	// Items is a list of routes
	Items []Route `json:"items" description:"list of routes"`
}

RouteList is a collection of Routes.

func (*RouteList) GetObjectKind

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

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 `` /* 170-byte string literal not displayed */
}

RoutePort defines a port mapping from a router to an endpoint in the service endpoints.

type RouteSpec

type RouteSpec struct {

	// Host is an alias/DNS that points to the service. Optional
	// Must follow DNS952 subdomain conventions.
	Host string `json:"host" description:"optional: alias/dns that points to the service, must follow DNS 952 subdomain conventions"`
	// Path that the router watches for, to route traffic for to the service. Optional
	Path string `json:"path,omitempty" description:"optional: path that the router watches to route traffic to the service"`

	// To is an object the route points to. Only the Service kind is allowed, and it will
	// be defaulted to Service.
	To kapi.ObjectReference `` /* 128-byte string literal not displayed */

	// 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 `` /* 183-byte string literal not displayed */

	// TLS provides the ability to configure certificates and termination for the route
	TLS *TLSConfig `json:"tls,omitempty" description:"provides the ability to configure certificates and termination for the route"`
}

RouteSpec describes the route the user wishes to exist.

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" description:"traffic reaches this route via these ingress paths"`
}

RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.

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 `` /* 128-byte string literal not displayed */

	// DNSSuffix for the shard ala: shard-1.v3.openshift.com
	DNSSuffix string `json:"dnsSuffix" description:"DNS suffix for the shard (i.e. shard-1.v3.openshift.com)"`
}

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.

type TLSConfig

type TLSConfig struct {
	// Termination indicates termination type.
	Termination TLSTerminationType `json:"termination" description:"indicates termination type"`

	// Certificate provides certificate contents
	Certificate string `json:"certificate,omitempty" description:"provides certificate contents"`

	// Key provides key file contents
	Key string `json:"key,omitempty" description:"provides key file contents"`

	// CACertificate provides the cert authority certificate contents
	CACertificate string `json:"caCertificate,omitempty" description:"provides the cert authority certificate contents"`

	// 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 `` /* 264-byte string literal not displayed */

	// InsecureEdgeTerminationPolicy indicates the desired behavior for
	// insecure connections to an edge-terminated route:
	//   disable, allow or redirect
	InsecureEdgeTerminationPolicy InsecureEdgeTerminationPolicyType `` /* 195-byte string literal not displayed */
}

TLSConfig defines config used to secure a route and provide termination

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