Skip to content

Commit 3ab14da

Browse files
authored
docs: update readme (#11009)
1 parent 69eccaa commit 3ab14da

File tree

1 file changed

+21
-30
lines changed

1 file changed

+21
-30
lines changed

README.md

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,46 +9,37 @@
99
</h1>
1010

1111
## About kgateway
12-
Kgateway is a feature-rich, fast, and flexible Kubernetes-native ingress controller and next-generation API gateway that is built on top of [Envoy proxy](https://www.envoyproxy.io) and the Kubernetes Gateway API. It excels in function-level routing, supports legacy apps, microservices and serverless, offers robust discovery capabilities, integrates seamlessly with open-source projects, and is designed to support hybrid applications with various technologies, architectures, protocols, and clouds.
1312

14-
Please see [the plan](https://github.com/kgateway-dev/kgateway/issues/10363) for more information and current status.
13+
Kgateway is:
1514

16-
[**Installation**](https://kgateway.dev/docs/quickstart/) &nbsp; |
17-
&nbsp; [**Documentation**](https://kgateway.dev/docs) &nbsp; |
18-
&nbsp; [**Blog**](https://kgateway.dev/blog/) &nbsp; |
19-
&nbsp; [**Slack invite**](https://slack.cncf.io/) &nbsp; |
20-
&nbsp; [**Slack channel**](https://cloud-native.slack.com/archives/C080D3PJMS4)
15+
* **An ingress/edge router for Kubernetes**: Powered by [Envoy](https://www.envoyproxy.io) and programmed with the [Gateway API](https://gateway-api.sigs.k8s.io/), kgateway is a world-leading Cloud Native ingress.
16+
* **An advanced API gateway**: Aggregate web APIs and apply key functions like authentication, authorization and rate limiting in one place
17+
* **A better waypoint proxy for [ambient mesh](https://ambientmesh.io/)**: Use the same stack for east-west management as you do for north-south.
18+
* **An AI gateway for securing LLMs**: Protect applications, models, and data from inappropriate access or use, whether you're producing or consuming. Manage traffic to LLM providers, and enrich prompts at a system level.
19+
* **A migration engine for hybrid apps**: Route to backends implemented as microservices, serverless functions or legacy apps. This can help you gradually migrate from legacy code to microservices and serverless, add new functionalities using cloud-native technologies while maintaining a legacy codebase or allow different teams in an organization to choose different architectures.
2120

22-
<BR><center><img align="center" src="https://raw.githubusercontent.com/kgateway-dev/kgateway.dev/main/assets/img/component-architecture.svg" alt="kgateway Architecture" width="700"></center>
21+
Kgateway is feature-rich, fast, and flexible. It excels in function-level routing, supports legacy apps, microservices and serverless, offers robust discovery capabilities, integrates seamlessly with open-source projects, and is designed to support hybrid applications with various technologies, architectures, protocols, and clouds.
2322

24-
### Using kgateway
25-
- **Kubernetes Gateway API**: Kgateway is a feature-rich ingress controller, built on top of the Envoy Proxy and fully conformant with the Kubernetes Gateway API.
26-
- **Next-generation API gateway**: Kgateway provides a long list of API gateway features including rate limiting, circuit breaking, retries, caching, transformation, service-mesh integration, security, external authentication and authorization.
27-
- **Hybrid apps**: Kgateway creates applications that route to backends implemented as microservices, serverless functions and legacy apps. This feature can help users to
28-
* Gradually migrate from their legacy code to microservices and serverless.
29-
* Add new functionalities using cloud-native technologies while maintaining their legacy codebase.
30-
* Allow different teams in an organization choose different architectures.
23+
The project was previously known as Gloo, and has been [production-ready since 2019](https://www.solo.io/blog/announcing-gloo-1-0-a-production-ready-envoy-based-api-gateway). Please see [the migration plan](https://github.com/kgateway-dev/kgateway/issues/10363) for more information and the current status of the change from Gloo to kgateway.
3124

32-
<!---
33-
PLEASE DO NOT RENAME THIS SECTION
34-
This header is used as an anchor in our CNCF Donation Issue
35-
-->
36-
### What makes kgateway unique
37-
- **Function-level routing allows integration of legacy applications, microservices and serverless**: Kgateway can route requests directly to functions. Request to Function can be a serverless function call (e.g. Lambda, Google Cloud Function, OpenFaaS Function, etc.), an API call on a microservice or a legacy service (e.g. a REST API call, OpenAPI operation, XML/SOAP request etc.), or publishing to a message queue (e.g. NATS, AMQP, etc.). This unique ability is what makes kgateway the only API gateway that supports hybrid apps as well as the only one that does not tie the user to a specific paradigm.
38-
- **Kgateway incorporates vetted open-source projects to provide broad functionality**: Kgateway supports high-quality features by integrating with top open-source projects, including gRPC, OpenTracing, NATS and more. Kgateway's architecture allows rapid integration of future popular open-source projects as they emerge.
39-
- **Full automated discovery lets users move fast**: Upon launch, kgateway creates a catalog of all available destinations and continuously keeps them up to date. This takes the responsibility for 'bookkeeping' away from the developers and guarantees that new features become available as soon as they are ready. Kgateway discovers across IaaS, PaaS and FaaS providers as well as Swagger, and gRPC.
40-
41-
42-
## Next steps
43-
- Join us on our Slack channel: [#kgateway](https://cloud-native.slack.com/archives/C080D3PJMS4) ([get an invite here]((https://slack.cncf.io/)))
44-
- Check out the docs: [https://kgateway.dev/docs](https://kgateway.dev/docs)
45-
- Learn more about the [community](https://github.com/kgateway-dev/community)
25+
## Get involved
26+
- [Join us on our Slack channel](https://kgateway.dev/slack/)
27+
- [Check out the docs](https://kgateway.dev/docs)
28+
- [Read the kgateway blog](https://kgateway.dev/blog/)
29+
- [Learn more about the community](https://github.com/kgateway-dev/community)
4630

4731
## Contributing to kgateway
4832
The [devel](devel) folder should be the starting point for understanding the code, and contributing to the product.
4933

5034
## Thanks
51-
Kgateway would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io).
35+
Kgateway would not be possible without the valuable open source work of projects in the community. We would like to extend a special thank-you to [Envoy](https://www.envoyproxy.io), upon whose shoulders we stand.
5236

5337
## Security
5438
*Reporting security issues* : We take kgateway's security very seriously. If you've found a security issue or a potential security issue in kgateway, please DO NOT file a public GitHub issue. Instead follow [the directions laid out in the kgateway/community repository](https://github.com/kgateway-dev/community/blob/main/CVE.md).
39+
40+
---
41+
42+
<div align="center">
43+
<img src="https://raw.githubusercontent.com/cncf/artwork/main/other/cncf-sandbox/horizontal/color/cncf-sandbox-horizontal-color.svg" width="300" alt="Cloud Native Computing Foundation logo"/>
44+
<p>kgateway is a <a href="https://cncf.io">Cloud Native Computing Foundation</a> sandbox project.</p>
45+
</div>

0 commit comments

Comments
 (0)