Skip to content

Commit 3197d4d

Browse files
frankbugeeknoid
authored andcommitted
Clarify location of timeout field (#1185)
1 parent 7d2523d commit 3197d4d

File tree

5 files changed

+23
-20
lines changed

5 files changed

+23
-20
lines changed

kubernetes/customresourcedefinitions.gen.yaml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/virtual_service.gen.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
"format": "string"
7878
},
7979
"route": {
80-
"description": "A http rule can either redirect or forward (default) traffic. The forwarding target can be one of several versions of a service (see glossary in beginning of document). Weights associated with the service version determine the proportion of traffic it receives.",
80+
"description": "A HTTP rule can either redirect or forward (default) traffic. The forwarding target can be one of several versions of a service (see glossary in beginning of document). Weights associated with the service version determine the proportion of traffic it receives.",
8181
"type": "array",
8282
"items": {
8383
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPRouteDestination"
@@ -383,7 +383,7 @@
383383
"type": "object",
384384
"properties": {
385385
"attempts": {
386-
"description": "Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the httpReqTimeout.",
386+
"description": "Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the request `timeout` of the [HTTP route](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRoute).",
387387
"type": "integer",
388388
"format": "int32"
389389
},
@@ -399,7 +399,7 @@
399399
}
400400
},
401401
"istio.networking.v1alpha3.HTTPFaultInjection": {
402-
"description": "HTTPFaultInjection can be used to specify one or more faults to inject while forwarding http requests to the destination specified in a route. Fault specification is part of a VirtualService rule. Faults include aborting the Http request from downstream service, and/or delaying proxying of requests. A fault rule MUST HAVE delay or abort or both.",
402+
"description": "HTTPFaultInjection can be used to specify one or more faults to inject while forwarding HTTP requests to the destination specified in a route. Fault specification is part of a VirtualService rule. Faults include aborting the Http request from downstream service, and/or delaying proxying of requests. A fault rule MUST HAVE delay or abort or both.",
403403
"type": "object",
404404
"properties": {
405405
"delay": {

networking/v1alpha3/virtual_service.pb.go

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/virtual_service.pb.html

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/virtual_service.proto

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ message VirtualService {
310310
// services must first be added to Istio's internal service registry using the
311311
// ServiceEntry resource. VirtualServices can then be defined to control traffic
312312
// bound to these external services. For example, the following rules define a
313-
// Service for wikipedia.org and set a timeout of 5s for http requests.
313+
// Service for wikipedia.org and set a timeout of 5s for HTTP requests.
314314
//
315315
// ```yaml
316316
// apiVersion: networking.istio.io/v1alpha3
@@ -383,13 +383,13 @@ message HTTPRoute {
383383
// is matched if any one of the match blocks succeed.
384384
repeated HTTPMatchRequest match = 1;
385385

386-
// A http rule can either redirect or forward (default) traffic. The
386+
// A HTTP rule can either redirect or forward (default) traffic. The
387387
// forwarding target can be one of several versions of a service (see
388388
// glossary in beginning of document). Weights associated with the
389389
// service version determine the proportion of traffic it receives.
390390
repeated HTTPRouteDestination route = 2;
391391

392-
// A http rule can either redirect or forward (default) traffic. If
392+
// A HTTP rule can either redirect or forward (default) traffic. If
393393
// traffic passthrough option is specified in the rule,
394394
// route/redirect will be ignored. The redirect primitive can be used to
395395
// send a HTTP 301 redirect to a different URI or Authority.
@@ -1003,7 +1003,8 @@ message StringMatch {
10031003
message HTTPRetry {
10041004
// Number of retries for a given request. The interval
10051005
// between retries will be determined automatically (25ms+). Actual
1006-
// number of retries attempted depends on the httpReqTimeout.
1006+
// number of retries attempted depends on the request `timeout` of the
1007+
// [HTTP route](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRoute).
10071008
int32 attempts = 1 [(google.api.field_behavior) = REQUIRED];
10081009

10091010
// Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms.
@@ -1078,7 +1079,7 @@ message CorsPolicy {
10781079
}
10791080

10801081
// HTTPFaultInjection can be used to specify one or more faults to inject
1081-
// while forwarding http requests to the destination specified in a route.
1082+
// while forwarding HTTP requests to the destination specified in a route.
10821083
// Fault specification is part of a VirtualService rule. Faults include
10831084
// aborting the Http request from downstream service, and/or delaying
10841085
// proxying of requests. A fault rule MUST HAVE delay or abort or both.

0 commit comments

Comments
 (0)