Skip to content

Commit a254b69

Browse files
hbagdihbagdi
committed
docs: add guide on using TCP route
1 parent 32572d4 commit a254b69

File tree

24 files changed

+1002
-9
lines changed

24 files changed

+1002
-9
lines changed

‎docs-src/tcp.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Service APIs is designed to work with multiple protocols.
2+
[TCPRoute](spec/#networking.x-k8s.io/v1alpha1.TCPRoute) is one such route which
3+
allows for managing TCP traffic.
4+
5+
In this example, we have one Gateway resource and two TCPRoute resources that
6+
distribute the traffic with the following rules:
7+
8+
- All TCP streams on port 8080 of the Gateway are forwarded to port 6000 of
9+
`my-foo-service` Kubernetes Service.
10+
- All TCP streams on port 8090 of the Gateway are forwarded to port 6000 of
11+
`my-bar-service` Kubernetes Service.
12+
13+
Please note the following:
14+
15+
- The `protocol` of listeners on the Gateway is `TCP`.
16+
- Each listener selects exactly one TCPRoute. This is important since the routing
17+
decision is performed based on destination port only. If more metadata is used
18+
for routing decisions, then one may associate multiple TCPRoutes to a single
19+
Gateway listener. Implementations can support such use-cases by adding a custom
20+
resource to specify advanced routing properties and then referencing it in
21+
`spec.rules[].matches[].extensionRef`. Conflicts due to routing colisions should
22+
be resolved as per the [conflict resolution](guidelines.md#conflicts) guidelines.
23+
24+
```
25+
{% include 'basic-tcp.yaml' %}
26+
```

‎docs/404.html

+12
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,18 @@
388388
</li>
389389

390390

391+
392+
393+
394+
395+
396+
<li class="md-nav__item">
397+
<a href="/tcp/" title="TCP routing" class="md-nav__link">
398+
TCP routing
399+
</a>
400+
</li>
401+
402+
391403
</ul>
392404
</nav>
393405
</li>

‎docs/api-overview/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,18 @@
501501
</li>
502502

503503

504+
505+
506+
507+
508+
509+
<li class="md-nav__item">
510+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
511+
TCP routing
512+
</a>
513+
</li>
514+
515+
504516
</ul>
505517
</nav>
506518
</li>

‎docs/community/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,18 @@
392392
</li>
393393

394394

395+
396+
397+
398+
399+
400+
<li class="md-nav__item">
401+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
402+
TCP routing
403+
</a>
404+
</li>
405+
406+
395407
</ul>
396408
</nav>
397409
</li>

‎docs/devguide/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,18 @@
392392
</li>
393393

394394

395+
396+
397+
398+
399+
400+
<li class="md-nav__item">
401+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
402+
TCP routing
403+
</a>
404+
</li>
405+
406+
395407
</ul>
396408
</nav>
397409
</li>

‎docs/enhancement-requests/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,18 @@
392392
</li>
393393

394394

395+
396+
397+
398+
399+
400+
<li class="md-nav__item">
401+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
402+
TCP routing
403+
</a>
404+
</li>
405+
406+
395407
</ul>
396408
</nav>
397409
</li>

‎docs/faq/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,18 @@
392392
</li>
393393

394394

395+
396+
397+
398+
399+
400+
<li class="md-nav__item">
401+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
402+
TCP routing
403+
</a>
404+
</li>
405+
406+
395407
</ul>
396408
</nav>
397409
</li>

‎docs/gateway/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,18 @@
439439
</li>
440440

441441

442+
443+
444+
445+
446+
447+
<li class="md-nav__item">
448+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
449+
TCP routing
450+
</a>
451+
</li>
452+
453+
442454
</ul>
443455
</nav>
444456
</li>

‎docs/gatewayclass/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,18 @@
446446
</li>
447447

448448

449+
450+
451+
452+
453+
454+
<li class="md-nav__item">
455+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
456+
TCP routing
457+
</a>
458+
</li>
459+
460+
449461
</ul>
450462
</nav>
451463
</li>

‎docs/getting-started/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,18 @@
453453
</li>
454454

455455

456+
457+
458+
459+
460+
461+
<li class="md-nav__item">
462+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
463+
TCP routing
464+
</a>
465+
</li>
466+
467+
456468
</ul>
457469
</nav>
458470
</li>

‎docs/guidelines/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,18 @@
459459
</li>
460460

461461

462+
463+
464+
465+
466+
467+
<li class="md-nav__item">
468+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
469+
TCP routing
470+
</a>
471+
</li>
472+
473+
462474
</ul>
463475
</nav>
464476
</li>

‎docs/guides/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,18 @@
403403
</li>
404404

405405

406+
407+
408+
409+
410+
411+
<li class="md-nav__item">
412+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
413+
TCP routing
414+
</a>
415+
</li>
416+
417+
406418
</ul>
407419
</nav>
408420
</li>

‎docs/http-routing/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,18 @@
403403
</li>
404404

405405

406+
407+
408+
409+
410+
411+
<li class="md-nav__item">
412+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
413+
TCP routing
414+
</a>
415+
</li>
416+
417+
406418
</ul>
407419
</nav>
408420
</li>

‎docs/httproute/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,18 @@
526526
</li>
527527

528528

529+
530+
531+
532+
533+
534+
<li class="md-nav__item">
535+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
536+
TCP routing
537+
</a>
538+
</li>
539+
540+
529541
</ul>
530542
</nav>
531543
</li>

‎docs/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,18 @@
444444
</li>
445445

446446

447+
448+
449+
450+
451+
452+
<li class="md-nav__item">
453+
<a href="tcp/" title="TCP routing" class="md-nav__link">
454+
TCP routing
455+
</a>
456+
</li>
457+
458+
447459
</ul>
448460
</nav>
449461
</li>

‎docs/multiple-ns/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,18 @@
403403
</li>
404404

405405

406+
407+
408+
409+
410+
411+
<li class="md-nav__item">
412+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
413+
TCP routing
414+
</a>
415+
</li>
416+
417+
406418
</ul>
407419
</nav>
408420
</li>

‎docs/releases/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,18 @@
392392
</li>
393393

394394

395+
396+
397+
398+
399+
400+
<li class="md-nav__item">
401+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
402+
TCP routing
403+
</a>
404+
</li>
405+
406+
395407
</ul>
396408
</nav>
397409
</li>

‎docs/security-model/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,18 @@
548548
</li>
549549

550550

551+
552+
553+
554+
555+
556+
<li class="md-nav__item">
557+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
558+
TCP routing
559+
</a>
560+
</li>
561+
562+
551563
</ul>
552564
</nav>
553565
</li>

‎docs/simple-gateway/index.html

+12
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,18 @@
403403
</li>
404404

405405

406+
407+
408+
409+
410+
411+
<li class="md-nav__item">
412+
<a href="../tcp/" title="TCP routing" class="md-nav__link">
413+
TCP routing
414+
</a>
415+
</li>
416+
417+
406418
</ul>
407419
</nav>
408420
</li>

0 commit comments

Comments
 (0)