danhuawang commented on code in PR #9511: URL: https://github.com/apache/gravitino/pull/9511#discussion_r2639207401
########## docs/lance-rest-server-chart.md: ########## @@ -0,0 +1,99 @@ +--- +title: "Install Lance Rest Server on Kubernetes" +slug: /lance-rest-server-chart +keyword: + - Lance REST Server Helm Chart +license: "This software is licensed under the Apache License version 2." +--- + +# Install Lance Rest Server on Kubernetes + +This Helm chart deploys Apache Gravitino Lance REST Server on Kubernetes with customizable configurations. + +## Prerequisites + +- Kubernetes 1.29+ +- Helm 3+ + +## Update Chart Dependency + +The Gravitino Lance REST Server Helm chart has not yet been officially released. +To proceed, please clone the repository, navigate to the chart directory [charts](../dev/charts), and execute the Helm dependency update command. + +```console +helm dependency update [CHART] +``` + +## View Chart values + +You can customize values.yaml parameters to override chart default settings. Additionally, Gravitino Lance REST Server configurations in [gravitino-lance-rest-server.conf](../dev/charts/gravitino-lance-rest-server/resources/gravitino-lance-rest-server.conf) can be modified through Helm values.yaml. + +To display the default values of the chart, run: + +```console +helm show values [CHART] +``` + +## Install Helm Chart + +```console +helm install [RELEASE_NAME] [CHART] [flags] +``` + +### Deploy with Default Configuration + +Run the following command to deploy Gravitino Lance REST Server using the default settings, specify container image versions using --set image.tag=x.y.z (replace x, y, z with the expected version numbers): + +```console +helm upgrade --install gravitino ./gravitino-lance-rest-server \ + -n gravitino \ + --create-namespace \ + --set image.tag=<x.y.z> \ + --set replicas=2 \ + --set resources.requests.memory="4Gi" \ + --set resources.requests.cpu="2" +``` + +### Deploy with Custom Configuration + +To customize the deployment, use the --set flag to override specific values: + +```console +helm upgrade --install gravitino ./gravitino-lance-rest-server + -n gravitino \ + --create-namespace \ + --set key1=val1,key2=val2,... +``` +Alternatively, you can provide a custom values.yaml file: + +```console +helm upgrade --install gravitino ./gravitino-lance-rest-server + -n gravitino \ + --create-namespace \ + -f /path/to/values.yaml +``` +_Note: \ +The path '/path/to/values.yaml' refers to the actual path to the values.yaml file._ Review Comment: It comes with the `_Note` above the sentence. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
