add doc for gracePeriodSeconds (#196)

Signed-off-by: 守辰 <shouchen.zz@alibaba-inc.com>
openkruise · Jul 10, 2024 · bc946b4 · bc946b4
1 parent 1a75ffa
commit bc946b4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/...usaurus-plugin-content-docs-rollouts/current/user-manuals/api-specifications.md b/...usaurus-plugin-content-docs-rollouts/current/user-manuals/api-specifications.md
@@ -50,6 +50,7 @@ spec:
         # 与服务相关的 Ingress 名称
         ingress:
           name: echoserver
+        gracePeriodSeconds: 10
 ```
 
   </TabItem>
@@ -95,6 +96,7 @@ spec:
       # 与服务相关的 Ingress 名称
         ingress:
           name: echoserver
+        gracePeriodSeconds: 10
 ```
 
   </TabItem>
@@ -177,14 +179,17 @@ spec:
         ingress:
           classType: <traffic-type> # 例如：nginx | higress，默认为 "nginx"
           name: <ingress-name-that-is-related-the-service>
+        gracePeriodSeconds: 10
       - service: <service-name-that-is-related-your-workload>
         gateway: # 或者选择使用 Ingress 或 GatewayAPI
           httpRouteName: <gateway-api-httpRoute-name>
+        gracePeriodSeconds: 10
       - service: <service-name-that-is-related-your-workload>
         customNetworkRefs:
         - apiVersion: <your-resource-apiVersion>
           kind: <your-resource-kind>
           name: <your-resource-name>
+        gracePeriodSeconds: 10
 ```
 
 | 字段                      | 类型  | 默认值     | 说明                                                                                            |
@@ -196,6 +201,7 @@ spec:
 | `ingress.classType`     | 字符串 | "nginx" | Ingress类型，如"nginx"、"higress"或其他                                                               |
 | `ingress.name`          | 字符串 | ""      | 绑定服务的Ingress资源的名称                                                                             |
 | `gateway.httpRouteName` | 字符串 | ""      | Gateway API的[HTTPRoute](https://gateway-api.sigs.k8s.io/concepts/api-overview/#httproute)资源名称 |
+| `gracePeriodSeconds`    | 整数| 3        | 在每个步骤中等待流量路由配置生效的时间（秒）| 
 注意：
 - 如果决定使用`trafficRoutings`，则`ingress`、`gateway`和`customNetworkRefs`不能同时为nil，且`ingress`、`gateway`和`customNetworkRefs` 不能同时配置在一个trafficRouting中。 
 
@@ -215,6 +221,7 @@ spec:
     ingress:
       classType: mse
       name: spring-cloud-a
+    gracePeriodSeconds: 10
   strategy:
     matches:
     - headers:

diff --git a/rollouts/user-manuals/api-specifications.md b/rollouts/user-manuals/api-specifications.md
@@ -172,14 +172,17 @@ spec:
         ingress: # alternative： ingress,gateway,customNetworkRefs
           classType: <traffic-type> # example: nginx | higress, defaults to "nginx"
           name: <ingress-name-that-is-related-the-service>
+        gracePeriodSeconds: 10
       - service: <service-name-that-is-related-your-workload>
         gateway:
           httpRouteName: <gateway-api-httpRoute-name>
+        gracePeriodSeconds: 10
       - service: <service-name-that-is-related-your-workload>
         customNetworkRefs:
         - apiVersion: <your-resource-apiVersion>
           kind: <your-resource-kind>
           name: <your-resource-name>
+        gracePeriodSeconds: 10
 ```
 
   </TabItem>
@@ -198,6 +201,7 @@ spec:
         ingress: # alternative： ingress,gateway,customNetworkRefs
           classType: <traffic-type> # example: nginx | higress, defaults to "nginx"
           name: <ingress-name-that-is-related-the-service>
+        gracePeriodSeconds: 10
       - service: <service-name-that-is-related-your-workload>
         gateway: 
           httpRouteName: <gateway-api-httpRoute-name>
@@ -216,10 +220,11 @@ spec:
 | `service`               | string | ""       | Name of service that select the pods of bounded workload                                                      |
 | `ingress`               | object | nil      | (optional) Description of the Ingress object you want to bind                                                 |
 | `gateway`               | object | nil      | (optional) Description of the [Gateway API](https://gateway-api.sigs.k8s.io/) resources you want to bind      |
-| `customNetworkRefs    ` | Array  | ""       | Definitions of [customize API Gateway resources](https://openkruisyye.io/rollouts/developer-manuals/custom-network-provider) | 
+| `customNetworkRefs    ` | Array  | ""       | (optional) Definitions of [customize API Gateway resources](https://openkruisyye.io/rollouts/developer-manuals/custom-network-provider) | 
 | `ingress.classType`     | string | "nginx"  | Ingress type, such as "nginx", "higress", or others                                                           |
 | `ingress.name`          | string | ""       | Name of ingress resource that bounded the service                                                             |
 | `gateway.httpRouteName` | string | ""       | Name of [HTTPRoute](https://gateway-api.sigs.k8s.io/concepts/api-overview/#httproute) resource of Gateway API |
+| `gracePeriodSeconds`    | integer| 3        | Duration in seconds that kruise rollout wait for the traffic routing configuration changes to take effects in each step |
 
 **Note: if you decide to use `trafficRoutings`, one and only one of `ingress`,`gateway`,`customNetworkRefs` can be present in one trafficRouting element*
 
@@ -238,6 +243,7 @@ spec:
     ingress:
       classType: mse
       name: spring-cloud-a
+    gracePeriodSeconds: 10
   strategy:
     matches:
     - headers: