refactor: Makefile, update docs #463

zdtsw · 2025-11-19T10:54:54Z

Changelist

split Makefile into 3 different parts:

tools+dependency - including install tools, check tools, download dependency(gcc etc) and tokenizer
cluster(including k8s and ocp) : deploy resource, apply rbac, etc
kind: only "kind" related tasks

download tools to "bin" folder instead of using global ones, avoid version conflicts
rename "openshift-base" folder to "kubernetes-base"
uplift go lint version from 1.62.0 to 2.1.6 to algin with GitHub Action's setting
rename make target for better usage, deprecating old targets
add more env variable in "make env"

Result

>make help
Usage:
  make <target>
  help             Print help

Development
  clean            Clean build artifacts, tools and caches
  format           Format Go source files
  lint             Run lint
  install-hooks    Install git hooks
  test             Run all tests (unit and e2e)
  test-unit        Run unit tests
  test-integration  Run integration tests
  test-e2e         Run end-to-end tests against a new kind cluster

Build
  build            Build the project for both epp and sidecar

Container image Build/Push/Pull
  image-build      Build Container image using $(CONTAINER_RUNTIME)
  image-push       Push container images to registry using $(CONTAINER_RUNTIME)
  image-pull       Pull all related images using $(CONTAINER_RUNTIME)

Container Run
  run-container    Run app in container using $(CONTAINER_RUNTIME)
  stop-container   Stop and remove container

Environment
  env              Print environment variables
  print-namespace  Print the current namespace
  print-project-name  Print the current project name

Deprecated aliases for backwards compatibility
  install-docker   DEPRECATED: Use 'make run-container' instead
  uninstall-docker  DEPRECATED: Use 'make stop-container' instead
  install          DEPRECATED: Use 'make run-container' instead
  uninstall        DEPRECATED: Use 'make stop-container' instead

Tools
  install-tools    Install all development tools and dependencies
  install-dependencies  Install development dependencies based on OS/ARCH
  check-tools      Check that all required tools are installed

Cluster Development Environments
  env-dev-kubernetes  Deploy full dev environment (vLLM + Gateway + EPP) to K8s/OpenShift cluster
  clean-env-dev-kubernetes  Clean up full dev environment from K8s/OpenShift cluster

RBAC Targets
  install-rbac     Apply RBAC configuration to cluster
  uninstall-rbac   Remove RBAC configuration from cluster

Kubernetes Targets
  install-k8s      Deploy resources to Kubernetes
  uninstall-k8s    Remove resources from Kubernetes

OpenShift Targets
  install-openshift  Deploy resources to OpenShift
  uninstall-openshift  Remove resources from OpenShift

Kind Development Environments
  env-dev-kind     Run under kind ($(KIND_CLUSTER_NAME))
  clean-env-dev-kind  Cleanup kind setup (delete cluster $(KIND_CLUSTER_NAME))

Alias checking
  check-alias      Check if the container alias works correctly

Test

enable pre-commit
run "make test" passed unit and e2e

- ==== Running Unit Tests ====
=== RUN   TestProxy
Running Suite: Proxy Suite - /home/wenzhou/upstream/llm-d/llm-d-inference-scheduler/pkg/sidecar/proxy
=====================================================================================================
Random Seed: 1763545447

Will run 22 of 22 specs
••••••••••••••••••••••

Ran 22 of 22 Specs in 22.745 seconds
SUCCESS! -- 22 Passed | 0 Failed | 0 Pending | 0 Skipped
- Ran 5 of 5 Specs in 137.447 seconds
SUCCESS! -- 5 Passed | 0 Failed | 0 Pending | 0 Skipped
--- PASS: TestEndToEnd (137.45s)
PASS
ok      github.com/llm-d/llm-d-inference-scheduler/test/e2e     137.461s
✔️  All checks passed!

shmuelk · 2025-11-19T13:28:31Z

This PR will need re-work once PR #453 merges.

zdtsw · 2025-11-19T13:44:10Z

This PR will need re-work once PR #453 merges.

thanks for the headsup, mark PR to draft for now.

zdtsw · 2025-11-21T11:21:21Z

This PR will need re-work once PR #453 merges.

@shmuelk if you might have time to give a review?

shmuelk · 2025-11-23T15:19:59Z

DEVELOPMENT.md

 ```

+> [!NOTE]
+> The full image reference will be constructed as `${EPP_IMAGE}:${EPP_TAG}`, where `EPP_IMAGE` defaults to `${IMAGE_REGISTRY}/llm-d-inference-scheduler`. For example, with `IMAGE_REGISTRY=quay.io/<my-id>` and `EPP_TAG=v1.0.0`, the final image will be `quay.io/<my-id>/llm-d-inference-scheduler:v1.0.0`.


EPP_IMAGE is the entire image including the tag

It defaults to ${IMAGE_REGISTRY}/llm-d-inference-scheduler:${EPP_TAG}, where EPP_TAG defaults to dev

shmuelk · 2025-11-23T15:20:20Z

DEVELOPMENT.md

 **1. Setting the EPP image and tag:**

-You can optionally set a custom EPP image (otherwise, the default will be used):
+You can optionally set a custom EPP image and tag (otherwise, defaults will be used):


See comment below on EPP_IMAGE

shmuelk · 2025-11-23T15:22:37Z

Makefile.kind.mk

+		GATEWAY_HOST_PORT=$(KIND_GATEWAY_HOST_PORT) \
+		IMAGE_REGISTRY=$(IMAGE_REGISTRY) \
+		EPP_IMAGE=$(EPP_IMAGE) \
+		EPP_TAG=$(EPP_TAG) \


There is no need to pass in EPP_TAG

shmuelk · 2025-11-23T15:23:04Z

Makefile.kind.mk

+		EPP_IMAGE=$(EPP_IMAGE) \
+		EPP_TAG=$(EPP_TAG) \
+		VLLM_SIMULATOR_IMAGE=${VLLM_SIMULATOR_IMAGE} \
+		VLLM_SIMULATOR_TAG=$(VLLM_SIMULATOR_TAG) \


There is no need to pass in VLLM_SIMULATOR_TAG

shmuelk · 2025-11-23T15:23:38Z

Makefile.kind.mk

+		VLLM_SIMULATOR_IMAGE=${VLLM_SIMULATOR_IMAGE} \
+		VLLM_SIMULATOR_TAG=$(VLLM_SIMULATOR_TAG) \
+		SIDECAR_IMAGE=$(SIDECAR_IMAGE) \
+		SIDECAR_TAG=$(SIDECAR_TAG) \


There is no need to pass in SIDECAR_TAG

shmuelk · 2025-11-23T15:26:46Z

Makefile.tools.mk

+GOLANGCI_LINT_VERSION ?= v2.1.6
+KUSTOMIZE_VERSION ?= v5.5.0
 TYPOS_VERSION ?= v1.34.0
+VLLM_SIMULATOR_TAG ?= v0.6.1


I want all of the images setup in the main Makefile

You need to export VLLM_SIMULATOR_IMAGE and no VLLM_SIMULATOR_TAG

shmuelk · 2025-11-23T15:28:41Z

This PR was not correctly updated to reflect the changes in PR #453

zdtsw · 2025-11-23T16:10:59Z

This PR was not correctly updated to reflect the changes in PR #453

Thanks for the review!
I've addressed them in new commit

- split Makefile 1. tools: include install tools, check tools, download dependency(gcc etc) and tokenizer. these will be download into "bin" folder than global path 2. cluster: include k8s and ocp 3. kind - rename "openshift-base" to "kubernetes-base" to be clear for purpose - uplift Go lint version to 2.1.6 to align with the same one set in Github Action - rename make targets for better visibility, deprcating old ones - add more print in "make env" Signed-off-by: Wen Zhou <[email protected]>

github-project-automation bot added this to llm-d-inference-scheduler Nov 19, 2025

zdtsw marked this pull request as draft November 19, 2025 13:44

zdtsw force-pushed the refactor_1 branch from 940b6d9 to 223ea5d Compare November 20, 2025 11:06

zdtsw marked this pull request as ready for review November 20, 2025 11:08

zdtsw force-pushed the refactor_1 branch 2 times, most recently from e492d43 to 3b7888e Compare November 20, 2025 13:53

zdtsw force-pushed the refactor_1 branch from 3b7888e to 1a874f9 Compare November 22, 2025 15:23

shmuelk requested changes Nov 23, 2025

View reviewed changes

github-project-automation bot moved this to In review in llm-d-inference-scheduler Nov 23, 2025

zdtsw force-pushed the refactor_1 branch from 1a874f9 to 324935c Compare November 23, 2025 16:09

zdtsw requested a review from shmuelk November 24, 2025 06:30

zdtsw force-pushed the refactor_1 branch 2 times, most recently from 24a5342 to 200a48a Compare November 24, 2025 12:50

zdtsw changed the title ~~refactor: Makefile, update docs, fix Go version~~ refactor: Makefile, update docs Nov 25, 2025

zdtsw force-pushed the refactor_1 branch 2 times, most recently from b13ab07 to 319a637 Compare November 26, 2025 15:22

zdtsw force-pushed the refactor_1 branch from 319a637 to d954f1a Compare November 28, 2025 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: Makefile, update docs #463

refactor: Makefile, update docs #463

zdtsw commented Nov 19, 2025 •

edited

Loading

Uh oh!

shmuelk commented Nov 19, 2025

Uh oh!

zdtsw commented Nov 19, 2025

Uh oh!

zdtsw commented Nov 21, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk Nov 23, 2025

Uh oh!

shmuelk commented Nov 23, 2025

Uh oh!

zdtsw commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refactor: Makefile, update docs #463

Are you sure you want to change the base?

refactor: Makefile, update docs #463

Conversation

zdtsw commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelist

Result

Test

Uh oh!

shmuelk commented Nov 19, 2025

Uh oh!

zdtsw commented Nov 19, 2025

Uh oh!

zdtsw commented Nov 21, 2025

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

shmuelk commented Nov 23, 2025

Uh oh!

zdtsw commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zdtsw commented Nov 19, 2025 •

edited

Loading