website: fix a wrong statement in LDAP enablement
Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/62361770 Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/62361770 Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/62361770 Branch: refs/heads/1.x-HBase1.1.3 Commit: 62361770477fdafd6fb043fa0ef1e8d7fa7480a3 Parents: e32f8dc Author: shaofengshi <shaofeng...@apache.org> Authored: Thu Jan 7 15:49:03 2016 +0800 Committer: shaofengshi <shaofeng...@apache.org> Committed: Thu Jan 7 15:49:33 2016 +0800 ---------------------------------------------------------------------- website/_docs/howto/howto_backup_metadata.md | 16 ++++++++-------- website/_docs/howto/howto_optimize_cubes.md | 2 +- website/_docs/index.md | 21 +++++++++------------ website/_docs/install/advance_settings.md | 22 +++++++++------------- website/_docs/tutorial/powerbi.md | 2 +- 5 files changed, 28 insertions(+), 35 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/62361770/website/_docs/howto/howto_backup_metadata.md ---------------------------------------------------------------------- diff --git a/website/_docs/howto/howto_backup_metadata.md b/website/_docs/howto/howto_backup_metadata.md index 1934a60..cf250b7 100644 --- a/website/_docs/howto/howto_backup_metadata.md +++ b/website/_docs/howto/howto_backup_metadata.md @@ -11,10 +11,10 @@ Kylin organizes all of its metadata (including cube descriptions and instances, {% highlight Groff markup %} ## The metadata store in hbase -kylin.metadata.url=kylin_metadata_qa@hbase +kylin.metadata.url=kylin_metadata@hbase {% endhighlight %} -This indicates that the metadata will be saved as a htable called `kylin_metadata_qa`. You can scan the htable in hbase shell to check it out. +This indicates that the metadata will be saved as a htable called `kylin_metadata`. You can scan the htable in hbase shell to check it out. ## Backup Metadata Store with binary package @@ -22,7 +22,7 @@ Sometimes you need to backup the Kylin's Metadata Store from hbase to your disk In such cases, assuming you're on the hadoop CLI(or sandbox) where you deployed Kylin, you can go to KYLIN_HOME and run : {% highlight Groff markup %} -bin/metastore.sh backup +./bin/metastore.sh backup {% endhighlight %} to dump your metadata to your local folder a folder under KYLIN_HOME/metadata_backps, the folder is named after current time with the syntax: KYLIN_HOME/meta_backups/meta_year_month_day_hour_minute_second @@ -34,15 +34,15 @@ In case you find your metadata store messed up, and you want to restore to a pre Firstly, reset the metadata store (this will clean everything of the Kylin metadata store in hbase, make sure to backup): {% highlight Groff markup %} -bin/metastore.sh reset +./bin/metastore.sh reset {% endhighlight %} Then upload the backup metadata to Kylin's metadata store: {% highlight Groff markup %} -bin/metastore.sh restore $KYLIN_HOME/meta_backups/meta_xxxx_xx_xx_xx_xx_xx +./bin/metastore.sh restore $KYLIN_HOME/meta_backups/meta_xxxx_xx_xx_xx_xx_xx {% endhighlight %} -## Backup/Restore metadata in development env (available since 0.7.3) +## Backup/restore metadata in development env (available since 0.7.3) When developing/debugging Kylin, typically you have a dev machine with an IDE, and a backend sandbox. Usually you'll write code and run test cases at dev machine. It would be troublesome if you always have to put a binary package in the sandbox to check the metadata. There is a helper class called SandboxMetastoreCLI to help you download/upload metadata locally at your dev machine. Follow the Usage information and run it in your IDE. @@ -51,12 +51,12 @@ As time goes on, some resources like dictionary, table snapshots became useless Firstly, run a check, this is safe as it will not change anything: {% highlight Groff markup %} -bin/metastore.sh clean +./bin/metastore.sh clean {% endhighlight %} The resources that will be dropped will be listed; Next, add the "--delete true" parameter to cleanup those resources; before this, make sure you have made a backup of the metadata store; {% highlight Groff markup %} -bin/metastore.sh clean --delete true +./bin/metastore.sh clean --delete true {% endhighlight %} http://git-wip-us.apache.org/repos/asf/kylin/blob/62361770/website/_docs/howto/howto_optimize_cubes.md ---------------------------------------------------------------------- diff --git a/website/_docs/howto/howto_optimize_cubes.md b/website/_docs/howto/howto_optimize_cubes.md index 50b42d4..4ebf7be 100644 --- a/website/_docs/howto/howto_optimize_cubes.md +++ b/website/_docs/howto/howto_optimize_cubes.md @@ -1,6 +1,6 @@ --- layout: docs -title: How to optimize cubes +title: How to Optimize Cubes categories: howto permalink: /docs/howto/howto_optimize_cubes.html version: v0.7.2 http://git-wip-us.apache.org/repos/asf/kylin/blob/62361770/website/_docs/index.md ---------------------------------------------------------------------- diff --git a/website/_docs/index.md b/website/_docs/index.md index 8f5f2f7..74e61dc 100644 --- a/website/_docs/index.md +++ b/website/_docs/index.md @@ -21,33 +21,30 @@ Advanced Topics #### Connectivity -1.[How to use kylin remote jdbc driver](howto/howto_jdbc.html) - -2.[SQL Reference](http://calcite.apache.org/) +1. [How to use Kylin remote JDBC driver](howto/howto_jdbc.html) +2. [SQL reference](http://calcite.apache.org/) --- #### REST API -1.[Kylin Restful API List](howto/howto_use_restapi.html) - -2.[Build Cube with Restful API](howto/howto_build_cube_with_restapi.html) - -3.[How to consume Kylin REST API in javascript](howto/howto_use_restapi_in_js.html) +1. [Kylin Restful API list](howto/howto_use_restapi.html) +2. [Build cube with Restful API](howto/howto_build_cube_with_restapi.html) +3. [How to consume Kylin REST API in javascript](howto/howto_use_restapi_in_js.html) --- #### Operations -1.[Check Kylin Metadata Store](howto/howto_backup_metadata.html) - -2.[Advanced settings of Kylin environment](install/advance_settings.html) +1. [Backup/restore Kylin metadata store](howto/howto_backup_metadata.html) +2. [Cleanup storage (HDFS & HBase tables)](howto/howto_cleanup_storage.html) +3. [Advanced env configurations](install/advance_settings.html) --- #### Technical Details -1.[New meta data model structure](/development/new_metadata.html) +1. [New meta data model structure](/development/new_metadata.html) http://git-wip-us.apache.org/repos/asf/kylin/blob/62361770/website/_docs/install/advance_settings.md ---------------------------------------------------------------------- diff --git a/website/_docs/install/advance_settings.md b/website/_docs/install/advance_settings.md index f9704ea..2785210 100644 --- a/website/_docs/install/advance_settings.md +++ b/website/_docs/install/advance_settings.md @@ -7,13 +7,11 @@ version: v0.7.2 since: v0.7.1 --- -## Enabling LZO compression +## Enable LZO compression -By default Kylin leverages snappy compression to compress the output of MR jobs, as well as hbase table storage, reducing the storage overhead. We do not choose LZO compression in Kylin because hadoop venders tend to not include LZO in their distributions due to license(GPL) issues. +By default Kylin leverages snappy compression to compress the output of MR jobs, as well as hbase table storage, reducing the storage overhead. We do not choose LZO compression in Kylin because hadoop venders tend to not include LZO in their distributions due to license(GPL) issues. To enable LZO in Kylin, follow these steps: -To enable LZO in Kylin, follow these steps: - -### Make sure LZO is working in your environment +#### Make sure LZO is working in your environment We have a simple tool to test whether LZO is well installed on EVERY SERVER in hbase cluster ( http://docs.hortonworks.com/HDPDocuments/HDP2/HDP-2.2.4/bk_installing_manually_book/content/ch_install_hdfs_yarn_chapter.html#install-snappy-man-install ), and restart the cluster. To test it on the hadoop CLI that you deployed Kylin, Just run @@ -29,26 +27,24 @@ To test if the hbase cluster is ready to create LZO compressed tables, test foll create 'lzoTable', {NAME => 'colFam',COMPRESSION => 'LZO'} {% endhighlight %} -### Use LZO for HBase compression +#### Use LZO for HBase compression You'll need to stop Kylin first by running `./kylin.sh stop`, and then modify $KYLIN_HOME/conf/kylin_job_conf.xml by uncommenting some configuration entries related to LZO compression. After this, you need to run `./kylin.sh start` to start Kylin again. Now Kylin will use LZO to compress MR outputs and hbase tables. Goto $KYLIN_HOME/conf/kylin.properties, change kylin.hbase.default.compression.codec=snappy to kylin.hbase.default.compression.codec=lzo -### Use LZO for MR jobs +#### Use LZO for MR jobs Modify $KYLIN_HOME/conf/kylin_job_conf.xml by changing all org.apache.hadoop.io.compress.SnappyCodec to com.hadoop.compression.lzo.LzoCodec. -### Restart Kylin - Start Kylin again. Now Kylin will use LZO to compress MR outputs and HBase tables. ## Enable LDAP authentication Kylin supports LDAP authentication for enterprise or production deployment; This is implemented based on Spring Security framework; Before enable LDAP, please contact your LDAP administrator to get necessary information, like LDAP server URL, username/password, search patterns, etc; -## Configure LDAP properties conf/kylin.properties +#### Configure LDAP properties conf/kylin.properties Firstly, provide your LDAP URL, and username/password if the LDAP server is secured; @@ -67,9 +63,9 @@ ldap.user.searchPattern=(&(AccountName={0})(memberOf=CN=MYCOMPANY-USERS,DC=mycom ldap.user.groupSearchBase=OU=Group,DC=mycompany,DC=com ``` -If you have service accounts (e.g, for system integration) which also need be authenticated, you can configure them in ldap.service.*; If not, leave them be empty; +If you have service accounts (e.g, for system integration) which also need be authenticated, you can configure them in ldap.service.*; Otherwise, leave them be empty; -### Enable LDAP mode +#### Enable LDAP mode -Set "kylin.sandbox=true" in conf/kylin.properties, then restart Kylin server; In the Login page, use a LDAP account name/password to login. \ No newline at end of file +Set "kylin.sandbox=false" in conf/kylin.properties, then restart Kylin server; In the Login page, use a LDAP account name/password to login. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/kylin/blob/62361770/website/_docs/tutorial/powerbi.md ---------------------------------------------------------------------- diff --git a/website/_docs/tutorial/powerbi.md b/website/_docs/tutorial/powerbi.md index d2305cf..20cd782 100644 --- a/website/_docs/tutorial/powerbi.md +++ b/website/_docs/tutorial/powerbi.md @@ -48,7 +48,7 @@ Please make sure to download and install Kylin ODBC Driver __v1.2__. If you alre 3. If you didnât input the SQL statement in last step, Power BI will list all tables in the project, which means you can load data from the whole table. But, since Apache Kylin cannot query on raw data currently, this function may be limited.  -4. Now you can start to enjou analyzing with Power BI. +4. Now you can start to enjoy analyzing with Power BI.  5. To reload the data and redraw the charts, just click `Refresh` button in `Home` fast tab.