nit

Signed-off-by: Kuromesi <[email protected]>

Author: Kuromesi

config/charts/inferencepool/README.md

@@ -1,34 +1,20 @@
-# Gateway Api Inference Extension
+# InferencePool
 
-A chart to deploy the inference extension and a InferencePool managed by the extension.
+A chart to deploy an InferencePool and a corresponding EndpointPicker (epp) deployment.  
 
-## Install
 
-Suppose now a vllm service with label `app: vllm-llama2-7b` and served on port `8000` is deployed in `default` namespace in the cluster.
+## Install
 
-To deploy the inference extension, you can run the following command:
+To install an InferencePool named `pool-1`  that selects from endpoints with label `app: vllm-llama2-7b` and listening on port `8000`, you can run the following command:
 
 ```txt
-$ helm install my-release . -n default \
-    --set inferencePool.targetPortNumber=8000 \
-    --set inferencePool.selector.app=vllm-llama2-7b
-```
-
-Or you can change the `values.yaml` to:
-
-```yaml
-inferencePool:
-  name: pool-1
-  targetPortNumber: 8000
-  selector:
-    app: vllm-llama2-7b
+$ helm install my-release ./config/charts/inferencepool \
+  --set inferencePool.name=pool-1 \
+  --set inferencePool.selector.app=vllm-llama2-7b \
+  --set inferencePool.targetPortNumber=8000
 ```
 
-where `inferencePool.targetPortNumber` is the pod that vllm backends served on and `inferencePool.selector` is the selector to match the vllm backends. And then run:
-
-```txt
-$ helm install my-release .
-```
+where `inferencePool.targetPortNumber` is the pod that vllm backends served on and `inferencePool.selector` is the selector to match the vllm backends.
 
 ## Uninstall
 
@@ -44,18 +30,16 @@ The following table list the configurable parameters of the chart.
 
 | **Parameter Name**                          | **Description**                                                                                                   |
 |---------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
+| `inferencePool.name`                        | Name for the InferencePool, and inference extension will be named as `${inferencePool.name}-epp`.                |
+| `inferencePool.targetPortNumber`            | Target port number for the vllm backends, will be used to scrape metrics by the inference extension.             |
+| `inferencePool.selector`                     | Label selector to match vllm backends managed by the inference pool.                                             |
 | `inferenceExtension.replicas`               | Number of replicas for the inference extension service. Defaults to `1`.                                           |
 | `inferenceExtension.image.name`             | Name of the container image used for the inference extension.                                                    |
 | `inferenceExtension.image.hub`              | Registry URL where the inference extension image is hosted.                                                     |
 | `inferenceExtension.image.tag`              | Image tag of the inference extension.                                                                             |
 | `inferenceExtension.image.pullPolicy`       | Image pull policy for the container. Possible values: `Always`, `IfNotPresent`, or `Never`. Defaults to `Always`. |
 | `inferenceExtension.extProcPort`            | Port where the inference extension service is served for external processing. Defaults to `9002`.                  |
-| `inferencePool.name`                        | Name for the InferencePool, and inference extension will be named as `${inferencePool.name}-epp`.                |
-| `inferencePool.targetPortNumber`            | Target port number for the vllm backends, will be used to scrape metrics by the inference extension.             |
-| `inferencePool.selector`                     | Label selector to match vllm backends managed by the inference pool.                                             |
 
 ## Notes
 
-This chart will only deploy the inference extension and InferencePool, before install the chart, please make sure that the inference extension CRDs have already been installed in the cluster. And You need to apply traffic policies to route traffic to the inference extension from the gateway after the inference extension is deployed.
-
-For more details, please refer to the [website](https://gateway-api-inference-extension.sigs.k8s.io/guides/).
+This chart will only deploy an InferencePool and its corresponding EndpointPicker extension. Before install the chart, please make sure that the inference extension CRDs are installed in the cluster. For more details, please refer to the [getting started guide](https://gateway-api-inference-extension.sigs.k8s.io/guides/).

config/charts/inferencepool/templates/NOTES.txt

@@ -1 +1 @@
-Gateway api inference extension deployed.
+InferencePool {{ .Values.inferencePool.name }} deployed.

config/charts/inferencepool/values.yaml

@@ -11,4 +11,4 @@ inferencePool:
   name: pool-1
   targetPortNumber: 8000
   selector:
-    app: vllm-llama2-7b
+    app: vllm-llama2-7b