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 02e31db7f0b14469d39efa49fbbd242512ccede5
Author: Mukvin <boyboys...@163.com>
AuthorDate: Tue Aug 16 14:35:11 2022 +0800
KYLIN-5221 add operations docs
---
website/docs/operations/cli_tool/diagnosis.md | 139 +++++++++++++++++++++
website/docs/operations/cli_tool/intro.md | 17 +++
.../operations/project-maintenance/alerting.md | 50 ++++++++
.../images/project_settings.png | Bin 0 -> 244469 bytes
.../images/project_settings_acceleration.png | Bin 0 -> 213058 bytes
.../images/project_settings_acceleration_tips.png | Bin 0 -> 150813 bytes
.../images/project_settings_basic_general.png | Bin 0 -> 170160 bytes
.../images/project_settings_cc_expose.png | Bin 0 -> 48912 bytes
.../images/project_settings_custom_config.png | Bin 0 -> 58667 bytes
.../project_settings_default_database_en.png | Bin 0 -> 297604 bytes
.../images/project_settings_job_notification.png | Bin 0 -> 144128 bytes
.../project_settings_job_notification_page.png | Bin 0 -> 354436 bytes
.../images/project_settings_model_rewrite.png | Bin 0 -> 250137 bytes
.../images/project_settings_pushdown.png | Bin 0 -> 302372 bytes
.../images/project_settings_segment_en.png | Bin 0 -> 191173 bytes
.../images/project_settings_storage.png | Bin 0 -> 233852 bytes
.../images/project_settings_storage_low_usage.png | Bin 0 -> 240252 bytes
.../images/project_settings_yarn_queue.png | Bin 0 -> 90074 bytes
.../images/recommendation_preferences_en.png | Bin 0 -> 153741 bytes
.../images/service_state.en.png | Bin 0 -> 58508 bytes
.../images/storage_quota.en.png | Bin 0 -> 34171 bytes
.../project-maintenance/images/toolbar.en.png | Bin 0 -> 688505 bytes
.../docs/operations/project-maintenance/intro.md | 17 +++
.../project-maintenance/project_settings.md | 127 +++++++++++++++++++
24 files changed, 350 insertions(+)
diff --git a/website/docs/operations/cli_tool/diagnosis.md
b/website/docs/operations/cli_tool/diagnosis.md
new file mode 100644
index 0000000000..e26e470720
--- /dev/null
+++ b/website/docs/operations/cli_tool/diagnosis.md
@@ -0,0 +1,139 @@
+---
+title: Diagnostic Package
+language: en
+sidebar_label: Diagnostic Package
+pagination_label: Diagnostic Package
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - diagnostic package
+draft: false
+last_update:
+ date: 08/16/2022
+---
+
+Kylin users may face with many problems during usage, such as failure in
creating a model or query errors. Kylin provides a cli tool to pack related
information into a zip package to help system administrator to better analyze
the root cause of these problems.
+Diagnosis function including System Diagnosis、Job Diagnosis and Query
Diagnosis.
+
+### Generate Diagnostic Package using bash script
+- In FusionInsight, you need to execute command `source
/opt/hadoopclient/bigdata_env` first. The `hadoopclient` is a variable.
+
+- Generate system diagnostic package
+Execute `$KYLIN_HOME/bin/diag.sh [-startTime <START_TIMESTAMP> -endTime
<END_TIMESTAMP>] [-destDir <DESTINATION_DIR>]` to generate the system
diagnostic package. The default time range is last 1 day, START_TIMESTAMP and
END_TIMESTAMP is in unix timestamp. You may get the current unix timestamp by
run ```echo $((`date +%s`*1000))``` in Linux.
+
+- Generate job diagnostic package
+Execute `$KYLIN_HOME/bin/diag.sh -job <jobid> [-destDir <DESTINATION_DIR>]` to
generate the job diagnostic package with replacing `<jobid>` with the job ID
number.
+
+- Generate query diagnostic package
+ Execute `$KYLIN_HOME/bin/diag.sh -project <project> -query <queryid>
[-destDir <DESTINATION_DIR>]` to generate the query diagnostic package with
replacing `<queryid>` with the actual query ID number and `<project>` with the
name of the project in which the actual query is made.
+
+- Diagnostic package storage location
+Diagnostic packages generated by scripts are stored under
`$KYLIN_HOME/diag_dump/` by default, you can specify the location by
configuring `-destDir` parameter.
+ > Note: In order to avoid the diagnostic package occupying a lot of
storage, please clean up the `$KYLIN_HOME/diag_dump/` directory in time.
+
+- Skip metadata files
+ If you want to exclude metadata files, please specify `-includeMeta false`.
+
+- Skip audit log files
+ If you want to exclude audit log files, please specify `-includeAuditLog
false` or add configuration `kylin.diag.include-auditlog=false` in the
`kylin.properties`
+
+### Diagnostic Package Content
+
+#### Full Diagnostic Package Content
+
+- `/conf`: configuration information under the `$KYLIN_HOME/conf` directory.
+- `/hadoop_conf`: configuration information under the
`$KYLIN_HOME/hadoop_conf` directory.
+- `/metadata`: metadata files.
+- `/logs`: all the logs in the specified time range, 1 day is by default.
+- `/spark_logs`: all Spark executor logs of query in the specified time range.
+- `/sparder_history`：all Sparder logs of query in the specified time range.
+- `/system_metrics`: all system metrics in the specified time range.
+- `/audit_log`: all audit logs of metdata in the specified time range.
+- `/job_tmp`: the optimization suggestions log.
+- `/client`: operating system resources occupied information, Hadoop version
and Kerberos information.
+- `/bin`: program execute and manager binary files.
+- `/monitor_metrics`: System monitoring statistics.
+- `/rec_candidate`: optimization suggestions for the model.
+- `/write_ hadoop_ conf`：`$KYLIN_HOME/write_hadoop_conf`, Hadoop configuration
of the build cluster. This directory will not be available when Read/Write
separation deployment is not configured.
+- file `catalog_info`: directory structure of install package.
+- file `commit_SHA1`: git-commit version.
+- file `hadoop_env`: hadoop environment information.
+- file `info`: license，package and hostname.
+- file `kylin_env`: Kylin version, operating system information, Java related
information, git-commit information.
+- file `time_used_info`: Time statistics of each file generated in the
diagnostic package.
+
+#### Job Diagnostic Package Content
+
+- `/conf`: configuration information under the `$KYLIN_HOME/conf` directory.
+- `/hadoop_conf`: configuration information under the
`$KYLIN_HOME/hadoop_conf` directory.
+- `/job_history`：Job execution history information mainly includes the
execution information of yarn application.
+- `/metadata`: metadata files.
+- `/logs`: the logs generated during the execution of the job.
+- `/spark_logs`: all spark executor logs generated during job execution.
+- `/system_metrics`: the system metrics generated during the execution.
+- `/audit_log`: the audit logs generated during the execution.
+- `/job_tmp`: the temporary files, logs and optimization suggestions log of
job.
+- `/yarn_application_log`: specifies the logs of yarn application of job.
+- `/client`: operating system resources occupied information, Hadoop version
and Kerberos information.
+- `/bin`: program execute and manager binary files.
+- `/monitor_metrics`: System monitoring statistics.
+- `/rec_candidate`: optimization suggestions for the model.
+- `/write_ hadoop_ conf`：`$KYLIN_HOME/write_hadoop_conf`, Hadoop configuration
of the build cluster. This directory will not be available when Read/Write
separation deployment is not configured.
+- file `catalog_info`: directory structure of install package.
+- file `commit_SHA1`: git-commit version.
+- file `hadoop_env`: hadoop environment information.
+- file `info`: license, package and hostname.
+- file `kylin_env`：kyligence Enterprise version, operating system information,
Java related information, git-commit information.
+- file `time_used_info`: Time statistics of each file generated in the
diagnostic package.
+
+#### Query Diagnostic Package Content
+
+- `/conf`: configuration information under the `$KYLIN_HOME/conf` directory.
+- `/hadoop_conf`: configuration information under the
`$KYLIN_HOME/hadoop_conf` directory.
+- `/metadata`：specify the metadata for all models under the project.
+- `/logs`：`$KYLIN_HOME/logs/kylin.log`，specify the log of the query.
+- `/spark_logs`：all Spark executor logs within the time range are included in
the query diagnostic package.
+- `/sparder_history`：all Sparder logs within the time range are included in
the query diagnostic package.
+- `/client`：operating system resource usage, Version information for Hadoop,
and Kerberos information.
+- file `catalog_info`: directory structure of install package.
+- file `commit_SHA1`: git-commit version.
+- file `hadoop_env`: hadoop environment information.
+- file `info`: license, package and hostname.
+- file `kylin_env`：kyligence Enterprise version, operating system information,
Java related information, git-commit information.
+- file `time_used_info`: Time statistics of each file generated in the
diagnostic package.
+
+### Multi-Node Diagnosis
+At present, there is no API to know which nodes are in the cluster. You need
to record the deployed nodes by yourself, and then go to each node to generate
diagnostic package separately. The method of generating the diagnostic package
is the same as the above.
+
+### Diagnostic package desensitization
+
+The diagnostic package desensitization function can hide sensitive information
in the diagnostic package, such as user names, passwords, etc. While helping
users solve problems, it can meet users' data security requirements.
+
+You can enable the diagnostic package desensitization function through the
following configuration item:
+
+```properties
+## The desensitization level of the diagnostic package. RAW stands for no
desensitization, OBF stands for desensitization
+kylin.diag.obf.level=OBF
+```
+
+After the configuration is enabled, the diagnostic package generated through
the Web UI or through the terminal CLI tool will be desensitized. The system
will desensitize all files starting with `kylin.properties` in the
`KYLIN_HONE/conf` directory. All configuration items including `password`,
`user`, `zookeeper.zk-auth`, ` The configuration items of source.jdbc.pass`
will be desensitized. The desensitization method is to replace the value of the
configuration item with `<hidden>`.
+
+### Common Questions
+
+**Q: Why is the system diagnostic package log content incomplete?**
+
+A: The extraction of the log is a text-based match (based on the minute-level
time string). If the content is found to be incomplete, it may be that the
specified timestamp is not converted to the corresponding one when converted to
a time string. You can try to modify the time range and re-generate the
diagnostic package.
+
+**Q: Why is the `system_metrics` directory missing content in diagnostic
package?**
+
+A: `system_metrics` contains system metrics, which are stored in InfluxDB. You
need to specify an RPC port when using InfluxDB to back up the data, so please
verify whether the configuration item
`kylin.metrics.influx-rpc-service-bind-address` in the file
`$KYLIN_HOME/conf/kylin.properties` is correct.
+
+**Q: How to deal with Out of Memory (OOM) problem that happens during
diagnostic package generating?**
+
+A: Please check the value of `JAVA_VM_XMX` in `conf/setenv.sh`, which is
recommended to be adjusted to more than 4 times the size of metadata. For
example, if the size of metadata is 1G, please set the value to 4G or above.
+
+**Q: Why is the file of the exported model optimization suggestion 0KB? **
+
+A: If the model has no optimization suggestions, then the optimization
suggestions generated by the corresponding model will be 0KB.
diff --git a/website/docs/operations/cli_tool/intro.md
b/website/docs/operations/cli_tool/intro.md
new file mode 100644
index 0000000000..4c034e42c8
--- /dev/null
+++ b/website/docs/operations/cli_tool/intro.md
@@ -0,0 +1,17 @@
+---
+title: CLI Operation Tool
+language: en
+sidebar_label: CLI Operation Tool
+pagination_label: CLI Operation Tool
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - cli operation tool
+draft: false
+last_update:
+ date: 08/12/2022
+---
+
+This chapter introduces how to use the Command-Line Interface tool to do daily
operation work. Such as environment dependency checking tool, metadata tool,
and diagnostic package.
diff --git a/website/docs/operations/project-maintenance/alerting.md
b/website/docs/operations/project-maintenance/alerting.md
new file mode 100755
index 0000000000..23477573fd
--- /dev/null
+++ b/website/docs/operations/project-maintenance/alerting.md
@@ -0,0 +1,50 @@
+---
+title: Job Status Alert
+language: en
+sidebar_label: Job Status Alert
+pagination_label: Job Status Alert
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - job status alert
+draft: true
+last_update:
+ date: 08/16/2022
+---
+
+Kylin provides *Job Status Alert* feature that sends emails to system
administrator if any job loads empty data or failed. It is very convenient for
follow-ups like troubleshooting or incremental building.
+
+Job status alert by email can be enabled by the following steps,
+
+**Step one**: You need to additionally set following properties in the
configuration file `$KYLIN_HOME/conf/kylin.properties`,
+
+ ```properties
+ kylin.job.notification-enabled=true|false # set to true to enable the
feature
+ kylin.job.notification-mail-enable-starttls=true|false
+ kylin.job.notification-mail-host=your-smtp-server # address of SMTP server
+ kylin.job.notification-mail-port=your-smtp-port # port of SMTP server
+ kylin.job.notification-mail-username=your-smtp-account # SMTP account
username
+ kylin.job.notification-mail-password=your-smtp-pwd # SMTP account password
+ kylin.job.notification-mail-sender=your-sender-address # sender address
+ ```
+
+> **Note**: If you need to encrypt `kylin.job.notification-mail-password`, you
can do it like this：
+>
+> i. run following commands in `${KYLIN_HOME}`, it will print encrypted
password
+> ```shell
+> ./bin/kylin.sh org.apache.kylin.tool.general.CryptTool -e AES -s <password>
+> ```
+> ii. config `kylin.job.notification-mail-password` like this
+> ```properties
+> kylin.job.notification-mail-password=ENC('${encrypted_password}')
+> ```
+
+ Please **Restart Kylin** to make configurations take effect.
+
+**Step two**: Set in the project settings page,
+
+ - Modelers and Analysts need to fill in the **Advanced Settings** -->
**Email Notification** with your email addresses.
+
+ 
diff --git
a/website/docs/operations/project-maintenance/images/project_settings.png
b/website/docs/operations/project-maintenance/images/project_settings.png
new file mode 100644
index 0000000000..20a687a052
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings.png differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_acceleration.png
b/website/docs/operations/project-maintenance/images/project_settings_acceleration.png
new file mode 100644
index 0000000000..e88b5e7167
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_acceleration.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_acceleration_tips.png
b/website/docs/operations/project-maintenance/images/project_settings_acceleration_tips.png
new file mode 100644
index 0000000000..e5d611f514
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_acceleration_tips.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_basic_general.png
b/website/docs/operations/project-maintenance/images/project_settings_basic_general.png
new file mode 100644
index 0000000000..6f5ddd598b
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_basic_general.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_cc_expose.png
b/website/docs/operations/project-maintenance/images/project_settings_cc_expose.png
new file mode 100644
index 0000000000..1f5a5a9ea1
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_cc_expose.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_custom_config.png
b/website/docs/operations/project-maintenance/images/project_settings_custom_config.png
new file mode 100644
index 0000000000..84324896a0
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_custom_config.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_default_database_en.png
b/website/docs/operations/project-maintenance/images/project_settings_default_database_en.png
new file mode 100644
index 0000000000..c7a28165ac
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_default_database_en.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_job_notification.png
b/website/docs/operations/project-maintenance/images/project_settings_job_notification.png
new file mode 100644
index 0000000000..1e082cc79b
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_job_notification.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_job_notification_page.png
b/website/docs/operations/project-maintenance/images/project_settings_job_notification_page.png
new file mode 100644
index 0000000000..05de4610b3
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_job_notification_page.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_model_rewrite.png
b/website/docs/operations/project-maintenance/images/project_settings_model_rewrite.png
new file mode 100644
index 0000000000..43b61350ac
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_model_rewrite.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_pushdown.png
b/website/docs/operations/project-maintenance/images/project_settings_pushdown.png
new file mode 100644
index 0000000000..c4b9a45cdd
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_pushdown.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_segment_en.png
b/website/docs/operations/project-maintenance/images/project_settings_segment_en.png
new file mode 100644
index 0000000000..825e3a384f
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_segment_en.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_storage.png
b/website/docs/operations/project-maintenance/images/project_settings_storage.png
new file mode 100644
index 0000000000..5aa17d2588
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_storage.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_storage_low_usage.png
b/website/docs/operations/project-maintenance/images/project_settings_storage_low_usage.png
new file mode 100644
index 0000000000..e11df66530
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_storage_low_usage.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/project_settings_yarn_queue.png
b/website/docs/operations/project-maintenance/images/project_settings_yarn_queue.png
new file mode 100644
index 0000000000..3d3590f228
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/project_settings_yarn_queue.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/recommendation_preferences_en.png
b/website/docs/operations/project-maintenance/images/recommendation_preferences_en.png
new file mode 100644
index 0000000000..6538741e6c
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/recommendation_preferences_en.png
differ
diff --git
a/website/docs/operations/project-maintenance/images/service_state.en.png
b/website/docs/operations/project-maintenance/images/service_state.en.png
new file mode 100644
index 0000000000..69dd4e44b1
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/service_state.en.png differ
diff --git
a/website/docs/operations/project-maintenance/images/storage_quota.en.png
b/website/docs/operations/project-maintenance/images/storage_quota.en.png
new file mode 100644
index 0000000000..40953f6ebc
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/storage_quota.en.png differ
diff --git a/website/docs/operations/project-maintenance/images/toolbar.en.png
b/website/docs/operations/project-maintenance/images/toolbar.en.png
new file mode 100644
index 0000000000..2e88c1d75a
Binary files /dev/null and
b/website/docs/operations/project-maintenance/images/toolbar.en.png differ
diff --git a/website/docs/operations/project-maintenance/intro.md
b/website/docs/operations/project-maintenance/intro.md
new file mode 100755
index 0000000000..93b8062075
--- /dev/null
+++ b/website/docs/operations/project-maintenance/intro.md
@@ -0,0 +1,17 @@
+---
+title: Project Operation
+language: en
+sidebar_label: Project Operation
+pagination_label: Project Operation
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - project operation
+draft: false
+last_update:
+ date: 08/16/2022
+---
+
+The following sections introduce how to do project operation.
diff --git a/website/docs/operations/project-maintenance/project_settings.md
b/website/docs/operations/project-maintenance/project_settings.md
new file mode 100644
index 0000000000..4f247ffbd6
--- /dev/null
+++ b/website/docs/operations/project-maintenance/project_settings.md
@@ -0,0 +1,127 @@
+---
+title: Project Settings
+language: en
+sidebar_label: Project Settings
+pagination_label: Project Settings
+toc_min_heading_level: 2
+toc_max_heading_level: 6
+pagination_prev: null
+pagination_next: null
+keywords:
+ - project settings
+draft: true
+last_update:
+ date: Aug 16, 2022
+---
+
+On the left side navigation bar of the page, click **Setting**，you can adjust
some settings at the project level on your business demands.
+
+
+
+All settings are composed of three main parts:
+
+- [Project Settings](#project-settings)
+ - [<span id="basic">Basic Settings</span>](#basic-settings)
+ - [<span id="advanced">Advanced Settings</span>](#advanced-settings)
+ - [<span id="rewrite_models">Model/Index Group Rewrite
Settings</span>](#modelindex-group-rewrite-settings)
+
+### <span id="basic">Basic Settings</span>
+
+#### 1. General Information
+
+In this part, you can check current project's name, type and description,
also, you can modify project description.
+
+
+
+#### 2. Storage Setting
+
+In this part, you can check the storage quota, which is the upper limit of the
storage. By default, storage size is 10TB.
+
+The picture below shows where to set storage quota:
+
+
+
+#### 3. Pushdown Setting
+
+If you don't have any models or there is no avaliable models to answer your
queries, you can use **pushdown** to get results for a more flexible user
experience, and your queries will be pushdown to Spark SQL by default. This
setting is turned on by default.
+
+
+
+#### 4. Segment Settings
+
+This part is about settings of segment, including Segment Merge, Retention
Threshold and Creating Reserved Segments.
+
+**Segment Merge** means the system will automatically merge segments when
those segments match the rules and contain the same indexes. Below is how to
define the rules.
+
+- **Auto-Merge**: You can choose to automatically merge segments within the
time range in 1 hour / 1 day / 1 week / 1 month / 1 quarter / 1 year （natural
concepts）.
+
+ > Example of natural concept: Natural week means Monday to Sunday.
Natural month means the first day of a month to the last day of the month.
Civil year means the first day of a year to the last day of the year.
+
+- **Volatile Range**: The system will delay for a period of time (i.e.
Volatile Range) to trigger automatic merging of Segments. You can set the time
range to N hour(s), day(s), week(s), month(s), quarter(s), and year(s), where
day(s), week(s), and month(s) are natural concepts. N is an integer, and the
default value is 0.
+
+ - Usage scenario: In actual business, due to the delay of the ETL process,
for example, the business often needs to refresh the data of the past N days
every day. During auto-merge, in order to reduce resource waste, you can set
Volatile Range to prevent the system from automatically merging segments to be
refreshed for the past N days.
+
+> For example: If you build a segment every day and you set the auto-merge
time range as 1 week, then you will have 7 segments no.01-07 over last week.
+>
+> - Volatile range is 0 day , the system will automatically merge 7 segments.
+> - Volatile range is 1 day(i.e. the business needs to refresh no.07 Segment
on the next day), therefore, the system will not merge no.01-07 segments; the
system will not merge the 01-07 segments until the segment no.08 is added in
the second week.
+> - Volatile range is 2 days(i.e. the business needs to refresh no.06-07
Segments on the next day), therefore, the system will not merge no.01-07
segments until the segments no.08-09 are added in the second week.
+
+**Retention Threshold** sets the oldest segment time range. Support setting
day, month, or year as units. By default, Kylin only keeps segments for 1 year,
segments beyond 1 year will be deleted automatically.
+
+**Creating Reserved Segments** With this switch ON, you may create a segment
with no index (reserved segment). Please note that queries would be answered by
pushdown engine when they hit reserved segments.
+
+The picture below is the segment setting page.
+
+
+
+### <span id="advanced">Advanced Settings</span>
+
+This module includes 5 parts mainly: default database, job notification, YARN
application queue, computed column exposure and custom project configuration.
+
+#### 1. Default Database
+
+After setting the default database, the database name can be omitted in SQL
statements when executing a query or importing a SQL file. Modifying the
default database may result in saved queries or SQL files being unavailable,
historical queries cannot hit the models. Please modify the default database
prudently.
+
+The picture below is the default database setting page:
+
+
+
+#### 2. Job Notification
+
+If you want to receive notification of abnormal jobs, you can add your email
addresses in this page, once there is any job which loads empty data or gets
failed, the system will send you a notification email, the example email goes
like this:
+
+
+
+For specific configuration, please refer to [Job Status Alert](alerting.md)
for more details.
+
+#### 3. YARN Application Queue
+
+The system admin user can set the YARN Application Queue of the project. After
setting the queue, the jobs will be submitted to the specified queue to achieve
computing resources allocation and separation between projects. This queue
resource is used for non-query jobs such as refreshing data, merging segments,
building indexes, loading data and sampling table.
+
+The system will submit the job to the **default** queue of YARN by default.
The name of YARN queue is case sensitive. Please make sure the queue you set is
available, otherwise the jobs may fail to execute or be submitted to the
default queue according to the current **Scheduler Policy** of YARN.
+
+The picture below is the yarn queue setting page:
+
+
+
+#### 4. Computed Column Exposure
+
+This config will control the exposure of the computed columns in current
project. If this config is on, Kylin will add computed columns of current
project to the table schemas returned. Otherwise, computed columns are hidden
from the table schema. This config will influence the table schemas in JDBC,
ODBC or BI tools.
+You may not want to change this config frequently as it might break the
project in your BI tools.
+
+
+
+#### 5. Custom Project Configuration
+
+Administrators can add additional project configuration items needed by
customizing the project configuration. You can click the **+ Configuration**
button, enter the configuration item and parameter value in the pop-up window,
and then click **OK**. If you need to modify or delete the added configuration
items, you can click the **Edit** or **Delete** button on the right side of the
list. These operations take effect immediately.
+
+
+
+### <span id="rewrite_models">Model/Index Group Rewrite Settings</span>
+
+Kylin supports rewriting some specific properties at level, including
Auto-Merge, Volatile Range, Retention Threshold, spark executor resource size
and Custom Settings.
+
+Click **+** button (Add Setting Item) under the right **Actions** tab:
+
+
