istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update docs to use durations for time fields instead of floats (#83)

This commit is contained in:
GregHanson 2017-05-01 09:51:36 -05:00 committed by Shriram Rajagopalan
parent 27561e5a8a
commit bc7df6d0c3
6 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
_docs/concepts/traffic-management/rules-configuration.md
View File

@ -159,7 +159,7 @@ route:
version: v1
httpReqTimeout:
simpleTimeout:
timeoutSeconds: 10
timeout: 10s
```
The number of retries for a given http request can also be specified in a route rule.
@ -197,7 +197,7 @@ route:
httpFault:
delay:
percent: 10
fixedDelaySeconds: 5
fixedDelay: 5s
```
The other kind of fault, abort, can be used to prematurely terminate a request,
@ -232,7 +232,7 @@ route:
version: v1
httpFault:
delay:
fixedDelaySeconds: 5
fixedDelay: 5s
abort:
percent: 10
httpStatus: 400

36
_docs/reference/api/proxy-config.md
View File

@ -111,9 +111,9 @@ Circuit breaker configuration.
<td>int32</td>
<td>Maximum number of requests to a backend.</td>
</tr>
<a name="istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy.sleep_window_seconds"></a>
<a name="istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy.sleep_window"></a>
<tr>
<td><code>sleep_window_seconds</code></td>
<td><code>sleep_window</code></td>
<td>double</td>
<td>Minimum time the circuit will be closed. In floating point seconds format.</td>
</tr>
@ -123,9 +123,9 @@ Circuit breaker configuration.
<td>int32</td>
<td>Number of 5XX errors before circuit is opened.</td>
</tr>
<a name="istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy.http_detection_interval_seconds"></a>
<a name="istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy.http_detection_interval"></a>
<tr>
<td><code>http_detection_interval_seconds</code></td>
<td><code>http_detection_interval</code></td>
<td>double</td>
<td>Interval for checking state of hystrix circuit.</td>
</tr>
@ -317,15 +317,15 @@ delay is unsupported at the moment.
<td>string</td>
<td>Specify delay duration as part of Http request.</td>
</tr>
<a name="istio.proxy.v1alpha.config.HTTPFaultInjection.Delay.fixed_delay_seconds"></a>
<a name="istio.proxy.v1alpha.config.HTTPFaultInjection.Delay.fixed_delay"></a>
<tr>
<td><code>fixed_delay_seconds</code></td>
<td><code>fixed_delay</code></td>
<td>double (oneof )</td>
<td>Add a fixed delay before forwarding the request. Delay duration in seconds.nanoseconds</td>
</tr>
<a name="istio.proxy.v1alpha.config.HTTPFaultInjection.Delay.exponential_delay_seconds"></a>
<a name="istio.proxy.v1alpha.config.HTTPFaultInjection.Delay.exponential_delay"></a>
<tr>
<td><code>exponential_delay_seconds</code></td>
<td><code>exponential_delay</code></td>
<td>double (oneof )</td>
<td>Add a delay (based on an exponential function) before forwarding the request. mean delay needed to derive the exponential delay values</td>
</tr>
@ -370,9 +370,9 @@ Retry policy to use when a request fails.
<td>int32</td>
<td>Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the http_timeout</td>
</tr>
<a name="istio.proxy.v1alpha.config.HTTPRetry.SimpleRetryPolicy.per_try_timeout_seconds"></a>
<a name="istio.proxy.v1alpha.config.HTTPRetry.SimpleRetryPolicy.per_try_timeout"></a>
<tr>
<td><code>per_try_timeout_seconds</code></td>
<td><code>per_try_timeout</code></td>
<td>double</td>
<td>Timeout per retry attempt for a given request. Specified in seconds.nanoseconds format.</td>
</tr>
@ -418,9 +418,9 @@ indicate the time for the entire response to arrive.
<th>Type</th>
<th>Description</th>
</tr>
<a name="istio.proxy.v1alpha.config.HTTPTimeout.SimpleTimeoutPolicy.timeout_seconds"></a>
<a name="istio.proxy.v1alpha.config.HTTPTimeout.SimpleTimeoutPolicy.timeout"></a>
<tr>
<td><code>timeout_seconds</code></td>
<td><code>timeout</code></td>
<td>double</td>
<td>Timeout for a HTTP request. Includes retries as well. Unit is in floating point seconds. Default 15 seconds. Specified in seconds.nanoseconds format</td>
</tr>
@ -484,9 +484,9 @@ established, emulating remote server crash or link failure.
<td>float</td>
<td>percentage of established Tcp connections to be terminated/reset</td>
</tr>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Terminate.terminate_after_seconds"></a>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Terminate.terminate_after_period"></a>
<tr>
<td><code>terminate_after_seconds</code></td>
<td><code>terminate_after_period</code></td>
<td>double</td>
<td></td>
</tr>
@ -520,15 +520,15 @@ Bandwidth throttling for Tcp and Udp connections
<td>int64</td>
<td>bandwidth limits in "bits" per second between proxy and upstream</td>
</tr>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Throttle.throttle_for_seconds"></a>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Throttle.throttle_for_period"></a>
<tr>
<td><code>throttle_for_seconds</code></td>
<td><code>throttle_for_period</code></td>
<td><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#doublevalue">DoubleValue</a></td>
<td>Stop throttling after the given duration. If not set, the connection will be throttled for its lifetime.</td>
</tr>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Throttle.throttle_after_seconds"></a>
<a name="istio.proxy.v1alpha.config.L4FaultInjection.Throttle.throttle_after_period"></a>
<tr>
<td><code>throttle_after_seconds</code></td>
<td><code>throttle_after_period</code></td>
<td>double (oneof )</td>
<td>Wait for X seconds after the connection is established, before starting bandwidth throttling. This would allow us to inject fault after the application protocol (e.g., MySQL) has had time to establish sessions/whatever handshake necessary.</td>
</tr>

12
_docs/reference/routing-and-traffic-management.md
View File

@ -239,7 +239,7 @@ route:
version: v1
httpReqTimeout:
simpleTimeout:
timeoutSeconds: 10
timeout: 10s
```
### httpReqRetries
@ -270,11 +270,11 @@ The faults injected depend on the following nested fields:
#### httpFault.delay
The *delay* field is used to delay a request by a specified amount of time. Nested fields
*percent* and one of either *fixedDelaySeconds* or *exponentialDelaySeconds* are used to specify the delay.
*percent* and one of either *fixedDelay* or *exponentialDelay* are used to specify the delay.
The *fixedDelaySeconds* field is used to indicate the amount of delay in seconds.
The *fixedDelay* field is used to indicate the amount of delay in seconds.
Alternatively, the *exponentialDelaySeconds* field can be used to specify the mean delay
Alternatively, the *exponentialDelay* field can be used to specify the mean delay
for values derived according to an exponential function.
An optional *percent* field, a value between 0 and 100, can be used to only delay a certain percentage of requests.
@ -290,7 +290,7 @@ route:
httpFault:
delay:
percent: 10
fixedDelaySeconds: 5
fixedDelay: 5s
```
#### httpFault.abort
@ -335,7 +335,7 @@ route:
version: v1
httpFault:
delay:
fixedDelaySeconds: 5
fixedDelay: 5s
abort:
percent: 10
httpStatus: 400

2
_docs/tasks/fault-injection.md
View File

@ -46,7 +46,7 @@ continue without any errors.
destination: ratings.default.svc.cluster.local
httpFault:
delay:
fixedDelaySeconds: 7
fixedDelay: 7s
percent: 100
match:
httpHeaders:

4
_docs/tasks/request-timeouts.md
View File

@ -60,7 +60,7 @@ to the `ratings` service.
httpFault:
delay:
percent: 100
fixedDelaySeconds: 2.0
fixedDelay: 2s
EOF
```
@ -82,7 +82,7 @@ to the `ratings` service.
version: v2
httpReqTimeout:
simpleTimeout:
timeoutSeconds: 1.0
timeout: 1s
EOF
```

2
wip/fault-injection.md
View File

@ -104,7 +104,7 @@ spec:
destination: httpbin.default.svc.cluster.local
http_req_timeout:
simple_timeout:
timeout_seconds: 3
timeout: 3s
EOF
# Give the file to istioctl