feat: pollers should allow customers to opt out of REST upgrade (#1744)

Fixes: #1732
NetApp · Feb 21, 2023 · d8d0a5c · d8d0a5c
1 parent 26f1846
commit d8d0a5c
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/cmd/poller/poller.go b/cmd/poller/poller.go
@@ -1173,7 +1173,7 @@ func (p *Poller) negotiateAPI(c conf.Collector, clusterVersion string, checkZAPI
 	// For ONTAP versions 9.12.1+ use REST unless the HARVEST_NO_COLLECTOR_UPGRADE environment variable is set.
 	// When the environment variable is set, honor that request unless the cluster no longer speaks ZAPI.
 	noUpgrade = os.Getenv(NoUpgrade)
-	if noUpgrade == "" {
+	if noUpgrade == "" && !p.params.PreferZAPI {
 		logger.Info().Str("collector", c.Name).Str("v", clusterVersion).Msg("Use REST")
 		upgradeCollector := strings.ReplaceAll(c.Name, "Zapi", "Rest")
 		return conf.Collector{
@@ -1195,7 +1195,9 @@ func (p *Poller) negotiateAPI(c conf.Collector, clusterVersion string, checkZAPI
 	logger.Info().
 		Str("collector", c.Name).
 		Str("v", clusterVersion).
-		Msg("ZAPIs exist and no-upgrade ENVVAR set. Use ZAPIs")
+		Str(NoUpgrade, noUpgrade).
+		Bool("preferZAPI", p.params.PreferZAPI).
+		Msg("Use ZAPIs")
 	return c
 }
 

diff --git a/cmd/poller/poller_test.go b/cmd/poller/poller_test.go
@@ -127,7 +127,7 @@ func TestPublishUrl(t *testing.T) {
 }
 
 func TestCollectorUpgrade(t *testing.T) {
-	poller := Poller{}
+	poller := Poller{params: &conf.Poller{}}
 
 	type test struct {
 		name           string

diff --git a/docs/configure-harvest-basic.md b/docs/configure-harvest-basic.md
@@ -21,6 +21,7 @@ All pollers are defined in `harvest.yml`, the main configuration file of Harvest
 | `log_max_bytes`        |                                                | Maximum size of the log file before it will be rotated                                                                                                                                                                                                                                                                                                                    | `5_242_880` (5 MB) |
 | `log_max_files`        |                                                | Number of rotated log files to keep                                                                                                                                                                                                                                                                                                                                       | `5`                |
 | `log`                  | optional, list of collector names              | Matching collectors log their ZAPI request/response                                                                                                                                                                                                                                                                                                                       |                    |
+| `prefer_zapi`          | optional, bool                                 | Use the ZAPI API if the cluster supports it, otherwise allow Harvest to choose REST or ZAPI, whichever is appropriate to the ONTAP version. See [rest-strategy](https://github.com/NetApp/harvest/blob/main/docs/architecture/rest-strategy.md) for details.                                                                                                              |                    |
 
 ## Defaults
 

diff --git a/pkg/conf/conf.go b/pkg/conf/conf.go
@@ -357,6 +357,7 @@ type Poller struct {
 	TLSMinVersion   string                `yaml:"tls_min_version,omitempty"`
 	UseInsecureTLS  *bool                 `yaml:"use_insecure_tls,omitempty"`
 	Username        string                `yaml:"username,omitempty"`
+	PreferZAPI      bool                  `yaml:"prefer_zapi,omitempty"`
 	promIndex       int
 	Name            string
 }