Merge pull request #4029 from shalier/addRetryPolicyFlag

feat(*): adds feature flag for retry policy
openservicemesh · Aug 24, 2021 · c05c35a · c05c35a
2 parents 928bd1a + a09d998
commit c05c35a
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 3 deletions.
diff --git a/charts/osm/README.md b/charts/osm/README.md
@@ -84,6 +84,7 @@ The following table lists the configurable parameters of the osm chart and their
 | OpenServiceMesh.featureFlags.enableEnvoyActiveHealthChecks | bool | `false` | Enable Envoy active health checks |
 | OpenServiceMesh.featureFlags.enableIngressBackendPolicy | bool | `true` | Enables OSM's IngressBackend policy API. When enabled, OSM will use the IngressBackend API allow ingress traffic to mesh backends |
 | OpenServiceMesh.featureFlags.enableMulticlusterMode | bool | `false` | Enable Multicluster mode. When enabled, multicluster mode will be enabled in OSM |
+| OpenServiceMesh.featureFlags.enableRetryPolicy | bool | `false` | Enable Retry Policy for automatic request retries |
 | OpenServiceMesh.featureFlags.enableSnapshotCacheMode | bool | `false` | Enables SnapshotCache feature for Envoy xDS server. |
 | OpenServiceMesh.featureFlags.enableValidatingWebhook | bool | `false` | Enable kubernetes validating webhook |
 | OpenServiceMesh.featureFlags.enableWASMStats | bool | `true` | Enable extra Envoy statistics generated by a custom WASM extension |

diff --git a/charts/osm/crds/config_meshconfig.yaml b/charts/osm/crds/config_meshconfig.yaml
@@ -233,3 +233,5 @@ spec:
                       type: boolean
                     enableEnvoyActiveHealthChecks:
                       type: boolean
+                    enableRetryPolicy:
+                      type: boolean
diff --git a/charts/osm/templates/preset-mesh-config.yaml b/charts/osm/templates/preset-mesh-config.yaml
@@ -56,6 +56,7 @@ data:
         "enableAsyncProxyServiceMapping": {{.Values.OpenServiceMesh.featureFlags.enableAsyncProxyServiceMapping}},
         "enableValidatingWebhook": {{.Values.OpenServiceMesh.featureFlags.enableValidatingWebhook}},
         "enableIngressBackendPolicy": {{.Values.OpenServiceMesh.featureFlags.enableIngressBackendPolicy}},
-        "enableEnvoyActiveHealthChecks": {{.Values.OpenServiceMesh.featureFlags.enableEnvoyActiveHealthChecks}}
+        "enableEnvoyActiveHealthChecks": {{.Values.OpenServiceMesh.featureFlags.enableEnvoyActiveHealthChecks}},
+        "enableRetryPolicy": {{.Values.OpenServiceMesh.featureFlags.enableRetryPolicy}}
       }
     }
diff --git a/charts/osm/values.schema.json b/charts/osm/values.schema.json
@@ -773,7 +773,8 @@
                         "enableValidatingWebhook",
                         "enableIngressBackendPolicy",
                         "enableEnvoyActiveHealthChecks",
-                        "enableSnapshotCacheMode"
+                        "enableSnapshotCacheMode",
+                        "enableRetryPolicy"
                     ],
                     "properties": {
                         "enableWASMStats": {
@@ -847,6 +848,15 @@
                             "examples": [
                                 true
                             ]
+                        },
+                        "enableRetryPolicy": {
+                            "$id": "#/properties/OpenServiceMesh/properties/featureFlags/properties/enableRetryPolicy",
+                            "type": "boolean",
+                            "title": "Enable Retry Policy",
+                            "description": "Enable automatic request retries.",
+                            "examples": [
+                                true
+                            ]
                         }
                     },
                     "additionalProperties": false

diff --git a/charts/osm/values.yaml b/charts/osm/values.yaml
@@ -262,6 +262,8 @@ OpenServiceMesh:
     enableEnvoyActiveHealthChecks: false
     # -- Enables SnapshotCache feature for Envoy xDS server.
     enableSnapshotCacheMode: false
+    # -- Enable Retry Policy for automatic request retries
+    enableRetryPolicy: false
 
   # -- OSM multicluster feature configuration
   multicluster:

diff --git a/cmd/osm-bootstrap/osm-bootstrap_test.go b/cmd/osm-bootstrap/osm-bootstrap_test.go
@@ -55,7 +55,8 @@ func TestCreateDefaultMeshConfig(t *testing.T) {
 	"enableValidatingWebhook": false,
 	"enableIngressBackendPolicy": true,
 	"enableEnvoyActiveHealthChecks": true,
-	"enableSnapshotCacheMode": true
+	"enableSnapshotCacheMode": true,
+	"enableRetryPolicy": false
 	}
 }`,
 		},
@@ -74,6 +75,7 @@ func TestCreateDefaultMeshConfig(t *testing.T) {
 	assert.Equal(meshConfig.Spec.Certificate.ServiceCertValidityDuration, "23h")
 	assert.True(meshConfig.Spec.FeatureFlags.EnableIngressBackendPolicy)
 	assert.True(meshConfig.Spec.FeatureFlags.EnableEnvoyActiveHealthChecks)
+	assert.False(meshConfig.Spec.FeatureFlags.EnableRetryPolicy)
 }
 
 func TestValidateCLIParams(t *testing.T) {

diff --git a/pkg/apis/config/v1alpha1/mesh_config.go b/pkg/apis/config/v1alpha1/mesh_config.go
@@ -203,4 +203,7 @@ type FeatureFlags struct {
 	// EnableEnvoyActiveHealthChecks defines if OSM will Envoy active health
 	// checks between services allowed to communicate.
 	EnableEnvoyActiveHealthChecks bool `json:"enableEnvoyActiveHealthChecks,omitempty"`
+
+	// EnableRetryPolicy defines if retry policy is enabled.
+	EnableRetryPolicy bool `json:"enableRetryPolicy,omitempty"`
 }