diff --git a/content/en/docs/A-Tune/A-Tune.md b/content/en/docs/A-Tune/A-Tune.md index dd4339cbe0773f0f3a8341f253d9117f256ec984..cb94a36db10e5d10f1ed758055c3a7ad99011d38 100644 --- a/content/en/docs/A-Tune/A-Tune.md +++ b/content/en/docs/A-Tune/A-Tune.md @@ -1 +1,5 @@ -This document describes how to install and use A-Tune, which is a performance self-optimization software for openEuler. \ No newline at end of file +# A-Tune User Guide + +This document describes how to install and use A-Tune, which is a performance self-optimization software for openEuler. + +This document is intended for developers, open-source enthusiasts, and partners who use the openEuler system and want to know and use A-Tune. You need to have basic knowledge of the Linux OS. \ No newline at end of file diff --git a/content/en/docs/A-Tune/a-tune-deployment.md b/content/en/docs/A-Tune/a-tune-deployment.md deleted file mode 100644 index 6d0d411922185b1ef5915d1fc1eef6818f466f03..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/a-tune-deployment.md +++ /dev/null @@ -1,6 +0,0 @@ -# A-Tune Deployment - -This chapter describes how to deploy A-Tune. - - - diff --git a/content/en/docs/A-Tune/a-tune-installation.md b/content/en/docs/A-Tune/a-tune-installation.md deleted file mode 100644 index d5f925797eb09849e975ad5a656e410ed56553d6..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/a-tune-installation.md +++ /dev/null @@ -1,6 +0,0 @@ -# A-Tune Installation - -This chapter describes the installation modes and methods of the A-Tune. - - - diff --git a/content/en/docs/A-Tune/acronyms-and-abbreviations.md b/content/en/docs/A-Tune/acronyms-and-abbreviations.md deleted file mode 100644 index 58101719b4ad58bcb75726402dc0945378e23ac4..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/acronyms-and-abbreviations.md +++ /dev/null @@ -1,24 +0,0 @@ -# Acronyms and Abbreviations - -**Table 1** Terminology - - - - - - - - - - - - - -

Term

-

Description

-

workload_type

-

Workload type, which is used to identify a type of service with the same characteristics.

-

profile

-

Set of optimization items and optimal parameter configuration.

-
- diff --git a/content/en/docs/A-Tune/activating-a-profile.md b/content/en/docs/A-Tune/activating-a-profile.md deleted file mode 100644 index 5226e3cdb090c344e299e9b9d7806ff16959ff7d..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/activating-a-profile.md +++ /dev/null @@ -1,2 +0,0 @@ -# Activating a Profile - diff --git a/content/en/docs/A-Tune/analysis.md b/content/en/docs/A-Tune/analysis.md deleted file mode 100644 index aaa46816acd15bb6380599b8d347280714733e5a..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/analysis.md +++ /dev/null @@ -1,45 +0,0 @@ -# analysis - -## Function - -Collect real-time statistics from the system to identify and automatically optimize workload types. - -## Format - -**atune-adm analysis** \[OPTIONS\] - -## Parameter Description - -- OPTIONS - - - - - - - - - - -

Parameter

-

Description

-

--model, -m

-

Model generated by user-defined training

-
- - -## Example - -- Use the default model for classification and identification. - - ``` - # atune-adm analysis - ``` - -- Use the user-defined training model for recognition. - - ``` - # atune-adm analysis --model /usr/libexec/atuned/analysis/models/new-model.m - ``` - - diff --git a/content/en/docs/A-Tune/appendixes.md b/content/en/docs/A-Tune/appendixes.md index 5d1d7dd335cb5df84266914dd920e91b05ca89dc..46f489cac3e98bcc418e368e7f442270d31a13fa 100644 --- a/content/en/docs/A-Tune/appendixes.md +++ b/content/en/docs/A-Tune/appendixes.md @@ -1,7 +1,30 @@ -# Appendixes +# Appendixes -   +- [Appendixes](#appendixes) + - [Acronyms and Abbreviations](#acronyms-and-abbreviations) +## Acronyms and Abbreviations +**Table 1** Terminology + + + + + + + + + + + + + +

Term

+

Description

+

workload_type

+

Workload type, which is used to identify a type of service with the same characteristics.

+

profile

+

Set of optimization items and optimal parameter configuration.

+
diff --git a/content/en/docs/A-Tune/application-scenarios.md b/content/en/docs/A-Tune/application-scenarios.md index 1d3aba8162253e0c228579ed56977d76ea9c7193..924170be9956171063f74f8a718545db93e55907 100644 --- a/content/en/docs/A-Tune/application-scenarios.md +++ b/content/en/docs/A-Tune/application-scenarios.md @@ -1,7 +1,1031 @@ -# Application Scenarios +# Application Scenarios You can use functions provided by A-Tune through the CLI client atune-adm. This chapter describes the functions and usage of the A-Tune client. +- [Application Scenarios](#application-scenarios) + - [Overview](#overview-0) + - [Querying Workload Types](#querying-workload-types) + - [list](#list) + - [Workload Type Analysis and Auto Optimization](#workload-type-analysis-and-auto-optimization) + - [analysis](#analysis) + - [User-defined Model](#user-defined-model) + - [define](#define) + - [collection](#collection) + - [train](#train) + - [undefine](#undefine) + - [Querying Profiles](#querying-profiles) + - [info](#info) + - [Updating a Profile](#updating-a-profile) + - [update](#update) + - [Activating a Profile](#activating-a-profile) + - [profile](#profile) + - [Rolling Back Profiles](#rolling-back-profiles) + - [rollback](#rollback) + - [Updating Database](#updating-database) + - [upgrade](#upgrade) + - [Querying System Information](#querying-system-information) + - [check](#check) + - [Automatic Parameter Optimization](#automatic-parameter-optimization) + - [Tuning](#tuning) +## Overview + +- You can run the **atune-adm help/--help/-h** command to query commands supported by atune-adm. +- All example commands are used in single-node mode. For distributed mode, specify an IP address and port number. For example: + + ``` + # atune-adm -a 192.168.3.196 -p 60001 list + ``` + +- The **define**, **update**, **undefine**, **collection**, **train**, and **upgrade **commands do not support remote execution. +- In the command format, brackets \(\[\]\) indicate that the parameter is optional, and angle brackets \(<\>\) indicate that the parameter is mandatory. The actual parameters prevail. +- In the command format, meanings of each command are as follows: + - **WORKLOAD\_TYPE**: name of a user-defined workload type. For details about the supported workload types, see the query result of the **list** command. + - **PROFILE\_NAME**: user-defined profile name. + - **PROFILE\_PATH**: path of the user-defined profile. + + +## Querying Workload Types + + + +### list + +#### Function + +Query the supported workload types, profiles, and the values of Active. + +#### Format + +**atune-adm list** + +#### Example + +``` +# atune-adm list + +Support WorkloadTypes: ++-----------------------------------+------------------------+-----------+ +| WorkloadType | ProfileName | Active | ++===================================+========================+===========+ +| default | default | true | ++-----------------------------------+------------------------+-----------+ +| webserver | ssl_webserver | false | ++-----------------------------------+------------------------+-----------+ +| big_database | database | false | ++-----------------------------------+------------------------+-----------+ +| big_data | big_data | false | ++-----------------------------------+------------------------+-----------+ +| in-memory_computing | in-memory_computing | false | ++-----------------------------------+------------------------+-----------+ +| in-memory_database | in-memory_database | false | ++-----------------------------------+------------------------+-----------+ +| single_computer_intensive_jobs | compute-intensive | false | ++-----------------------------------+------------------------+-----------+ +| communication | rpc_communication | false | ++-----------------------------------+------------------------+-----------+ +| idle | default | false | ++-----------------------------------+------------------------+-----------+ + +``` + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>If the value of Active is **true**, the profile is activated. In the example, the profile of the default type is activated. + +## Workload Type Analysis and Auto Optimization + + + + +### analysis + +#### Function + +Collect real-time statistics from the system to identify and automatically optimize workload types. + +#### Format + +**atune-adm analysis** \[OPTIONS\] + +#### Parameter Description + +- OPTIONS + + + + + + + + + +

Parameter

+

Description

+

--model, -m

+

Model generated by user-defined training

+
+ + +#### Example + +- Use the default model for classification and identification. + + ``` + # atune-adm analysis + ``` + +- Use the user-defined training model for recognition. + + ``` + # atune-adm analysis --model /usr/libexec/atuned/analysis/models/new-model.m + ``` + + +## User-defined Model + +A-Tune allows users to define and learn new models. To define a new model, perform the following steps: + +1. Run the **define** command to define workload\_type and profile. +2. Run the **collection** command to collect the profile data corresponding to workload\_type. +3. Run the **train** command to train the model. + + + + +### define + +#### Function + +Add a user-defined workload type and the corresponding profile optimization item. + +#### Format + +**atune-adm define** + +#### Example + +Add a workload type. Set workload type to **test\_type**, profile name to **test\_name**, and configuration file of an optimization item to **example.conf**. + +``` +# atune-adm define test_type test_name ./example.conf +``` + +The **example.conf** file can be written as follows \(the following optimization items are optional and are for reference only\). You can also run the **atune-adm info** command to view how the existing profile is written. + +``` +[main] +# list its parent profile +[tip] +# the recommended optimization, which should be performed manunaly +[check] +# check the environment +[affinity.irq] +# to change the affinity of irqs +[affinity.task] +# to change the affinity of tasks +[bios] +# to change the bios config +[bootloader.grub2] +# to change the grub2 config +[kernel_config] +# to change the kernel config +[script] +# the script extention of cpi +[sysctl] +# to change the /proc/sys/* config +[sysfs] +# to change the /sys/* config +[systemctl] +# to change the system service config +[ulimit] +# to change the resources limit of user +``` + +### collection + +#### Function + +Collect the global resource usage and OS status information during service running, and save the collected information to a CSV output file as the input dataset for model training. + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- This command depends on the sampling tools such as perf, mpstat, vmstat, iostat, and sar. +>- Currently, only the Kunpeng 920 CPU is supported. You can run the **dmidecode -t processor** command to check the CPU model. + +#### Format + +**atune-adm collection** + +#### Parameter Description + +- OPTIONS + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Description

+

--filename, -f

+

Name of the generated CSV file used for training: name-timestamp.csv

+

--output_path, -o

+

Path for storing the generated CSV file. The absolute path is required.

+

--disk, -b

+

Disk used during service running, for example, /dev/sda.

+

--network, -n

+

Network port used during service running, for example, eth0.

+

--workload_type, -t

+

Workload type, which is used as a label for training.

+

--duration, -d

+

Data collection time during service running, in seconds. The default collection time is 1200 seconds.

+

--interval, -i

+

Interval for collecting data, in seconds. The default interval is 5 seconds.

+
+ + +#### Example + +``` +# atune-adm collection --filename name --interval 5 --duration 1200 --output_path /home/data --disk sda --network eth0 --workload_type test_type +``` + +### train + +#### Function + +Use the collected data to train the model. Collect data of at least two workload types during training. Otherwise, an error is reported. + +#### Format + +**atune-adm train** + +#### Parameter Description + +- OPTIONS + + | Parameter | Description | + | ----------------- | ------------------------------------------------------ | + | --data_path, -d | Path for storing CSV files required for model training | + | --output_file, -o | Model generated through training | + + +#### Example + +Use the CSV file in the **data** directory as the training input. The generated model **new-model.m** is stored in the **model** directory. + +``` +# atune-adm train --data_path /home/data --output_file /usr/libexec/atuned/analysis/models/new-model.m +``` + +### undefine + +#### Function + +Delete a user-defined workload type. + +#### Format + +**atune-adm undefine** + +#### Example + +Delete the **test\_type** workload type. + +``` +# atune-adm undefine test_type +``` + +## Querying Profiles + + +### info + +#### Function + +View the profile content of a workload type. + +#### Format + +**atune-adm info** _ + +#### Example + +View the profile content of webserver. + +``` +# atune-adm info webserver + +*** ssl_webserver: + +# +# webserver tuned configuration +# +[main] +#TODO CONFIG + +[kernel_config] +#TODO CONFIG + +[bios] +#TODO CONFIG + +[sysfs] +#TODO CONFIG + +[sysctl] +fs.file-max=6553600 +fs.suid_dumpable = 1 +fs.aio-max-nr = 1048576 +kernel.shmmax = 68719476736 +kernel.shmall = 4294967296 +kernel.shmmni = 4096 +kernel.sem = 250 32000 100 128 +net.ipv4.tcp_tw_reuse = 1 +net.ipv4.tcp_syncookies = 1 +net.ipv4.ip_local_port_range = 1024 65500 +net.ipv4.tcp_max_tw_buckets = 5000 +net.core.somaxconn = 65535 +net.core.netdev_max_backlog = 262144 +net.ipv4.tcp_max_orphans = 262144 +net.ipv4.tcp_max_syn_backlog = 262144 +net.ipv4.tcp_timestamps = 0 +net.ipv4.tcp_synack_retries = 1 +net.ipv4.tcp_syn_retries = 1 +net.ipv4.tcp_fin_timeout = 1 +net.ipv4.tcp_keepalive_time = 60 +net.ipv4.tcp_mem = 362619 483495 725238 +net.ipv4.tcp_rmem = 4096 87380 6291456 +net.ipv4.tcp_wmem = 4096 16384 4194304 +net.core.wmem_default = 8388608 +net.core.rmem_default = 8388608 +net.core.rmem_max = 16777216 +net.core.wmem_max = 16777216 + +[systemctl] +sysmonitor=stop +irqbalance=stop + +[bootloader.grub2] +selinux=0 +iommu.passthrough=1 + +[tip] +bind your master process to the CPU near the network = affinity +bind your network interrupt to the CPU that has this network = affinity +relogin into the system to enable limits setting = OS + +[script] +openssl_hpre = 0 +prefetch = off + +[ulimit] +{user}.hard.nofile = 102400 +{user}.soft.nofile = 102400 + +[affinity.task] +#TODO CONFIG + +[affinity.irq] +#TODO CONFIG + +[check] +#TODO CONFIG + +``` + +   + +## Updating a Profile + +You can update the existing profile as required. + + + + +### update + +#### Function + +Update an optimization item of a workload type to the content in the **new.conf** file. + +#### Format + +**atune-adm update** + +#### Example + +Update the workload type to **test\_type** and the optimization item of test\_name to **new.conf**. + +``` +# atune-adm update test_type test_name ./new.conf +``` + +## Activating a Profile + +### profile + +#### Function + +Manually activate a profile of a workload type. + +#### Format + +**atune-adm profile **_<_WORKLOAD\_TYPE_\>_ + +#### Parameter Description + +You can run the **list** command to query the supported workload types. + +#### Example + +Activate the profile configuration of webserver. + +``` +# atune-adm profile webserver +``` + +## Rolling Back Profiles + +   + + + +### rollback + +#### Functions + +Roll back the current configuration to the initial configuration of the system. + +#### Format + +**atune-adm rollback** + +#### Example + +``` +# atune-adm rollback +``` + +## Updating Database + +   + + + +### upgrade + +#### Function + +Update the system database. + +#### Format + +**atune-adm upgrade** + +#### Parameter Description + +- DB\_FILE + + New database file path. + + +#### Example + +The database is updated to **new\_sqlite.db**. + +``` +# atune-adm upgrade ./new_sqlite.db +``` + +## Querying System Information + +   + + + + +### check + +#### Function + +Check the CPU, BIOS, OS, and NIC information. + +#### Format + +**atune-adm check** + +#### Example + +``` +# atune-adm check + cpu information: + cpu:0 version: Kunpeng 920-6426 speed: 2600000000 HZ cores: 64 + cpu:1 version: Kunpeng 920-6426 speed: 2600000000 HZ cores: 64 + system information: + DMIBIOSVersion: 0.59 + OSRelease: 4.19.36-vhulk1906.3.0.h356.eulerosv2r8.aarch64 + network information: + name: eth0 product: HNS GE/10GE/25GE RDMA Network Controller + name: eth1 product: HNS GE/10GE/25GE Network Controller + name: eth2 product: HNS GE/10GE/25GE RDMA Network Controller + name: eth3 product: HNS GE/10GE/25GE Network Controller + name: eth4 product: HNS GE/10GE/25GE RDMA Network Controller + name: eth5 product: HNS GE/10GE/25GE Network Controller + name: eth6 product: HNS GE/10GE/25GE RDMA Network Controller + name: eth7 product: HNS GE/10GE/25GE Network Controller + name: docker0 product: +``` + +## Automatic Parameter Optimization + +A-Tune provides the automatic search capability for optimal configurations, eliminating the need for repeated manual parameter adjustment and performance evaluation. This greatly improves the search efficiency of optimal configurations. + + + + +### Tuning + +#### Function + +Use the specified project file to search the dynamic space for parameters and find the optimal solution under the current environment configuration. + +#### Format + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Before running the command, ensure that the following conditions are met: +>1. The YAML configuration file of the server has been edited and placed in the **/etc/atuned/tuning/** directory on the server by the server administrator. +>2. The YAML configuration file of the client has been edited and placed in an arbitrary directory on the client. + +**atune-adm tuning** \[OPTIONS\] + +#### Parameter Description + +- OPTIONS + + + + + + + + + + + + +

Parameter

+

Description

+

--restore, -r

+

Restores the initial configuration before tuning.

+

--project, -p

+

Specifies the project name in the YAML file to be restored.

+
+ + >![](public_sys-resources/icon-note.gif) **NOTE:** + >The preceding two parameters must be used at the same time, and the -p parameter must be followed by the specific project name. + + +- **PROJECT\_YAML**: YAML configuration file of the client. + +#### Configuration Description + +**Table 1** YAML file on the server + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Description

+

Type

+

Value Range

+

project

+

Project name.

+

Character string

+

-

+

startworkload

+

Script for starting the service to be optimized.

+

Character string

+

-

+

stopworkload

+

Script for stopping the service to be optimized.

+

Character string

+

-

+

maxiterations

+

Maximum number of optimization iterations, which is used to limit the number of iterations on the client. Generally, the more optimization iterations, the better the optimization effect, but the longer the time required. Set this parameter based on the site requirements.

+

Integer

+

>10

+

object

+

Parameters to be optimized and related information.

+

For details about the object configuration items, see Table 2.

+

-

+

-

+
+**Table 2** Description of object configuration items + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Description

+

Type

+

Value Range

+

name

+

Parameter to be optimized.

+

Character string

+

-

+

desc

+

Description of parameters to be optimized.

+

Character string

+

-

+

get

+

Script for querying parameter values.

+

-

+

-

+

set

+

Script for setting parameter values.

+

-

+

-

+

needrestart

+

Specifies whether to restart the service for the parameter to take effect.

+

Enumeration

+

true or false

+

type

+

Parameter type. Currently, the discrete and continuous types are supported.

+

Enumeration

+

discrete or continuous

+

dtype

+

This parameter is available only when type is set to discrete. Currently, only int and string are supported.

+

Enumeration

+

int, string

+

scope

+

Parameter setting range. This parameter is valid only when type is set to discrete and dtype is set to int, or type is set to continuous.

+

Integer

+

The value is user-defined and must be within the valid range of this parameter.

+

step

+

Parameter value step, which is used when dtype is set to int.

+

Integer

+

This value is user-defined.

+

items

+

Enumerated value of which the parameter value is not within the scope. This is used when dtype is set to int.

+

Integer

+

The value is user-defined and must be within the valid range of this parameter.

+

options

+

Enumerated value range of the parameter value, which is used when dtype is set to string.

+

Character string

+

The value is user-defined and must be within the valid range of this parameter.

+

ref

+

Recommended initial value of the parameter

+

Integer or character string

+

The value is user-defined and must be within the valid range of this parameter.

+
+ +**Table 3** Description of configuration items of a YAML file on the client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Description

+

Type

+

Value Range

+

project

+

Project name, which must be the same as that in the configuration file on the server.

+

Character string

+

-

+

iterations

+

Number of optimization iterations.

+

Integer

+

≥ 10

+

benchmark

+

Performance test script.

+

-

+

-

+

evaluations

+

Performance test evaluation index.

+

For details about the evaluations configuration items, see Table 4.

+

-

+

-

+
+**Table 4** Description of evaluations configuration item + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Description

+

Type

+

Value Range

+

name

+

Evaluation index name.

+

Character string

+

-

+

get

+

Script for obtaining performance evaluation results.

+

-

+

-

+

type

+

Specifies a positive or negative type of the evaluation result. The value positive indicates that the performance value is minimized, and the value negative indicates that the performance value is maximized.

+

Enumeration

+

positive or negative

+

weight

+

Weight of the index. The value ranges from 0 to 100.

+

Integer

+

0-100

+

threshold

+

Minimum performance requirement of the index.

+

Integer

+

User-defined

+
+ +#### Example + +The following is an example of the YAML file configuration on a server: + +``` +project: "example" +maxiterations: 10 +startworkload: "" +stopworkload: "" +object : + - + name : "vm.swappiness" + info : + desc : "the vm.swappiness" + get : "sysctl -a | grep vm.swappiness" + set : "sysctl -w vm.swappiness=$value" + needrestart: "false" + type : "continuous" + scope : + - 0 + - 10 + ref : 1 + - + name : "irqbalance" + info : + desc : "system irqbalance" + get : "systemctl status irqbalance" + set : "systemctl $value sysmonitor;systemctl $value irqbalance" + needrestart: "false" + type : "discrete" + options: + - "start" + - "stop" + dtype : "string" + ref : "start" + - + name : "net.tcp_min_tso_segs" + info : + desc : "the minimum tso number" + get : "cat /proc/sys/net/ipv4/tcp_min_tso_segs" + set : "echo $value > /proc/sys/net/ipv4/tcp_min_tso_segs" + needrestart: "false" + type : "continuous" + scope: + - 1 + - 16 + ref : 2 + - + name : "prefetcher" + info : + desc : "" + get : "cat /sys/class/misc/prefetch/policy" + set : "echo $value > /sys/class/misc/prefetch/policy" + needrestart: "false" + type : "discrete" + options: + - "0" + - "15" + dtype : "string" + ref : "15" + - + name : "kernel.sched_min_granularity_ns" + info : + desc : "Minimal preemption granularity for CPU-bound tasks" + get : "sysctl kernel.sched_min_granularity_ns" + set : "sysctl -w kernel.sched_min_granularity_ns=$value" + needrestart: "false" + type : "continuous" + scope: + - 5000000 + - 50000000 + ref : 10000000 + - + name : "kernel.sched_latency_ns" + info : + desc : "" + get : "sysctl kernel.sched_latency_ns" + set : "sysctl -w kernel.sched_latency_ns=$value" + needrestart: "false" + type : "continuous" + scope: + - 10000000 + - 100000000 + ref : 16000000 + +``` + +   + +The following is an example of the YAML file configuration on a client: + +``` +project: "example" +iterations : 10 +benchmark : "sh /home/Benchmarks/mysql/tunning_mysql.sh" +evaluations : + - + name: "tps" + info: + get: "echo -e '$out' |grep 'transactions:' |awk '{print $3}' | cut -c 2-" + type: "negative" + weight: 100 + threshold: 100 +``` + +   + +#### Example + +- Perform tuning. + + ``` + # atune-adm tuning example-client.yaml + ``` + +- Restore the initial configuration before tuning. The example value is the project name in the YAML file. + + ``` + # atune-adm tuning --restore --project example + ``` + + diff --git a/content/en/docs/A-Tune/architecture.md b/content/en/docs/A-Tune/architecture.md deleted file mode 100644 index 478dd9e44e1e071056ea79f9f4d41d626bfdccad..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/architecture.md +++ /dev/null @@ -1,10 +0,0 @@ -# Architecture - -The following figure shows the A-Tune core technical architecture, which consists of intelligent decision-making, system profile, and interaction system. - -- Intelligent decision-making layer: consists of the awareness and decision-making subsystems, which implements intelligent awareness of applications and system optimization decision-making, respectively. -- System profile layer: consists of the labeling and learning subsystems. The labeling subsystem is used to cluster service models, and the learning subsystem is used to learn and classify service models. -- Interaction system layer: monitors and configures various system resources and executes optimization policies. - -![](figures/en-us_image_0227497343.png) - diff --git a/content/en/docs/A-Tune/automatic-parameter-optimization.md b/content/en/docs/A-Tune/automatic-parameter-optimization.md deleted file mode 100644 index 01046e1fc7f16d3e1927134e89711a10b0c39b83..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/automatic-parameter-optimization.md +++ /dev/null @@ -1,7 +0,0 @@ -# Automatic Parameter Optimization - -A-Tune provides the automatic search capability for optimal configurations, eliminating the need for repeated manual parameter adjustment and performance evaluation. This greatly improves the search efficiency of optimal configurations. - - - - diff --git a/content/en/docs/A-Tune/check.md b/content/en/docs/A-Tune/check.md deleted file mode 100644 index ac2e17c141bde553060c862bf99b0dc8fb1fb1ac..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/check.md +++ /dev/null @@ -1,32 +0,0 @@ -# check - -## Function - -Check the CPU, BIOS, OS, and NIC information. - -## Format - -**atune-adm check** - -## Example - -``` -# atune-adm check - cpu information: - cpu:0 version: Kunpeng 920-6426 speed: 2600000000 HZ cores: 64 - cpu:1 version: Kunpeng 920-6426 speed: 2600000000 HZ cores: 64 - system information: - DMIBIOSVersion: 0.59 - OSRelease: 4.19.36-vhulk1906.3.0.h356.eulerosv2r8.aarch64 - network information: - name: eth0 product: HNS GE/10GE/25GE RDMA Network Controller - name: eth1 product: HNS GE/10GE/25GE Network Controller - name: eth2 product: HNS GE/10GE/25GE RDMA Network Controller - name: eth3 product: HNS GE/10GE/25GE Network Controller - name: eth4 product: HNS GE/10GE/25GE RDMA Network Controller - name: eth5 product: HNS GE/10GE/25GE Network Controller - name: eth6 product: HNS GE/10GE/25GE RDMA Network Controller - name: eth7 product: HNS GE/10GE/25GE Network Controller - name: docker0 product: -``` - diff --git a/content/en/docs/A-Tune/collection.md b/content/en/docs/A-Tune/collection.md deleted file mode 100644 index 7c15aec494ebf287114d711f81d54c69a63b76d4..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/collection.md +++ /dev/null @@ -1,70 +0,0 @@ -# collection - -## Function - -Collect the global resource usage and OS status information during service running, and save the collected information to a CSV output file as the input dataset for model training. - ->![](public_sys-resources/icon-note.gif) **NOTE:** ->- This command depends on the sampling tools such as perf, mpstat, vmstat, iostat, and sar. ->- Currently, only the Kunpeng 920 CPU is supported. You can run the **dmidecode -t processor** command to check the CPU model. - -## Format - -**atune-adm collection** - -## Parameter Description - -- OPTIONS - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter

-

Description

-

--filename, -f

-

Name of the generated CSV file used for training: name-timestamp.csv

-

--output_path, -o

-

Path for storing the generated CSV file. The absolute path is required.

-

--disk, -b

-

Disk used during service running, for example, /dev/sda.

-

--network, -n

-

Network port used during service running, for example, eth0.

-

--workload_type, -t

-

Workload type, which is used as a label for training.

-

--duration, -d

-

Data collection time during service running, in seconds. The default collection time is 1200 seconds.

-

--interval, -i

-

Interval for collecting data, in seconds. The default interval is 5 seconds.

-
- - -## Example - -``` -# atune-adm collection --filename name --interval 5 --duration 1200 --output_path /home/data --disk sda --network eth0 --workload_type test_type -``` - diff --git a/content/en/docs/A-Tune/define.md b/content/en/docs/A-Tune/define.md deleted file mode 100644 index 1a17162eb6ad682ee79b486345925e4a293f7307..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/define.md +++ /dev/null @@ -1,49 +0,0 @@ -# define - -## Function - -Add a user-defined workload type and the corresponding profile optimization item. - -## Format - -**atune-adm define** - -## Example - -Add a workload type. Set workload type to **test\_type**, profile name to **test\_name**, and configuration file of an optimization item to **example.conf**. - -``` -# atune-adm define test_type test_name ./example.conf -``` - -The **example.conf** file can be written as follows \(the following optimization items are optional and are for reference only\). You can also run the **atune-adm info** command to view how the existing profile is written. - -``` -[main] -# list its parent profile -[tip] -# the recommended optimization, which should be performed manunaly -[check] -# check the environment -[affinity.irq] -# to change the affinity of irqs -[affinity.task] -# to change the affinity of tasks -[bios] -# to change the bios config -[bootloader.grub2] -# to change the grub2 config -[kernel_config] -# to change the kernel config -[script] -# the script extention of cpi -[sysctl] -# to change the /proc/sys/* config -[sysfs] -# to change the /sys/* config -[systemctl] -# to change the system service config -[ulimit] -# to change the resources limit of user -``` - diff --git a/content/en/docs/A-Tune/environment-preparation.md b/content/en/docs/A-Tune/environment-preparation.md deleted file mode 100644 index dd8cfb1edfe6862c6068e19bf391aa6a04a1fa91..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/environment-preparation.md +++ /dev/null @@ -1,4 +0,0 @@ -# Environment Preparation - -For details about installing an openEuler OS, see _openEuler 20.03 LTS Installation Guide_. - diff --git a/content/en/docs/A-Tune/faqs.md b/content/en/docs/A-Tune/faqs.md index 4b7c3eb1b889d59d126e194961425b60aeaa4f14..0a350b3ebf59fe290d0be52a0c9bd838bc54df4a 100644 --- a/content/en/docs/A-Tune/faqs.md +++ b/content/en/docs/A-Tune/faqs.md @@ -1,12 +1,14 @@ -# FAQs +# FAQs -Q1: An error occurs when the **train **command is used to train a model, and the message "training data failed" is displayed. +## Q1: An error occurs when the **train** command is used to train a model, and the message "training data failed" is displayed. Cause: Only one type of data is collected by using the **collection **command. Solution: Collect data of at least two data types for training. -Q2: The atune-adm cannot connect to the atuned service. + + +## Q2: The atune-adm cannot connect to the atuned service. Possible cause: @@ -43,7 +45,7 @@ Solution: ``` -Q3: The atuned service cannot be started, and the message "Job for atuned.service failed because a timeout was exceeded." is displayed. +## Q3: The atuned service cannot be started, and the message "Job for atuned.service failed because a timeout was exceeded." is displayed. Cause: The hosts file does not contain the localhost information. diff --git a/content/en/docs/A-Tune/getting-to-know-a-tune.md b/content/en/docs/A-Tune/getting-to-know-a-tune.md index db9e447051e3a51455afd8e4b83f2787cfd50f28..03415ded0cdc5fe96a42f1d872a45dde1ede6c4d 100644 --- a/content/en/docs/A-Tune/getting-to-know-a-tune.md +++ b/content/en/docs/A-Tune/getting-to-know-a-tune.md @@ -1,3 +1,179 @@ -# Getting to Know A-Tune +# Getting to Know A-Tune +- [Getting to Know A-Tune](#getting-to-know-a-tune) + - [Introduction](#introduction) + - [Architecture](#architecture) + - [Supported Features and Service Models](#supported-features-and-service-models) + + + +## Introduction + +An operating system \(OS\) is basic software that connects applications and hardware. It is critical for users to adjust OS and application configurations and make full use of software and hardware capabilities to achieve optimal service performance. However, numerous workload types and varied applications run on the OS, and the requirements on resources are different. Currently, the application environment composed of hardware and software involves more than 7000 configuration objects. As the service complexity and optimization objects increase, the time cost for optimization increases exponentially. As a result, optimization efficiency decreases sharply. Optimization becomes complex and brings great challenges to users. + +Second, as infrastructure software, the OS provides a large number of software and hardware management capabilities. The capability required varies in different scenarios. Therefore, capabilities need to be enabled or disabled depending on scenarios, and a combination of capabilities will maximize the optimal performance of applications. + +In addition, the actual business embraces hundreds and thousands of scenarios, and each scenario involves a wide variety of hardware configurations for computing, network, and storage. The lab cannot list all applications, business scenarios, and hardware combinations. + +To address the preceding challenges, openEuler launches A-Tune. + +A-Tune is an AI-based engine that optimizes system performance. It uses AI technologies to precisely profile business scenarios, discover and infer business characteristics, so as to make intelligent decisions, match with the optimal system parameter configuration combination, and give recommendations, ensuring the optimal business running status. + +![](figures/en-us_image_0227497000.png) + +## Architecture + +The following figure shows the A-Tune core technical architecture, which consists of intelligent decision-making, system profile, and interaction system. + +- Intelligent decision-making layer: consists of the awareness and decision-making subsystems, which implements intelligent awareness of applications and system optimization decision-making, respectively. +- System profile layer: consists of the labeling and learning subsystems. The labeling subsystem is used to cluster service models, and the learning subsystem is used to learn and classify service models. +- Interaction system layer: monitors and configures various system resources and executes optimization policies. + +![](figures/en-us_image_0227497343.png) + +## Supported Features and Service Models + +### Supported Features + +[Table 1](#table1919220557576) describes the main features supported by A-Tune, feature maturity, and usage suggestions. + +**Table 1** Feature maturity + + + + + + + + + + + + + + + + + + + + +

Feature

+

Maturity

+

Usage Suggestion

+

Auto optimization of 11 applications in seven workload types

+

Tested

+

Pilot

+

User-defined workload types and service models

+

Tested

+

Pilot

+

Automatic parameter optimization

+

Tested

+

Pilot

+
+ +### Supported Service Models + +Based on the workload characteristics of applications, A-Tune classifies services into seven types. For details about the workload characteristics of each type and the applications supported by A-Tune, see [Table 2](#table2819164611311). + +**Table 2** Supported workload types and applications + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Workload

+

Type

+

Workload Characteristic

+

Supported Application

+

default

+

Default type

+

The usage of CPU, memory bandwidth, network, and I/O resources is low.

+

N/A

+

webserver

+

HTTPS application

+

The CPU usage is high.

+

Nginx

+

big_database

+

Database

+
  • Relational database

    Read: The usage of CPU, memory bandwidth, and network is high.

    +

    Write: The usage of I/O is high.

    +
+
  • Non-relational database

    The usage of CPU and I/O is high.

    +
+

MongoDB, MySQL, PostgreSQL, and MariaDB

+

big_data

+

Big data

+

The usage of CPU and I/O is high.

+

Hadoop and Spark

+

in-memory_computing

+

Memory-intensive application

+

The usage of CPU and memory bandwidth is high.

+

SPECjbb2015

+

in-memory_database

+

Computing- and network-intensive application

+

The usage of a single-core CPU is high, and the network usage is high in multi-instance scenarios.

+

Redis

+

single_computer_intensive_jobs

+

Computing-intensive application

+

The usage of a single-core CPU is high, and the usage of memory bandwidth of some subitems is high.

+

SPECCPU2006

+

communication

+

Network-intensive application

+

The usage of CPU and network is high.

+

Dubbo

+

idle

+

System in idle state

+

The system is in idle state and no applications are running.

+

N/A

+
diff --git a/content/en/docs/A-Tune/info.md b/content/en/docs/A-Tune/info.md deleted file mode 100644 index 9d122f46e4e35ac2925397da72bc6cfe7f87145a..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/info.md +++ /dev/null @@ -1,97 +0,0 @@ -# info - -## Function - -View the profile content of a workload type. - -## Format - -**atune-adm info** _ - -## Example - -View the profile content of webserver. - -``` -# atune-adm info webserver - -*** ssl_webserver: - -# -# webserver tuned configuration -# -[main] -#TODO CONFIG - -[kernel_config] -#TODO CONFIG - -[bios] -#TODO CONFIG - -[sysfs] -#TODO CONFIG - -[sysctl] -fs.file-max=6553600 -fs.suid_dumpable = 1 -fs.aio-max-nr = 1048576 -kernel.shmmax = 68719476736 -kernel.shmall = 4294967296 -kernel.shmmni = 4096 -kernel.sem = 250 32000 100 128 -net.ipv4.tcp_tw_reuse = 1 -net.ipv4.tcp_syncookies = 1 -net.ipv4.ip_local_port_range = 1024 65500 -net.ipv4.tcp_max_tw_buckets = 5000 -net.core.somaxconn = 65535 -net.core.netdev_max_backlog = 262144 -net.ipv4.tcp_max_orphans = 262144 -net.ipv4.tcp_max_syn_backlog = 262144 -net.ipv4.tcp_timestamps = 0 -net.ipv4.tcp_synack_retries = 1 -net.ipv4.tcp_syn_retries = 1 -net.ipv4.tcp_fin_timeout = 1 -net.ipv4.tcp_keepalive_time = 60 -net.ipv4.tcp_mem = 362619 483495 725238 -net.ipv4.tcp_rmem = 4096 87380 6291456 -net.ipv4.tcp_wmem = 4096 16384 4194304 -net.core.wmem_default = 8388608 -net.core.rmem_default = 8388608 -net.core.rmem_max = 16777216 -net.core.wmem_max = 16777216 - -[systemctl] -sysmonitor=stop -irqbalance=stop - -[bootloader.grub2] -selinux=0 -iommu.passthrough=1 - -[tip] -bind your master process to the CPU near the network = affinity -bind your network interrupt to the CPU that has this network = affinity -relogin into the system to enable limits setting = OS - -[script] -openssl_hpre = 0 -prefetch = off - -[ulimit] -{user}.hard.nofile = 102400 -{user}.soft.nofile = 102400 - -[affinity.task] -#TODO CONFIG - -[affinity.irq] -#TODO CONFIG - -[check] -#TODO CONFIG - -``` - -   - diff --git a/content/en/docs/A-Tune/installation-and-deployment.md b/content/en/docs/A-Tune/installation-and-deployment.md index f7fdb4f76bcf190ab95fa2a904fa594c5a759de2..96a1e025d01cdf9261809680afb1e6e42115feaf 100644 --- a/content/en/docs/A-Tune/installation-and-deployment.md +++ b/content/en/docs/A-Tune/installation-and-deployment.md @@ -1,6 +1,242 @@ -# Installation and Deployment +# Installation and Deployment This chapter describes how to install and deploy A-Tune. +- [Installation and Deployment](#installation-and-deployment) + - [Software and Hardware Requirements](#software-and-hardware-requirements) + - [Environment Preparation](#environment-preparation) + - [A-Tune Installation](#a-tune-installation) + - [Installation Modes](#installation-modes) + - [Installation Procedure](#installation-procedure) + - [A-Tune Deployment](#a-tune-deployment) + - [Starting A-Tune](#starting-a-tune) + + + + +## Software and Hardware Requirements + +### Hardware Requirement + +- Huawei Kunpeng 920 processor + +### Software Requirement + +- OS: openEuler 20.03 LTS + +## Environment Preparation + +For details about installing an openEuler OS, see _openEuler 20.03 LTS Installation Guide_. + +## A-Tune Installation + +This chapter describes the installation modes and methods of the A-Tune. + +### Installation Modes + +A-Tune can be installed in single-node or distributed mode. + +- Single-node mode + + The client and server are installed on the same system. + +- Distributed mode + + The client and server are installed on different systems. + + +The installation modes are as follows: + +![](figures/en-us_image_0231122163.png) + +   + +### Installation Procedure + +To install the A-Tune, perform the following steps: + +1. Mount an openEuler ISO file. + + ``` + # mount openEuler-20.03-LTS-aarch64-dvd.iso /mnt + ``` + +2. Configure the local yum source. + + ``` + # vim /etc/yum.repos.d/local.repo + ``` + + The configured contents are as follows: + + ``` + [local] + name=local + baseurl=file:///mnt + gpgcheck=1 + enabled=1 + ``` + +3. Import the GPG public key of the RPM digital signature to the system. + + ``` + # rpm --import /mnt/RPM-GPG-KEY-openEuler + ``` + + +4. Install an A-Tune server. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >In this step, both the server and client software packages are installed. For the single-node deployment, skip **Step 5**. + + ``` + # yum install atune -y + ``` + +5. For a distributed mode, install an A-Tune client. + + ``` + # yum install atune-client -y + ``` + +6. Check whether the installation is successful. + + ``` + # rpm -qa | grep atune + atune-client-xxx + atune-db-xxx + atune-xxx + ``` + + If the preceding information is displayed, the installation is successful. + + +## A-Tune Deployment + +This chapter describes how to deploy A-Tune. + + + +### Overview + +The configuration items in the A-Tune configuration file **/etc/atuned/atuned.cnf** are described as follows: + +- A-Tune service startup configuration + + You can modify the parameter value as required. + + - **protocol**: Protocol used by the gRPC service. The value can be **unix** or **tcp**. **unix** indicates the local socket communication mode, and **tcp** indicates the socket listening port mode. The default value is **unix**. + + - **address**: Listening IP address of the gRPC service. The default value is **unix socket**. If the gRPC service is deployed in distributed mode, change the value to the listening IP address. + - **port**: Listening port of the gRPC server. The value ranges from 0 to 65535. If **protocol** is set to **unix**, you do not need to set this parameter. + - **rest\_port**: Listening port of the system REST service. The value ranges from 0 to 65535. + - **sample\_num**: Number of samples collected when the system executes the analysis process. + +- System information + + System is the parameter information required for system optimization. You must modify the parameter information according to the actual situation. + + - **disk**: Disk information to be collected during the analysis process or specified disk during disk optimization. + - **network**: NIC information to be collected during the analysis process or specified NIC during NIC optimization. + - **user**: User name used for ulimit optimization. Currently, only the user **root** is supported. + - **tls**: SSL/TLS certificate verification for the gRPC and HTTP services of A-Tune. This is disabled by default. After TLS is enabled, you need to set the following environment variables before running the **atune-adm** command to communicate with the server: + - export ATUNE\_TLS=yes + - export ATUNE\_CLICERT= + + - **tlsservercertfile**: path of the gPRC server certificate. + - **tlsserverkeyfile**: gPRC server key path. + - **tlshttpcertfile**: HTTP server certificate path. + - **tlshttpkeyfile**: HTTP server key path. + - **tlshttpcacertfile**: CA certificate path of the HTTP server. + +- Log information + + Change the log path and level based on the site requirements. By default, the log information is stored in **/var/log/messages**. + +- Monitor information + + Hardware information that is collected by default when the system is started. + + +#### Example + +``` +#################################### server ############################### +# atuned config +[server] +# the protocol grpc server running on +# ranges: unix or tcp +protocol = unix + +# the address that the grpc server to bind to +# default is unix socket /var/run/atuned/atuned.sock +# ranges: /var/run/atuned/atuned.sock or ip +address = /var/run/atuned/atuned.sock + +# the atuned grpc listening port, default is 60001 +# the port can be set between 0 to 65535 which not be used +port = 60001 + +# the rest service listening port, default is 8383 +# the port can be set between 0 to 65535 which not be used +rest_port = 8383 + +# when run analysis command, the numbers of collected data. +# default is 20 +sample_num = 20 + +# Enable gRPC and http server authentication SSL/TLS +# default is false +# tls = true +# tlsservercertfile = /etc/atuned/server.pem +# tlsserverkeyfile = /etc/atuned/server.key +# tlshttpcertfile = /etc/atuned/http/server.pem +# tlshttpkeyfile = /etc/atuned/http/server.key +# tlshttpcacertfile = /etc/atuned/http/cacert.pem + +#################################### log ############################### +# Either "debug", "info", "warn", "error", "critical", default is "info" +level = info + +#################################### monitor ############################### +[monitor] +# With the module and format of the MPI, the format is {module}_{purpose} +# The module is Either "mem", "net", "cpu", "storage" +# The purpose is "topo" +module = mem_topo, cpu_topo + +#################################### system ############################### +# you can add arbitrary key-value here, just like key = value +# you can use the key in the profile +[system] +# the disk to be analysis +disk = sda + +# the network to be analysis +network = enp189s0f0 + +user = root +``` + +## Starting A-Tune + +After the A-Tune is installed, you need to start the A-Tune service. + +- Start the atuned service. + + ``` + # systemctl start atuned + ``` + + +- To query the status of the atuned service, run the following command: + + ``` + # systemctl status atuned + ``` + + If the following information is displayed, the service is started successfully: + + ![](figures/en-us_image_0214540398.png) diff --git a/content/en/docs/A-Tune/installation-modes.md b/content/en/docs/A-Tune/installation-modes.md deleted file mode 100644 index 49eb118ab58361d0abaa86f137eff21367aed44d..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/installation-modes.md +++ /dev/null @@ -1,19 +0,0 @@ -# Installation Modes - -A-Tune can be installed in single-node or distributed mode. - -- Single-node mode - - The client and server are installed on the same system. - -- Distributed mode - - The client and server are installed on different systems. - - -The installation modes are as follows: - -![](figures/en-us_image_0231122163.png) - -   - diff --git a/content/en/docs/A-Tune/installation-procedure.md b/content/en/docs/A-Tune/installation-procedure.md deleted file mode 100644 index d2b14c534de38f78337e76470c1acf0aad35ef37..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/installation-procedure.md +++ /dev/null @@ -1,53 +0,0 @@ -# Installation Procedure - -To install the A-Tune, perform the following steps: - -1. Mount an openEuler ISO file. - - ``` - # mount openEuler-20.03-LTS-aarch64-dvd.iso /mnt - ``` - -2. Configure the local yum source. - - ``` - # vim /etc/yum.repos.d/local.repo - ``` - - The configured contents are as follows: - - ``` - [local] - name=local - baseurl=file:///mnt - gpgcheck=0 - enabled=1 - ``` - -3. Install an A-Tune server. - - >![](public_sys-resources/icon-note.gif) **NOTE:** - >In this step, both the server and client software packages are installed. For the single-node deployment, skip **Step 4**. - - ``` - # yum install atune -y - ``` - -4. For a distributed mode, install an A-Tune client. - - ``` - # yum install atune-client -y - ``` - -5. Check whether the installation is successful. - - ``` - # rpm -qa | grep atune - atune-client-xxx - atune-db-xxx - atune-xxx - ``` - - If the preceding information is displayed, the installation is successful. - - diff --git a/content/en/docs/A-Tune/introduction.md b/content/en/docs/A-Tune/introduction.md deleted file mode 100644 index 02f0e24af63c4346157707f733c22aba13e72617..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/introduction.md +++ /dev/null @@ -1,14 +0,0 @@ -# Introduction - -An operating system \(OS\) is basic software that connects applications and hardware. It is critical for users to adjust OS and application configurations and make full use of software and hardware capabilities to achieve optimal service performance. However, numerous workload types and varied applications run on the OS, and the requirements on resources are different. Currently, the application environment composed of hardware and software involves more than 7000 configuration objects. As the service complexity and optimization objects increase, the time cost for optimization increases exponentially. As a result, optimization efficiency decreases sharply. Optimization becomes complex and brings great challenges to users. - -Second, as infrastructure software, the OS provides a large number of software and hardware management capabilities. The capability required varies in different scenarios. Therefore, capabilities need to be enabled or disabled depending on scenarios, and a combination of capabilities will maximize the optimal performance of applications. - -In addition, the actual business embraces hundreds and thousands of scenarios, and each scenario involves a wide variety of hardware configurations for computing, network, and storage. The lab cannot list all applications, business scenarios, and hardware combinations. - -To address the preceding challenges, openEuler launches A-Tune. - -A-Tune is an AI-based engine that optimizes system performance. It uses AI technologies to precisely profile business scenarios, discover and infer business characteristics, so as to make intelligent decisions, match with the optimal system parameter configuration combination, and give recommendations, ensuring the optimal business running status. - -![](figures/en-us_image_0227497000.png) - diff --git a/content/en/docs/A-Tune/legal-statement.md b/content/en/docs/A-Tune/legal-statement.md deleted file mode 100644 index 1d65a4f2d4145fe249dd622c212b02896a9c2e83..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/legal-statement.md +++ /dev/null @@ -1,16 +0,0 @@ -# Legal Statement - -**Copyright © Huawei Technologies Co., Ltd. 2020. All rights reserved.** - -Your replication, use, modification, and distribution of this document are governed by the Creative Commons License Attribution-ShareAlike 4.0 International Public License \(CC BY-SA 4.0\). You can visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) to view a human-readable summary of \(and not a substitute for\) CC BY-SA 4.0. For the complete CC BY-SA 4.0, visit [https://creativecommons.org/licenses/by-sa/4.0/legalcode](https://creativecommons.org/licenses/by-sa/4.0/legalcode). - -   - -**Trademarks and Permissions** - -A-Tune and openEuler are trademarks of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders. - -**Disclaimer** - -This document is used only as a guide. Unless otherwise specified by applicable laws or agreed by both parties in written form, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, including but not limited to non-infringement, timeliness, and specific purposes. - diff --git a/content/en/docs/A-Tune/list.md b/content/en/docs/A-Tune/list.md deleted file mode 100644 index c1eacc44343e5f622e75cecae42575209f32caeb..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/list.md +++ /dev/null @@ -1,43 +0,0 @@ -# list - -## Function - -Query the supported workload types, profiles, and the values of Active. - -## Format - -**atune-adm list** - -## Example - -``` -# atune-adm list - -Support WorkloadTypes: -+-----------------------------------+------------------------+-----------+ -| WorkloadType | ProfileName | Active | -+===================================+========================+===========+ -| default | default | true | -+-----------------------------------+------------------------+-----------+ -| webserver | ssl_webserver | false | -+-----------------------------------+------------------------+-----------+ -| big_database | database | false | -+-----------------------------------+------------------------+-----------+ -| big_data | big_data | false | -+-----------------------------------+------------------------+-----------+ -| in-memory_computing | in-memory_computing | false | -+-----------------------------------+------------------------+-----------+ -| in-memory_database | in-memory_database | false | -+-----------------------------------+------------------------+-----------+ -| single_computer_intensive_jobs | compute-intensive | false | -+-----------------------------------+------------------------+-----------+ -| communication | rpc_communication | false | -+-----------------------------------+------------------------+-----------+ -| idle | default | false | -+-----------------------------------+------------------------+-----------+ - -``` - ->![](public_sys-resources/icon-note.gif) **NOTE:** ->If the value of Active is **true**, the profile is activated. In the example, the profile of the default type is activated. - diff --git a/content/en/docs/A-Tune/overview-0.md b/content/en/docs/A-Tune/overview-0.md deleted file mode 100644 index 04ba06829eafd77fe7b5fb32394f819ee9258cee..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/overview-0.md +++ /dev/null @@ -1,17 +0,0 @@ -# Overview - -- You can run the **atune-adm help/--help/-h** command to query commands supported by atune-adm. -- All example commands are used in single-node mode. For distributed mode, specify an IP address and port number. For example: - - ``` - # atune-adm -a 192.168.3.196 -p 60001 list - ``` - -- The **define**, **update**, **undefine**, **collection**, **train**, and **upgrade **commands do not support remote execution. -- In the command format, brackets \(\[\]\) indicate that the parameter is optional, and angle brackets \(<\>\) indicate that the parameter is mandatory. The actual parameters prevail. -- In the command format, meanings of each command are as follows: - - **WORKLOAD\_TYPE**: name of a user-defined workload type. For details about the supported workload types, see the query result of the **list** command. - - **PROFILE\_NAME**: user-defined profile name. - - **PROFILE\_PATH**: path of the user-defined profile. - - diff --git a/content/en/docs/A-Tune/overview.md b/content/en/docs/A-Tune/overview.md deleted file mode 100644 index 3fc44fa408c5f7bc4b87ccd1f2d139b7f5d775ec..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/overview.md +++ /dev/null @@ -1,101 +0,0 @@ -# Overview - -The configuration items in the A-Tune configuration file **/etc/atuned/atuned.cnf** are described as follows: - -- A-Tune service startup configuration - - You can modify the parameter value as required. - - - **protocol**: Protocol used by the gRPC service. The value can be **unix** or **tcp**. **unix** indicates the local socket communication mode, and **tcp** indicates the socket listening port mode. The default value is **unix**. - - - **address**: Listening IP address of the gRPC service. The default value is **unix socket**. If the gRPC service is deployed in distributed mode, change the value to the listening IP address. - - **port**: Listening port of the gRPC server. The value ranges from 0 to 65535. If **protocol** is set to **unix**, you do not need to set this parameter. - - **rest\_port**: Listening port of the system REST service. The value ranges from 0 to 65535. - - **sample\_num**: Number of samples collected when the system executes the analysis process. - -- System information - - System is the parameter information required for system optimization. You must modify the parameter information according to the actual situation. - - - **disk**: Disk information to be collected during the analysis process or specified disk during disk optimization. - - **network**: NIC information to be collected during the analysis process or specified NIC during NIC optimization. - - **user**: User name used for ulimit optimization. Currently, only the user **root** is supported. - - **tls**: SSL/TLS certificate verification for the gRPC and HTTP services of A-Tune. This is disabled by default. After TLS is enabled, you need to set the following environment variables before running the **atune-adm** command to communicate with the server: - - export ATUNE\_TLS=yes - - export ATUNE\_CLICERT= - - - **tlsservercertfile**: path of the gPRC server certificate. - - **tlsserverkeyfile**: gPRC server key path. - - **tlshttpcertfile**: HTTP server certificate path. - - **tlshttpkeyfile**: HTTP server key path. - - **tlshttpcacertfile**: CA certificate path of the HTTP server. - -- Log information - - Change the log path and level based on the site requirements. By default, the log information is stored in **/var/log/messages**. - -- Monitor information - - Hardware information that is collected by default when the system is started. - - -## Example - -``` -#################################### server ############################### -# atuned config -[server] -# the protocol grpc server running on -# ranges: unix or tcp -protocol = unix - -# the address that the grpc server to bind to -# default is unix socket /var/run/atuned/atuned.sock -# ranges: /var/run/atuned/atuned.sock or ip -address = /var/run/atuned/atuned.sock - -# the atuned grpc listening port, default is 60001 -# the port can be set between 0 to 65535 which not be used -port = 60001 - -# the rest service listening port, default is 8383 -# the port can be set between 0 to 65535 which not be used -rest_port = 8383 - -# when run analysis command, the numbers of collected data. -# default is 20 -sample_num = 20 - -# Enable gRPC and http server authentication SSL/TLS -# default is false -# tls = true -# tlsservercertfile = /etc/atuned/server.pem -# tlsserverkeyfile = /etc/atuned/server.key -# tlshttpcertfile = /etc/atuned/http/server.pem -# tlshttpkeyfile = /etc/atuned/http/server.key -# tlshttpcacertfile = /etc/atuned/http/cacert.pem - -#################################### log ############################### -# Either "debug", "info", "warn", "error", "critical", default is "info" -level = info - -#################################### monitor ############################### -[monitor] -# With the module and format of the MPI, the format is {module}_{purpose} -# The module is Either "mem", "net", "cpu", "storage" -# The purpose is "topo" -module = mem_topo, cpu_topo - -#################################### system ############################### -# you can add arbitrary key-value here, just like key = value -# you can use the key in the profile -[system] -# the disk to be analysis -disk = sda - -# the network to be analysis -network = enp189s0f0 - -user = root -``` - diff --git a/content/en/docs/A-Tune/preface.md b/content/en/docs/A-Tune/preface.md deleted file mode 100644 index a3a76d12fd6b588a394490da0819b0cbec97d061..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/preface.md +++ /dev/null @@ -1,36 +0,0 @@ -# Preface - -## Overview - -This document describes how to install and use A-Tune, which is a performance self-optimization software for openEuler. - -## Intended Audience - -This document is intended for developers, open-source enthusiasts, and partners who use the openEuler system and want to know and use A-Tune. You need to have basic knowledge of the Linux OS. - -## Symbol Conventions - -The symbols that may be found in this document are defined as follows: - - - - - - - - - - - - - -

Symbol

-

Description

-

-

Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results.

-

NOTICE is used to address practices not related to personal injury.

-

-

Supplements the important information in the main text.

-

NOTE is used to address information not related to personal injury, equipment damage, and environment deterioration.

-
- diff --git a/content/en/docs/A-Tune/profile.md b/content/en/docs/A-Tune/profile.md deleted file mode 100644 index ef8fdec14f32e45f5da201037ffebf095dab3a27..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/profile.md +++ /dev/null @@ -1,22 +0,0 @@ -# profile - -## Function - -Manually activate a profile of a workload type. - -## Format - -**atune-adm profile **_<_WORKLOAD\_TYPE_\>_ - -## Parameter Description - -You can run the **list** command to query the supported workload types. - -## Example - -Activate the profile configuration of webserver. - -``` -# atune-adm profile webserver -``` - diff --git a/content/en/docs/A-Tune/querying-profiles.md b/content/en/docs/A-Tune/querying-profiles.md deleted file mode 100644 index 61d7bb13f0c350e48e4274ee875b96f9d7aa61fa..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/querying-profiles.md +++ /dev/null @@ -1,3 +0,0 @@ -# Querying Profiles - - diff --git a/content/en/docs/A-Tune/querying-system-information.md b/content/en/docs/A-Tune/querying-system-information.md deleted file mode 100644 index 7d9264310e67d363338504b8b533c52c0c64f84b..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/querying-system-information.md +++ /dev/null @@ -1,7 +0,0 @@ -# Querying System Information - -   - - - - diff --git a/content/en/docs/A-Tune/querying-workload-types.md b/content/en/docs/A-Tune/querying-workload-types.md deleted file mode 100644 index a531e5d55e6aa6e93a7907dbafece4bf1c81bd2e..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/querying-workload-types.md +++ /dev/null @@ -1,4 +0,0 @@ -# Querying Workload Types - - - diff --git a/content/en/docs/A-Tune/rollback.md b/content/en/docs/A-Tune/rollback.md deleted file mode 100644 index 7d64993e413854f6cd853ed56ff6718256f15290..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/rollback.md +++ /dev/null @@ -1,16 +0,0 @@ -# rollback - -## Function - -Roll back the current configuration to the initial configuration of the system. - -## Format - -**atune-adm rollback** - -## Example - -``` -# atune-adm rollback -``` - diff --git a/content/en/docs/A-Tune/rolling-back-profiles.md b/content/en/docs/A-Tune/rolling-back-profiles.md deleted file mode 100644 index 383ffdec9072ee985259fe9a02bd56d76d19dc4c..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/rolling-back-profiles.md +++ /dev/null @@ -1,6 +0,0 @@ -# Rolling Back Profiles - -   - - - diff --git a/content/en/docs/A-Tune/software-and-hardware-requirements.md b/content/en/docs/A-Tune/software-and-hardware-requirements.md deleted file mode 100644 index 7d260015bcc466f04fc065a69345c4aa43109c32..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/software-and-hardware-requirements.md +++ /dev/null @@ -1,10 +0,0 @@ -# Software and Hardware Requirements - -## Hardware Requirement - -- Huawei Kunpeng 920 processor - -## Software Requirement - -- OS: openEuler 20.03 LTS - diff --git a/content/en/docs/A-Tune/starting-a-tune.md b/content/en/docs/A-Tune/starting-a-tune.md deleted file mode 100644 index 96b49fec05faf77d4e62a339bd08ee52160632c2..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/starting-a-tune.md +++ /dev/null @@ -1,22 +0,0 @@ -# Starting A-Tune - -After the A-Tune is installed, you need to start the A-Tune service. - -- Start the atuned service. - - ``` - # systemctl start atuned - ``` - - -- To query the status of the atuned service, run the following command: - - ``` - # systemctl status atuned - ``` - - If the following information is displayed, the service is started successfully: - - ![](figures/en-us_image_0214540398.png) - - diff --git a/content/en/docs/A-Tune/supported-features-and-service-models.md b/content/en/docs/A-Tune/supported-features-and-service-models.md deleted file mode 100644 index 00be2f9772e66515da60a52730c676acb1903d4f..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/supported-features-and-service-models.md +++ /dev/null @@ -1,146 +0,0 @@ -# Supported Features and Service Models - -## Supported Features - -[Table 1](#table1919220557576) describes the main features supported by A-Tune, feature maturity, and usage suggestions. - -**Table 1** Feature maturity - - - - - - - - - - - - - - - - - - - - -

Feature

-

Maturity

-

Usage Suggestion

-

Auto optimization of 11 applications in seven workload types

-

Tested

-

Pilot

-

User-defined workload types and service models

-

Tested

-

Pilot

-

Automatic parameter optimization

-

Tested

-

Pilot

-
- -## Supported Service Models - -Based on the workload characteristics of applications, A-Tune classifies services into seven types. For details about the workload characteristics of each type and the applications supported by A-Tune, see [Table 2](#table2819164611311). - -**Table 2** Supported workload types and applications - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Workload

-

Type

-

Workload Characteristic

-

Supported Application

-

default

-

Default type

-

The usage of CPU, memory bandwidth, network, and I/O resources is low.

-

N/A

-

webserver

-

HTTPS application

-

The CPU usage is high.

-

Nginx

-

big_database

-

Database

-
  • Relational database

    Read: The usage of CPU, memory bandwidth, and network is high.

    -

    Write: The usage of I/O is high.

    -
-
  • Non-relational database

    The usage of CPU and I/O is high.

    -
-

MongoDB, MySQL, PostgreSQL, and MariaDB

-

big_data

-

Big data

-

The usage of CPU and I/O is high.

-

Hadoop and Spark

-

in-memory_computing

-

Memory-intensive application

-

The usage of CPU and memory bandwidth is high.

-

SPECjbb2015

-

in-memory_database

-

Computing- and network-intensive application

-

The usage of a single-core CPU is high, and the network usage is high in multi-instance scenarios.

-

Redis

-

single_computer_intensive_jobs

-

Computing-intensive application

-

The usage of a single-core CPU is high, and the usage of memory bandwidth of some subitems is high.

-

SPECCPU2006

-

communication

-

Network-intensive application

-

The usage of CPU and network is high.

-

Dubbo

-

idle

-

System in idle state

-

The system is in idle state and no applications are running.

-

N/A

-
- diff --git a/content/en/docs/A-Tune/train.md b/content/en/docs/A-Tune/train.md deleted file mode 100644 index 3e7318fd83ccbdab08b4d1e1f74e19c4d87c81dc..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/train.md +++ /dev/null @@ -1,43 +0,0 @@ -# train - -## Function - -Use the collected data to train the model. Collect data of at least two workload types during training. Otherwise, an error is reported. - -## Format - -**atune-adm train** - -## Parameter Description - -- OPTIONS - - - - - - - - - - - - - -

Parameter

-

Description

-

--data_path, -d

-

Path for storing CSV files required for model training

-

--output_file, -o

-

Model generated through training

-
- - -## Example - -Use the CSV file in the **data** directory as the training input. The generated model **new-model.m** is stored in the **model** directory. - -``` -# atune-adm train --data_path /home/data --output_file /usr/libexec/atuned/analysis/models/new-model.m -``` - diff --git a/content/en/docs/A-Tune/tuning.md b/content/en/docs/A-Tune/tuning.md deleted file mode 100644 index daa6f79361a4e3bef3643fd4e07c9b9cdeac94b2..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/tuning.md +++ /dev/null @@ -1,469 +0,0 @@ -# Tuning - -## Function - -Use the specified project file to search the dynamic space for parameters and find the optimal solution under the current environment configuration. - -## Format - ->![](public_sys-resources/icon-note.gif) **NOTE:** ->Before running the command, ensure that the following conditions are met: ->1. The YAML configuration file of the server has been edited and placed in the **/etc/atuned/tuning/** directory on the server by the server administrator. ->2. The YAML configuration file of the client has been edited and placed in an arbitrary directory on the client. - -**atune-adm tuning** \[OPTIONS\] - -## Parameter Description - -- OPTIONS - - - - - - - - - - - - - -

Parameter

-

Description

-

--restore, -r

-

Restores the initial configuration before tuning.

-

--project, -p

-

Specifies the project name in the YAML file to be restored.

-
- - >![](public_sys-resources/icon-note.gif) **NOTE:** - >The preceding two parameters must be used at the same time, and the -p parameter must be followed by the specific project name. - - -- **PROJECT\_YAML**: YAML configuration file of the client. - -## Configuration Description - -**Table 1** YAML file on the server - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

Type

-

Value Range

-

project

-

Project name.

-

Character string

-

-

-

startworkload

-

Script for starting the service to be optimized.

-

Character string

-

-

-

stopworkload

-

Script for stopping the service to be optimized.

-

Character string

-

-

-

maxiterations

-

Maximum number of optimization iterations, which is used to limit the number of iterations on the client. Generally, the more optimization iterations, the better the optimization effect, but the longer the time required. Set this parameter based on the site requirements.

-

Integer

-

>10

-

object

-

Parameters to be optimized and related information.

-

For details about the object configuration items, see Table 2.

-

-

-

-

-
- -**Table 2** Description of object configuration items - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

Type

-

Value Range

-

name

-

Parameter to be optimized.

-

Character string

-

-

-

desc

-

Description of parameters to be optimized.

-

Character string

-

-

-

get

-

Script for querying parameter values.

-

-

-

-

-

set

-

Script for setting parameter values.

-

-

-

-

-

needrestart

-

Specifies whether to restart the service for the parameter to take effect.

-

Enumeration

-

true or false

-

type

-

Parameter type. Currently, the discrete and continuous types are supported.

-

Enumeration

-

discrete or continuous

-

dtype

-

This parameter is available only when type is set to discrete. Currently, only int and string are supported.

-

Enumeration

-

int, string

-

scope

-

Parameter setting range. This parameter is valid only when type is set to discrete and dtype is set to int, or type is set to continuous.

-

Integer

-

The value is user-defined and must be within the valid range of this parameter.

-

step

-

Parameter value step, which is used when dtype is set to int.

-

Integer

-

This value is user-defined.

-

items

-

Enumerated value of which the parameter value is not within the scope. This is used when dtype is set to int.

-

Integer

-

The value is user-defined and must be within the valid range of this parameter.

-

options

-

Enumerated value range of the parameter value, which is used when dtype is set to string.

-

Character string

-

The value is user-defined and must be within the valid range of this parameter.

-

ref

-

Recommended initial value of the parameter

-

Integer or character string

-

The value is user-defined and must be within the valid range of this parameter.

-
- -**Table 3** Description of configuration items of a YAML file on the client - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

Type

-

Value Range

-

project

-

Project name, which must be the same as that in the configuration file on the server.

-

Character string

-

-

-

iterations

-

Number of optimization iterations.

-

Integer

-

≥ 10

-

benchmark

-

Performance test script.

-

-

-

-

-

evaluations

-

Performance test evaluation index.

-

For details about the evaluations configuration items, see Table 4.

-

-

-

-

-
- -**Table 4** Description of evaluations configuration item - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

Type

-

Value Range

-

name

-

Evaluation index name.

-

Character string

-

-

-

get

-

Script for obtaining performance evaluation results.

-

-

-

-

-

type

-

Specifies a positive or negative type of the evaluation result. The value positive indicates that the performance value is minimized, and the value negative indicates that the performance value is maximized.

-

Enumeration

-

positive or negative

-

weight

-

Weight of the index. The value ranges from 0 to 100.

-

Integer

-

0-100

-

threshold

-

Minimum performance requirement of the index.

-

Integer

-

User-defined

-
- -## Example - -The following is an example of the YAML file configuration on a server: - -``` -project: "example" -maxiterations: 10 -startworkload: "" -stopworkload: "" -object : - - - name : "vm.swappiness" - info : - desc : "the vm.swappiness" - get : "sysctl -a | grep vm.swappiness" - set : "sysctl -w vm.swappiness=$value" - needrestart: "false" - type : "continuous" - scope : - - 0 - - 10 - ref : 1 - - - name : "irqbalance" - info : - desc : "system irqbalance" - get : "systemctl status irqbalance" - set : "systemctl $value sysmonitor;systemctl $value irqbalance" - needrestart: "false" - type : "discrete" - options: - - "start" - - "stop" - dtype : "string" - ref : "start" - - - name : "net.tcp_min_tso_segs" - info : - desc : "the minimum tso number" - get : "cat /proc/sys/net/ipv4/tcp_min_tso_segs" - set : "echo $value > /proc/sys/net/ipv4/tcp_min_tso_segs" - needrestart: "false" - type : "continuous" - scope: - - 1 - - 16 - ref : 2 - - - name : "prefetcher" - info : - desc : "" - get : "cat /sys/class/misc/prefetch/policy" - set : "echo $value > /sys/class/misc/prefetch/policy" - needrestart: "false" - type : "discrete" - options: - - "0" - - "15" - dtype : "string" - ref : "15" - - - name : "kernel.sched_min_granularity_ns" - info : - desc : "Minimal preemption granularity for CPU-bound tasks" - get : "sysctl kernel.sched_min_granularity_ns" - set : "sysctl -w kernel.sched_min_granularity_ns=$value" - needrestart: "false" - type : "continuous" - scope: - - 5000000 - - 50000000 - ref : 10000000 - - - name : "kernel.sched_latency_ns" - info : - desc : "" - get : "sysctl kernel.sched_latency_ns" - set : "sysctl -w kernel.sched_latency_ns=$value" - needrestart: "false" - type : "continuous" - scope: - - 10000000 - - 100000000 - ref : 16000000 - -``` - -   - -The following is an example of the YAML file configuration on a client: - -``` -project: "example" -iterations : 10 -benchmark : "sh /home/Benchmarks/mysql/tunning_mysql.sh" -evaluations : - - - name: "tps" - info: - get: "echo -e '$out' |grep 'transactions:' |awk '{print $3}' | cut -c 2-" - type: "negative" - weight: 100 - threshold: 100 -``` - -   - -## Example - -- Perform tuning. - - ``` - # atune-adm tuning example-client.yaml - ``` - -- Restore the initial configuration before tuning. The example value is the project name in the YAML file. - - ``` - # atune-adm tuning --restore --project example - ``` - - diff --git a/content/en/docs/A-Tune/undefine.md b/content/en/docs/A-Tune/undefine.md deleted file mode 100644 index 9a4acd425395d8e46b190a2f3ad0c8cc75e65869..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/undefine.md +++ /dev/null @@ -1,18 +0,0 @@ -# undefine - -## Function - -Delete a user-defined workload type. - -## Format - -**atune-adm undefine** - -## Example - -Delete the **test\_type** workload type. - -``` -# atune-adm undefine test_type -``` - diff --git a/content/en/docs/A-Tune/update.md b/content/en/docs/A-Tune/update.md deleted file mode 100644 index e5fbd8e7d69aa37fcf96093fc29488901a471270..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/update.md +++ /dev/null @@ -1,18 +0,0 @@ -# update - -## Function - -Update an optimization item of a workload type to the content in the **new.conf** file. - -## Format - -**atune-adm update** - -## Example - -Update the workload type to **test\_type** and the optimization item of test\_name to **new.conf**. - -``` -# atune-adm update test_type test_name ./new.conf -``` - diff --git a/content/en/docs/A-Tune/updating-a-profile.md b/content/en/docs/A-Tune/updating-a-profile.md deleted file mode 100644 index 69ea874bd2b17596782c02f03dbaf09ec02d8a82..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/updating-a-profile.md +++ /dev/null @@ -1,7 +0,0 @@ -# Updating a Profile - -You can update the existing profile as required. - - - - diff --git a/content/en/docs/A-Tune/updating-database.md b/content/en/docs/A-Tune/updating-database.md deleted file mode 100644 index 2a19223694c761557d5d59bf8bb9bda3f0287765..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/updating-database.md +++ /dev/null @@ -1,6 +0,0 @@ -# Updating Database - -   - - - diff --git a/content/en/docs/A-Tune/upgrade.md b/content/en/docs/A-Tune/upgrade.md deleted file mode 100644 index 7acfa97aacc9b6436f621ea615f4f903b2d2ab34..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/upgrade.md +++ /dev/null @@ -1,25 +0,0 @@ -# upgrade - -## Function - -Update the system database. - -## Format - -**atune-adm upgrade** - -## Parameter Description - -- DB\_FILE - - New database file path. - - -## Example - -The database is updated to **new\_sqlite.db**. - -``` -# atune-adm upgrade ./new_sqlite.db -``` - diff --git a/content/en/docs/A-Tune/user-defined-model.md b/content/en/docs/A-Tune/user-defined-model.md deleted file mode 100644 index e48b7c8864c1b2ab25923900d4be7bab4caf7409..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/user-defined-model.md +++ /dev/null @@ -1,11 +0,0 @@ -# User-defined Model - -A-Tune allows users to define and learn new models. To define a new model, perform the following steps: - -1. Run the **define** command to define workload\_type and profile. -2. Run the **collection** command to collect the profile data corresponding to workload\_type. -3. Run the **train** command to train the model. - - - - diff --git a/content/en/docs/A-Tune/workload-type-analysis-and-auto-optimization.md b/content/en/docs/A-Tune/workload-type-analysis-and-auto-optimization.md deleted file mode 100644 index 5ccd1909bce9d4109aa3528c131e259e50d060ef..0000000000000000000000000000000000000000 --- a/content/en/docs/A-Tune/workload-type-analysis-and-auto-optimization.md +++ /dev/null @@ -1,5 +0,0 @@ -# Workload Type Analysis and Auto Optimization - - - - diff --git a/content/en/menu/index.md b/content/en/menu/index.md index 8904c6085341ecb39ee150b95b7d25323c364e9f..f69178f1795b19533ffe8ae3dc573a9d073f08e3 100644 --- a/content/en/menu/index.md +++ b/content/en/menu/index.md @@ -498,66 +498,14 @@ headless: true - [events]({{< relref "./docs/Container/events.md" >}}) - [info]({{< relref "./docs/Container/info.md" >}}) - [version]({{< relref "./docs/Container/version.md" >}}) - + + - [A-Tune User Guide]({{< relref "./docs/A-Tune/A-Tune.md" >}}) - - [Preface]({{< relref "./docs/A-Tune/preface.md" >}}) - [Getting to Know A-Tune]({{< relref "./docs/A-Tune/getting-to-know-a-tune.md" >}}) - - [Introduction]({{< relref "./docs/A-Tune/introduction.md" >}}) - - [Architecture]({{< relref "./docs/A-Tune/architecture.md" >}}) - - [Supported Features and Service Models]({{< relref "./docs/A-Tune/supported-features-and-service-models.md" >}}) - - [Installation and Deployment]({{< relref "./docs/A-Tune/installation-and-deployment.md" >}}) - - [Software and Hardware Requirements]({{< relref "./docs/A-Tune/software-and-hardware-requirements.md" >}}) - - [Environment Preparation]({{< relref "./docs/A-Tune/environment-preparation.md" >}}) - - [A-Tune Installation]({{< relref "./docs/A-Tune/a-tune-installation.md" >}}) - - [Installation Modes]({{< relref "./docs/A-Tune/installation-modes.md" >}}) - - [Installation Procedure]({{< relref "./docs/A-Tune/installation-procedure.md" >}}) - - - [A-Tune Deployment]({{< relref "./docs/A-Tune/a-tune-deployment.md" >}}) - - [Overview]({{< relref "./docs/A-Tune/overview.md" >}}) - - - [Starting A-Tune]({{< relref "./docs/A-Tune/starting-a-tune.md" >}}) - - [Application Scenarios]({{< relref "./docs/A-Tune/application-scenarios.md" >}}) - - [Overview]({{< relref "./docs/A-Tune/overview-0.md" >}}) - - [Querying Workload Types]({{< relref "./docs/A-Tune/querying-workload-types.md" >}}) - - [list]({{< relref "./docs/A-Tune/list.md" >}}) - - - [Workload Type Analysis and Auto Optimization]({{< relref "./docs/A-Tune/workload-type-analysis-and-auto-optimization.md" >}}) - - [analysis]({{< relref "./docs/A-Tune/analysis.md" >}}) - - - [User-defined Model]({{< relref "./docs/A-Tune/user-defined-model.md" >}}) - - [define]({{< relref "./docs/A-Tune/define.md" >}}) - - [collection]({{< relref "./docs/A-Tune/collection.md" >}}) - - [train]({{< relref "./docs/A-Tune/train.md" >}}) - - [undefine]({{< relref "./docs/A-Tune/undefine.md" >}}) - - - [Querying Profiles]({{< relref "./docs/A-Tune/querying-profiles.md" >}}) - - [info]({{< relref "./docs/A-Tune/info.md" >}}) - - - [Updating a Profile]({{< relref "./docs/A-Tune/updating-a-profile.md" >}}) - - [update]({{< relref "./docs/A-Tune/update.md" >}}) - - - [Activating a Profile]({{< relref "./docs/A-Tune/activating-a-profile.md" >}}) - - [profile]({{< relref "./docs/A-Tune/profile.md" >}}) - - - [Rolling Back Profiles]({{< relref "./docs/A-Tune/rolling-back-profiles.md" >}}) - - [rollback]({{< relref "./docs/A-Tune/rollback.md" >}}) - - - [Updating Database]({{< relref "./docs/A-Tune/updating-database.md" >}}) - - [upgrade]({{< relref "./docs/A-Tune/upgrade.md" >}}) - - - [Querying System Information]({{< relref "./docs/A-Tune/querying-system-information.md" >}}) - - [check]({{< relref "./docs/A-Tune/check.md" >}}) - - - [Automatic Parameter Optimization]({{< relref "./docs/A-Tune/automatic-parameter-optimization.md" >}}) - - [Tuning]({{< relref "./docs/A-Tune/tuning.md" >}}) - - - - [FAQs]({{< relref "./docs/A-Tune/faqs.md" >}}) + - [FAQs]({{< relref "./docs/NewA-Tune/faqs.md" >}}) - [Appendixes]({{< relref "./docs/A-Tune/appendixes.md" >}}) - - [Acronyms and Abbreviations]({{< relref "./docs/A-Tune/acronyms-and-abbreviations.md" >}}) -