Skip to content

Commit

Permalink
[doc][misc] add note for Kubernetes users (#5916)
Browse files Browse the repository at this point in the history
  • Loading branch information
youkaichao authored Jun 27, 2024
1 parent 98cf2ed commit 3fd02bd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/serving/env_vars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ vLLM uses the following environment variables to configure the system:
.. warning::
Please note that ``VLLM_PORT`` and ``VLLM_HOST_IP`` set the port and ip for vLLM's **internal usage**. It is not the port and ip for the API server. If you use ``--host $VLLM_HOST_IP`` and ``--port $VLLM_PORT`` to start the API server, it will not work.

All environment variables used by vLLM are prefixed with ``VLLM_``. **Special care should be taken for Kubernetes users**: please do not name the service as ``vllm``, otherwise environment variables set by Kubernetes might conflict with vLLM's environment variables, because `Kubernetes sets environment variables for each service with the capitalized service name as the prefix <https://kubernetes.io/docs/concepts/services-networking/service/#environment-variables>`_.

.. literalinclude:: ../../../vllm/envs.py
:language: python
:start-after: begin-env-vars-definition
Expand Down

0 comments on commit 3fd02bd

Please sign in to comment.