-
Notifications
You must be signed in to change notification settings - Fork 5
/
zalando.org_routegroups.yaml
270 lines (270 loc) · 12.3 KB
/
zalando.org_routegroups.yaml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.14.0
name: routegroups.zalando.org
spec:
group: zalando.org
names:
categories:
- all
kind: RouteGroup
listKind: RouteGroupList
plural: routegroups
shortNames:
- rg
- rgs
singular: routegroup
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Hosts defined for the RouteGroup
jsonPath: .spec.hosts
name: Hosts
type: string
- description: Address of the Load Balancer for the RouteGroup
jsonPath: .status.loadBalancer
name: Address
type: string
name: v1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
properties:
backends:
description: List of backends that can be referenced in the routes
items:
properties:
address:
description: Address is required for type `network`
type: string
algorithm:
description: |-
Algorithm is required for type `lb`.
`roundRobin` - backend is chosen by the round robin algorithm, starting with a random selected backend to spread across all backends from the beginning.
`random` - backend is chosen at random.
`consistentHash` - backend is chosen by [consistent hashing](https://en.wikipedia.org/wiki/Consistent_hashing) algorithm based on the request key. The request key is derived from `X-Forwarded-For` header or request remote IP address as the fallback. Use [`consistentHashKey`](filters.md#consistenthashkey) filter to set the request key. Use [`consistentHashBalanceFactor`](filters.md#consistenthashbalancefactor) to prevent popular keys from overloading a single backend endpoint.
`powerOfRandomNChoices` - backend is chosen by selecting N random endpoints and picking the one with least outstanding requests from them (see http://www.eecs.harvard.edu/~michaelm/postscripts/handbook2001.pdf).
enum:
- roundRobin
- random
- consistentHash
- powerOfRandomNChoices
type: string
endpoints:
description: Endpoints is required for type `lb`
items:
type: string
minItems: 1
type: array
name:
description: Name is the BackendName that can be referenced
as RouteGroupBackendReference
type: string
serviceName:
description: ServiceName is required for type `service`
type: string
servicePort:
description: ServicePort is required for type `service`
type: integer
type:
description: |-
Type of the backend.
`service`- resolve Kubernetes service to the available Endpoints belonging to the Service, and generate load balanced routes using them.
`shunt` - reply directly from the proxy itself. This can be used to shortcut, for example have a default that replies with 404 or use skipper as a backend serving static content in demos.
`loopback` - lookup again the routing table to a better matching route after processing the current route. Like this you can add some headers or change the request path for some specific matching requests.
`dynamic` - use the backend provided by filters. This allows skipper as library users to do proxy calls to a certain target from their own implementation dynamically looked up by their filters.
`lb` - balance the load across multiple network endpoints using specified algorithm. If algorithm is not specified it will use the default algorithm set by Skipper at start.
`network` - use arbitrary HTTP or HTTPS URL.
enum:
- service
- shunt
- loopback
- dynamic
- lb
- network
type: string
required:
- name
- type
type: object
type: array
defaultBackends:
description: |-
DefaultBackends is a list of default backends defined if no explicit
backend is defined for a route
items:
properties:
backendName:
description: BackendName references backend by name
type: string
weight:
description: |-
Weight defines a portion of traffic for the referenced backend.
It equals to weight divided by the sum of all backend weights.
When all references have zero (or unspecified) weight then traffic is split equally between them.
minimum: 0
type: integer
required:
- backendName
type: object
type: array
hosts:
description: List of hostnames for the RouteGroup
items:
maxLength: 255
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
minItems: 1
type: array
routes:
description: Routes describe how a matching HTTP request is handled
and where it is forwarded to
items:
properties:
backends:
description: |-
RouteGroupBackendReference specifies the list of backendReference that should
be applied to override the defaultBackends
items:
properties:
backendName:
description: BackendName references backend by name
type: string
weight:
description: |-
Weight defines a portion of traffic for the referenced backend.
It equals to weight divided by the sum of all backend weights.
When all references have zero (or unspecified) weight then traffic is split equally between them.
minimum: 0
type: integer
required:
- backendName
type: object
type: array
filters:
description: Filters specifies the list of filters applied to
the routeSpec
items:
type: string
type: array
methods:
description: Methods defines valid HTTP methods for the specified
routeSpec
items:
description: HTTPMethod is a valid HTTP method in uppercase.
enum:
- GET
- HEAD
- POST
- PUT
- PATCH
- DELETE
- CONNECT
- OPTIONS
- TRACE
type: string
type: array
path:
description: Path specifies Path predicate, only one of Path
or PathSubtree is allowed
type: string
pathRegexp:
description: PathRegexp can be added additionally
type: string
pathSubtree:
description: PathSubtree specifies PathSubtree predicate, only
one of Path or PathSubtree is allowed
type: string
predicates:
description: Predicates specifies the list of predicates applied
to the routeSpec
items:
type: string
type: array
type: object
minItems: 1
type: array
tls:
description: |-
TLS defines which Kubernetes secret will be used to terminate the connection
based on the matching hostnames
items:
properties:
hosts:
description: |-
TLS hosts specify the list of hosts included in the TLS secret.
The values in this list must match the host name(s) used for
the RouteGroup in order to terminate TLS for the host(s).
items:
maxLength: 255
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?([.][a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
minItems: 1
type: array
secretName:
description: |-
SecretName is the name of the secret used to terminate TLS traffic.
Secret should reside in the same namespace as the RouteGroup.
type: string
required:
- hosts
- secretName
type: object
type: array
required:
- backends
type: object
status:
properties:
loadBalancer:
description: |-
LoadBalancer is similar to ingress status, such that
external-dns has the same style as in ingress
properties:
routegroup:
description: RouteGroup is similar to Ingress in ingress status.LoadBalancer.
items:
properties:
hostname:
description: Hostname is the hostname of the load balancer
and is empty if IP is set
type: string
ip:
description: IP is the IP address of the load balancer and
is empty if Hostname is set
type: string
type: object
type: array
required:
- routegroup
type: object
required:
- loadBalancer
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}