You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tez.apache.org by je...@apache.org on 2014/09/20 05:23:13 UTC
git commit: TEZ-1595. Document timeline server setup for use with the
Tez UI (jeagles)
Repository: tez
Updated Branches:
refs/heads/TEZ-8 cf3318e1b -> 78828f0c8
TEZ-1595. Document timeline server setup for use with the Tez UI (jeagles)
Project: http://git-wip-us.apache.org/repos/asf/tez/repo
Commit: http://git-wip-us.apache.org/repos/asf/tez/commit/78828f0c
Tree: http://git-wip-us.apache.org/repos/asf/tez/tree/78828f0c
Diff: http://git-wip-us.apache.org/repos/asf/tez/diff/78828f0c
Branch: refs/heads/TEZ-8
Commit: 78828f0c8de86fc6cca4fa03799ff49fd5c3b03b
Parents: cf3318e
Author: Jonathan Eagles <je...@gmail.com>
Authored: Fri Sep 19 22:22:54 2014 -0500
Committer: Jonathan Eagles <je...@gmail.com>
Committed: Fri Sep 19 22:22:54 2014 -0500
----------------------------------------------------------------------
CHANGES.txt | 2 +
docs/src/site/markdown/tez-ui.md | 103 ++++++++++++++++++++++++++++++++++
docs/src/site/site.xml | 1 +
3 files changed, 106 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tez/blob/78828f0c/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 5e2c2cd..8dabca0 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -21,6 +21,8 @@ ALL CHANGES:
TEZ-1581. GroupByOrderByMRRTest no longer functional.
TEZ-1563. TezClient.submitDAGSession alters DAG local resources regardless of DAG submission.
TEZ-1157. Optimize broadcast shuffle to download data only once per host.
+ TEZ-1594. Initial TezUI into TEZ-8 branch
+ TEZ-1595. Document timeline server setup for use with the Tez UI
Release 0.5.1: Unreleased
http://git-wip-us.apache.org/repos/asf/tez/blob/78828f0c/docs/src/site/markdown/tez-ui.md
----------------------------------------------------------------------
diff --git a/docs/src/site/markdown/tez-ui.md b/docs/src/site/markdown/tez-ui.md
new file mode 100644
index 0000000..70d57cf
--- /dev/null
+++ b/docs/src/site/markdown/tez-ui.md
@@ -0,0 +1,103 @@
+<!--
+ 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.
+-->
+
+<head><title>Tez UI</title></head>
+
+Tez UI Overview
+---------------
+
+The Tez UI relies on the _Application Timeline Server_ whose role is as a
+backing store for the application data generated during the lifetime of a
+YARN application.
+
+Tez provides its own UI that interfaces with the _Application Timeline Server_
+and displays both a live and historical view of the Tez application inside
+a Tez UI web application.
+
+Application Timeline Server Setup
+---------------------------------
+
+A minimal _yarn-site.xml_ configuration snippet is provided below. Replace
+localhost with the actual hostname if running in a distributed setup.
+
+```
+yarn-site.xml
+-------------
+...
+<property>
+ <description>Indicate to clients whether Timeline service is enabled or not.
+ If enabled, the TimelineClient library used by end-users will post entities
+ and events to the Timeline server.</description>
+ <name>yarn.timeline-service.enabled</name>
+ <value>true</value>
+</property>
+
+<property>
+ <description>The hostname of the Timeline service web application.</description>
+ <name>yarn.timeline-service.hostname</name>
+ <value>localhost</value>
+</property>
+
+<property>
+ <description>Enables cross-origin support (CORS) for web services where
+ cross-origin web response headers are needed. For example, javascript making
+ a web services request to the timeline server.</description>
+ <name>yarn.timeline-service.http-cross-origin.enabled</name>
+ <value>true</value>
+</property>
+...
+```
+
+[Detailed Application Timeline Server Configuration](http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/TimelineServer.html)
+
+```
+# Starting the Application Timeline Server
+$ $HADOOP_PREFIX/sbin/yarn-daemon.sh start timelineserver
+```
+
+Tez Setup
+---------
+
+A minimal _tez-site.xml_ configuration snippet is provided below
+
+```
+tez-site.xml
+-------------
+...
+<property>
+ <description>Log history using the Application Timeline Server</description>
+ <name>tez.history.logging.service.class</name>
+ <value>org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService</value>
+</property>
+...
+```
+
+Tez UI Install
+--------------
+
+Tez UI is currently under development and is targeted for the 0.6.0 release. A
+proof-of-concept Tez UI is available in the Tez UI feature branch TEZ-8.
+
+```
+$ git clone git://git.apache.org/tez.git
+$ cd tez
+$ git checkout TEZ-8
+
+# Navigate you web browser to file:///<tez git directory root>/tez-ui/original/login.html
+# Enter hostname to the Application Timeline Server hostname specified in yarn-site.xml
+# Enter port to the Application Timeline Server as 8188
+```
http://git-wip-us.apache.org/repos/asf/tez/blob/78828f0c/docs/src/site/site.xml
----------------------------------------------------------------------
diff --git a/docs/src/site/site.xml b/docs/src/site/site.xml
index a3d629c..e9f6906 100644
--- a/docs/src/site/site.xml
+++ b/docs/src/site/site.xml
@@ -100,6 +100,7 @@
<menu name="Documentation">
<item name="Install Guide" href="install.html"/>
<item name="Local Mode" href="localmode.html"/>
+ <item name="Tez UI" href="tez-ui.html"/>
</menu>
<menu name="Community">