Skip to content

Commit d94bd83

Browse files
authored
Merge pull request #13 from kfswain/readme-update
Updating top level README
2 parents 1706607 + 931c6cd commit d94bd83

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

+13-19
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
1-
# Kubernetes Template Project
1+
# Kubernetes LLM Instance Gateway
22

3-
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:
3+
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.
44

5-
- a `README.md` outlining the project goals, sponsoring sig, and community contact information
6-
- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
7-
- a `CONTRIBUTING.md` outlining how to contribute to the project
8-
- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code
9-
- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content
10-
- a `SECURITY_CONTACTS` with the contact points for the Product Security Team
11-
to reach out to for triaging and handling of incoming issues. They must agree to abide by the
12-
[Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy)
13-
and will be removed and replaced if they violate that agreement.
5+
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.
146

15-
## Community, discussion, contribution, and support
7+
## Status
168

17-
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
9+
This project is currently in development.
1810

19-
You can reach the maintainers of this project at:
11+
For more rapid testing, our PoC is in the `./examples/` dir.
2012

21-
- [Slack](https://slack.k8s.io/)
22-
- [Mailing List](https://groups.google.com/a/kubernetes.io/g/dev)
13+
## Contributing
14+
15+
Our community meeting is weekly at Th 10AM PDT; [zoom link here](https://zoom.us/j/9955436256?pwd=Z2FQWU1jeDZkVC9RRTN4TlZyZTBHZz09).
16+
17+
We currently utilize the [#wg-serving](https://kubernetes.slack.com/?redir=%2Fmessages%2Fwg-serving) slack channel for communications.
18+
19+
Contributions are readily welcomed, thanks for joining us!
2320

2421
### Code of conduct
2522

2623
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
27-
28-
[owners]: https://git.k8s.io/community/contributors/guide/owners.md
29-
[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE

0 commit comments

Comments
 (0)