yuqi1129 commented on code in PR #9511: URL: https://github.com/apache/gravitino/pull/9511#discussion_r2638515301
########## dev/charts/gravitino-lance-rest-server/resources/log4j2.properties: ########## @@ -0,0 +1,85 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +status = {{ .Values.log4j2Properties.status | default "warn" }} + +# Log files location +property.basePath = {{ .Values.log4j2Properties.basePath | default "${sys:gravitino.log.path}" }} +property.serverName = {{ .Values.log4j2Properties.serverName | default "${sys:gravitino.server.name}" }} + +# RollingFileAppender name, pattern, path and rollover policy +appender.rolling.type = {{ .Values.log4j2Properties.rollingAppenderType | default "RollingFile" }} +appender.rolling.name = {{ .Values.log4j2Properties.rollingAppenderName | default "fileLogger" }} +appender.rolling.fileName = {{ .Values.log4j2Properties.rollingAppenderFileName | default "${basePath}/${serverName}.log" }} +appender.rolling.filePattern = {{ .Values.log4j2Properties.rollingAppenderFilePattern | default "${basePath}/${serverName}_%d{yyyyMMdd}.log.gz" }} +appender.rolling.layout.type = {{ .Values.log4j2Properties.rollingAppenderLayoutType | default "PatternLayout" }} +appender.rolling.layout.pattern = {{ .Values.log4j2Properties.rollingAppenderLayoutPattern | default "%d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n" }} +appender.rolling.policies.type = {{ .Values.log4j2Properties.rollingAppenderPoliciesType | default "Policies" }} + +# RollingFileAppender rotation policy +appender.rolling.policies.size.type = {{ .Values.log4j2Properties.rollingAppenderPoliciesSizeType | default "SizeBasedTriggeringPolicy" }} +appender.rolling.policies.size.size = {{ .Values.log4j2Properties.rollingAppenderPoliciesSizeSize | default "10MB" }} +appender.rolling.policies.time.type = {{ .Values.log4j2Properties.rollingAppenderPoliciesTimeType | default "TimeBasedTriggeringPolicy" }} +appender.rolling.policies.time.interval = {{ .Values.log4j2Properties.rollingAppenderPoliciesTimeInterval | default 1 }} +appender.rolling.policies.time.modulate = {{ .Values.log4j2Properties.rollingAppenderPoliciesTimeModulate | default true }} +appender.rolling.strategy.type = {{ .Values.log4j2Properties.rollingAppenderStrategyType | default "DefaultRolloverStrategy" }} +appender.rolling.strategy.delete.type = {{ .Values.log4j2Properties.rollingAppenderStrategyDeleteType | default "Delete" }} +appender.rolling.strategy.delete.basePath = {{ .Values.log4j2Properties.rollingAppenderStrategyDeleteBasePath | default "${basePath}" }} +appender.rolling.strategy.delete.maxDepth = {{ .Values.log4j2Properties.rollingAppenderStrategyDeleteMaxDepth | default 10 }} +appender.rolling.strategy.delete.ifLastModified.type = {{ .Values.log4j2Properties.rollingAppenderStrategyDeleteIfLastModifiedType | default "IfLastModified" }} + +# Delete all files older than 30 days +appender.rolling.strategy.delete.ifLastModified.age = {{ .Values.log4j2Properties.rollingAppenderStrategyDeleteIfLastModifiedAge | default "30d" }} + +## use seperate file for lineage log Review Comment: typo: seperate ########## 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: What is the meaning of the suffix `_` in `file._`? ########## dev/charts/gravitino-lance-rest-server/Chart.yaml: ########## @@ -0,0 +1,47 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +apiVersion: v2 +name: gravitino-lance-rest-server +description: Apache Gravitino's Lance REST server provides high-performance columnar data management via RESTful APIs, supporting HDFS/S3/OSS/Azure/GCS storage backends, and Lance format compatibility for analytical workloads. + +home: https://gravitino.apache.org +icon: https://gravitino.apache.org/img/apache-gravitino.svg +keywords: + - gravitino + - lance + - metadata + - catalog Review Comment: I would suggest you also add the keyword `REST` here. ########## dev/charts/gravitino-lance-rest-server/resources/gravitino-lance-rest-server.conf: ########## @@ -0,0 +1,50 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +# THE CONFIGURATION FOR Lance REST SERVER +gravitino.lance-rest.shutdown.timeout = {{ .Values.lanceRest.shutdownTimeout | default 3000 }} + +# THE CONFIGURATION FOR Lance REST WEB SERVER +# The host name of the built-in web server +gravitino.lance-rest.host = {{ .Values.lanceRest.host | default "0.0.0.0" }} +gravitino.lance-rest.httpPort = {{ .Values.lanceRest.httpPort | default 9101 }} +gravitino.lance-rest.minThreads = {{ .Values.lanceRest.minThreads | default 24 }} +gravitino.lance-rest.maxThreads = {{ .Values.lanceRest.maxThreads | default 200 }} +gravitino.lance-rest.stopTimeout = {{ .Values.lanceRest.stopTimeout | default 30000 }} +gravitino.lance-rest.idleTimeout = {{ .Values.lanceRest.idleTimeout | default 30000 }} +gravitino.lance-rest.threadPoolWorkQueueSize = {{ .Values.lanceRest.threadPoolWorkQueueSize | default 100 }} +gravitino.lance-rest.requestHeaderSize = {{ .Values.lanceRest.requestHeaderSize | default 131072 }} +gravitino.lance-rest.responseHeaderSize = {{ .Values.lanceRest.responseHeaderSize | default 131072 }} + +# THE CONFIGURATION FOR Lance namespace backend +# The backend Lance namespace for Lance REST service, it's recommended to use Gravitino +gravitino.lance-rest.namespace-backend = {{ .Values.lanceRest.namespaceBackend | default "gravitino" }} +# The uri of the Lance REST service gravitino namespace backend +gravitino.lance-rest.gravitino-uri = {{ .Values.lanceRest.gravitinoUri | default "http://localhost:8090"; }} +# The metalake name used for Lance REST service gravitino namespace backend, please create the metalake before using it, and configure the metalake name here. +{{- if .Values.lanceRest.gravitinoMetalake }} +gravitino.lance-rest.gravitino-metalake = {{ .Values.lanceRest.gravitinoMetalake }} +{{- else }} +# gravitino.lance-rest.gravitino-metalake = metalake +{{- end }} Review Comment: Does this mean that if `gravitinoMetalake` is not set, we will not set the configuration `gravitino.lance-rest.gravitino-metalake`? Can we directly throw an exception or something similar if `gravitino-metalake` has not been assigned a value? -- 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]
