Simultaneously support versions v2 and v2beta2 of Autoscaling (#1014)

* Update to v2beta2 Signed-off-by: Kevin Earls <kearls@redhat.com> * First attempt at supporting v2 and v2beta2 of autoscaling Signed-off-by: Kevin Earls <kearls@redhat.com> * Fix ErrorF statement Signed-off-by: Kevin Earls <kearls@redhat.com> * Adding whitespace to rerun CI Signed-off-by: Kevin Earls <kearls@redhat.com> * Make the stupid linter happy Signed-off-by: Kevin Earls <kearls@redhat.com> * Just run on 1.24 to get full test results Signed-off-by: Kevin Earls <kearls@redhat.com> * Just run on 1.19 to get full test results Signed-off-by: Kevin Earls <kearls@redhat.com> * Cleanup, remove extraneous autodetect() calls, run only on 1.24 Signed-off-by: Kevin Earls <kearls@redhat.com> * Remove redundant builder.Owns call Signed-off-by: Kevin Earls <kearls@redhat.com> * Start of cleanup Signed-off-by: Kevin Earls <kearls@redhat.com> * Appease the stupid linter Signed-off-by: Kevin Earls <kearls@redhat.com> * Cleanup Signed-off-by: Kevin Earls <kearls@redhat.com> * Check before returning v2beta2, reduce copy/pasted code Signed-off-by: Kevin Earls <kearls@redhat.com> * Back out DRY changes Signed-off-by: Kevin Earls <kearls@redhat.com> * reduc copy/pasted code Signed-off-by: Kevin Earls <kearls@redhat.com> * Respond to comments Signed-off-by: Kevin Earls <kearls@redhat.com> * Implement autoscaling version constants as an enum Signed-off-by: Kevin Earls <kearls@redhat.com> * remove TODO, move declaration Signed-off-by: Kevin Earls <kearls@redhat.com> Signed-off-by: Kevin Earls <kearls@redhat.com>
open-telemetry · Aug 18, 2022 · cb91777 · cb91777
1 parent 5021ca7
commit cb91777
Show file tree

Hide file tree

Showing 13 changed files with 468 additions and 132 deletions.
diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/controllers/opentelemetrycollector_controller.go b/controllers/opentelemetrycollector_controller.go
@@ -21,7 +21,8 @@ import (
 
 	"github.com/go-logr/logr"
 	appsv1 "k8s.io/api/apps/v1"
-	autoscalingv1 "k8s.io/api/autoscaling/v1"
+	autoscalingv2 "k8s.io/api/autoscaling/v2"
+	autoscalingv2beta2 "k8s.io/api/autoscaling/v2beta2"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -31,6 +32,7 @@ import (
 
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
 	"github.com/open-telemetry/opentelemetry-operator/internal/config"
+	"github.com/open-telemetry/opentelemetry-operator/pkg/autodetect"
 	"github.com/open-telemetry/opentelemetry-operator/pkg/collector/reconcile"
 )
 
@@ -173,14 +175,25 @@ func (r *OpenTelemetryCollectorReconciler) RunTasks(ctx context.Context, params
 
 // SetupWithManager tells the manager what our controller is interested in.
 func (r *OpenTelemetryCollectorReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
+	err := r.config.AutoDetect() // We need to call this so we can get the correct autodetect version
+	if err != nil {
+		return err
+	}
+	builder := ctrl.NewControllerManagedBy(mgr).
 		For(&v1alpha1.OpenTelemetryCollector{}).
 		Owns(&corev1.ConfigMap{}).
 		Owns(&corev1.ServiceAccount{}).
 		Owns(&corev1.Service{}).
 		Owns(&appsv1.Deployment{}).
-		Owns(&autoscalingv1.HorizontalPodAutoscaler{}).
 		Owns(&appsv1.DaemonSet{}).
-		Owns(&appsv1.StatefulSet{}).
-		Complete(r)
+		Owns(&appsv1.StatefulSet{})
+
+	autoscalingVersion := r.config.AutoscalingVersion()
+	if autoscalingVersion == autodetect.AutoscalingVersionV2 {
+		builder = builder.Owns(&autoscalingv2.HorizontalPodAutoscaler{})
+	} else {
+		builder = builder.Owns(&autoscalingv2beta2.HorizontalPodAutoscaler{})
+	}
+
+	return builder.Complete(r)
 }
diff --git a/controllers/opentelemetrycollector_controller_test.go b/controllers/opentelemetrycollector_controller_test.go
@@ -36,14 +36,21 @@ import (
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
 	"github.com/open-telemetry/opentelemetry-operator/controllers"
 	"github.com/open-telemetry/opentelemetry-operator/internal/config"
+	"github.com/open-telemetry/opentelemetry-operator/pkg/autodetect"
 	"github.com/open-telemetry/opentelemetry-operator/pkg/collector/reconcile"
+	"github.com/open-telemetry/opentelemetry-operator/pkg/platform"
 )
 
 var logger = logf.Log.WithName("unit-tests")
+var mockAutoDetector = &mockAutoDetect{
+	HPAVersionFunc: func() (autodetect.AutoscalingVersion, error) {
+		return autodetect.AutoscalingVersionV2Beta2, nil
+	},
+}
 
 func TestNewObjectsOnReconciliation(t *testing.T) {
 	// prepare
-	cfg := config.New(config.WithCollectorImage("default-collector"), config.WithTargetAllocatorImage("default-ta-allocator"))
+	cfg := config.New(config.WithCollectorImage("default-collector"), config.WithTargetAllocatorImage("default-ta-allocator"), config.WithAutoDetect(mockAutoDetector))
 	nsn := types.NamespacedName{Name: "my-instance", Namespace: "default"}
 	reconciler := controllers.NewReconciler(controllers.Params{
 		Client: k8sClient,
@@ -129,7 +136,7 @@ func TestNewObjectsOnReconciliation(t *testing.T) {
 
 func TestNewStatefulSetObjectsOnReconciliation(t *testing.T) {
 	// prepare
-	cfg := config.New()
+	cfg := config.New(config.WithAutoDetect(mockAutoDetector))
 	nsn := types.NamespacedName{Name: "my-instance", Namespace: "default"}
 	reconciler := controllers.NewReconciler(controllers.Params{
 		Client: k8sClient,
@@ -341,3 +348,21 @@ func TestRegisterWithManager(t *testing.T) {
 	// verify
 	assert.NoError(t, err)
 }
+
+var _ autodetect.AutoDetect = (*mockAutoDetect)(nil)
+
+type mockAutoDetect struct {
+	PlatformFunc   func() (platform.Platform, error)
+	HPAVersionFunc func() (autodetect.AutoscalingVersion, error)
+}
+
+func (m *mockAutoDetect) HPAVersion() (autodetect.AutoscalingVersion, error) {
+	return m.HPAVersionFunc()
+}
+
+func (m *mockAutoDetect) Platform() (platform.Platform, error) {
+	if m.PlatformFunc != nil {
+		return m.PlatformFunc()
+	}
+	return platform.Unknown, nil
+}
diff --git a/internal/config/main.go b/internal/config/main.go
@@ -49,6 +49,7 @@ type Config struct {
 	labelsFilter                   []string
 	platform                       platform.Platform
 	autoDetectFrequency            time.Duration
+	autoscalingVersion             autodetect.AutoscalingVersion
 }
 
 // New constructs a new configuration based on the given options.
@@ -61,6 +62,7 @@ func New(opts ...Option) Config {
 		logger:                        logf.Log.WithName("config"),
 		platform:                      platform.Unknown,
 		version:                       version.Get(),
+		autoscalingVersion:            autodetect.DefaultAutoscalingVersion,
 	}
 	for _, opt := range opts {
 		opt(&o)
@@ -81,6 +83,7 @@ func New(opts ...Option) Config {
 		autoInstrumentationPythonImage: o.autoInstrumentationPythonImage,
 		autoInstrumentationDotNetImage: o.autoInstrumentationDotNetImage,
 		labelsFilter:                   o.labelsFilter,
+		autoscalingVersion:             o.autoscalingVersion,
 	}
 }
 
@@ -132,6 +135,13 @@ func (c *Config) AutoDetect() error {
 		}
 	}
 
+	hpaVersion, err := c.autoDetect.HPAVersion()
+	if err != nil {
+		return err
+	}
+	c.autoscalingVersion = hpaVersion
+	c.logger.Info("In Autodetect, Set HPA version to [", c.autoscalingVersion, "] from [", hpaVersion, "]")
+
 	return nil
 }
 
@@ -160,6 +170,11 @@ func (c *Config) Platform() platform.Platform {
 	return c.platform
 }
 
+// AutoscalingVersion represents the preferred version of autoscaling.
+func (c *Config) AutoscalingVersion() autodetect.AutoscalingVersion {
+	return c.autoscalingVersion
+}
+
 // AutoInstrumentationJavaImage returns OpenTelemetry Java auto-instrumentation container image.
 func (c *Config) AutoInstrumentationJavaImage() string {
 	return c.autoInstrumentationJavaImage

diff --git a/internal/config/main_test.go b/internal/config/main_test.go
@@ -102,6 +102,10 @@ type mockAutoDetect struct {
 	PlatformFunc func() (platform.Platform, error)
 }
 
+func (m *mockAutoDetect) HPAVersion() (autodetect.AutoscalingVersion, error) {
+	return autodetect.DefaultAutoscalingVersion, nil
+}
+
 func (m *mockAutoDetect) Platform() (platform.Platform, error) {
 	if m.PlatformFunc != nil {
 		return m.PlatformFunc()

diff --git a/internal/config/options.go b/internal/config/options.go
@@ -45,6 +45,7 @@ type options struct {
 	labelsFilter                   []string
 	platform                       platform.Platform
 	autoDetectFrequency            time.Duration
+	autoscalingVersion             autodetect.AutoscalingVersion
 }
 
 func WithAutoDetect(a autodetect.AutoDetect) Option {

diff --git a/pkg/autodetect/main.go b/pkg/autodetect/main.go
@@ -16,6 +16,9 @@
 package autodetect
 
 import (
+	"errors"
+	"sort"
+
 	"k8s.io/client-go/discovery"
 	"k8s.io/client-go/rest"
 
@@ -27,12 +30,23 @@ var _ AutoDetect = (*autoDetect)(nil)
 // AutoDetect provides an assortment of routines that auto-detect traits based on the runtime.
 type AutoDetect interface {
 	Platform() (platform.Platform, error)
+	HPAVersion() (AutoscalingVersion, error)
 }
 
 type autoDetect struct {
 	dcl discovery.DiscoveryInterface
 }
 
+type AutoscalingVersion int
+
+const (
+	AutoscalingVersionV2 AutoscalingVersion = iota
+	AutoscalingVersionV2Beta2
+	AutoscalingVersionUnknown
+)
+
+const DefaultAutoscalingVersion = AutoscalingVersionV2
+
 // New creates a new auto-detection worker, using the given client when talking to the current cluster.
 func New(restConfig *rest.Config) (AutoDetect, error) {
 	dcl, err := discovery.NewDiscoveryClientForConfig(restConfig)
@@ -64,3 +78,51 @@ func (a *autoDetect) Platform() (platform.Platform, error) {
 
 	return platform.Kubernetes, nil
 }
+
+func (a *autoDetect) HPAVersion() (AutoscalingVersion, error) {
+	apiList, err := a.dcl.ServerGroups()
+	if err != nil {
+		return AutoscalingVersionUnknown, err
+	}
+
+	for _, apiGroup := range apiList.Groups {
+		if apiGroup.Name == "autoscaling" {
+			// Sort this so we can make sure to get v2 before v2beta2
+			versions := apiGroup.Versions
+			sort.Slice(versions, func(i, j int) bool {
+				return versions[i].Version < versions[j].Version
+			})
+
+			for _, version := range versions {
+				if version.Version == "v2" || version.Version == "v2beta2" {
+					return toAutoscalingVersion(version.Version), nil
+				}
+			}
+			return AutoscalingVersionUnknown, errors.New("Failed to find appropriate version of apiGroup autoscaling, only v2 and v2beta2 are supported")
+		}
+	}
+
+	return AutoscalingVersionUnknown, errors.New("Failed to find apiGroup autoscaling")
+}
+
+func (v AutoscalingVersion) String() string {
+	switch v {
+	case AutoscalingVersionV2:
+		return "v2"
+	case AutoscalingVersionV2Beta2:
+		return "v2beta2"
+	case AutoscalingVersionUnknown:
+		return "unknown"
+	}
+	return "unknown"
+}
+
+func toAutoscalingVersion(version string) AutoscalingVersion {
+	switch version {
+	case "v2":
+		return AutoscalingVersionV2Beta2
+	case "v2beta2":
+		return AutoscalingVersionV2Beta2
+	}
+	return AutoscalingVersionUnknown
+}
diff --git a/pkg/autodetect/main_test.go b/pkg/autodetect/main_test.go
@@ -88,3 +88,9 @@ func TestUnknownPlatformOnError(t *testing.T) {
 	assert.Error(t, err)
 	assert.Equal(t, platform.Unknown, plt)
 }
+
+func TestAutoscalingVersionToString(t *testing.T) {
+	assert.Equal(t, "v2", autodetect.AutoscalingVersionV2.String())
+	assert.Equal(t, "v2beta2", autodetect.AutoscalingVersionV2Beta2.String())
+	assert.Equal(t, "unknown", autodetect.AutoscalingVersionUnknown.String())
+}