Merge pull request #7418 from RusJaI/master

Update documentation for the added config to modify the buffered payload limit in choreo connect.
wso2 · Dec 7, 2023 · 021e56b · 021e56b
2 parents f7aee7c + 72daea2
commit 021e56b
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/...ublish/deploy-on-gateway/choreo-connect/configurations/router-configurations.md b/...ublish/deploy-on-gateway/choreo-connect/configurations/router-configurations.md
@@ -52,6 +52,7 @@ See the example .toml file given below.
   enforcerResponseTimeoutInSeconds = 20
   systemHost = "localhost"
   useRemoteAddress = false
+  perConnectionBufferLimitBytes = 1048576
 </code></pre>
                     </div>
                 </div>
@@ -218,6 +219,28 @@ See the example .toml file given below.
                                     </div>
                                 </div>
                             </div>
+                            <div class="param">
+                                <div class="param-name">
+                                  <span class="param-name-wrap"> <code>perConnectionBufferLimitBytes</code> </span>
+                                </div>
+                                <div class="param-info">
+                                    <div>
+                                        <p>
+                                            <span class="param-type string"> integer </span>
+                                        </p>
+                                        <div class="param-default">
+                                            <span class="param-default-value">Default: <code>1048576</code></span>
+                                        </div>
+                                    </div>
+                                    <div class="param-description">
+                                        <p>The buffer limit per connection in Bytes. Default value is 1 MiB</p>
+                                    </div>
+                                    <div class="admonition attention">
+                                        <p class="admonition-title">Update Level 4</p>
+                                        <p>This feature is available only as an update, after Update level 1.2.0.4 (released on 21 Nov 2023) and further. For more information regarding Choreo Connect updates, see <a href="https://apim.docs.wso2.com/en/latest/deploy-and-publish/deploy-on-gateway/choreo-connect/update-choreo-connect/">here</a>.</p>
+                                    </div>
+                                </div>
+                            </div>
                         </div>
                     </div>
                 </div>

diff --git a/en/tools/config-catalog-generator-cc/data/router/configs.json b/en/tools/config-catalog-generator-cc/data/router/configs.json
@@ -63,6 +63,13 @@
               "required": false,
               "default": false,
               "description": "If configured as true, the Router appends the immediate downstream IP address to the x-forward-for header."
+            },
+            {
+              "name": "perConnectionBufferLimitBytes",
+              "type": "integer",
+              "required": false,
+              "default": "1048576",
+              "description": "The buffered payload limit per connection in Bytes. Default value is 1 MiB"
             }
           ]
         }

diff --git a/en/tools/config-catalog-generator-cc/data/router/router.toml b/en/tools/config-catalog-generator-cc/data/router/router.toml
@@ -7,3 +7,4 @@
   enforcerResponseTimeoutInSeconds = 20
   systemHost = "localhost"
   useRemoteAddress = false
+  perConnectionBufferLimitBytes = 1048576
diff --git a/en/tools/config-catalog-generator-cc/dist/router-configurations.md b/en/tools/config-catalog-generator-cc/dist/router-configurations.md
@@ -52,6 +52,7 @@ See the example .toml file given below.
   enforcerResponseTimeoutInSeconds = 20
   systemHost = "localhost"
   useRemoteAddress = false
+  perConnectionBufferLimitBytes = 1048576
 </code></pre>
                     </div>
                 </div>
@@ -217,6 +218,25 @@ See the example .toml file given below.
                                         <p>If configured as true, the Router appends the immediate downstream IP address to the x-forward-for header.</p>
                                     </div>
                                 </div>
+                            </div><div class="param">
+                                <div class="param-name">
+                                  <span class="param-name-wrap"> <code>perConnectionBufferLimitBytes</code> </span>
+                                </div>
+                                <div class="param-info">
+                                    <div>
+                                        <p>
+                                            <span class="param-type string"> integer </span>
+                                            
+                                        </p>
+                                        <div class="param-default">
+                                            <span class="param-default-value">Default: <code>1048576</code></span>
+                                        </div>
+                                        
+                                    </div>
+                                    <div class="param-description">
+                                        <p>The buffered payload limit per connection in Bytes. Default value is 1 MiB</p>
+                                    </div>
+                                </div>
                             </div>
                         </div>
                     </div>