forked from openshift/origin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
108 lines (86 loc) · 5.04 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
package v1
import (
kapi "github.com/GoogleCloudPlatform/kubernetes/pkg/api/v1"
)
// Route encapsulates the inputs needed to connect an alias to endpoints.
type Route struct {
kapi.TypeMeta `json:",inline"`
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"`
}
// RouteList is a collection of Routes.
type RouteList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
// Items is a list of routes
Items []Route `json:"items" description:"list of routes"`
}
// RouteSpec describes the route the user wishes to exist.
type RouteSpec struct {
// Ports are the ports that the user wishes to expose.
//Ports []RoutePort `json:"ports,omitempty"`
// Host is an alias/DNS that points to the service. Optional
// Can be host or host:port
// host and port are combined to follow the net/url URL struct
Host string `json:"host" description:"optional: alias/dns that points to the service, can be host or host:port"`
// 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 `json:"to" description:"an object the route points to. only the service kind is allowed, and it will be defaulted to a service."`
// 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"`
}
/*
type RoutePort struct {
// Name is the name of the port that is used by the router. Routers may require
// this field be set. Routers may decide which names to expose.
Name string `json:"name"`
// TargetName is the name of the target endpoint port. Optional
TargetName string `json:"targetName"`
// TargetPort is the value of the target endpoint port to expose. May be omitted if
// name is set, and vice versa. Optional
TargetPort util.IntOrString `json:"targetPort"`
}
*/
// RouteStatus describes the current state of this route.
type RouteStatus struct{}
// 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 RouterShard struct {
// ShardName uniquely identifies a router shard in the "set" of
// routers used for routing traffic to the services.
ShardName string `json:"shardName" description:"uniquely identifies a router shard in the set of routers used for routing traffic to the services"`
// 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)"`
}
// TLSConfig defines config used to secure a route and provide termination
type TLSConfig struct {
// Termination indicates termination type. If termination type is not set, any termination config will be ignored
Termination TLSTerminationType `json:"termination,omitempty" description:"indicates termination type. if not set, any termination config will be ignored"`
// 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 `json:"destinationCACertificate,omitempty" description:"provides the contents of the ca certificate of the final destination. When using re-encrypt termination this file should be provided in order to have routers use it for health checks on the secure connection"`
}
// TLSTerminationType dictates where the secure communication will stop
type TLSTerminationType string
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"
)