An Envoy inspired, ultimate LLM-first gateway for LLM serving and downstream application developers and enterprises
Lite and easy dedicated Gateway with various of LLM specific optimizations and features. You can think of it as Nginx, but for LLMs, and upcoming supported models (such as Stable Diffusion, etc.).
- 💬 LLM-first: Designed for LLMs, with optimizations and features that are specific to LLMs.
- 🕸️ Envoy Inspired: Inspired by Envoy, similar architecture and features, if you are already familiar with Envoy, you will find it easy to use and understand this codebase.
- 💻 Single command deployment: Deploy the gateway with a single command, just like
nginx -c nginx.conf. - 🚢 Kubernetes Native: CRDs, control plane side implementations are batteries included,
helm install knowayand you are ready to go.
Some of the LLMs specific optimizations and features include:
- 👷 Serverless boot loader: Able to boot up the upstream Pod of serving services on-demand, make LLM serving more cost-effective.
- ✅ Fault tolerance: Fault tolerance for LLMs, with the ability to retry, circuit breaking, etc. when dealing with external providers.
- 🚥 Rate limiting: Rate limiting based on tokens, prompts, etc., to protect the LLMs serving services from being abused.
- 📚 Semantic Cache: Cache based on the semantics of the prompts and tokens, CDN of the LLMs.
- 📖 Semantic Route: Route based on the difficulties, semantic meaning of prompts, etc., to make the LLMs serving services more efficient with right models.
- 🔍 OpenTelemetry: OpenTelemetry support, with the ability to trace the calls to LLMs, and the gateway itself.
goversion v1.22.0+dockerversion 17.03+.kubectlversion v1.11.3+.- Access to a Kubernetes v1.11.3+ cluster.
Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/knoway:tagWarning
This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.
Install the CRDs into the cluster:
make installDeploy the Manager to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/knoway:tagNote
If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.
Create instances of your solution
You can apply the samples (examples) from the config/sample:
kubectl apply -k config/samples/Note
Ensure that the samples has default values to test it out.
Delete the instances (CRs) from the cluster:
kubectl delete -k config/samples/Delete the APIs(CRDs) from the cluster:
make uninstallUnDeploy the controller from the cluster:
make undeployFollowing are the steps to build the installer and distribute this project to users.
- Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/knoway:tagNOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.
- Using the installer
Users can just run kubectl apply -f to install the project, i.e.:
kubectl apply -f https://raw.githubusercontent.com/<org>/knoway/<tag or branch>/dist/install.yamlNote
Run make help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
Copyright 2024.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.