Skip to content

Commit b81aef5

Browse files
phyyoupan3793
authored andcommitted
[KYUUBI #4589] [HELM] Update template on port-foward usage guide NOTES.txt
- Fix Stale Docs URL in Helm Chart - ~~Update kyuubiDefaults structure~~ - Update NOTES.txt - When kyuubi.kyuubiConf.kyuubiDefaults."kyuubi.frontend.bind.host" set localhost, render port-forward example in NOTES.txt for development usage guide - ~~Add extraFiles for config mount~~ - ~~extraFiles for another file mount in kyuubi conf directory.~~ ### _Why are the changes needed?_ Based on #4561 (comment) > I think Helm chart notes had been wrong from this commit. >https://github.com/apache/kyuubi/blob/dbb741fc5b0d2fd4b0640ff70ea12aca75864166/charts/kyuubi/templates/NOTES.txt#L33-L34 > Can we delete this note or update this note if `--address` option is work like this? : > ```suggestion > - To access {{ $.Release.Name }}-{{ $name | kebabcase }} service from outside the cluster for debugging, run the following > > > command: > kubectl port-forward svc/{{ $.Release.Name }}-{{ $name | kebabcase }} {{ tpl $frontend.service.port $ }}:{{ tpl >?> >$frontend.service.port $ }} -n {{ $.Release.Namespace }} --address <your-ip> > ``` ~~and more changes:~~ - ~~Update `.Values.kyuubiConf.kyuubiDefaults` to dict for more variant usage in templates. (like NOTES.txt changes)~~ - ~~Add extraFiles in configmap for like mounting hive-site-xml on kyuubi config directory.~~ ### _How was this patch tested?_ - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4589 from phyyou/feat/helm-chart-improve. Closes #4589 d7ee29e [phyyou] Fix regex when no equal sign 0b86f28 [phyyou] Update condition for edge case 4edf904 [phyyou] chore aabe93c [PHYYOU] Update kyuubiDefaults example guide in Helm Chart 4de8964 [phyyou] Add README.md for Kyuubi Helm Chart (It from airflow chart README.md) abacd32 [phyyou] Add Example Usecases in kyuubiConf ebcb231 [phyyou] Update empty string to nil 2533a93 [phyyou] Revert extraFiles 56fa525 [phyyou] Revert kyuubiConf Structure Update Update NOTES.txt for Reverted values 966e74c [phyyou] fix: template => include 03d6984 [phyyou] Fix: Add EOF e6affdd [phyyou] Add extraFiles for config mount b0963fd [phyyou] Update NOTES.txt; ac9766a [phyyou] Update kyuubiDefaults structure 77eaa05 [phyyou] Fix Stale Docs URL Lead-authored-by: phyyou <[email protected]> Co-authored-by: PHYYOU <[email protected]> Signed-off-by: Cheng Pan <[email protected]> (cherry picked from commit 0ebedda) Signed-off-by: Cheng Pan <[email protected]>
1 parent 2230a86 commit b81aef5

File tree

4 files changed

+70
-4
lines changed

4 files changed

+70
-4
lines changed

charts/kyuubi/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Helm Chart for Apache Kyuubi
21+
22+
[Apache Kyuubi](https://airflow.apache.org/) is a distributed and multi-tenant gateway to provide serverless SQL on Data Warehouses and Lakehouses.
23+
24+
25+
## Introduction
26+
27+
This chart will bootstrap an [Kyuubi](https://kyuubi.apache.org) deployment on a [Kubernetes](http://kubernetes.io)
28+
cluster using the [Helm](https://helm.sh) package manager.
29+
30+
## Requirements
31+
32+
- Kubernetes cluster
33+
- Helm 3.0+
34+
35+
<!-- ## Features -->
36+
37+
## Documentation
38+
39+
Configuration guide documentation for Kyuubi lives [on the website](https://kyuubi.readthedocs.io/en/master/deployment/settings.html#kyuubi-configurations). (Not just for Helm Chart)
40+
41+
## Contributing
42+
43+
Want to help build Apache Kyuubi? Check out our [contributing documentation](https://kyuubi.readthedocs.io/en/master/community/CONTRIBUTING.html).

charts/kyuubi/templates/NOTES.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,13 @@ In order to check the release status, use:
3030
{{ $name | snakecase | upper }}:
3131
- To access {{ $.Release.Name }}-{{ $name | kebabcase }} service within the cluster, use the following URL:
3232
{{ $.Release.Name }}-{{ $name | kebabcase }}.{{ $.Release.Namespace }}.svc.cluster.local
33+
{{- if $.Values.kyuubiConf.kyuubiDefaults }}
34+
{{- if regexMatch "(^|\\s)kyuubi.frontend.bind.host\\s*=?\\s*(localhost|127\\.0\\.0\\.1)($|\\s)" $.Values.kyuubiConf.kyuubiDefaults }}
3335
- To access {{ $.Release.Name }}-{{ $name | kebabcase }} service from outside the cluster for debugging, run the following command:
3436
kubectl port-forward svc/{{ $.Release.Name }}-{{ $name | kebabcase }} {{ tpl $frontend.service.port $ }}:{{ tpl $frontend.service.port $ }} -n {{ $.Release.Namespace }}
3537
and use 127.0.0.1:{{ tpl $frontend.service.port $ }}
38+
{{- end }}
39+
{{- end }}
3640
{{- if eq $frontend.service.type "NodePort" }}
3741
- To access {{ $.Release.Name }}-{{ $name | kebabcase }} service from outside the cluster through configured NodePort, run the following commands:
3842
export NODE_PORT=$(kubectl get service {{ $.Release.Name }}-{{ $name | kebabcase }} -n {{ $.Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}")

charts/kyuubi/values.yaml

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,34 @@ server:
101101
kyuubiConfDir: /opt/kyuubi/conf
102102
kyuubiConf:
103103
# The value (templated string) is used for kyuubi-env.sh file
104-
# See https://kyuubi.apache.org/docs/latest/deployment/settings.html#environments for more details
104+
# Example:
105+
#
106+
# kyuubiEnv: |
107+
# export JAVA_HOME=/usr/jdk64/jdk1.8.0_152
108+
# export SPARK_HOME=/opt/spark
109+
# export FLINK_HOME=/opt/flink
110+
# export HIVE_HOME=/opt/hive
111+
#
112+
# See example at conf/kyuubi-env.sh.template and https://kyuubi.readthedocs.io/en/master/deployment/settings.html#environments for more details
105113
kyuubiEnv: ~
106114

107115
# The value (templated string) is used for kyuubi-defaults.conf file
108-
# See https://kyuubi.apache.org/docs/latest/deployment/settings.html#kyuubi-configurations for more details
116+
# Example:
117+
#
118+
# kyuubiDefaults: |
119+
# kyuubi.authentication=NONE
120+
# kyuubi.frontend.bind.host=10.0.0.1
121+
# kyuubi.engine.type=SPARK_SQL
122+
# kyuubi.engine.share.level=USER
123+
# kyuubi.session.engine.initialize.timeout=PT3M
124+
# kyuubi.ha.addresses=zk1:2181,zk2:2181,zk3:2181
125+
# kyuubi.ha.namespace=kyuubi
126+
#
127+
# See https://kyuubi.readthedocs.io/en/master/deployment/settings.html#kyuubi-configurations for more details
109128
kyuubiDefaults: ~
110129

111130
# The value (templated string) is used for log4j2.xml file
112-
# See https://kyuubi.apache.org/docs/latest/deployment/settings.html#logging for more details
131+
# See example at conf/log4j2.xml.template https://kyuubi.readthedocs.io/en/master/deployment/settings.html#logging for more details
113132
log4j2: ~
114133

115134
# Environment variables (templated)

docker/kyuubi-configmap.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ data:
5252
# kyuubi.frontend.bind.port 10009
5353
#
5454
55-
# Details in https://kyuubi.apache.org/docs/latest/deployment/settings.html
55+
# Details in https://kyuubi.readthedocs.io/en/master/deployment/settings.html

0 commit comments

Comments
 (0)