-
Notifications
You must be signed in to change notification settings - Fork 201
Cleanup helm flags which have default values from values yaml #1429
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,18 +83,18 @@ $ helm install triton-llama3-8b-instruct \ | |
|
|
||
| To deploy the EndpointPicker in a high-availability (HA) active-passive configuration, you can enable leader election. When enabled, the EPP deployment will have multiple replicas, but only one "leader" replica will be active and ready to process traffic at any given time. If the leader pod fails, another pod will be elected as the new leader, ensuring service continuity. | ||
|
|
||
| To enable HA, set `inferenceExtension.enableLeaderElection` to `true` and increase the number of replicas in your `values.yaml` file: | ||
| To enable HA, set `inferenceExtension.flags.has-enable-leader-election` to `true` and increase the number of replicas in your `values.yaml` file: | ||
|
|
||
| ```yaml | ||
| inferenceExtension: | ||
| replicas: 3 | ||
| enableLeaderElection: true | ||
| has-enable-leader-election: true | ||
| ``` | ||
|
|
||
| Then apply it with: | ||
|
|
||
| ```txt | ||
| helm install vllm-llama3-8b-instruct ./config/charts/inferencepool -f values.yaml \ | ||
| helm install vllm-llama3-8b-instruct ./config/charts/inferencepool -f values.yaml | ||
| ``` | ||
|
|
||
| ## Uninstall | ||
|
|
@@ -122,10 +122,9 @@ The following table list the configurable parameters of the chart. | |
| | `inferenceExtension.env` | List of environment variables to set in the endpoint picker container as free-form YAML. Defaults to `[]`. | | ||
| | `inferenceExtension.extraContainerPorts` | List of additional container ports to expose. Defaults to `[]`. | | ||
| | `inferenceExtension.extraServicePorts` | List of additional service ports to expose. Defaults to `[]`. | | ||
| | `inferenceExtension.flags` | List of flags which are passed through to endpoint picker. | | ||
| | `inferenceExtension.flags` | List of flags which are passed through to endpoint picker. Example flags, enable-pprof, grpc-port etc. Refer [runner.go](https://github.com/kubernetes-sigs/gateway-api-inference-extension/blob/main/cmd/epp/runner/runner.go) for complete list. | | ||
| | `inferenceExtension.flags.has-enable-leader-election` | Enable leader election for high availability. When enabled, only one EPP pod (the leader) will be ready to serve traffic. | | ||
| | `provider.name` | Name of the Inference Gateway implementation being used. Possible values: `gke`. Defaults to `none`. | | ||
| | `inferenceExtension.enableLeaderElection` | Enable leader election for high availability. When enabled, only one EPP pod (the leader) will be ready to serve traffic. It is recommended to set `inferenceExtension.replicas` to a value greater than 1 when this is set to `true`. Defaults to `false`. | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reading Can we update the documentation like I suggested in the previous PR #1302 (comment) , basically document this as part of the
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated. I think referring to values.yaml for example is more suitable. Let me know what you think.. Thanks!
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think the way its formatted currently would allow this key info to be easily skipped by a reader. I agree with @liu-cong that we should probably bullet list a couple important flags, and then the last bullet can be your link to the exhaustive list.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I reformatted the flags. I think they are more readable in the README. Also added a sample instruction on the top. Thanks! |
||
|
|
||
|
|
||
| ## Notes | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.