This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch doc5.0
in repository https://gitbox.apache.org/repos/asf/kylin.git
commit d321b51c9da2a9de5ab58b8457ef731ae033463c
Author: Mukvin <boyboys...@163.com>
AuthorDate: Tue Aug 16 14:32:52 2022 +0800
KYLIN-5221 add installation docs
---
.../installation/images/download_krb5.en.png | Bin 0 -> 520189 bytes
.../images/installation_job_monitor.png | Bin 0 -> 97444 bytes
.../images/installation_query_result.png | Bin 0 -> 104403 bytes
.../images/installation_show_model.png | Bin 0 -> 40453 bytes
.../docs/deployment/installation/images/job.png | Bin 0 -> 273294 bytes
.../deployment/installation/images/minimal.png | Bin 0 -> 99177 bytes
.../deployment/installation/images/model_list.png | Bin 0 -> 123821 bytes
.../docs/deployment/installation/images/query.png | Bin 0 -> 199326 bytes
.../installation/images/query_result.png | Bin 0 -> 198222 bytes
.../deployment/installation/install_validation.md | 81 ++++++++++++++++
website/docs/deployment/installation/intro.md | 20 ++++
.../docs/deployment/installation/uninstallation.md | 103 +++++++++++++++++++++
12 files changed, 204 insertions(+)
diff --git a/website/docs/deployment/installation/images/download_krb5.en.png
b/website/docs/deployment/installation/images/download_krb5.en.png
new file mode 100644
index 0000000000..4f6ad87b8c
Binary files /dev/null and
b/website/docs/deployment/installation/images/download_krb5.en.png differ
diff --git
a/website/docs/deployment/installation/images/installation_job_monitor.png
b/website/docs/deployment/installation/images/installation_job_monitor.png
new file mode 100644
index 0000000000..71d71cde34
Binary files /dev/null and
b/website/docs/deployment/installation/images/installation_job_monitor.png
differ
diff --git
a/website/docs/deployment/installation/images/installation_query_result.png
b/website/docs/deployment/installation/images/installation_query_result.png
new file mode 100644
index 0000000000..8c0008424d
Binary files /dev/null and
b/website/docs/deployment/installation/images/installation_query_result.png
differ
diff --git
a/website/docs/deployment/installation/images/installation_show_model.png
b/website/docs/deployment/installation/images/installation_show_model.png
new file mode 100644
index 0000000000..1c3b11461e
Binary files /dev/null and
b/website/docs/deployment/installation/images/installation_show_model.png differ
diff --git a/website/docs/deployment/installation/images/job.png
b/website/docs/deployment/installation/images/job.png
new file mode 100644
index 0000000000..b139648ede
Binary files /dev/null and
b/website/docs/deployment/installation/images/job.png differ
diff --git a/website/docs/deployment/installation/images/minimal.png
b/website/docs/deployment/installation/images/minimal.png
new file mode 100644
index 0000000000..2761e25a09
Binary files /dev/null and
b/website/docs/deployment/installation/images/minimal.png differ
diff --git a/website/docs/deployment/installation/images/model_list.png
b/website/docs/deployment/installation/images/model_list.png
new file mode 100644
index 0000000000..1feb8dba00
Binary files /dev/null and
b/website/docs/deployment/installation/images/model_list.png differ
diff --git a/website/docs/deployment/installation/images/query.png
b/website/docs/deployment/installation/images/query.png
new file mode 100644
index 0000000000..2a02096776
Binary files /dev/null and
b/website/docs/deployment/installation/images/query.png differ
diff --git a/website/docs/deployment/installation/images/query_result.png
b/website/docs/deployment/installation/images/query_result.png
new file mode 100644
index 0000000000..7c19d2acfa
Binary files /dev/null and
b/website/docs/deployment/installation/images/query_result.png differ
diff --git a/website/docs/deployment/installation/install_validation.md
b/website/docs/deployment/installation/install_validation.md
new file mode 100644
index 0000000000..a3d0dbc8e2
--- /dev/null
+++ b/website/docs/deployment/installation/install_validation.md
@@ -0,0 +1,81 @@
+---
+title: Install Validation
+language: en
+sidebar_label: Install Validation
+pagination_label: Install Validation
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - install
+ - validation
+draft: true
+last_update:
+ date: 08/12/2022
+---
+
+Kylin uses the open source **SSB** (Star Schema Benchmark) dataset for star
schema OLAP scenarios as a test dataset. You can verify whether the
installation is successful by running a script to import the SSB dataset into
Hive. The SSB dataset is from multiple CSV files.
+
+This section verifies installation with the following steps:
+
+- [Import Sample Data](#ssb)
+- [Validate Product Functions](#function)
+- [Validate Query Analysis](#query)
+
+
+### <span id="ssb">Import Sample Data</span>
+
+Run the following command to import the sample data:
+
+```shell
+$KYLIN_HOME/bin/sample.sh
+```
+
+The script will create 1 database **SSB** and 6 Hive tables then import data
into it.
+
+After running successfully, you should be able to see the following
information in the console:
+
+```shell
+Sample hive tables are created successfully
+```
+
+We will be using SSB dataset as the data sample to introduce Kylin in several
sections of this product manual. The SSB dataset simulates transaction data
for the online store, see more details in [Sample
Dataset](../../Get-to-Know-Kyligence-Enterprise/quickstart/sample_dataset.en.md).
Below is a brief introduction.
+
+
+| Table | Description | Introduction
|
+| ----------- | -------------------- |
------------------------------------------------------------ |
+| CUSTOMER | customer information | includes customer name,
address, contact information .etc. |
+| DATES | order date | includes a order's specific date, week,
month, year .etc. |
+| LINEORDER | order information | includes some basic information
like order date, order amount, order revenue, supplier ID, commodity ID,
customer Id .etc. |
+| PART | product information | includes some basic
information like product name, category, brand .etc. |
+| P_LINEORDER | view based on order information table | includes all content
in the order information table and new content in the view |
+| SUPPLIER | supplier information | includes supplier name, address,
contact information .etc. |
+
+### <span id="function">Validate Product Functions</span>
+
+On the **Data Asset -> Model** page, you should see an example model with som
storage over 0.00 KB, this indicates the data has been is loaded for this model.
+
+
+
+On the **Monitor -> Job** page, you should see all jobs have been completed
successfully.
+
+
+
+### <span id="query">Validate Query Analysis</span>
+
+When the metadata is loaded successfully, at the **Insight** page, 6 sample
hive tables would be shown at the left panel. User could input query statements
against these tables. For example, the SQL statement queries different product
group by order date, and in descending order by total revenue:
+
+```sql
+SELECT LO_PARTKEY, SUM(LO_REVENUE) AS TOTAL_REVENUE
+FROM SSB.P_LINEORDER
+WHERE LO_ORDERDATE between '19930601' AND '19940601'
+group by LO_PARTKEY
+order by SUM(LO_REVENUE) DESC
+```
+
+The query result will be displayed at the **Insight** page, showing that the
query hit the sample model.
+
+
+
+You can also use the same SQL statement to query on Hive to verify the result
and response time of this query.
diff --git a/website/docs/deployment/installation/intro.md
b/website/docs/deployment/installation/intro.md
new file mode 100644
index 0000000000..acc4d62152
--- /dev/null
+++ b/website/docs/deployment/installation/intro.md
@@ -0,0 +1,20 @@
+---
+title: Install and Uninstall
+language: en
+sidebar_label: Install and Uninstall
+pagination_label: Install and Uninstall
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - install
+ - uninstall
+draft: false
+last_update:
+ date: 08/12/2022
+---
+
+## Install and Uninstall
+
+This chapter will introduce how to install Kylin on different platforms and
how to uninstall Kylin.
diff --git a/website/docs/deployment/installation/uninstallation.md
b/website/docs/deployment/installation/uninstallation.md
new file mode 100644
index 0000000000..6d005606aa
--- /dev/null
+++ b/website/docs/deployment/installation/uninstallation.md
@@ -0,0 +1,103 @@
+---
+title: Uninstall
+language: en
+sidebar_label: Uninstall
+pagination_label: Uninstall
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - uninstall
+draft: false
+last_update:
+ date: 08/12/2022
+---
+
+In this section, we will show you how to uninstall Kylin.
+
+The steps to uninstall Kylin and remove all relevant data are as follows:
+
+1. Run the following command on all Kylin nodes to stop the Kylin instance:
+
+ ```shell
+ $KYLIN_HOME/bin/kylin.sh stop
+ ```
+
+2. Data backup (optional):
+
+ - Backup metadata before full unloading so that it can be restored when
needed.
+
+ ```shell
+ $KYLIN_HOME/bin/metastore.sh backup
+ ```
+
+ > Notice: We recommend that you copy metadata to more reliable storage
devices later.
+
+3. Please check the configuration file `$KYLIN_HOME/conf/kylin.properties` to
determine the name of the working directory. Suppose your item is:
+
+ ```properties
+ kylin.hdfs.working.dir=/kylin
+ ```
+
+ Please run the following command to delete the working directory:
+
+ ```shell
+ hdfs dfs -rm -r /kylin
+ ```
+
+4. Please check the configuration file `$KYLIN_HOME/conf/kylin.properties` to
confirm the name of the metadata table. Suppose your item is:
+
+ ```properties
+ kylin.metadata.url=kylin_metadata@jdbc
+ ```
+
+ Please run following commands to delete metadata tables:
+
+ - If you are using PostgreSQL as your metastore:
+
+ - Set environment variable of PostgreSQL user password. Say your
PostgreSQL user password is `kylin`:
+
+ ```
+ export PGPASSWORD=kylin
+ ```
+
+ - Delete metadata tables:
+
+ ```shell
+ /usr/pgsql-10/bin/psql -h {hostname} -p {port} -U {user} -d {database}
-c "drop table if exists {metadataUrl}"
+ ```
+
+ Below is a description of the fields:
+
+ - hostname: PostgreSQL host address;
+ - port: PostgreSQL server port;
+ - user: PostgreSQL user password;
+ - database: PostgreSQL database name;
+ - metadataUrl: PostgreSQL metadata table name, it is `kylin_metadata`
in this example.
+
+ You can also log in to PostgreSQL and query `drop table if exists
{metadataUrl}` to delete your metadata table.
+
+ - If you are using MySQL as your metastore, run the following command to
delete your metadata tables:
+
+ ```shell
+ mysql -h{hostname} -u {root} -p{password} -D {database} -e "drop table if
exists {metadataUrl}"
+ ```
+
+ Below is a description of the fields:
+
+ - hostname: MySQL host address;
+ - user: MySQL user name;
+ - password: MySQL user password, please note that there is no space
between `-p` and password;
+ - database: MySQL metadata database name;
+ - metadataUrl: MySQL metadata table name, it is `kylin_metadata` in this
example.
+
+ You can also log in to MySQL and query `drop table if exists
{metadataUrl}` to delete your metadata table.
+
+5. Run the following commands on all Kylin nodes to delete the Kylin
installation directory:
+
+ ```shell
+ rm -rf $KYLIN_HOME
+ ```
+
+At this point, the Kylin uninstall is complete.
