You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ch...@apache.org on 2021/08/19 01:53:58 UTC
[incubator-kyuubi] branch master updated: [KYUUBI #951] [LICENSE]
Add license header on all docs
This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new a76c344 [KYUUBI #951] [LICENSE] Add license header on all docs
a76c344 is described below
commit a76c3440421c395d5746378c5eed4a923341058c
Author: Cheng Pan <ch...@apache.org>
AuthorDate: Thu Aug 19 09:53:52 2021 +0800
[KYUUBI #951] [LICENSE] Add license header on all docs
<!--
Thanks for sending a pull request!
Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->
### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
1. If you add a feature, you can talk about the use case of it.
2. If you fix a bug, you can clarify why it is a bug.
-->
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
- [ ] Add screenshots for manual tests if appropriate
- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request
Closes #951 from pan3793/license.
Closes #951
4629eecd [Cheng Pan] Fix
c45a0784 [Cheng Pan] nit
b9a46b42 [Cheng Pan] pin license header at first line
80d1a71b [Cheng Pan] nit
b2a46e4c [Cheng Pan] Update
f6acaaf8 [Cheng Pan] minor
ef99183f [Cheng Pan] Add license header on all docs
Authored-by: Cheng Pan <ch...@apache.org>
Signed-off-by: Cheng Pan <ch...@apache.org>
---
.gitattributes | 17 ++++++++++
.gitignore | 17 ++++++++++
.readthedocs.yml | 2 ++
.travis.yml | 2 ++
README.md | 17 ++++++++++
_config.yml | 2 ++
codecov.yml | 2 ++
docs/appendix/index.rst | 15 +++++++++
docs/appendix/terminology.md | 17 ++++++++++
docs/client/hive_jdbc.md | 17 ++++++++++
docs/client/index.rst | 15 +++++++++
docs/community/badges.md | 17 ++++++++++
docs/community/collaborators.md | 17 ++++++++++
docs/community/contributions.md | 17 ++++++++++
docs/community/improvement-proposals.md | 17 ++++++++++
docs/community/index.rst | 15 +++++++++
docs/community/release.md | 24 +++++++++++---
docs/deployment/high_availability_guide.md | 17 ++++++++++
docs/deployment/hive_metastore.md | 17 ++++++++++
docs/deployment/index.rst | 15 +++++++++
docs/deployment/on_kubernetes.md | 17 ++++++++++
docs/deployment/on_yarn.md | 17 ++++++++++
docs/deployment/settings.md | 17 ++++++++++
docs/deployment/spark/aqe.md | 17 ++++++++++
docs/deployment/spark/basics.md | 19 ++++++++++-
docs/deployment/spark/driver.md | 19 +++++++++--
docs/deployment/spark/dynamic_allocation.md | 17 ++++++++++
docs/deployment/spark/dynamicpartitionpruning.md | 20 ++++++++++--
docs/deployment/spark/ess.md | 18 ++++++++++-
docs/deployment/spark/eventqueue.md | 19 +++++++++--
docs/deployment/spark/executor.md | 19 +++++++++--
docs/deployment/spark/heartbeart.md | 18 ++++++++++-
docs/deployment/spark/index.rst | 15 +++++++++
docs/deployment/spark/locality.md | 18 ++++++++++-
docs/deployment/spark/monitering.md | 19 +++++++++--
docs/deployment/spark/shuffle.md | 19 +++++++++--
docs/deployment/spark/speculation.md | 18 ++++++++++-
docs/deployment/spark/sql.md | 18 ++++++++++-
docs/develop_tools/build_document.md | 17 ++++++++++
docs/develop_tools/building.md | 17 ++++++++++
docs/develop_tools/debugging.md | 17 ++++++++++
docs/develop_tools/developer.md | 17 ++++++++++
docs/develop_tools/distribution.md | 17 ++++++++++
docs/develop_tools/index.rst | 15 +++++++++
docs/develop_tools/testing.md | 17 ++++++++++
docs/imgs/{dataGrip => datagrip}/configuration.png | Bin
.../datasource_and_driver.png | Bin
.../{dataGrip => datagrip}/select_database.png | Bin
docs/imgs/{dataGrip => datagrip}/workspace.png | Bin
docs/index.rst | 15 +++++++++
docs/integrations/index.rst | 15 +++++++++
docs/integrations/kudu.md | 17 ++++++++++
docs/monitor/index.rst | 15 +++++++++
docs/monitor/logging.md | 17 ++++++++++
docs/monitor/metrics.md | 17 ++++++++++
docs/monitor/trouble_shooting.md | 31 +++++++++++++-----
docs/overview/architecture.md | 17 ++++++++++
docs/overview/index.rst | 15 +++++++++
docs/overview/kyuubi_vs_hive.md | 17 ++++++++++
docs/overview/kyuubi_vs_thriftserver.md | 17 ++++++++++
docs/quick_start/index.rst | 15 +++++++++
docs/quick_start/quick_start.md | 17 ++++++++++
docs/quick_start/quick_start_with_beeline.md | 17 ++++++++++
docs/quick_start/quick_start_with_datagrip.md | 25 ++++++++++++---
docs/quick_start/quick_start_with_dbeaver.md | 17 ++++++++++
docs/quick_start/quick_start_with_hue.md | 17 ++++++++++
docs/quick_start/quick_start_with_jdbc.md | 17 ++++++++++
docs/quick_start/quick_start_with_jupyter.md | 17 ++++++++++
docs/security/authentication.md | 17 ++++++++++
docs/security/authorization.md | 17 ++++++++++
docs/security/index.rst | 15 +++++++++
docs/security/kinit.md | 16 ++++++++++
docs/sql/functions.md | 19 ++++++++++-
docs/sql/index.rst | 15 +++++++++
docs/sql/rules.md | 17 ++++++++++
docs/tools/index.rst | 15 +++++++++
docs/tools/spark_block_cleaner.md | 17 ++++++++++
.../spark/udf/KyuubiDefinedFunctionSuite.scala | 35 ++++++++++++++++++++-
.../kyuubi/config/AllKyuubiConfiguration.scala | 18 ++++++++++-
79 files changed, 1219 insertions(+), 37 deletions(-)
diff --git a/.gitattributes b/.gitattributes
index ab2435f..53be9d4 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,3 +1,20 @@
+#
+# 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.
+#
+
licenses-binary/* export-ignore
LICENSE-binary export-ignore
NOTICE-binary export-ignore
diff --git a/.gitignore b/.gitignore
index 15e48aa..624638b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,20 @@
+#
+# 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.
+#
+
*#*#
*.#*
*.iml
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 5f81802..671f292 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,3 +1,4 @@
+#
# 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.
@@ -12,6 +13,7 @@
# 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.
+#
version: 2
diff --git a/.travis.yml b/.travis.yml
index fe0c6f1..8dbcac0 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,3 +1,4 @@
+#
# 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.
@@ -12,6 +13,7 @@
# 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.
+#
sudo: required
diff --git a/README.md b/README.md
index 25c5033..e439732 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
[](https://www.apache.org/licenses/LICENSE-2.0.html)
diff --git a/_config.yml b/_config.yml
index a3fb8b6..50ee944 100644
--- a/_config.yml
+++ b/_config.yml
@@ -1,3 +1,4 @@
+#
# 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.
@@ -12,5 +13,6 @@
# 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.
+#
theme: jekyll-theme-leap-day
diff --git a/codecov.yml b/codecov.yml
index fdcad2e..6267ea3 100644
--- a/codecov.yml
+++ b/codecov.yml
@@ -1,3 +1,4 @@
+#
# 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.
@@ -12,6 +13,7 @@
# 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.
+#
codecov:
token: b624e642-b0c8-4d45-94a1-a370888435bb
diff --git a/docs/appendix/index.rst b/docs/appendix/index.rst
index 925eab5..ad54368 100644
--- a/docs/appendix/index.rst
+++ b/docs/appendix/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/appendix/terminology.md b/docs/appendix/terminology.md
index 421cab0..d83445a 100644
--- a/docs/appendix/terminology.md
+++ b/docs/appendix/terminology.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/client/hive_jdbc.md b/docs/client/hive_jdbc.md
index 5f0f7eb..bc6b456 100644
--- a/docs/client/hive_jdbc.md
+++ b/docs/client/hive_jdbc.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/client/index.rst b/docs/client/index.rst
index 272d581..615a4bf 100644
--- a/docs/client/index.rst
+++ b/docs/client/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/community/badges.md b/docs/community/badges.md
index 246db50..15b6954 100644
--- a/docs/community/badges.md
+++ b/docs/community/badges.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<script async defer src="https://buttons.github.io/buttons.js"></script>
# Community [](https://gitter.im/kyuubi-on-spark/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
diff --git a/docs/community/collaborators.md b/docs/community/collaborators.md
index 0ef4822..d424262 100644
--- a/docs/community/collaborators.md
+++ b/docs/community/collaborators.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Collaborators
[PPMC Members and Committers](https://people.apache.org/phonebook.html?podling=kyuubi)
diff --git a/docs/community/contributions.md b/docs/community/contributions.md
index 4b9fc83..cc3ff5d 100644
--- a/docs/community/contributions.md
+++ b/docs/community/contributions.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<script async defer src="https://buttons.github.io/buttons.js"></script>
# Contribution Guidelines
diff --git a/docs/community/improvement-proposals.md b/docs/community/improvement-proposals.md
index 7419082..e8f1aa5 100644
--- a/docs/community/improvement-proposals.md
+++ b/docs/community/improvement-proposals.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/community/index.rst b/docs/community/index.rst
index 09c26ef..e1dd2ef 100644
--- a/docs/community/index.rst
+++ b/docs/community/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/community/release.md b/docs/community/release.md
index f2e8553..ab05a60 100644
--- a/docs/community/release.md
+++ b/docs/community/release.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
Kyuubi Release Guide
===
@@ -105,9 +122,8 @@ https://www.apache.org/dev/openpgp.html#export-public-key
```shell
svn checkout --depth=files "https://dist.apache.org/repos/dist/dev/incubator/kyuubi" work/svn-kyuubi
-cd work/svn-kyuubi
-... edit svn-kyuubi/KEYS file
-svn commit --username "${ASF_USERNAME}" --password "${ASF_PASSWORD}" --message "Update KEYS"
+... edit work/svn-kyuubi/KEYS file
+svn commit --username "${ASF_USERNAME}" --password "${ASF_PASSWORD}" --message "Update KEYS" work/svn-kyuubi
```
## Cut branch iff for major release
@@ -193,7 +209,7 @@ After some time this will be sync’d to [Maven Central](https://search.maven.or
## Promote the release
-## Update Website
+### Update Website
TODO
diff --git a/docs/deployment/high_availability_guide.md b/docs/deployment/high_availability_guide.md
index 3e54aa6..14a89df 100644
--- a/docs/deployment/high_availability_guide.md
+++ b/docs/deployment/high_availability_guide.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Kyuubi High Availability Guide
As an enterprise-class ad-hoc SQL query service built on top of [Apache Spark](http://spark.apache.org/), Kyuubi takes high availability(HA) as a major characteristic, aiming to ensure an agreed level of service availability, such as a higher than normal period of uptime.
diff --git a/docs/deployment/hive_metastore.md b/docs/deployment/hive_metastore.md
index 861d77f..39a5ebd 100644
--- a/docs/deployment/hive_metastore.md
+++ b/docs/deployment/hive_metastore.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/deployment/index.rst b/docs/deployment/index.rst
index 18e4f77..12ebc16 100644
--- a/docs/deployment/index.rst
+++ b/docs/deployment/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/deployment/on_kubernetes.md b/docs/deployment/on_kubernetes.md
index 9042a83..594ee63 100644
--- a/docs/deployment/on_kubernetes.md
+++ b/docs/deployment/on_kubernetes.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/deployment/on_yarn.md b/docs/deployment/on_yarn.md
index d185259..89abff3 100644
--- a/docs/deployment/on_yarn.md
+++ b/docs/deployment/on_yarn.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md
index 394c46f..150b216 100644
--- a/docs/deployment/settings.md
+++ b/docs/deployment/settings.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY [org.apache.kyuubi.config.AllKyuubiConfiguration] -->
<div align=center>
diff --git a/docs/deployment/spark/aqe.md b/docs/deployment/spark/aqe.md
index c9fad8b..863afe2 100644
--- a/docs/deployment/spark/aqe.md
+++ b/docs/deployment/spark/aqe.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/deployment/spark/basics.md b/docs/deployment/spark/basics.md
index 560673f..541eb11 100644
--- a/docs/deployment/spark/basics.md
+++ b/docs/deployment/spark/basics.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
```properties
## Spark Configurations, they will override those in $SPARK_HOME/conf/spark-defaults.conf
## Dummy Ones
@@ -12,4 +29,4 @@
# spark.local.dir ./local
# spark.network.timeout 120s
# spark.cleaner.periodicGC.interval 10min
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/driver.md b/docs/deployment/spark/driver.md
index 8ac45f2..e715d87 100644
--- a/docs/deployment/spark/driver.md
+++ b/docs/deployment/spark/driver.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
```properties
## Spark Driver / AM Sizing
@@ -10,5 +26,4 @@
# spark.yarn.am.cores 4
# spark.yarn.am.memory 2g
# spark.yarn.am.memoryOverhead 1024
-
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/dynamic_allocation.md b/docs/deployment/spark/dynamic_allocation.md
index d544c7b..210078d 100644
--- a/docs/deployment/spark/dynamic_allocation.md
+++ b/docs/deployment/spark/dynamic_allocation.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/deployment/spark/dynamicpartitionpruning.md b/docs/deployment/spark/dynamicpartitionpruning.md
index 3e5befe..f113ea6 100644
--- a/docs/deployment/spark/dynamicpartitionpruning.md
+++ b/docs/deployment/spark/dynamicpartitionpruning.md
@@ -1,11 +1,25 @@
+<!--
+ - 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.
+ -->
## Dynamic Partition Pruning
```properties
-
# spark.sql.optimizer.dynamicPartitionPruning.enabled true
# spark.sql.optimizer.dynamicPartitionPruning.useStats true
# spark.sql.optimizer.dynamicPartitionPruning.fallbackFilterRatio 0.5
# spark.sql.optimizer.dynamicPartitionPruning.reuseBroadcastOnly true
-
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/ess.md b/docs/deployment/spark/ess.md
index 26b1995..0869817 100644
--- a/docs/deployment/spark/ess.md
+++ b/docs/deployment/spark/ess.md
@@ -1,7 +1,23 @@
+<!--
+ - 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.
+ -->
```properties
## External Shuffle Service
# spark.shuffle.service.enabled true
# spark.shuffle.service.fetch.rdd.enabled true
# spark.shuffle.service.port 7337
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/eventqueue.md b/docs/deployment/spark/eventqueue.md
index c48b5a8..82a0953 100644
--- a/docs/deployment/spark/eventqueue.md
+++ b/docs/deployment/spark/eventqueue.md
@@ -1,7 +1,22 @@
+<!--
+ - 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.
+ -->
## Event Queue Capacity
-
```properties
# spark.scheduler.revive.interval 1s
# spark.scheduler.listenerbus.eventqueue.capacity 100000
@@ -9,4 +24,4 @@
# spark.scheduler.listenerbus.eventqueue.appStatus.capacity 100000
# spark.scheduler.listenerbus.eventqueue.shared.capacity 100000
# spark.scheduler.listenerbus.eventqueue.eventLog.capacity 20000
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/executor.md b/docs/deployment/spark/executor.md
index d4cd728..ed8b725 100644
--- a/docs/deployment/spark/executor.md
+++ b/docs/deployment/spark/executor.md
@@ -1,10 +1,25 @@
+<!--
+ - 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.
+ -->
```properties
-
## Spark Executor Sizing
# spark.executor.instances 100
# spark.executor.cores 4
# spark.executor.memory 16g
# spark.executor.memoryOverhead 4096
# spark.executor.extraJavaOptions -XX:MaxDirectMemorySize=2048m
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/heartbeart.md b/docs/deployment/spark/heartbeart.md
index 7ae4a9e..f2c2e10 100644
--- a/docs/deployment/spark/heartbeart.md
+++ b/docs/deployment/spark/heartbeart.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
## Executor Heartbeat
@@ -5,4 +21,4 @@
# spark.storage.blockManagerHeartbeatTimeoutMs 300s
# spark.executor.heartbeatInterval 15s
# spark.executor.heartbeat.maxFailures 30
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/index.rst b/docs/deployment/spark/index.rst
index 545c03b..772d8b9 100644
--- a/docs/deployment/spark/index.rst
+++ b/docs/deployment/spark/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/deployment/spark/locality.md b/docs/deployment/spark/locality.md
index 37e3395..4d530fc 100644
--- a/docs/deployment/spark/locality.md
+++ b/docs/deployment/spark/locality.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
```properties
## Data Locality for Task Schedule
@@ -5,4 +21,4 @@
# spark.locality.wait.process 0s
# spark.locality.wait.node 0s
# spark.locality.wait.rack 0s
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/monitering.md b/docs/deployment/spark/monitering.md
index c76d507..1ca0d9b 100644
--- a/docs/deployment/spark/monitering.md
+++ b/docs/deployment/spark/monitering.md
@@ -1,8 +1,23 @@
-
+<!--
+ - 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.
+ -->
```properties
## Event Logging for History Server
- spark.eventLog.enabled true
+# spark.eventLog.enabled true
# spark.eventLog.dir hdfs://hadoop-dfs/history
# spark.eventLog.compress true
# spark.eventLog.longForm.enabled true
diff --git a/docs/deployment/spark/shuffle.md b/docs/deployment/spark/shuffle.md
index e46a860..87c1d63 100644
--- a/docs/deployment/spark/shuffle.md
+++ b/docs/deployment/spark/shuffle.md
@@ -1,6 +1,21 @@
+<!--
+ - 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.
+ -->
```properties
-
## Shuffle Behavior
# spark.shuffle.compress true
# spark.shuffle.detectCorrupt true
@@ -28,4 +43,4 @@
# spark.reducer.maxSizeInFlight 48m
# spark.reducer.maxReqsInFlight 256
# spark.reducer.maxBlocksInFlightPerAddress 256
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/speculation.md b/docs/deployment/spark/speculation.md
index 38094de..aeba043 100644
--- a/docs/deployment/spark/speculation.md
+++ b/docs/deployment/spark/speculation.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
```properties
## Speculation
@@ -6,4 +22,4 @@
# spark.speculation.multiplier 1.5
# spark.speculation.quantile 0.9
# spark.speculation.task.duration.threshold 10min
-```
\ No newline at end of file
+```
diff --git a/docs/deployment/spark/sql.md b/docs/deployment/spark/sql.md
index 219c22c..6e03ea3 100644
--- a/docs/deployment/spark/sql.md
+++ b/docs/deployment/spark/sql.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
```properties
## SQL
@@ -11,4 +27,4 @@
# spark.sql.parquet.filterPushdown true
# spark.sql.parquet.recordLevelFilter.enabled true
# spark.sql.statistics.fallBackToHdfs true
-```
\ No newline at end of file
+```
diff --git a/docs/develop_tools/build_document.md b/docs/develop_tools/build_document.md
index efa9fbb..5570953 100644
--- a/docs/develop_tools/build_document.md
+++ b/docs/develop_tools/build_document.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/develop_tools/building.md b/docs/develop_tools/building.md
index d692e50..e24ae97 100644
--- a/docs/develop_tools/building.md
+++ b/docs/develop_tools/building.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/develop_tools/debugging.md b/docs/develop_tools/debugging.md
index d78e90f..f240ee6 100644
--- a/docs/develop_tools/debugging.md
+++ b/docs/develop_tools/debugging.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/develop_tools/developer.md b/docs/develop_tools/developer.md
index 1a493cd..b6da278 100644
--- a/docs/develop_tools/developer.md
+++ b/docs/develop_tools/developer.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/develop_tools/distribution.md b/docs/develop_tools/distribution.md
index 2661337..02ad777 100644
--- a/docs/develop_tools/distribution.md
+++ b/docs/develop_tools/distribution.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/develop_tools/index.rst b/docs/develop_tools/index.rst
index a24103a..e266068 100644
--- a/docs/develop_tools/index.rst
+++ b/docs/develop_tools/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/develop_tools/testing.md b/docs/develop_tools/testing.md
index 945fc13..cf3b742 100644
--- a/docs/develop_tools/testing.md
+++ b/docs/develop_tools/testing.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/imgs/dataGrip/configuration.png b/docs/imgs/datagrip/configuration.png
similarity index 100%
rename from docs/imgs/dataGrip/configuration.png
rename to docs/imgs/datagrip/configuration.png
diff --git a/docs/imgs/dataGrip/datasource_and_driver.png b/docs/imgs/datagrip/datasource_and_driver.png
similarity index 100%
rename from docs/imgs/dataGrip/datasource_and_driver.png
rename to docs/imgs/datagrip/datasource_and_driver.png
diff --git a/docs/imgs/dataGrip/select_database.png b/docs/imgs/datagrip/select_database.png
similarity index 100%
rename from docs/imgs/dataGrip/select_database.png
rename to docs/imgs/datagrip/select_database.png
diff --git a/docs/imgs/dataGrip/workspace.png b/docs/imgs/datagrip/workspace.png
similarity index 100%
rename from docs/imgs/dataGrip/workspace.png
rename to docs/imgs/datagrip/workspace.png
diff --git a/docs/index.rst b/docs/index.rst
index 03dae70..e2ce17c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. Kyuubi documentation master file, created by
sphinx-quickstart on Wed Oct 28 14:23:28 2020.
You can adapt this file completely to your liking, but it should at least
diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst
index e6e681a..f6ad1a5 100644
--- a/docs/integrations/index.rst
+++ b/docs/integrations/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/integrations/kudu.md b/docs/integrations/kudu.md
index 928c880..860009c 100644
--- a/docs/integrations/kudu.md
+++ b/docs/integrations/kudu.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Kyuubi On Apache Kudu
## What is Apache Kudu
diff --git a/docs/monitor/index.rst b/docs/monitor/index.rst
index 87fc25a..215031c 100644
--- a/docs/monitor/index.rst
+++ b/docs/monitor/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/monitor/logging.md b/docs/monitor/logging.md
index 7443c73..cc62f91 100644
--- a/docs/monitor/logging.md
+++ b/docs/monitor/logging.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/monitor/metrics.md b/docs/monitor/metrics.md
index 29ea144..c07dc24 100644
--- a/docs/monitor/metrics.md
+++ b/docs/monitor/metrics.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Kyuubi Server Metrics
Kyuubi has a configurable metrics system based on the [Dropwizard Metrics Library](https://metrics.dropwizard.io/).
diff --git a/docs/monitor/trouble_shooting.md b/docs/monitor/trouble_shooting.md
index f552f6a..00f2748 100644
--- a/docs/monitor/trouble_shooting.md
+++ b/docs/monitor/trouble_shooting.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
@@ -8,7 +25,7 @@
## Common Issues
### java.lang.UnsupportedClassVersionError .. Unsupported major.minor version 52.0
-```java
+```
Exception in thread "main" java.lang.UnsupportedClassVersionError: org/apache/kyuubi/server/KyuubiServer : Unsupported major.minor version 52.0
at java.lang.ClassLoader.defineClass1(Native Method)
at java.lang.ClassLoader.defineClass(ClassLoader.java:803)
@@ -53,7 +70,7 @@ echo "export JAVA_HOME=/path/to/jdk1.8.0_251" >> conf/kyuubi-env.sh
### org.apache.spark.SparkException: When running with master 'yarn' either HADOOP_CONF_DIR or YARN_CONF_DIR must be set in the environment
-```java
+```
Exception in thread "main" org.apache.spark.SparkException: When running with master 'yarn' either HADOOP_CONF_DIR or YARN_CONF_DIR must be set in the environment.
at org.apache.spark.deploy.SparkSubmitArguments.error(SparkSubmitArguments.scala:630)
at org.apache.spark.deploy.SparkSubmitArguments.validateSubmitArguments(SparkSubmitArguments.scala:270)
@@ -81,7 +98,7 @@ echo "export HADOOP_CONF_DIR=/path/to/hadoop/conf" >> conf/kyuubi-env.sh
### org.apache.hadoop.security.AccessControlException: Permission denied: user=hzyanqin, access=WRITE, inode="/user":hdfs:hdfs:drwxr-xr-x
-```java
+```
org.apache.hadoop.security.AccessControlException: Permission denied: user=hzyanqin, access=WRITE, inode="/user":hdfs:hdfs:drwxr-xr-x
at org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.check(FSPermissionChecker.java:350)
at org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.checkPermission(FSPermissionChecker.java:251)
@@ -158,7 +175,7 @@ To fix this problem you need to create this directory first and grant ACL permis
### org.apache.thrift.TApplicationException: Invalid method name: 'get_table_req'
-```java
+```
Caused by: org.apache.thrift.TApplicationException: Invalid method name: 'get_table_req'
at org.apache.thrift.TServiceClient.receiveBase(TServiceClient.java:79)
at org.apache.hadoop.hive.metastore.api.ThriftHiveMetastore$Client.recv_get_table_req(ThriftHiveMetastore.java:1567)
@@ -189,7 +206,7 @@ To fix this problem you could use a compatible version for Hive client by config
### hive.server2.thrift.max.worker.threads
-```java
+```
Unexpected end of file when reading from HS2 server. The root cause might be too many concurrent connections. Please ask the administrator to check the number of active connections, and adjust hive.server2.thrift.max.worker.threads if applicable.
Error: org.apache.thrift.transport.TTransportException (state=08S01,code=0)
```
@@ -199,7 +216,7 @@ In Kyuubi, we should increase `kyuubi.frontend.min.worker.threads` instead of `h
### Failed to create function using jar
`CREATE TEMPORARY FUNCTION TEST AS 'com.netease.UDFTest' using jar 'hdfs:///tmp/udf.jar'`
-```java
+```
Error operating EXECUTE_STATEMENT: org.apache.spark.sql.AnalysisException: Can not load class 'com.netease.UDFTest' when registering the function 'test', please make sure it is on the classpath;
at org.apache.spark.sql.catalyst.catalog.SessionCatalog.$anonfun$registerFunction$1(SessionCatalog.scala:1336)
at scala.Option.getOrElse(Option.scala:189)
@@ -237,7 +254,7 @@ You should update JDK to JDK1.8.0_121 and later, since JDK1.8.0_121 fix a securi
### Failed to start Spark 3.1 with error msg 'Cannot modify the value of a Spark config'
Here is the error message
-```java
+```
Caused by: org.apache.spark.sql.AnalysisException: Cannot modify the value of a Spark config: spark.yarn.queue
at org.apache.spark.sql.RuntimeConfig.requireNonStaticConf(RuntimeConfig.scala:156)
at org.apache.spark.sql.RuntimeConfig.set(RuntimeConfig.scala:40)
diff --git a/docs/overview/architecture.md b/docs/overview/architecture.md
index e2b0a95..ccc52fe 100644
--- a/docs/overview/architecture.md
+++ b/docs/overview/architecture.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/overview/index.rst b/docs/overview/index.rst
index 90015e7..1dcaf11 100644
--- a/docs/overview/index.rst
+++ b/docs/overview/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi.png
:align: center
diff --git a/docs/overview/kyuubi_vs_hive.md b/docs/overview/kyuubi_vs_hive.md
index 320e247..c8c9b37 100644
--- a/docs/overview/kyuubi_vs_hive.md
+++ b/docs/overview/kyuubi_vs_hive.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Kyuubi v.s. HiveServer2
diff --git a/docs/overview/kyuubi_vs_thriftserver.md b/docs/overview/kyuubi_vs_thriftserver.md
index ee97f77..5f28477 100644
--- a/docs/overview/kyuubi_vs_thriftserver.md
+++ b/docs/overview/kyuubi_vs_thriftserver.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst
index 8b0b007..b536d3e 100644
--- a/docs/quick_start/index.rst
+++ b/docs/quick_start/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/quick_start/quick_start.md b/docs/quick_start/quick_start.md
index 0414f07..bc27c18 100644
--- a/docs/quick_start/quick_start.md
+++ b/docs/quick_start/quick_start.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<script async defer src="https://buttons.github.io/buttons.js"></script>
<div align=center>
diff --git a/docs/quick_start/quick_start_with_beeline.md b/docs/quick_start/quick_start_with_beeline.md
index d796c01..4967e52 100644
--- a/docs/quick_start/quick_start_with_beeline.md
+++ b/docs/quick_start/quick_start_with_beeline.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/quick_start/quick_start_with_datagrip.md b/docs/quick_start/quick_start_with_datagrip.md
index 18bd92f..d0a4226 100644
--- a/docs/quick_start/quick_start_with_datagrip.md
+++ b/docs/quick_start/quick_start_with_datagrip.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# Getting Started With Kyuubi and DataGrip
## What is DataGrip
[DataGrip](https://www.jetbrains.com/datagrip/) is a multi-engine database environment released by JetBrains, supporting MySQL and PostgreSQL, Microsoft SQL Server and Oracle, Sybase, DB2, SQLite, HyperSQL, Apache Derby, and H2.
@@ -15,11 +32,11 @@ After you install DataGrip, just launch it.
### Select Database
Substantially, this step is to choose a JDBC Driver type to use later. We can choose Apache Hive to set up a driver for Kyuubi.
-
+
### Datasource Driver
You should first download the missing driver files. Just click on the link below, DataGrip will download and install those.
-
+
### Generic JDBC Connection Settings
After install drivers, you should configure the right host and port which you can find in kyuubi server log. By default, we use `localhost` and `10009` to configure.
@@ -27,7 +44,7 @@ Of curse, you can fill other configs.
After generic configs, you can use test connection to test.
-
+
## Interacting With Kyuubi Server
Now, you can interact with Kyuubi server.
@@ -35,6 +52,6 @@ The left side of the photo is the table, and the right side of the photo is the
You can interact through the visual interface or code.
-
+
## The End
There are many other amazing features in both Kyuubi and DataGrip and here is just the tip of the iceberg. The rest is for you to discover.
\ No newline at end of file
diff --git a/docs/quick_start/quick_start_with_dbeaver.md b/docs/quick_start/quick_start_with_dbeaver.md
index 5e3236b..2383ddf 100644
--- a/docs/quick_start/quick_start_with_dbeaver.md
+++ b/docs/quick_start/quick_start_with_dbeaver.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/quick_start/quick_start_with_hue.md b/docs/quick_start/quick_start_with_hue.md
index 72c3590..29eca52 100644
--- a/docs/quick_start/quick_start_with_hue.md
+++ b/docs/quick_start/quick_start_with_hue.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/quick_start/quick_start_with_jdbc.md b/docs/quick_start/quick_start_with_jdbc.md
index e7e36f1..bc84098 100644
--- a/docs/quick_start/quick_start_with_jdbc.md
+++ b/docs/quick_start/quick_start_with_jdbc.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/quick_start/quick_start_with_jupyter.md b/docs/quick_start/quick_start_with_jupyter.md
index 0b5de87..242b623 100644
--- a/docs/quick_start/quick_start_with_jupyter.md
+++ b/docs/quick_start/quick_start_with_jupyter.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/security/authentication.md b/docs/security/authentication.md
index 19ee08f..2540e1e 100644
--- a/docs/security/authentication.md
+++ b/docs/security/authentication.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/docs/security/authorization.md b/docs/security/authorization.md
index b332ee7..1507808 100644
--- a/docs/security/authorization.md
+++ b/docs/security/authorization.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
# ACL Management Guide
- [Authorization Modes](#1)
diff --git a/docs/security/index.rst b/docs/security/index.rst
index 0348393..e8eacf9 100644
--- a/docs/security/index.rst
+++ b/docs/security/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/security/kinit.md b/docs/security/kinit.md
index 42ca1cf..6320d42 100644
--- a/docs/security/kinit.md
+++ b/docs/security/kinit.md
@@ -1,3 +1,19 @@
+<!--
+ - 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.
+ -->
<div align=center>
diff --git a/docs/sql/functions.md b/docs/sql/functions.md
index 0415e7b..cc6e19e 100644
--- a/docs/sql/functions.md
+++ b/docs/sql/functions.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY [org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite] -->
<div align=center>
@@ -8,7 +25,7 @@
# Auxiliary SQL Functions for Spark SQL
-Kyuubi provides several auxiliary SQL functions as supplement to Spark's [Built-in Functions](http://spark.apache.org/docs/latest/api/sql/index.html#built-in-functions)
+Kyuubi provides several auxiliary SQL functions as supplement to Spark's [Built-in Functions](https://spark.apache.org/docs/latest/api/sql/index.html#built-in-functions)
Name | Description | Return Type | Since
--- | --- | --- | ---
diff --git a/docs/sql/index.rst b/docs/sql/index.rst
index 8217677..70b45aa 100644
--- a/docs/sql/index.rst
+++ b/docs/sql/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/sql/rules.md b/docs/sql/rules.md
index b11491b..1b1e3f8 100644
--- a/docs/sql/rules.md
+++ b/docs/sql/rules.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY [org.apache.kyuubi.engine.spark.udf.KyuubiUDFRegistrySuite] -->
<div align=center>
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index 2e0b02e..eebaf6c 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -1,3 +1,18 @@
+.. 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.
+
.. image:: ../imgs/kyuubi_logo.png
:align: center
diff --git a/docs/tools/spark_block_cleaner.md b/docs/tools/spark_block_cleaner.md
index e4f2ce1..8514fa9 100644
--- a/docs/tools/spark_block_cleaner.md
+++ b/docs/tools/spark_block_cleaner.md
@@ -1,3 +1,20 @@
+<!--
+ - 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.
+ -->
+
<div align=center>
diff --git a/externals/kyuubi-spark-sql-engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala b/externals/kyuubi-spark-sql-engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala
index 0dd55dc..64b03d0 100644
--- a/externals/kyuubi-spark-sql-engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala
+++ b/externals/kyuubi-spark-sql-engine/src/test/scala/org/apache/kyuubi/engine/spark/udf/KyuubiDefinedFunctionSuite.scala
@@ -23,6 +23,22 @@ import scala.collection.mutable.ArrayBuffer
import org.apache.kyuubi.{KyuubiFunSuite, TestUtils}
+// scalastyle:off line.size.limit
+/**
+ * End-to-end test cases for configuration doc file
+ * The golden result file is "docs/sql/functions.md".
+ *
+ * To run the entire test suite:
+ * {{{
+ * build/mvn test -DwildcardSuites=org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite -pl '!externals/kyuubi-download'
+ * }}}
+ *
+ * To re-generate golden files for entire suite, run:
+ * {{{
+ * KYUUBI_UPDATE=1 build/mvn test -DwildcardSuites=org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite -pl '!externals/kyuubi-download'
+ * }}}
+ */
+// scalastyle:on line.size.limit
class KyuubiDefinedFunctionSuite extends KyuubiFunSuite {
private val kyuubiHome: String = getClass.getProtectionDomain.getCodeSource
@@ -32,6 +48,23 @@ class KyuubiDefinedFunctionSuite extends KyuubiFunSuite {
test("verify or update kyuubi spark sql functions") {
val newOutput = new ArrayBuffer[String]()
+ newOutput += "<!--"
+ newOutput += " - Licensed to the Apache Software Foundation (ASF) under one or more"
+ newOutput += " - contributor license agreements. See the NOTICE file distributed with"
+ newOutput += " - this work for additional information regarding copyright ownership."
+ newOutput += " - The ASF licenses this file to You under the Apache License, Version 2.0"
+ newOutput += " - (the \"License\"); you may not use this file except in compliance with"
+ newOutput += " - the License. You may obtain a copy of the License at"
+ newOutput += " -"
+ newOutput += " - http://www.apache.org/licenses/LICENSE-2.0"
+ newOutput += " -"
+ newOutput += " - Unless required by applicable law or agreed to in writing, software"
+ newOutput += " - distributed under the License is distributed on an \"AS IS\" BASIS,"
+ newOutput += " - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied."
+ newOutput += " - See the License for the specific language governing permissions and"
+ newOutput += " - limitations under the License."
+ newOutput += " -->"
+ newOutput += ""
newOutput += "<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY" +
" [org.apache.kyuubi.engine.spark.udf.KyuubiDefinedFunctionSuite] -->"
newOutput += ""
@@ -44,7 +77,7 @@ class KyuubiDefinedFunctionSuite extends KyuubiFunSuite {
newOutput += "# Auxiliary SQL Functions for Spark SQL"
newOutput += ""
newOutput += "Kyuubi provides several auxiliary SQL functions as supplement to Spark's " +
- "[Built-in Functions](http://spark.apache.org/docs/latest/api/sql/index.html#" +
+ "[Built-in Functions](https://spark.apache.org/docs/latest/api/sql/index.html#" +
"built-in-functions)"
newOutput += ""
newOutput += "Name | Description | Return Type | Since"
diff --git a/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala b/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala
index e5f9ca7..89b2f3c 100644
--- a/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala
+++ b/kyuubi-server/src/test/scala/org/apache/kyuubi/config/AllKyuubiConfiguration.scala
@@ -74,10 +74,26 @@ class AllKyuubiConfiguration extends KyuubiFunSuite {
ZookeeperConf
val newOutput = new ArrayBuffer[String]()
+ newOutput += "<!--"
+ newOutput += " - Licensed to the Apache Software Foundation (ASF) under one or more"
+ newOutput += " - contributor license agreements. See the NOTICE file distributed with"
+ newOutput += " - this work for additional information regarding copyright ownership."
+ newOutput += " - The ASF licenses this file to You under the Apache License, Version 2.0"
+ newOutput += " - (the \"License\"); you may not use this file except in compliance with"
+ newOutput += " - the License. You may obtain a copy of the License at"
+ newOutput += " -"
+ newOutput += " - http://www.apache.org/licenses/LICENSE-2.0"
+ newOutput += " -"
+ newOutput += " - Unless required by applicable law or agreed to in writing, software"
+ newOutput += " - distributed under the License is distributed on an \"AS IS\" BASIS,"
+ newOutput += " - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied."
+ newOutput += " - See the License for the specific language governing permissions and"
+ newOutput += " - limitations under the License."
+ newOutput += " -->"
+ newOutput += ""
newOutput += "<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS AUTO GENERATED BY" +
" [org.apache.kyuubi.config.AllKyuubiConfiguration] -->"
newOutput += ""
-
newOutput += "<div align=center>"
newOutput += ""
newOutput += ""