diff --git a/README.md b/README.md index 5bf9c1f0..94e8dbd1 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,23 @@ -# Kubernetes Template Project +# Kubernetes LLM Instance Gateway -The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files: +The LLM Instance Gateway is a part of [wg-serving](https://github.com/kubernetes/community/tree/master/wg-serving), and this repo contains: the load balancing algorithm, [ext-proc](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_proc_filter) code, CRDs, and controllers to support the LLM Instance Gateway. -- a `README.md` outlining the project goals, sponsoring sig, and community contact information -- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners]) -- a `CONTRIBUTING.md` outlining how to contribute to the project -- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code -- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content -- a `SECURITY_CONTACTS` with the contact points for the Product Security Team - to reach out to for triaging and handling of incoming issues. They must agree to abide by the - [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy) - and will be removed and replaced if they violate that agreement. +This Gateway is intented to provide value to multiplexed LLM services on a shared pool of compute. See the [proposal](https://github.com/kubernetes-sigs/wg-serving/tree/main/proposals/012-llm-instance-gateway) for more info. -## Community, discussion, contribution, and support +## Status -Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/). +This project is currently in development. -You can reach the maintainers of this project at: +For more rapid testing, our PoC is in the `./examples/` dir. -- [Slack](https://slack.k8s.io/) -- [Mailing List](https://groups.google.com/a/kubernetes.io/g/dev) +## Contributing + +Our community meeting is weekly at Th 10AM PDT; [zoom link here](https://zoom.us/j/9955436256?pwd=Z2FQWU1jeDZkVC9RRTN4TlZyZTBHZz09). + +We currently utilize the [#wg-serving](https://kubernetes.slack.com/?redir=%2Fmessages%2Fwg-serving) slack channel for communications. + +Contributions are readily welcomed, thanks for joining us! ### Code of conduct Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). - -[owners]: https://git.k8s.io/community/contributors/guide/owners.md -[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE