You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by lu...@apache.org on 2015/06/02 12:26:06 UTC
[12/49] incubator-kylin git commit: update website structure and
content
update website structure and content
Signed-off-by: Luke Han <lu...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/incubator-kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-kylin/commit/d1b8e50f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-kylin/tree/d1b8e50f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-kylin/diff/d1b8e50f
Branch: refs/heads/0.7.1
Commit: d1b8e50f064ee214f41a3e628abb018a9a9dd6e6
Parents: 69dda1d
Author: Luwei Chen <ch...@hotmail.com>
Authored: Wed May 27 18:18:28 2015 +0800
Committer: Luke Han <lu...@apache.org>
Committed: Wed May 27 18:51:02 2015 +0800
----------------------------------------------------------------------
docs/website/_includes/navside.html | 92 +
docs/website/_layouts/docs.html | 48 +
.../2014-12-31-Build-Cube-with-Restful-API.md | 57 +
.../API/2015-03-18-Restful-Service-Doc.md | 2042 ++++++++++++++++++
...05-18-FAQ-on-Kylin-Installation-and-Usage.md | 46 +
.../2014-10-23-Kylin-web-front-end-summary.md | 47 +
.../How to/2014-10-24-How-to-Contribute.md | 52 +
...w to install kylin in your Hadoop cluster.md | 54 +
.../2014-12-09-New-meta-data-model-structure.md | 31 +
...n-Kylin-test-case-with-HBase-Mini-Cluster.md | 23 +
...w-to-consume-Kylin-REST-API-in-javascript.md | 49 +
.../How to/2015-03-05-Kylin-Metadata-Store.md | 47 +
...03-18-How-to-use-kylin-remote-jdbc-driver.md | 93 +
.../2015-05-18-Export-Kylin-HBase-data.md | 25 +
...On-Hadoop-Kylin-installation-using-Docker.md | 44 +
...-22-Advance-settings-of-Kylin-environment.md | 37 +
...015-01-22-Kylin-Manual-Installation-Guide.md | 62 +
...f-Hadoop-CLI-Installation-(Dev-Env-Setup).md | 96 +
.../2015-03-13-On-Hadoop-CLI-installation.md | 149 ++
.../2014-11-05-Kylin-Cube-Creation-Tutorial.md | 127 ++
.../2014-11-05-Kylin-ODBC-Driver-Tutorial.md | 34 +
...in-Cube-Build-and-Job-Monitoring-Tutorial.md | 65 +
...1-11-Kylin-Cube-Permission-Grant-Tutorial.md | 32 +
.../Tutorial/2015-04-17-Kylin-Web-Tutorial.md | 138 ++
.../2015-04-17-Kylin-and-Tableau-Tutorial.md | 113 +
docs/website/_posts/Tutorial/2015-05-25-test~ | 28 +
.../blog/2015-01-25-introduce-data-model.md | 40 +
docs/website/assets/css/docs.css | 106 +
docs/website/assets/css/pygments.css | 61 +
docs/website/blog/index.html | 64 +
docs/website/blog/index.html~ | 64 +
docs/website/blog/index.md~ | 43 +
docs/website/community/index.html | 83 +
docs/website/community/index.html~ | 83 +
docs/website/docs/index.html | 108 +
docs/website/docs/index.html~ | 109 +
docs/website/docs/installation-content.html | 34 +
docs/website/docs/installation-content.html~ | 34 +
docs/website/docs/intro-content.html | 72 +
docs/website/docs/intro-content.html~ | 72 +
.../1 action-build.png | Bin 0 -> 93893 bytes
.../2 pop-up.png | Bin 0 -> 40055 bytes
.../3 end-date.png | Bin 0 -> 66610 bytes
.../4 submit.png | Bin 0 -> 36292 bytes
.../4.1 success.png | Bin 0 -> 14426 bytes
.../5 jobs-page.png | Bin 0 -> 96398 bytes
.../6 discard.png | Bin 0 -> 55747 bytes
.../7 job-steps.png | Bin 0 -> 157315 bytes
.../8 hover-step.png | Bin 0 -> 90405 bytes
.../9 log-d.png | Bin 0 -> 85634 bytes
.../9 log.png | Bin 0 -> 42840 bytes
.../9 mrjob-d.png | Bin 0 -> 197651 bytes
.../9 mrjob.png | Bin 0 -> 43079 bytes
.../9 parameters-d.png | Bin 0 -> 102501 bytes
.../9 parameters.png | Bin 0 -> 43674 bytes
.../1 manage-prject.png | Bin 0 -> 44662 bytes
.../Kylin-Cube-Creation-Tutorial/10 filter.png | Bin 0 -> 71620 bytes
.../11 refresh-setting1.png | Bin 0 -> 125565 bytes
.../11 refresh-setting2.png | Bin 0 -> 94895 bytes
.../12 advanced.png | Bin 0 -> 63237 bytes
.../13 overview.png | Bin 0 -> 59024 bytes
.../Kylin-Cube-Creation-Tutorial/2 +project.png | Bin 0 -> 57637 bytes
.../3 new-project.png | Bin 0 -> 35511 bytes
.../3.1 pj-created.png | Bin 0 -> 13207 bytes
.../Kylin-Cube-Creation-Tutorial/4 +table.png | Bin 0 -> 58675 bytes
.../5 hive-table.png | Bin 0 -> 29548 bytes
.../Kylin-Cube-Creation-Tutorial/6 +cube.png | Bin 0 -> 79558 bytes
.../7 cube-info.png | Bin 0 -> 159724 bytes
.../Kylin-Cube-Creation-Tutorial/8 dim-+dim.png | Bin 0 -> 56207 bytes
.../Kylin-Cube-Creation-Tutorial/8 dim-edit.png | Bin 0 -> 95337 bytes
.../8 dim-factable.png | Bin 0 -> 68022 bytes
.../8 dim-typeA.png | Bin 0 -> 61561 bytes
.../8 dim-typeB-1.png | Bin 0 -> 54939 bytes
.../8 dim-typeB-2.png | Bin 0 -> 50999 bytes
.../8 dim-typeC.png | Bin 0 -> 62033 bytes
.../8 dim-typeD.png | Bin 0 -> 54444 bytes
.../9 meas-+meas.png | Bin 0 -> 49541 bytes
.../9 meas-count.png | Bin 0 -> 49857 bytes
.../9 meas-distinct.png | Bin 0 -> 57420 bytes
.../Kylin-Cube-Creation-Tutorial/9 meas-max.png | Bin 0 -> 51820 bytes
.../Kylin-Cube-Creation-Tutorial/9 meas-min.png | Bin 0 -> 47379 bytes
.../Kylin-Cube-Creation-Tutorial/9 meas-sum.png | Bin 0 -> 44017 bytes
.../14 +grant.png | Bin 0 -> 96078 bytes
.../15 grantInfo.png | Bin 0 -> 131013 bytes
.../16 grant-user.png | Bin 0 -> 70868 bytes
.../16 user-update.png | Bin 0 -> 74230 bytes
.../images/Kylin-Web-Tutorial/1 login.png | Bin 0 -> 19030 bytes
.../Kylin-Web-Tutorial/10 query-result.png | Bin 0 -> 229099 bytes
.../Kylin-Web-Tutorial/11 save-query-2.png | Bin 0 -> 217907 bytes
.../images/Kylin-Web-Tutorial/11 save-query.png | Bin 0 -> 29373 bytes
.../images/Kylin-Web-Tutorial/12 general.png | Bin 0 -> 32194 bytes
.../images/Kylin-Web-Tutorial/13 results.png | Bin 0 -> 77124 bytes
.../images/Kylin-Web-Tutorial/14 drag.png | Bin 0 -> 81057 bytes
.../images/Kylin-Web-Tutorial/15 bar-chart.png | Bin 0 -> 79660 bytes
.../images/Kylin-Web-Tutorial/16 pie-chart.png | Bin 0 -> 91917 bytes
.../images/Kylin-Web-Tutorial/17 line-chart.png | Bin 0 -> 83227 bytes
.../images/Kylin-Web-Tutorial/2 tables.png | Bin 0 -> 131629 bytes
.../images/Kylin-Web-Tutorial/3 cubes.png | Bin 0 -> 106631 bytes
.../images/Kylin-Web-Tutorial/4 form-view.png | Bin 0 -> 106172 bytes
.../images/Kylin-Web-Tutorial/5 sql-view.png | Bin 0 -> 111612 bytes
.../Kylin-Web-Tutorial/6 visualization.png | Bin 0 -> 73256 bytes
.../images/Kylin-Web-Tutorial/7 access.png | Bin 0 -> 63248 bytes
.../images/Kylin-Web-Tutorial/7 job-steps.png | Bin 0 -> 157315 bytes
.../images/Kylin-Web-Tutorial/8 query.png | Bin 0 -> 86323 bytes
.../images/Kylin-Web-Tutorial/9 query-table.png | Bin 0 -> 106686 bytes
.../Kylin-and-Tableau-Tutorial/1 odbc.png | Bin 0 -> 77143 bytes
.../10 connectLive.jpg | Bin 0 -> 36887 bytes
.../Kylin-and-Tableau-Tutorial/11 analysis.jpg | Bin 0 -> 109334 bytes
.../12 edit tables.jpg | Bin 0 -> 87229 bytes
.../Kylin-and-Tableau-Tutorial/13 visual.jpg | Bin 0 -> 170415 bytes
.../Kylin-and-Tableau-Tutorial/14 publish.jpg | Bin 0 -> 93989 bytes
.../16 prepare-publish.png | Bin 0 -> 19791 bytes
.../17 embedded-pwd.png | Bin 0 -> 12464 bytes
.../18 groupby-folder.jpg | Bin 0 -> 112470 bytes
.../Kylin-and-Tableau-Tutorial/19 custom.jpg | Bin 0 -> 57976 bytes
.../Kylin-and-Tableau-Tutorial/2 serverhost.jpg | Bin 0 -> 50146 bytes
.../Kylin-and-Tableau-Tutorial/3 project.jpg | Bin 0 -> 50594 bytes
.../Kylin-and-Tableau-Tutorial/4 done.jpg | Bin 0 -> 48155 bytes
.../5 multipleTable.jpg | Bin 0 -> 65831 bytes
.../Kylin-and-Tableau-Tutorial/6 facttable.jpg | Bin 0 -> 58203 bytes
.../Kylin-and-Tableau-Tutorial/6 facttable2.jpg | Bin 0 -> 58269 bytes
.../Kylin-and-Tableau-Tutorial/7 lkptable.jpg | Bin 0 -> 61669 bytes
.../Kylin-and-Tableau-Tutorial/8 join.jpg | Bin 0 -> 67952 bytes
.../Kylin-and-Tableau-Tutorial/9 connName.jpg | Bin 0 -> 82397 bytes
.../On-Hadoop-CLI-installation/Picture1.png | Bin 0 -> 53722 bytes
.../On-Hadoop-CLI-installation/Picture2.png | Bin 0 -> 72567 bytes
.../images/On-Hadoop-CLI-installation/cube.png | Bin 0 -> 151306 bytes
.../installation.pptx | Bin 0 -> 83098 bytes
.../images/On-Hadoop-CLI-installation/job.png | Bin 0 -> 226745 bytes
.../images/On-Hadoop-CLI-installation/query.png | Bin 0 -> 112305 bytes
.../On-Hadoop-CLI-installation/starthbase.png | Bin 0 -> 210066 bytes
131 files changed, 4604 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/d1b8e50f/docs/website/_includes/navside.html
----------------------------------------------------------------------
diff --git a/docs/website/_includes/navside.html b/docs/website/_includes/navside.html
new file mode 100755
index 0000000..058659a
--- /dev/null
+++ b/docs/website/_includes/navside.html
@@ -0,0 +1,92 @@
+<!--
+* 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 class="col-md-3 col-lg-3 col-xs-4 aside1 visible-md visible-lg">
+ <ul class="nav nav-pills nav-stacked">
+ {% for category in site.categories %} <!-- categories -->
+ {% if category[0] == 'installation' %}
+ <li><a href="#{{ category | first }}" data-toggle="collapse" >Installation</a></li>
+ <div class="collapse in" id="{{ category[0] }}">
+ <div class="list-group">
+ <ul style="list-style-type:disc">
+ {% for post in category[1] %}
+ <li><a href="{{ post.url }}" class="list-group-item-lay pjaxlink">{{post.title}}</a></li>
+ {% endfor %}
+ <ul>
+ </div>
+ </div>
+ {% endif %}
+ {% endfor %}
+ {% for category in site.categories %}
+ {% if category[0] == 'tutorial' %}
+ <li><a href="#{{ category | first }}" data-toggle="collapse" >Tutorial</a></li>
+ <div class="collapse in" id="{{ category[0] }}">
+ <div class="list-group">
+ <ul style="list-style-type:disc">
+ {% for post in category[1] %}
+ <li><a href="{{ post.url }}" class="list-group-item-lay pjaxlink">{{post.title}}</a></li>
+ {% endfor %}
+ <ul>
+ </div>
+ </div>
+ {% endif %}
+ {% for category in site.categories %}
+ {% endfor %}
+ {% if category[0] == 'howto' %}
+ <li><a href="#{{ category | first }}" data-toggle="collapse" >How to</a></li>
+ <div class="collapse in" id="{{ category[0] }}">
+ <div class="list-group">
+ <ul style="list-style-type:disc">
+ {% for post in category[1] %}
+ <li><a href="{{ post.url }}" class="list-group-item-lay pjaxlink">{{post.title}}</a></li>
+ {% endfor %}
+ <ul>
+ </div>
+ </div>
+ {% endif %}
+ {% endfor %}
+ {% for category in site.categories %}
+ {% if category[0] == 'api' %}
+ <li><a href="#{{ category | first }}" data-toggle="collapse" >API</a></li>
+ <div class="collapse in" id="{{ category[0] }}">
+ <div class="list-group">
+ <ul style="list-style-type:disc">
+ {% for post in category[1] %}
+ <li><a href="{{ post.url }}" class="list-group-item-lay pjaxlink">{{post.title}}</a></li>
+ {% endfor %}
+ <ul>
+ </div>
+ </div>
+ {% endif %}
+ {% endfor %}
+ {% for category in site.categories %}
+ {% if category[0] == 'faq' %}
+ <li><a href="#{{ category | first }}" data-toggle="collapse" >FAQ</a></li>
+ <div class="collapse in" id="{{ category[0] }}">
+ <div class="list-group">
+ <ul style="list-style-type:disc">
+ {% for post in category[1] %}
+ <li><a href="{{ post.url }}" class="list-group-item-lay pjaxlink">{{post.title}}</a></li>
+ {% endfor %}
+ <ul>
+ </div>
+ </div>
+ {% endif %}
+ {% endfor %}
+ </ul>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/d1b8e50f/docs/website/_layouts/docs.html
----------------------------------------------------------------------
diff --git a/docs/website/_layouts/docs.html b/docs/website/_layouts/docs.html
new file mode 100755
index 0000000..d5b00d9
--- /dev/null
+++ b/docs/website/_layouts/docs.html
@@ -0,0 +1,48 @@
+<!--
+* 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.
+-->
+
+<!doctype html>
+<html>
+ {% include head.html %}
+ <body>
+ {% include header.html %}
+ <div class="page-content">
+ <header style=" padding:2em 0 0 0">
+ <div class="container" >
+ <h4 class="section-title"><span>Kylin Docs</span></h4>
+ </div>
+ </div>
+ <div class="container">
+ <div class="row">
+ {% include navside.html %}
+ <div class="col-md-9 col-lg-9 col-xs-14 aside2">
+ <div id="container">
+ <div id="pjax">
+ {{ content }}
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ {% include footer.html %}
+
+ <script src="/assets/js/jquery-1.9.1.min.js"></script>
+ <script src="/assets/js/bootstrap.min.js"></script>
+ <script src="/assets/js/main.js"></script>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-kylin/blob/d1b8e50f/docs/website/_posts/API/2014-12-31-Build-Cube-with-Restful-API.md
----------------------------------------------------------------------
diff --git a/docs/website/_posts/API/2014-12-31-Build-Cube-with-Restful-API.md b/docs/website/_posts/API/2014-12-31-Build-Cube-with-Restful-API.md
new file mode 100644
index 0000000..6e7e34f
--- /dev/null
+++ b/docs/website/_posts/API/2014-12-31-Build-Cube-with-Restful-API.md
@@ -0,0 +1,57 @@
+---
+layout: post
+title: "Build Cube with Restful API"
+date: 2014-12-31
+author: liyang-gmt8
+categories: api
+---
+
+### 1. Authentication
+* Currently, Kylin uses [basic authentication](http://en.wikipedia.org/wiki/Basic_access_authentication).
+* Add `Authorization` header to first request for authentication
+* Or you can do a specific request by `POST http://localhost:7070/kylin/api/user/authentication`
+* Once authenticated, client can go subsequent requests with cookies.
+* Example
+{% highlight Groff markup %}
+ POST http://localhost:7070/kylin/api/user/authentication
+
+ Authorization:Basic xxxxJD124xxxGFxxxSDF
+ Content-Type: application/json;charset=UTF-8
+{% endhighlight %}
+
+### 2. Get details of cube.
+* `GET http://localhost:7070/kylin/api/cubes?cubeName={cube_name}&limit=15&offset=0`
+* Client can find cube segment date ranges in returned cube detail.
+* Example
+{% highlight Groff markup %}
+ GET http://localhost:7070/kylin/api/cubes?cubeName=test_kylin_cube_with_slr&limit=15&offset=0
+
+ Authorization:Basic xxxxJD124xxxGFxxxSDF
+ Content-Type: application/json;charset=UTF-8
+{% endhighlight %}
+### 3. Then submit a build job of the cube.
+* `PUT http://localhost:7070/kylin/api/cubes/{cube_name}/rebuild`
+* For put request body detail please refer to [service doc](https://github.com/KylinOLAP/Kylin/wiki/Restful-Service-Doc).
+ * `startTime` and `endTime` should be utc timestamp.
+ * `buildType` can be `BUILD` or `MERGE`. `BUILD` is for building a new segment or refreshing an existing segment. `MERGE` is for merging multiple existing segments into one bigger segment.
+* This method will return a newly created job instance, in which the uuid is the identity of job to track job status.
+* Example
+{% highlight Groff markup %}
+ PUT http://localhost:7070/kylin/api/cubes/test_kylin_cube_with_slr/rebuild
+
+ Authorization:Basic xxxxJD124xxxGFxxxSDF
+ Content-Type: application/json;charset=UTF-8
+
+ {
+ "startTime": 0,
+ "endTime": 1388563200000,
+ "buildType": "BUILD"
+ }
+{% endhighlight %}
+
+### 4. Track job status.
+* `GET http://localhost:7070/kylin/api/jobs/{job_uuid}`
+* Returned `job_status` represents current status of job.
+
+### 5. If the job failed, you can resume the job.
+* `PUT http://localhost:7070/kylin/api/jobs/{job_uuid}/resume`