Skip to content

Commit

Permalink
Merge pull request #8186 from vishmi49/vishmi_master_docs
Browse files Browse the repository at this point in the history 
[master] Update passthru_https config in Config Catalog
  • Loading branch information
@tharikaGitHub
tharikaGitHub authored Jul 16, 2024
2 parents fa12582 + 0d886b4 commit 5ee1aae
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 19 deletions.
21 changes: 11 additions & 10 deletions en/docs/reference/config-catalog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8914,16 +8914,16 @@ SSLEnabled = "true"</code></pre>
<label class="tab-selector" for="_tab_65"><i class="icon fa fa-code"></i></label>
<div class="superfences-content">
<div class="mb-config-example">
<pre><code class="toml">[transport.passthru_https]
<pre><code class="toml">[passthru_http]
http.socket.timeout = "3m"
worker_pool_size_core = 300
worker_pool_size_max = 400
worker_pool_queue_length = -1
io_buffer_size = 16384
http.max.connection.per.host.port = 32767
http.user.agent.preserve = false
'http.user.agent.preserve' = false
preserve_http_server_name = true
http.headers.preserve = ["Content-Type"]
'http.headers.preserve' = ["Content-Type"]
disable_connection_keepalive = false
max_open_connections = -1
force_xml_validation = false
Expand Down Expand Up @@ -8956,16 +8956,17 @@ sender.trust_store.file_name = "$ref{truststore.file_name}"
sender.trust_store.type = "$ref{truststore.type}"
sender.trust_store.password = "$ref{truststore.password}"
sender.ssl_profile.file_path = "repository/resources/security/sslprofiles.xml"
sender.ssl_profile.interval = "600000"</code></pre>
sender.ssl_profile.interval = "600000"
</code></pre>
</div>
</div>
<div class="doc-wrapper">
<div class="mb-config">
<div class="config-wrap">
<code>[transport.passthru_http]</code>
<code>[passthru_http]</code>

<p>
This configuration header is required for configuring the parameters that are used for tuning the default HTTP/S passthrough transport of the API Manager in non-blocking mode.
This configuration header is required for configuring the parameters that are used for tuning the default HTTP passthrough transport of the API Manager in non-blocking mode.
</p>
</div>
<div class="params-wrap">
Expand Down Expand Up @@ -9097,7 +9098,7 @@ sender.ssl_profile.interval = "600000"</code></pre>
</div>
</div><div class="param">
<div class="param-name">
<span class="param-name-wrap"> <code>http.user.agent.preserve</code> </span>
<span class="param-name-wrap"> <code>&#39;http.user.agent.preserve&#39;</code> </span>
</div>
<div class="param-info">
<div>
Expand All @@ -9118,7 +9119,7 @@ sender.ssl_profile.interval = "600000"</code></pre>
</div>
</div><div class="param">
<div class="param-name">
<span class="param-name-wrap"> <code>http.headers.preserve</code> </span>
<span class="param-name-wrap"> <code>&#39;http.headers.preserve&#39;</code> </span>
</div>
<div class="param-info">
<div>
Expand Down Expand Up @@ -9155,7 +9156,7 @@ sender.ssl_profile.interval = "600000"</code></pre>
</div>
</div>
<div class="param-description">
<p>If this parameter is set to true, the HTTP connections with the back end service are closed soon after the request is served. It is recommended to set this property to false so that the integrator does not have to create a new connection every time it sends a request to a back-end service. However, you may need to close connections after they are used if the back-end service does not provide sufficient support for keep-alive connections.</p>
<p>This parameter allows you to specify the header field/s of messages passing through the APIM that need to be preserved and printed in the outgoing message such as Location, CommonsHTTPTransportSenderKeep-Alive, Date, Server, User-Agent, and Host.</p>
</div>
</div>
</div><div class="param">
Expand Down Expand Up @@ -14716,7 +14717,7 @@ key_password = "wso2carbon"</code></pre>
<div class="superfences-content">
<div class="mb-config-example">
<pre><code class="toml">[http_access_log]
useLogger = true</code></pre>
enabled = true</code></pre>
</div>
</div>
<div class="doc-wrapper">
Expand Down
8 changes: 4 additions & 4 deletions en/tools/config-catalog-generator/data/_http-passthrough-transport.toml
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[transport.passthru_https]
[passthru_http]
http.socket.timeout = "3m"
worker_pool_size_core = 300
worker_pool_size_max = 400
worker_pool_queue_length = -1
io_buffer_size = 16384
http.max.connection.per.host.port = 32767
http.user.agent.preserve = false
'http.user.agent.preserve' = false
preserve_http_server_name = true
http.headers.preserve = ["Content-Type"]
'http.headers.preserve' = ["Content-Type"]
disable_connection_keepalive = false
max_open_connections = -1
force_xml_validation = false
Expand Down Expand Up @@ -40,4 +40,4 @@ sender.trust_store.file_name = "$ref{truststore.file_name}"
sender.trust_store.type = "$ref{truststore.type}"
sender.trust_store.password = "$ref{truststore.password}"
sender.ssl_profile.file_path = "repository/resources/security/sslprofiles.xml"
sender.ssl_profile.interval = "600000"
sender.ssl_profile.interval = "600000"
10 changes: 5 additions & 5 deletions en/tools/config-catalog-generator/data/configs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3368,9 +3368,9 @@
"title": "HTTP/S Pass-through Transport (non-blocking mode)",
"options": [
{
"name": "transport.passthru_http",
"name": "passthru_http",
"required": false,
"description": "This configuration header is required for configuring the parameters that are used for tuning the default HTTP/S passthrough transport of the API Manager in non-blocking mode.",
"description": "This configuration header is required for configuring the parameters that are used for tuning the default HTTP passthrough transport of the API Manager in non-blocking mode.",
"params": [
{
"name": "http.socket.timeout",
Expand Down Expand Up @@ -3421,15 +3421,15 @@
"description": "This defines the maximum number of connections allowed per host port."
},
{
"name": "http.user.agent.preserve",
"name": "'http.user.agent.preserve'",
"type": "boolean",
"required": true,
"default": "\"true\" or \"false\"",
"possible": "-",
"description": "If this parameter is set to true, the user-agent HTTP header of messages passing through the integrator is preserved and printed in the outgoing message."
},
{
"name": "http.headers.preserve",
"name": "'http.headers.preserve'",
"type": "string",
"required": true,
"default": "Content-Type",
Expand All @@ -3442,7 +3442,7 @@
"required": true,
"default": false,
"possible": "\"true\" or \"false\"",
"description": "If this parameter is set to true, the HTTP connections with the back end service are closed soon after the request is served. It is recommended to set this property to false so that the integrator does not have to create a new connection every time it sends a request to a back-end service. However, you may need to close connections after they are used if the back-end service does not provide sufficient support for keep-alive connections."
"description": "This parameter allows you to specify the header field/s of messages passing through the APIM that need to be preserved and printed in the outgoing message such as Location, CommonsHTTPTransportSenderKeep-Alive, Date, Server, User-Agent, and Host."
},
{
"name": "listener.parameters.port",
Expand Down

0 comments on commit 5ee1aae

Please sign in to comment.