generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 526
/
Copy pathindex.html
854 lines (487 loc) · 19 KB
/
index.html
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="lang:clipboard.copy" content="Copy to clipboard">
<meta name="lang:clipboard.copied" content="Copied to clipboard">
<meta name="lang:search.language" content="en">
<meta name="lang:search.pipeline.stopwords" content="True">
<meta name="lang:search.pipeline.trimmer" content="True">
<meta name="lang:search.result.none" content="No matching documents">
<meta name="lang:search.result.one" content="1 matching document">
<meta name="lang:search.result.other" content="# matching documents">
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
<title>Getting started - Kubernetes Gateway API</title>
<link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
<script src="../assets/javascripts/modernizr.268332fc.js"></script>
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
<link rel="stylesheet" href="../assets/fonts/material-icons.css">
</head>
<body dir="ltr">
<svg class="md-svg">
<defs>
</defs>
</svg>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
<a href="#getting-started-with-services-apis" tabindex="1" class="md-skip">
Skip to content
</a>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href=".." title="Kubernetes Gateway API" class="md-header-nav__button md-logo">
<i class="md-icon"></i>
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
<span class="md-header-nav__topic">
Kubernetes Gateway API
</span>
<span class="md-header-nav__topic">
Getting started
</span>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="http://sigs.k8s.io/gateway-api" title="Go to repository" class="md-source" data-md-source="">
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main" role="main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="__drawer">
<a href=".." title="Kubernetes Gateway API" class="md-nav__button md-logo">
<i class="md-icon"></i>
</a>
Kubernetes Gateway API
</label>
<div class="md-nav__source">
<a href="http://sigs.k8s.io/gateway-api" title="Go to repository" class="md-source" data-md-source="">
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
<label class="md-nav__link" for="nav-2">
Concepts
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-2">
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../api-overview/" title="API overview" class="md-nav__link">
API overview
</a>
</li>
<li class="md-nav__item">
<a href="../security-model/" title="Security Model" class="md-nav__link">
Security Model
</a>
</li>
<li class="md-nav__item">
<a href="../guidelines/" title="Implementation Guidelines" class="md-nav__link">
Implementation Guidelines
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
API Types
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-3">
API Types
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../gatewayclass/" title="GatewayClass" class="md-nav__link">
GatewayClass
</a>
</li>
<li class="md-nav__item">
<a href="../gateway/" title="Gateway" class="md-nav__link">
Gateway
</a>
</li>
<li class="md-nav__item">
<a href="../httproute/" title="HTTPRoute" class="md-nav__link">
HTTPRoute
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
<label class="md-nav__link" for="nav-4">
Guides
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../guides/" title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Getting started
</label>
<a href="./" title="Getting started" class="md-nav__link md-nav__link--active">
Getting started
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installing-crds" class="md-nav__link">
Installing CRDs
</a>
</li>
<li class="md-nav__item">
<a href="#install-an-implementation" class="md-nav__link">
Install an implementation
</a>
</li>
<li class="md-nav__item">
<a href="#sample-gateway" class="md-nav__link">
Sample Gateway
</a>
</li>
<li class="md-nav__item">
<a href="#uninstalling-the-crds" class="md-nav__link">
Uninstalling the CRDs
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../simple-gateway/" title="Simple Gateway" class="md-nav__link">
Simple Gateway
</a>
</li>
<li class="md-nav__item">
<a href="../http-routing/" title="HTTP routing" class="md-nav__link">
HTTP routing
</a>
</li>
<li class="md-nav__item">
<a href="../traffic-splitting/" title="HTTP traffic splitting" class="md-nav__link">
HTTP traffic splitting
</a>
</li>
<li class="md-nav__item">
<a href="../multiple-ns/" title="Multiple namespaces and routes" class="md-nav__link">
Multiple namespaces and routes
</a>
</li>
<li class="md-nav__item">
<a href="../tls/" title="TLS" class="md-nav__link">
TLS
</a>
</li>
<li class="md-nav__item">
<a href="../tcp/" title="TCP routing" class="md-nav__link">
TCP routing
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
References
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-5">
References
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../spec/" title="API specification" class="md-nav__link">
API specification
</a>
</li>
<li class="md-nav__item">
<a href="../releases/" title="Releases" class="md-nav__link">
Releases
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
<label class="md-nav__link" for="nav-6">
Contributing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-6">
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../devguide/" title="Developer guide" class="md-nav__link">
Developer guide
</a>
</li>
<li class="md-nav__item">
<a href="../enhancement-requests/" title="Enhancement requests" class="md-nav__link">
Enhancement requests
</a>
</li>
<li class="md-nav__item">
<a href="../community/" title="Community" class="md-nav__link">
Community
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../faq/" title="FAQ" class="md-nav__link">
FAQ
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installing-crds" class="md-nav__link">
Installing CRDs
</a>
</li>
<li class="md-nav__item">
<a href="#install-an-implementation" class="md-nav__link">
Install an implementation
</a>
</li>
<li class="md-nav__item">
<a href="#sample-gateway" class="md-nav__link">
Sample Gateway
</a>
</li>
<li class="md-nav__item">
<a href="#uninstalling-the-crds" class="md-nav__link">
Uninstalling the CRDs
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<h1 id="getting-started-with-services-apis">Getting started with Services APIs</h1>
<h2 id="installing-crds">Installing CRDs</h2>
<p>This project provides a collection of Custom Resource Definitions (CRDs) that can
be installed into any Kubernetes (>= 1.16) cluster.</p>
<p>To install the CRDs, please execute:</p>
<pre><code>kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.1.0" \
| kubectl apply -f -
</code></pre>
<h2 id="install-an-implementation">Install an implementation</h2>
<p>Multiple projects implement the APIs defined by this project.
You will need to either install an implementation or verify that one is already
setup for your cluster.</p>
<h2 id="sample-gateway">Sample Gateway</h2>
<p>Once you have the CRDs and an implementation installed, you are ready to
use Gateway API.</p>
<p>In this example, we are installing three resources:</p>
<ul>
<li>An <code>acme-lb</code> GatewayClass which is being managed by a <code>acme.io/gateway-controller</code>
controller running in the cluster. Typically, a GatewayClass is provided by
the implementation and must be installed in the cluster.</li>
<li>
<p>A Gateway which is of type <code>acme-lb</code>:</p>
<ul>
<li>This gateway has a single HTTP listener on port 80 which selects HTTPRoutes
from all namespaces which have the label <code>app: foo</code> on them.</li>
</ul>
</li>
<li>
<p>Finally, we have an HTTPRoute resource which is attached to the above Gateway
and has two rules:</p>
<ul>
<li>All requests with path beginning with <code>/bar</code> are forwarded to my-service1
Kubernetes Service.</li>
<li>All requests with path beginning with <code>/some/thing</code> AND have an HTTP header
<code>magic: foo</code> are forwarded to my-service2 Kubernetes Service.</li>
</ul>
</li>
</ul>
<p>With this configuration, you now have a Gateway resource which is forwarding
traffic to two Kubernetes Services based on HTTP request metadata.</p>
<pre><code>kind: GatewayClass
apiVersion: networking.x-k8s.io/v1alpha1
metadata:
name: acme-lb
spec:
controller: acme.io/gateway-controller
parametersRef:
name: acme-lb
group: acme.io
kind: Parameters
---
kind: Gateway
apiVersion: networking.x-k8s.io/v1alpha1
metadata:
name: my-gateway
spec:
gatewayClassName: acme-lb
listeners: # Use GatewayClass defaults for listener definition.
- protocol: HTTP
port: 80
routes:
kind: HTTPRoute
selector:
matchLabels:
app: foo
namespaces:
from: "Same"
---
kind: HTTPRoute
apiVersion: networking.x-k8s.io/v1alpha1
metadata:
name: http-app-1
labels:
app: foo
spec:
hostnames:
- "foo.com"
rules:
- matches:
- path:
type: Prefix
value: /bar
forwardTo:
- serviceName: my-service1
port: 8080
- matches:
- headers:
type: Exact
values:
magic: foo
path:
type: Prefix
value: /some/thing
forwardTo:
- serviceName: my-service2
port: 8080
</code></pre>
<p>For more advanced examples, please read the other <a href="../guides/">guides</a>.</p>
<h2 id="uninstalling-the-crds">Uninstalling the CRDs</h2>
<p>To uninstall the CRDs and all resources created with them, run the following
command. Note that this will remove all GatewayClass and Gateway resources in
your cluster. If you have been using these resources for any other purpose do
not uninstall these CRDs.</p>
<pre><code>kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.1.0" \
| kubectl delete -f -
</code></pre>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../guides/" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div>
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Introduction
</span>
</div>
</a>
<a href="../simple-gateway/" title="Simple Gateway" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Simple Gateway
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
powered by
<a href="https://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">
Material for MkDocs</a>
</div>
</div>
</div>
</footer>
</div>
<script src="../assets/javascripts/application.808e90bb.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
</body>
</html>