Skip to content

README.md

Latest commit

 

History

History
146 lines (91 loc) · 4.68 KB

README.md

File metadata and controls

146 lines (91 loc) · 4.68 KB

Development

Important Links and Resources

Here are some essential resources for anyone interested in AIBrix:

Additional resources for contributors:

  • Kubebuilder Tutorial: Learn Kubebuilder - A comprehensive, step-by-step guide to developing with Kubebuilder.
  • Kubernetes Documentation: Explore Kubernetes Docs - Detailed explanations of Kubernetes concepts.

Prerequisites

Before you start, ensure the following are installed on your system:

  • Go version 1.21.0 or higher
  • Docker version 26.x or higher
  • kubectl version 1.25.x or higher
  • Access to a Kubernetes cluster, version 1.25.x or higher

For Mac developers, it is recommended to use Docker Desktop which includes built-in support for Kubernetes.

Alternatively, you can use Kind or Minikube to quickly set up a localized, small-scale Kubernetes cluster for development purposes.

Start your Coding

Fork and Clone the Repository

  • Fork the AIBrix repository on GitHub.

  • Clone your fork locally:

    git clone https://github.com/vllm-project/aibrix.git
cd aibrix

Build and Deploy

Navigate to the cloned directory and run:

make build

Build and push your images to the registry location specified by AIBRIX_CONTAINER_REGISTRY_NAMESPACE:

make docker-build-all docker-push-all AIBRIX_CONTAINER_REGISTRY_NAMESPACE=<some-registry>

NOTE: 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 install

NOTE: once you modify the project code, like change the api definition, you need to redo this step. Some auxiliary code will be auto-generated and the installed resources on K8S will be refreshed.

Deploy the Manager to Kubernetes

Deploy the Manager to your cluster using the AIBRIX_CONTAINER_REGISTRY_NAMESPACE environment variable to specify the image:

make deploy AIBRIX_CONTAINER_REGISTRY_NAMESPACE=<some-registry>

If you prefer local testing and do not want to push the image to a remote DockerHub, you can specify any name, such as:

make deploy AIBRIX_CONTAINER_REGISTRY_NAMESPACE=example.com

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Start the Manager through an IDE

Alternatively, for better debugging, you can start AIBrix in debug mode using an IDE like Goland or VSCode. The main entry point of the project is located at cmd/controllers/main.go.

Create AIBrix Sample Instances

Apply the samples from the config/samples directory. These samples create a list of AIBrix CRD instances, such as PodAutoscaler and ModelAdapter:

kubectl apply -k config/samples/

NOTE: Ensure that the samples have default values for testing purposes.

Run Demo App to Verify AIBrix Functionality

Start a demo application on Kubernetes and verify the functionality and effectiveness of the AIBrix suite. We provide some demo application YAMLs at TODO: link to demo application YAMLs.

Uninstall and Undeploy

To remove the deployed instances (CRs) from your cluster:

kubectl delete -k config/samples/

To remove the Custom Resource Definitions (CRDs) from the cluster:

make uninstall

To undeploy the controller from the cluster:

make undeploy

Run Test

To test the build, run:

make test

Project Distribution

Following are the steps to build the installer and distribute this project to users.

  1. Build the installer for the image built and published in the registry:
make build-installer AIBRIX_CONTAINER_REGISTRY_NAMESPACE=<some-registry>

NOTE: 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.

  1. Using the installer: Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
kubectl apply -f https://raw.githubusercontent.com/<org>/aibrix/<tag or branch>/dist/install.yaml