api

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Apr 21, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package api is the internal version of the API.

Index

Constants

View Source 
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"
)
View Source 
const FutureGroupName = "route.openshift.io"
View Source 
const GroupName = ""

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_api_Route added in v1.3.0 

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

func DeepCopy_api_RouteIngress added in v1.3.0 

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

func DeepCopy_api_RouteIngressCondition added in v1.3.0 

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

func DeepCopy_api_RouteList added in v1.3.0 

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

func DeepCopy_api_RoutePort added in v1.3.0 

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

func DeepCopy_api_RouteSpec added in v1.3.0 

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

func DeepCopy_api_RouteStatus added in v1.3.0 

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

func DeepCopy_api_RouteTargetReference added in v1.3.0 

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

func DeepCopy_api_RouterShard added in v1.3.0 

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

func DeepCopy_api_TLSConfig added in v1.3.0 

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

func GetDomainForHost added in v1.4.0 

func GetDomainForHost(host string) string

GetDomainForHost returns the domain for the specified host. Note for top level domains, this will return an empty string.

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 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 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 RouteLessThan added in v1.2.0 

func RouteLessThan(route1, route2 *Route) bool

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) GetObjectKind added in v1.1.3 

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

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
	// Name is a name chosen by the router to identify itself; this value is required
	RouterName string
	// Conditions is the state of the route, may be empty.
	Conditions []RouteIngressCondition
	// Wildcard policy is the wildcard policy that was allowed where this route is exposed.
	WildcardPolicy WildcardPolicyType
	// CanonicalHostname is an external host name for the router; this value is optional
	RouterCanonicalHostname string
}

RouteIngress holds information about the places where a route is exposed

type RouteIngressCondition added in v1.1.3 

type RouteIngressCondition struct {
	// Type is the type of the condition.
	// Currently only Ready.
	Type RouteIngressConditionType
	// Status is the status of the condition.
	// Can be True, False, Unknown.
	Status kapi.ConditionStatus
	// (brief) reason for the condition's last transition, and is usually a machine and human
	// readable constant
	Reason string
	// Human readable message indicating details about last transition.
	Message string
	// RFC 3339 date and time at which the object was acknowledged by the router.
	// This may be before the router exposes the route
	LastTransitionTime *unversioned.Time
}

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

func IngressConditionStatus added in v1.1.4 

func IngressConditionStatus(ingress *RouteIngress, t RouteIngressConditionType) (kapi.ConditionStatus, RouteIngressCondition)

IngressConditionStatus returns the first status and condition matching the provided ingress condition type. Conditions prefer the first matching entry and clients are allowed to ignore later conditions of the same type.

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"
	// RouteExtendedValidationFailed means the route configuration failed an extended validation check.
	RouteExtendedValidationFailed RouteIngressConditionType = "ExtendedValidationFailed"
)

These are valid conditions of pod.

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) GetObjectKind added in v1.1.3 

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

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

	// Objects that the route points to. Only the Service kind is allowed, and it will
	// be defaulted to Service.
	To RouteTargetReference

	// Alternate objects that the route may want to point to. Use the 'weight' field to
	// determine which ones of the several get more emphasis
	AlternateBackends []RouteTargetReference

	// 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

	// Wildcard policy if any for the route.
	// Currently only 'Subdomain' or 'None' is allowed.
	WildcardPolicy WildcardPolicyType
}

RouteSpec describes the desired behavior of a route.

type RouteStatus added in v1.0.6 

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
}

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

type RouteTargetReference added in v1.3.0 

type RouteTargetReference struct {
	Kind   string
	Name   string
	Weight *int32
}

RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.

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

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: With 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

Directories

Path Synopsis
Package v1 is the v1 version of the API.
 Package v1 is the v1 version of the API.

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.