Update config.md

jd-opensource · May 30, 2024 · 4cad556 · 4cad556
1 parent 03fe435
commit 4cad556
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 14 deletions.
diff --git a/docs/cn/config.md b/docs/cn/config.md
@@ -1,9 +1,11 @@
 配置参考手册
 ===
 
-## 1. 环境变量
+## 1. 系统配置文件
 
-配置文件支持环境变量占位符
+## 1.1 bootstrap.properties
+
+存放应用信息和类加载器配置
 
 ```properties
 app.name=${APPLICATION_NAME}
@@ -18,6 +20,10 @@ app.location.laneSpaceId=${APPLICATION_LOCATION_LANESPACE_ID}
 app.location.lane=${APPLICATION_LOCATION_LANE}
 ```
 
+## 1.2 config.yaml
+
+存放增强配置、插件定义以及多活流量治理策略配置
+
 ```yaml
 agent: 
   switch:
@@ -27,7 +33,11 @@ agent:
       sofarpc: true
 ```
 
-### 1.1 环境变量来源
+## 2. 环境变量
+
+配置文件支持环境变量占位符
+
+### 2.1 环境变量来源
 1. 系统环境变量
 
 `System.getenv()`
@@ -81,10 +91,10 @@ ConfigEnvSupplier  -->  AbstractEnvSupplier
 SpringEnvSupplier  -->  AbstractEnvSupplier 
 
 ```
-1. ConfigEnvSupplier从应用资源路径加载`live-agent.properties`
-2. SpringEnvSupplier从应用资源路径加载应用名称
+1. `ConfigEnvSupplier`从应用资源路径加载`live-agent.properties`
+2. `SpringEnvSupplier`从应用资源路径加载应用名称
 
-### 1.2 常用环境变量
+### 2.2 常用环境变量
 
 | 名称                              | 说明               | 必需 | 默认值    | 说明                                                     |
 |-----------------------------------|--------------------|------|-----------|----------------------------------------------------------|

diff --git a/docs/config.md b/docs/config.md
@@ -1,9 +1,11 @@
 Configuration Reference Manual
 ===
 
-## 1. Environment Variables
+## 1. System Configuration Files
 
-The configuration file supports environment variable placeholders.
+## 1.1 bootstrap.properties
+
+Stores application information and class loader configuration.
 
 ```properties
 app.name=${APPLICATION_NAME}
@@ -18,6 +20,10 @@ app.location.laneSpaceId=${APPLICATION_LOCATION_LANESPACE_ID}
 app.location.lane=${APPLICATION_LOCATION_LANE}
 ```
 
+## 1.2 config.yaml
+
+Stores enhanced configuration, plugin definitions, and multi-active traffic governance policy configuration.
+
 ```yaml
 agent: 
   switch:
@@ -27,7 +33,11 @@ agent:
       sofarpc: true
 ```
 
-### 1.1 Sources of Environment Variables
+## 2. Environment Variables
+
+The configuration file supports environment variable placeholders.
+
+### 2.1 Sources of Environment Variables
 1. System Environment Variables
 
 `System.getenv()`
@@ -84,7 +94,7 @@ SpringEnvSupplier  -->  AbstractEnvSupplier
 1. `ConfigEnvSupplier` loads `live-agent.properties` from the application resource path.
 2. `SpringEnvSupplier` loads the application name from the application resource path.
 
-### 1.2 Common Environment Variables
+### 2.2 Common Environment Variables
 
 | Name                              | Description        | Required | Default   | Notes                                                     |
 |-----------------------------------|--------------------|----------|-----------|----------------------------------------------------------|
@@ -101,7 +111,4 @@ SpringEnvSupplier  -->  AbstractEnvSupplier
 | CONFIG_POLICY_INITIALIZE_TIMEOUT  | Policy Sync Timeout | No      | 10000(ms) |                                                          |
 | CONFIG_FLOW_CONTROL_ENABLED       | Enable Service Flow Control | No | true  | Enable service flow control, including rate limiting, circuit breaking, load balancing, tag routing, etc. |
 | CONFIG_LANE_ENABLED               | Enable Lane Flow Control | No | true      | Enable lane flow control                                  |
-| CONFIG_WARMUP_SERVICES            | Warmup Services    | No       |           | Configure the names of microservices to warm up, separated by semicolons or commas |
-```
-
-
+| CONFIG_WARMUP_SERVICES            | Warmup Services    | No       |           | Configure the names of microservices to warm up, separated by semicolons or commas |