From d6d9440dba11b9a973a3d925d5fe0925d7b2bd24 Mon Sep 17 00:00:00 2001
From: Eric Bishop <ericdbishop1@gmail.com>
Date: Thu, 20 Jun 2024 10:47:09 -0400
Subject: [PATCH] Added comment to clarify necessity of VS retry policy

---
 networking/v1alpha3/destination_rule.pb.go   | 4 ++++
 networking/v1alpha3/destination_rule.pb.html | 3 +++
 networking/v1alpha3/destination_rule.proto   | 4 ++++
 3 files changed, 11 insertions(+)

diff --git a/networking/v1alpha3/destination_rule.pb.go b/networking/v1alpha3/destination_rule.pb.go
index 520984a2e04..e7cfc180dc7 100644
--- a/networking/v1alpha3/destination_rule.pb.go
+++ b/networking/v1alpha3/destination_rule.pb.go
@@ -2412,6 +2412,10 @@ type ConnectionPoolSettings_HTTPSettings struct {
 	MaxConcurrentStreams int32 `protobuf:"varint,8,opt,name=max_concurrent_streams,json=maxConcurrentStreams,proto3" json:"max_concurrent_streams,omitempty"`
 	// The amount of concurrent retries allowed in the case of failure, a
 	// percentage of the active requests.
+	//
+	// NOTE: Including a retry budget requires a retry policy to exist within
+	// the [VirtualService](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPRetry) resource
+	// routing to this destination, in order for failed requests to be retried.
 	RetryBudget *RetryBudget `protobuf:"bytes,9,opt,name=retry_budget,json=retryBudget,proto3" json:"retry_budget,omitempty"`
 }
 
diff --git a/networking/v1alpha3/destination_rule.pb.html b/networking/v1alpha3/destination_rule.pb.html
index 77bb849be76..ea192a4bf84 100644
--- a/networking/v1alpha3/destination_rule.pb.html
+++ b/networking/v1alpha3/destination_rule.pb.html
@@ -1718,6 +1718,9 @@ <h2 id="ConnectionPoolSettings-HTTPSettings">ConnectionPoolSettings.HTTPSettings
 <td>
 <p>The amount of concurrent retries allowed in the case of failure, a
 percentage of the active requests.</p>
+<p>NOTE: Including a retry budget requires a retry policy to exist within
+the <a href="https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPRetry">VirtualService</a> resource
+routing to this destination, in order for failed requests to be retried.</p>
 
 </td>
 <td>
diff --git a/networking/v1alpha3/destination_rule.proto b/networking/v1alpha3/destination_rule.proto
index 31e472cb6ab..e8f7de17165 100644
--- a/networking/v1alpha3/destination_rule.proto
+++ b/networking/v1alpha3/destination_rule.proto
@@ -647,6 +647,10 @@ message ConnectionPoolSettings {
 
     // The amount of concurrent retries allowed in the case of failure, a
     // percentage of the active requests.
+    //
+    // NOTE: Including a retry budget requires a retry policy to exist within
+    // the [VirtualService](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPRetry) resource
+    // routing to this destination, in order for failed requests to be retried.
     RetryBudget retry_budget = 9;
   };