You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ul...@apache.org on 2021/10/22 06:24:45 UTC
[incubator-kyuubi] branch branch-1.3 updated: [KYUUBI #1269] Online
documentation section in the readme is outdated
This is an automated email from the ASF dual-hosted git repository.
ulyssesyou pushed a commit to branch branch-1.3
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git
The following commit(s) were added to refs/heads/branch-1.3 by this push:
new 6fd60fd [KYUUBI #1269] Online documentation section in the readme is outdated
6fd60fd is described below
commit 6fd60fd9c275eed6ae129abc3382e73baadb39f6
Author: ulysses-you <ul...@gmail.com>
AuthorDate: Fri Oct 22 14:22:46 2021 +0800
[KYUUBI #1269] Online documentation section in the readme is outdated
<!--
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 ...'.
-->
<!--
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.
-->
Closes https://github.com/apache/incubator-kyuubi/issues/1269
docs only
Closes #1270 from ulysses-you/kyuubi#1269.
Closes #1269
1cb99ef5 [ulysses-you] address comment
7a597e66 [ulysses-you] address comment
4b15c2c9 [ulysses-you] Online documentation section in the readme is outdated
Authored-by: ulysses-you <ul...@gmail.com>
Signed-off-by: ulysses-you <ul...@apache.org>
(cherry picked from commit 936a532d2e3a4c0de5a56335650e59608b829cfd)
Signed-off-by: ulysses-you <ul...@apache.org>
---
README.md | 21 ++---
conf/kyuubi-defaults.conf.template | 2 +-
docs/community/contributions.md | 4 +-
docs/deployment/settings.md | 2 +-
docs/quick_start/quick_start_with_datagrip.md | 57 -------------
docs/quick_start/quick_start_with_helm.md | 111 ++++++++++++++++++++++++++
6 files changed, 123 insertions(+), 74 deletions(-)
diff --git a/README.md b/README.md
index e439732..dfa2d3a 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
[](https://codecov.io/gh/apache/incubator-kyuubi)
[](https://travis-ci.com/apache/incubator-kyuubi)
-[](https://kyuubi.apache.org/?badge=latest)
+[](https://kyuubi.apache.org/docs/latest/)
## What is Kyuubi?
@@ -93,29 +93,24 @@ The figure below shows our vision for the Kyuubi Ecosystem. Some of them have be
## Online Documentation
-Since Kyuubi 1.0.0, the Kyuubi online documentation is hosted by [https://readthedocs.org/](https://readthedocs.org/).
+Since Kyuubi 1.3.0-incubating, the Kyuubi online documentation is hosted by [https://kyuubi.apache.org/](https://kyuubi.apache.org/docs/latest/).
You can find the specific version of Kyuubi documentation as listed below.
-- [master/latest](https://kyuubi.readthedocs.io/en/latest/)
-- [stable](https://kyuubi.readthedocs.io/en/stable/)
-- [v1.1.0](https://kyuubi.readthedocs.io/en/v1.1.0/)
-- [v1.0.3](https://kyuubi.readthedocs.io/en/v1.0.3/)
-- [v1.0.2](https://kyuubi.readthedocs.io/en/v1.0.2/)
-- [v1.0.1](https://kyuubi.readthedocs.io/en/v1.0.1/)
-- [v1.0.0](https://kyuubi.readthedocs.io/en/v1.0.0/)
+- [1.3.0-incubating](https://kyuubi.apache.org/docs/r1.3.0-incubating/)
+- [stable](https://kyuubi.apache.org/docs/stable/)
-For 0.8 and earlier versions, please check the [Github Pages](https://apache.github.io/incubator-kyuubi/) directly.
+For 1.2 and earlier versions, please check the [Github Pages](https://kyuubi.readthedocs.io/en/v1.2.0/) directly.
## Quick Start
-Ready? [Getting Started](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html) with Kyuubi.
+Ready? [Getting Started](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html) with Kyuubi.
## Contributing
All bits of help are welcome. You can make various types of contributions to Kyuubi, including the following but not limited to,
- Help new users in chat channel or share your success stories with us - [](https://gitter.im/kyuubi-on-spark/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-- Improve Documentation - [](https://kyuubi.readthedocs.io/en/latest/?badge=latest)
+- Improve Documentation - [](https://kyuubi.apache.org/docs/latest/)
- Test releases - [](https://github.com/apache/incubator-kyuubi//releases)
- Improve test coverage - [](https://codecov.io/gh/apache/incubator-kyuubi)
- Report bugs and better help developers to reproduce
@@ -124,7 +119,7 @@ All bits of help are welcome. You can make various types of contributions to Kyu
- Promote to others
- Click the star button if you like this project
-Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.readthedocs.io/en/latest/community/contributions.html) first.
+Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.apache.org/docs/latest/community/contributions.html) first.
## Aside
diff --git a/conf/kyuubi-defaults.conf.template b/conf/kyuubi-defaults.conf.template
index 7f65a69..5a4b9b2 100644
--- a/conf/kyuubi-defaults.conf.template
+++ b/conf/kyuubi-defaults.conf.template
@@ -23,4 +23,4 @@
# kyuubi.frontend.bind.port 10009
#
-# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
+# Details in https://kyuubi.apache.org/docs/latest/deployment/settings.html
diff --git a/docs/community/contributions.md b/docs/community/contributions.md
index cc3ff5d..79a2b1b 100644
--- a/docs/community/contributions.md
+++ b/docs/community/contributions.md
@@ -54,7 +54,7 @@ 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
+ https://kyuubi.apache.org/docs/latest/community/contributions.html
-->
### _Which issue are you going to fix?_
@@ -79,6 +79,6 @@ Please clarify why the changes are needed. For instance,
- [ ] 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
+- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
```
diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md
index 1ce18f6..c3aa472 100644
--- a/docs/deployment/settings.md
+++ b/docs/deployment/settings.md
@@ -114,7 +114,7 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co
# kyuubi.frontend.bind.port 10009
#
-# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
+# Details in https://kyuubi.apache.org/docs/latest/deployment/settings.html
```
### Authentication
diff --git a/docs/quick_start/quick_start_with_datagrip.md b/docs/quick_start/quick_start_with_datagrip.md
deleted file mode 100644
index d0a4226..0000000
--- a/docs/quick_start/quick_start_with_datagrip.md
+++ /dev/null
@@ -1,57 +0,0 @@
-<!--
- - 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.
-
-## Preparation
-### Get DataGrip And Install
-Please go to [Download DataGrip](https://www.jetbrains.com/datagrip/download) to get and install an appropriate version for yourself.
-### Get Kyuubi Started
-[Get kyuubi server started](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html) before you try DataGrip with kyuubi.
-
-For debugging purpose, you can use `tail -f` or `tailf` to track the server log.
-## Configurations
-### Start DataGrip
-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.
-
-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.
-
-The left side of the photo is the table, and the right side of the photo is the console.
-
-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_helm.md b/docs/quick_start/quick_start_with_helm.md
new file mode 100644
index 0000000..cf4c6f2
--- /dev/null
+++ b/docs/quick_start/quick_start_with_helm.md
@@ -0,0 +1,111 @@
+<!--
+ - 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>
+
+
+
+</div>
+
+# Getting Started With Kyuubi on kubernetes
+
+## Running kyuubi with helm
+
+[Helm](https://helm.sh/) is the package manager for Kubernetes，it can be used to find, share, and use software built for Kubernetes.
+
+### Get helm and Install
+
+Please go to [Install Helm](https://helm.sh/docs/intro/install/) page to get and install an appropriate release version for yourself.
+
+### Get Kyuubi Started
+
+#### [Optional] Create namespace on kubernetes
+```bash
+cretate ns kyuubi
+```
+
+#### Get kyuubi started
+```bash
+helm install kyuubi-helm ${KYUUBI_HOME}/docker/helm -n ${namespace_name}
+```
+It will print variables and the way to get kyuubi expose ip and port
+```bash
+NAME: kyuubi-helm
+LAST DEPLOYED: Wed Oct 20 15:22:47 2021
+NAMESPACE: kyuubi
+STATUS: deployed
+REVISION: 1
+TEST SUITE: None
+NOTES:
+Get kyuubi expose URL by running these commands:
+ export NODE_PORT=$(kubectl get --namespace kyuubi -o jsonpath="{.spec.ports[0].nodePort}" services kyuubi-helm-nodeport)
+ export NODE_IP=$(kubectl get nodes --namespace kyuubi -o jsonpath="{.items[0].status.addresses[0].address}")
+ echo $NODE_IP:$NODE_PORT
+```
+
+#### Using hive beeline
+[Using Hive Beeline](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html#using-hive-beeline) to opening a connection.
+
+#### Remove kyuubi
+```bash
+helm uninstall kyuubi-helm -n ${namespace_name}
+```
+
+#### Edit server config
+
+Modify `values.yaml` under `${KYUUBI_HOME}/docker/helm`
+```yaml
+# Kyuubi server numbers
+replicaCount: 2
+
+image:
+ repository: apache/kyuubi
+ pullPolicy: Always
+ # Overrides the image tag whose default is the chart appVersion.
+ tag: "master-snapshot"
+
+server:
+ bind:
+ host: 0.0.0.0
+ port: 10009
+ conf:
+ mountPath: /opt/kyuubi/conf
+
+service:
+ type: NodePort
+ # The default port limit of kubernetes is 30000-32767
+ # to change:
+ # vim kube-apiserver.yaml (usually under path: /etc/kubernetes/manifests/)
+ # add or change line 'service-node-port-range=1-32767' under kube-apiserver
+ port: 30009
+```
+
+#### Get server log
+List all server pods:
+```bash
+kubectl get po -n ${namespace_name}
+```
+The server pods will print:
+```text
+NAME READY STATUS RESTARTS AGE
+kyuubi-server-585d8944c5-m7j5s 1/1 Running 0 30m
+kyuubi-server-32sdsa1245-2d2sj 1/1 Running 0 30m
+```
+then, use pod name to get logs
+```bash
+kubectl -n ${namespace_name} logs kyuubi-server-585d8944c5-m7j5s
+```