From b73249c50b41214384c8b211b1a7d33ae52ef0c2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=83=A1=E5=A4=A9=E5=9E=9A?= <huty@hty1024.com>
Date: Fri, 17 May 2024 09:00:00 +0000
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0description?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 description/compose.yaml | 75 ++++++++++++++++++++++++++++++++++------
 1 file changed, 65 insertions(+), 10 deletions(-)

diff --git a/description/compose.yaml b/description/compose.yaml
index 3387510..6be3bcf 100644
--- a/description/compose.yaml
+++ b/description/compose.yaml
@@ -1,50 +1,105 @@
+# 指定API版本号
 version: "3.9"
+# 指定文件名称
+name: ${NAME}
 
-services: 
+# 服务相关
+services:
+  ## 服务1 
   ${SERVICE_NAME}: 
+    ### 镜像
     image: ${IMAGE_NAME}:${IMAGE_TAG}
+    ### 容器名称
     container_name: ${CONTAINER_NAME}
+    ### 重启规则
     restart: on-failure:3
+    ### 是否以特权模式启动容器
     privileged: true
+    ### 容器内用户
     user: ${USER_NAME}:${USER_GROUP}
+    ### 容器内工作目录
     working_dir: ${WORKING_DIR}
+    ### 挂载的存储卷或目录
     volumes: 
+      #### 确保容器内时间和主机一致
       - /etc/localtime:/etc/localtime:ro
+      #### 挂载存储卷（需在volumes部分设置卷相关参数）
       - ${VOLUME_NAME}:${CONTAINER_PATH}
+      #### 挂载主机目录
       - ${HOST_PATH}:${CONTAINER_PATH}
+    ### 使用的配置（需在configs部分设置配置相关参数）
     configs: 
       - ${CONFIG_NAME}
+    ### 使用的凭据（需在secrets部分设置凭据相关参数）
     secrets: 
       - ${SECRET_NAME}
+    ### 容器内环境变量
     environment: 
       - ${KEY}=${VALUE}
+    ### 运行容器时执行的命令
     command: ${COMMAND}
+    ### 当前服务依赖的容器
     depends_on:
       - ${SERVICE_NAME}
+    ### 容器的网络模式
     network_mode: host
+    ### 容器的端口号
     ports:
       - ${HOST_PORT}:${CONTAINER_PORT}
+    ### 容器的网络
     networks:
       - ${NETWORK_NAME}
 
+# 存储卷相关
 volumes:
+  ## 存储卷1
   ${VOLUME_NAME}:
-    external: true
+    ## 存储卷名称
     name: ${VOLUME_NAME}
-
-configs: 
-  ${CONFIG_NAME}:
+    ## 是否使用已存在的存储卷
     external: true
+
+# 配置相关
+configs:
+  ## 配置1 
+  ${CONFIG_NAME}:
+    ### 配置名称
     name: ${CONFIG_NAME}
+    ### 是否使用已存在的配置
+    external: true
+    ### 配置对应的文件
     file: ${CONFIG_FILE_NAME}
 
+# 凭据相关
 secrets:
+  ## 凭据1
   ${SECRET_NAME}:
-    external: true
+    ### 凭据名称
     name: ${SECRET_NAME}
-    file: ${SECRET_FILE_NAME}
-
-networks:
-  ${NETWORK_NAME}:
+    ### 是否使用已存在的凭据
     external: true
+    ### 凭据对应的文件
+    file: ${SECRddET_FILE_NAME}
+
+# 网络相关
+networks:
+  ## 网络1
+  ${NETWORK_NAME}:
+    ## 网络名称
     name: ${NETWORK_NAME}
+    ## 是否使用已存在的网络
+    external: true
+    ## 网络适配器
+    driver: bridge
+    ## 网络适配器参数
+    driver_opts:
+      ### 是否加密
+      encrypted: 'true'
+    ## 网络参数
+    ipam:
+      ### 适配器
+      driver: default
+      ### 配置
+      config:
+        #### 网段
+        - subnet: 172.21.0.1/24