Merge pull request #948 from 09harsh/flag_disabling_no_wait_excludes

Flag for enabling no-wait excludes

Author: 09harsh

api/v1beta1/foundationdb_version.go

@@ -155,11 +155,8 @@ func (version FdbVersion) HasZoneFaultToleranceInStatus() bool {
 
 // HasNonBlockingExcludes determines if a version has support for non-blocking
 // exclude commands.
-//
-// This is currently set to false across the board, pending investigation into
-// potential bugs with non-blocking excludes.
-func (version FdbVersion) HasNonBlockingExcludes() bool {
-	return false
+func (version FdbVersion) HasNonBlockingExcludes(useNonBlockingExcludes bool) bool {
+	return version.IsAtLeast(FdbVersion{Major: 6, Minor: 3, Patch: 5}) && useNonBlockingExcludes
 }
 
 // NextMajorVersion returns the next major version of FoundationDB.

api/v1beta1/foundationdb_version_test.go

@@ -22,6 +22,7 @@ package v1beta1
 
 import (
 	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/extensions/table"
 	. "github.com/onsi/gomega"
 )
 
@@ -91,4 +92,43 @@ var _ = Describe("[api] FDBVersion", func() {
 			Expect(version.Equal(FdbVersion{Major: 6, Minor: 2, Patch: 21})).To(BeFalse())
 		})
 	})
+
+	When("checking if the version has support for non-blocking exclude commands", func() {
+		type testCase struct {
+			version                FdbVersion
+			useNonBlockingExcludes bool
+			expectedResult         bool
+		}
+
+		DescribeTable("should return if non-blocking excludes are enabled",
+			func(tc testCase) {
+				Expect(tc.version.HasNonBlockingExcludes(tc.useNonBlockingExcludes)).To(Equal(tc.expectedResult))
+			},
+			Entry("When version is below 6.3.5 and useNonBlockingExcludes is false",
+				testCase{
+					version:                FdbVersion{Major: 6, Minor: 3, Patch: 0},
+					useNonBlockingExcludes: false,
+					expectedResult:         false,
+				}),
+			Entry("When version is below 6.3.5 and useNonBlockingExcludes is true",
+				testCase{
+					version:                FdbVersion{Major: 6, Minor: 3, Patch: 0},
+					useNonBlockingExcludes: false,
+					expectedResult:         false,
+				}),
+			Entry("When version is atleast 6.3.5 and useNonBlockingExcludes is false",
+				testCase{
+					version:                FdbVersion{Major: 6, Minor: 3, Patch: 5},
+					useNonBlockingExcludes: false,
+					expectedResult:         false,
+				}),
+			Entry("When version is atleast 6.3.5 and useNonBlockingExcludes is true",
+				testCase{
+					version:                FdbVersion{Major: 6, Minor: 3, Patch: 6},
+					useNonBlockingExcludes: true,
+					expectedResult:         true,
+				}),
+		)
+
+	})
 })

api/v1beta1/foundationdbcluster_types.go

@@ -1108,6 +1108,10 @@ type FoundationDBClusterAutomationOptions struct {
 	// Defaults to true.
 	// Deprecated: Will be enforced by default in 1.0.0 without disabling.
 	EnforceFullReplicationForDeletion *bool `json:"enforceFullReplicationForDeletion,omitempty"`
+
+	// UseNonBlockingExcludes defines whether the operator is allowed to use non blocking exclude commands.
+	// The default is false.
+	UseNonBlockingExcludes *bool `json:"useNonBlockingExcludes,omitempty"`
 }
 
 // AutomaticReplacementOptions controls options for automatically replacing
@@ -2924,6 +2928,15 @@ func (cluster *FoundationDBCluster) GetEnforceFullReplicationForDeletion() bool
 	return *cluster.Spec.AutomationOptions.EnforceFullReplicationForDeletion
 }
 
+// GetUseNonBlockingExcludes returns the value of useNonBlockingExcludes or false if unset.
+func (cluster *FoundationDBCluster) GetUseNonBlockingExcludes() bool {
+	if cluster.Spec.AutomationOptions.UseNonBlockingExcludes == nil {
+		return false
+	}
+
+	return *cluster.Spec.AutomationOptions.UseNonBlockingExcludes
+}
+
 // GetProcessClassLabel provides the label that this cluster is using for the
 // process class when identifying resources.
 func (cluster *FoundationDBCluster) GetProcessClassLabel() string {

api/v1beta1/zz_generated.deepcopy.go

@@ -76,6 +76,8 @@ spec:
                           minimum: 0
                           type: integer
                       type: object
+                    useNonBlockingExcludes:
+                      type: boolean
                   type: object
                 automountServiceAccountToken:
                   type: boolean

config/crd/bases/apps.foundationdb.org_foundationdbclusters.yaml

@@ -191,6 +191,7 @@ FoundationDBClusterAutomationOptions provides flags for enabling or disabling op
 | replacements | Replacements contains options for automatically replacing failed processes. | [AutomaticReplacementOptions](#automaticreplacementoptions) | false |
 | ignorePendingPodsDuration | IgnorePendingPodsDuration defines how long a Pod has to be in the Pending Phase before ignore it during reconciliation. This prevents Pod that are stuck in Pending to block further reconciliation. | time.Duration | false |
 | enforceFullReplicationForDeletion | EnforceFullReplicationForDeletion defines if the operator is only allowed to delete Pods if the cluster is fully replicated. If the cluster is not fully replicated the Operator won't delete any Pods that are marked for removal. Defaults to true. **Deprecated: Will be enforced by default in 1.0.0 without disabling.** | *bool | false |
+| useNonBlockingExcludes | UseNonBlockingExcludes defines whether the operator is allowed to use non blocking exclude commands. The default is false. | *bool | false |
 
 [Back to TOC](#table-of-contents)
 

docs/cluster_spec.md

@@ -237,7 +237,7 @@ func (client *cliAdminClient) ExcludeInstances(addresses []fdbtypes.ProcessAddre
 		return err
 	}
 
-	if version.HasNonBlockingExcludes() {
+	if version.HasNonBlockingExcludes(client.Cluster.GetUseNonBlockingExcludes()) {
 		_, err = client.runCommand(cliCommand{
 			command: fmt.Sprintf(
 				"exclude no_wait %s",
@@ -299,7 +299,7 @@ func (client *cliAdminClient) CanSafelyRemove(addresses []fdbtypes.ProcessAddres
 		return nil, err
 	}
 
-	if version.HasNonBlockingExcludes() {
+	if version.HasNonBlockingExcludes(client.Cluster.GetUseNonBlockingExcludes()) {
 		output, err := client.runCommand(cliCommand{command: fmt.Sprintf(
 			"exclude no_wait %s",
 			fdbtypes.ProcessAddressesString(addresses, " "),