From f940e783dad2879c8f483d8ce59aca8877429010 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Sat, 3 Aug 2024 19:15:13 +0530 Subject: [PATCH 1/3] Add introduction and glossary for gateway API --- archive/v0.8/index.html | 170 +++++++++--------- .../concepts/About Gateway API types/index.md | 62 +++++++ .../glossary/gateway-api-glossary.md | 31 ++++ 3 files changed, 178 insertions(+), 85 deletions(-) create mode 100644 content/en/docs/concepts/About Gateway API types/index.md create mode 100644 content/en/docs/reference/glossary/gateway-api-glossary.md diff --git a/archive/v0.8/index.html b/archive/v0.8/index.html index 3226ddd213d4d..d408a1826b5e3 100644 --- a/archive/v0.8/index.html +++ b/archive/v0.8/index.html @@ -571,13 +571,13 @@

Ready to get started?

istio-users@ - - - - + + + + @@ -586,20 +586,20 @@

Ready to get started?

twitter - - - + + + @@ -668,13 +668,13 @@

Ready to get started?

istio-dev@ - - - - + + + + @@ -683,23 +683,23 @@

Ready to get started?

github - - - + + + @@ -708,12 +708,12 @@

Ready to get started?

drive - - - + + + @@ -722,29 +722,29 @@

Ready to get started?

working groups - - - - - - - - - - - - - - + + + + + + + + + + + + + + @@ -753,17 +753,17 @@

Ready to get started?

slack - - - + + + diff --git a/content/en/docs/concepts/About Gateway API types/index.md b/content/en/docs/concepts/About Gateway API types/index.md new file mode 100644 index 0000000000000..8dc15ea15a199 --- /dev/null +++ b/content/en/docs/concepts/About Gateway API types/index.md @@ -0,0 +1,62 @@ +--- +title: Introduction to Using Gateway API for Istio Users +description: Learn how to use the Gateway API with Istio. +weight: 50 +--- + +## Overview + +The Gateway API is a set of resources designed to configure networking in Kubernetes clusters. It provides a more expressive and extensible way to define how traffic should be routed within a cluster. For Istio users, understanding the Gateway API is essential for leveraging its full potential in managing traffic flows. + +## Key Concepts + +1. **Gateway**: A Gateway describes a load balancer operating at the edge of the mesh, handling incoming or outgoing HTTP/TCP connections. It configures a set of listeners for inbound or outbound traffic. + +2. **HTTPRoute**: An HTTPRoute defines how HTTP traffic should be routed. It includes rules for matching requests and forwarding them to specific services. + +3. **TCPRoute**: Similar to HTTPRoute, but for TCP traffic. It defines rules for matching TCP connections and forwarding them. + +4. **parentRefs**: This field specifies the parent resources that a route is attached to. For example, an HTTPRoute might specify a Gateway as its parent. + +5. **targetRefs**: This field specifies the target resources that a route should forward traffic to. For example, an HTTPRoute might specify a Kubernetes Service as its target. + +## Example Configuration + +Below is an example configuration demonstrating how to use the Gateway API with Istio: + +```yaml +apiVersion: gateway.networking.k8s.io/v1alpha2 +kind: Gateway +metadata: + name: my-gateway + namespace: istio-system +spec: + gatewayClassName: istio + listeners: + - name: http + protocol: HTTP + port: 80 + routes: + kind: HTTPRoute + name: my-route +--- +apiVersion: gateway.networking.k8s.io/v1alpha2 +kind: HTTPRoute +metadata: + name: my-route + namespace: default +spec: + parentRefs: + - name: my-gateway + namespace: istio-system + rules: + - matches: + - path: + type: Prefix + value: /my-service + forwardTo: + - targetRef: + kind: Service + name: my-service + namespace: default + port: 80 diff --git a/content/en/docs/reference/glossary/gateway-api-glossary.md b/content/en/docs/reference/glossary/gateway-api-glossary.md new file mode 100644 index 0000000000000..71bd86f0b9af2 --- /dev/null +++ b/content/en/docs/reference/glossary/gateway-api-glossary.md @@ -0,0 +1,31 @@ + +#### Adding Glossary Entries + +You should also add glossary entries for the key concepts. Create a new file named `gateway-api-glossary.md` in the `content/en/docs/reference/glossary` directory with the following content: + +```markdown +--- +title: Gateway API Glossary +description: Glossary of terms related to the Gateway API. +weight: 50 +--- + +### Gateway + +A Gateway describes a load balancer operating at the edge of the mesh, handling incoming or outgoing HTTP/TCP connections. It configures a set of listeners for inbound or outbound traffic. + +### HTTPRoute + +An HTTPRoute defines how HTTP traffic should be routed. It includes rules for matching requests and forwarding them to specific services. + +### TCPRoute + +Similar to HTTPRoute, but for TCP traffic. It defines rules for matching TCP connections and forwarding them. + +### parentRefs + +This field specifies the parent resources that a route is attached to. For example, an HTTPRoute might specify a Gateway as its parent. + +### targetRefs + +This field specifies the target resources that a route should forward traffic to. For example, an HTTPRoute might specify a Kubernetes Service as its target. From 7f1d255e27c440bf156544c22477684cd1f49390 Mon Sep 17 00:00:00 2001 From: Ayush Gupta <114745463+Ayush9026@users.noreply.github.com> Date: Sat, 3 Aug 2024 19:30:59 +0530 Subject: [PATCH 2/3] Delete archive/v0.8/index.html The file archive/v0.8/index.html was deleted because changes were made to it by mistake. This commit removes the file to correct the unintended modifications and maintain the repository's intended state. --- archive/v0.8/index.html | 794 ---------------------------------------- 1 file changed, 794 deletions(-) delete mode 100644 archive/v0.8/index.html diff --git a/archive/v0.8/index.html b/archive/v0.8/index.html deleted file mode 100644 index d408a1826b5e3..0000000000000 --- a/archive/v0.8/index.html +++ /dev/null @@ -1,794 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - Istioldie 0.8 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - - - -
-
-
-

Istio Archive 0.8

- -

An open platform to connect, manage, and secure microservices

- - -
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

Intelligent Routing and Load Balancing

-

- Control traffic between services with dynamic route configuration, - conduct A/B tests, release canaries, and gradually upgrade versions using red/black deployments. - Learn more... -

-
-
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

Resilience Across Languages and Platforms

-

- Increase reliability by shielding applications from flaky networks and cascading failures in adverse conditions. - Learn more... -

-
-
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

Fleet-Wide Policy Enforcement

-

- Apply organizational policies to the interaction between services, ensure access policies are enforced and resources are fairly distributed - among consumers. - Learn more... -

-
-
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

In-Depth Telemetry

-

- Understand the dependencies between services, the nature and flow of traffic between them, and quickly identify issues with distributed tracing. - Learn more... -

-
-
-
- -
-
-
-

Want to learn more?

-

Get started by learning Istio concepts and running through our BookInfo sample.

- GET STARTED -
- -
-

Ready to get started?

-

Download the latest bits.

- DOWNLOAD -
-
-
- - -
- - - - - -
- -
- - - - - - - - - - - From 2c06280da9921a467c86ef45183a5af0870c4466 Mon Sep 17 00:00:00 2001 From: Ayush Gupta <114745463+Ayush9026@users.noreply.github.com> Date: Mon, 5 Aug 2024 09:54:15 +0530 Subject: [PATCH 3/3] Update gateway-api-glossary.md --- content/en/docs/reference/glossary/gateway-api-glossary.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/content/en/docs/reference/glossary/gateway-api-glossary.md b/content/en/docs/reference/glossary/gateway-api-glossary.md index 71bd86f0b9af2..0b9ec356ca9dc 100644 --- a/content/en/docs/reference/glossary/gateway-api-glossary.md +++ b/content/en/docs/reference/glossary/gateway-api-glossary.md @@ -1,9 +1,4 @@ -#### Adding Glossary Entries - -You should also add glossary entries for the key concepts. Create a new file named `gateway-api-glossary.md` in the `content/en/docs/reference/glossary` directory with the following content: - -```markdown --- title: Gateway API Glossary description: Glossary of terms related to the Gateway API.