Skip to content

Commit d4002d7

Browse files
Update refdocs to use markdown links and standardize HTTP/2 notation in master (#3430)
* update-refdocs-master-brokenUrl * update-refdocs-release-1.24-brokenUrl * updatedoc * Regenerate API docs after changes * Update networking/v1alpha3/destination_rule.proto Co-authored-by: Craig Box <craig.box@gmail.com> * Update networking/v1alpha3/destination_rule.proto Co-authored-by: Craig Box <craig.box@gmail.com> * Update networking/v1alpha3/destination_rule.proto Co-authored-by: Craig Box <craig.box@gmail.com> * Updated refdoc --------- Co-authored-by: Craig Box <craig.box@gmail.com>
1 parent d98ae9c commit d4002d7

File tree

6 files changed

+40
-40
lines changed

6 files changed

+40
-40
lines changed

kubernetes/customresourcedefinitions.gen.yaml

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

networking/v1/destination_rule_alias.gen.go

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/destination_rule.pb.go

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

networking/v1alpha3/destination_rule.pb.html

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

networking/v1alpha3/destination_rule.proto

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ option go_package = "istio.io/api/networking/v1alpha3";
139139
// +cue-gen:DestinationRule:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp
140140
// representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations.
141141
// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
142-
// Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
142+
// Populated by the system. Read-only. Null for lists. For more information, see [Kubernetes API Conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata)"
143143
// +cue-gen:DestinationRule:preserveUnknownFields:false
144144
// -->
145145
//
@@ -278,7 +278,7 @@ message TrafficPolicy {
278278
// ⁣PROXY protocol version 2. Binary format.
279279
V2 = 1;
280280
};
281-
// The PROXY protocol version to use. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details.
281+
// The PROXY protocol version to use. See [the protocol spec](https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt) for details.
282282
// By default it is `V1`.
283283
VERSION version = 1;
284284
}
@@ -480,8 +480,8 @@ message LoadBalancerSettings {
480480
};
481481

482482
// The hash algorithm to use.
483-
// Please refer to https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#ring-hash
484-
// and https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#maglev for
483+
// Please refer to Envoy's [Ring Hash Load Balancer](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#ring-hash)
484+
// and [Maglev Load Balancer](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#maglev) docs for
485485
// considerations on choosing an algorithm.
486486
// Defaults to RingHash if not specified.
487487
oneof hash_algorithm {
@@ -617,13 +617,13 @@ message ConnectionPoolSettings {
617617
message HTTPSettings {
618618
// Maximum number of requests that will be queued while waiting for
619619
// a ready connection pool connection. Default 2^32-1.
620-
// Refer to https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/circuit_breaking
621-
// under which conditions a new connection is created for HTTP2.
622-
// Please note that this is applicable to both HTTP/1.1 and HTTP2.
620+
// Refer to [Envoy Circuit Breaking](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/circuit_breaking)
621+
// under which conditions a new connection is created for HTTP/2.
622+
// Please note that this is applicable to both HTTP/1.1 and HTTP/2.
623623
int32 http1_max_pending_requests = 1;
624624

625625
// Maximum number of active requests to a destination. Default 2^32-1.
626-
// Please note that this is applicable to both HTTP/1.1 and HTTP2.
626+
// Please note that this is applicable to both HTTP/1.1 and HTTP/2.
627627
int32 http2_max_requests = 2;
628628

629629
// Maximum number of requests per connection to a backend. Setting this
@@ -641,7 +641,7 @@ message ConnectionPoolSettings {
641641
// the connection will be closed. If the connection is an HTTP/2
642642
// connection a drain sequence will occur prior to closing the connection.
643643
// Note that request based timeouts mean that HTTP/2 PINGs will not
644-
// keep the connection alive. Applies to both HTTP1.1 and HTTP2 connections.
644+
// keep the connection alive. Applies to both HTTP/1.1 and HTTP/2 connections.
645645
google.protobuf.Duration idle_timeout = 5;
646646

647647
// Policy for upgrading http1.1 connections to http2.
@@ -686,7 +686,7 @@ message ConnectionPoolSettings {
686686
//
687687
// The following rule sets a connection pool size of 100 HTTP1 connections
688688
// with no more than 10 req/connection to the "reviews" service. In addition,
689-
// it sets a limit of 1000 concurrent HTTP2 requests and configures upstream
689+
// it sets a limit of 1000 concurrent HTTP/2 requests and configures upstream
690690
// hosts to be scanned every 5 mins so that any host that fails 7 consecutive
691691
// times with a 502, 503, or 504 error code will be ejected for 15 minutes.
692692
//

networking/v1beta1/destination_rule_alias.gen.go

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

0 commit comments

Comments
 (0)