doc init 2
This commit is contained in:
Kent Yao
parent
0abf85dcb7
commit
7fcad51d55
@ -1,6 +1,5 @@
|
||||
|
||||
Kyuubi Client Documentation
|
||||
===========================
|
||||
Client Documentation
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
11
docs/conf.py
11
docs/conf.py
@ -23,14 +23,12 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
import recommonmark
|
||||
from recommonmark.transform import AutoStructify
|
||||
from recommonmark.parser import CommonMarkParser
|
||||
source_parsers = {
|
||||
'.md': CommonMarkParser,
|
||||
}
|
||||
# source_parsers = {
|
||||
# '.md': CommonMarkParser,
|
||||
# }
|
||||
|
||||
source_suffix = ['.rst', '.md']
|
||||
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Kyuubi'
|
||||
@ -98,5 +96,6 @@ def setup(app):
|
||||
app.add_config_value('recommonmark_config', {
|
||||
'url_resolver': lambda url: github_doc_root + url,
|
||||
'auto_toc_tree_section': 'Contents',
|
||||
'enable_eval_rst': True,
|
||||
}, True)
|
||||
app.add_transform(AutoStructify)
|
||||
app.add_transform(AutoStructify)
|
||||
|
||||
@ -1 +0,0 @@
|
||||
.. image:: ha.png
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
Quick Start
|
||||
===========
|
||||
|
||||
@ -6,4 +5,4 @@ Quick Start
|
||||
:maxdepth: 2
|
||||
:numbered: 2
|
||||
|
||||
building
|
||||
building
|
||||
|
||||
@ -20,9 +20,7 @@ of HiveServer2, which can be found at [HiveServer2 Thrift API](https://cwiki.apa
|
||||
as the client-server communication mechanism, and a user session level `SparkContext` instantiating / registering / caching / recycling
|
||||
mechanism to implement multi-tenant functionality.
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 0.88" src="./imgs/kyuubi_architecture.png" />
|
||||
</div>
|
||||
|
||||
|
||||
<h2 id="1.1">Unified Interface</h2>
|
||||
|
||||
@ -113,9 +111,7 @@ spark.kyuubi.<br />ha.zk.namespace|kyuubiserver|The parent node in ZooKeeper use
|
||||
|
||||
Kyuubi's internal is very simple to understand, which is shown as the picture below. We may take about it more detailly later.
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="./imgs/kyuubi_internal.png" />
|
||||
</div>
|
||||
|
||||
|
||||
## Additional Documentations
|
||||
|
||||
|
||||
@ -12,9 +12,7 @@ service serving in YARN Container.
|
||||
|
||||
<h2 id="1">Service Model</h2>
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="./imgs/containerization.png" />
|
||||
</div>
|
||||
|
||||
|
||||
The above picture shows the whole architecture for Kyuubi containerization. The key concept is simple and obvious, which runs Kyuubi server as YARN container and serve the JDBC/ODBC client remotely. In such an deployment mode, we do not need to configure or even make some customizations for some complicated situations.
|
||||
|
||||
@ -61,15 +59,11 @@ $ bin/start-kyuubi.sh \
|
||||
|
||||
At last, a KYUUBI type YARN application named KYUUBI SERVER[version] will be created on the YARN cluster. If we go to the ResourceManager UI, we may see somme thing as follow,
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="./imgs/kyuubi_server_on_yarn.png" />
|
||||
</div>
|
||||
|
||||
|
||||
And also, the server log is available to look up through the ApplicationMaster page.
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="./imgs/kyuubi_server_on_yarn_log.png" />
|
||||
</div>
|
||||
|
||||
|
||||
## Additional Documentations
|
||||
[Building Kyuubi](https://yaooqinn.github.io/kyuubi/docs/building.html)
|
||||
|
||||
@ -20,9 +20,7 @@ The number of user concurrency and the size of your cluster may be two major ind
|
||||
|
||||
Load balancing aims to optimize all Kyuubi service units usage, maximize throughput, minimize response time, and avoid overload of a single unit. Using multiple Kyuubi service units with load balancing instead of a single unit may increase reliability and availability through redundancy.
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="../_images/ha.png" />
|
||||
</div>
|
||||
|
||||
|
||||
With Hive JDBC Driver, a client can specify service discovery mode in JDBC connection string, i.e. `serviceDiscoveryMode=zooKeeper;` and set `zooKeeperNameSpace=kyuubiserver;`, then it can randomly pick one of the Kyuubi service uris from the specified ZooKeeper address in the `/kyuubiserver` path.
|
||||
|
||||
@ -32,9 +30,7 @@ When we set `spark.kyuubi.ha.enabled` to `true`, load balance mode is activated
|
||||
|
||||
Active/Standby failover enables you to use a standby Kyuubi server to take over the functionality of a failed unit. When the active unit fails, it changes to the standby state after fixed while the standby unit changes to the active state.
|
||||
|
||||
<div style="text-align: center">
|
||||
<img style="zoom: 1.00" src="./imgs/ha_failover.png" />
|
||||
</div>
|
||||
|
||||
|
||||
A client need not to change any of its behaviours to support load balance or failover mode. But because only the active Kyuubi server will expose its service uri to ZooKeeper in `/kyuubiserver`, clients always randomly pick a server from one and the only choice.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Trouble Shooting
|
||||
|
||||
## Debugging Kyuubi
|
||||
```shell script
|
||||
```java
|
||||
KYUUBI_JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 bin/kyuubi.sh start
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user