Merge pull request #276 from james-milligan/flagdspec

feat: Decouple feature flag spec from flagd config

Author: james-milligan

PROJECT

@@ -25,4 +25,13 @@ resources:
   kind: FeatureFlagConfiguration
   path: github.com/open-feature/open-feature-operator/apis/core/v1alpha2
   version: v1alpha2
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: openfeature.dev
+  group: core
+  kind: FlagSourceConfiguration
+  path: github.com/open-feature/open-feature-operator/apis/core/v1alpha1
+  version: v1alpha1
 version: "3"

apis/core/v1alpha1/featureflagconfiguration_types.go

@@ -37,6 +37,7 @@ type FeatureFlagConfigurationSpec struct {
 	// +optional
 	// +nullable
 	SyncProvider *FeatureFlagSyncProvider `json:"syncProvider"`
+	// FlagDSpec [DEPRECATED]: superseded by FlagSourceConfiguration
 	// +optional
 	// +nullable
 	FlagDSpec *FlagDSpec `json:"flagDSpec"`

apis/core/v1alpha1/flagsourceconfiguration_conversion.go

@@ -0,0 +1,28 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import ctrl "sigs.k8s.io/controller-runtime"
+
+// Hub marks this type as a conversion hub.
+func (ffc *FlagSourceConfiguration) Hub() {}
+
+func (r *FlagSourceConfiguration) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewWebhookManagedBy(mgr).
+		For(r).
+		Complete()
+}

apis/core/v1alpha1/flagsourceconfiguration_types.go

@@ -0,0 +1,185 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	"fmt"
+	"os"
+
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	FlagdMetricPortEnvVar string = "FLAGD_METRICS_PORT"
+	FlagdPortEnvVar       string = "FLAGD_PORT"
+	FlagdSocketPathEnvVar string = "FLAGD_SOCKET_PATH"
+	FlagdEvaluatorEnvVar  string = "FLAGD_EVALUATOR"
+	flagDVersionEnvVar    string = "FLAGD_VERSION"
+	defaultMetricPort     int32  = 8014
+	defaultPort           int32  = 8013
+	defaultSocketPath     string = ""
+	defaultEvaluator      string = "json"
+	defaultImage          string = "ghcr.io/open-feature/flagd"
+	defaultTag            string = "main"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// FlagSourceConfigurationSpec defines the desired state of FlagSourceConfiguration
+type FlagSourceConfigurationSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// MetricsPort defines the port to serve metrics on, defaults to 8014
+	// +optional
+	MetricsPort int32 `json:"metricsPort"`
+
+	// Port defines the port to listen on, defaults to 8013
+	// +optional
+	Port int32 `json:"port"`
+
+	// SocketPath defines the unix socket path to listen on
+	// +optional
+	SocketPath string `json:"socketPath"`
+
+	//SyncProviderArgs are string arguments passed to all sync providers, defined as key values separated by =
+	// +optional
+	SyncProviderArgs []string `json:"syncProviderArgs"`
+
+	// Evaluator sets an evaluator, defaults to 'json'
+	// +optional
+	Evaluator string `json:"evaluator"`
+
+	// Image allows for the flagd image to be overridden, defaults to 'ghcr.io/open-feature/flagd'
+	// +optional
+	Image string `json:"image"`
+
+	// Tag to be appended to the flagd image, defaults to 'main'
+	// +optional
+	Tag string `json:"tag"`
+}
+
+func NewFlagSourceConfigurationSpec() *FlagSourceConfigurationSpec {
+	var tag = defaultTag
+	if flagDVersion := os.Getenv(flagDVersionEnvVar); flagDVersion != "" {
+		tag = flagDVersion
+	}
+	return &FlagSourceConfigurationSpec{
+		MetricsPort:      defaultMetricPort,
+		Port:             defaultPort,
+		SocketPath:       defaultSocketPath,
+		SyncProviderArgs: []string{},
+		Evaluator:        defaultEvaluator,
+		Image:            defaultImage,
+		Tag:              tag,
+	}
+}
+
+func (fc *FlagSourceConfigurationSpec) Merge(new *FlagSourceConfigurationSpec) {
+	if new == nil {
+		return
+	}
+	if new.MetricsPort != 0 {
+		fc.MetricsPort = new.MetricsPort
+	}
+	if new.Port != 0 {
+		fc.Port = new.Port
+	}
+	if new.SocketPath != "" {
+		fc.SocketPath = new.SocketPath
+	}
+	if new.Evaluator != "" {
+		fc.Evaluator = new.Evaluator
+	}
+	if new.Image != "" {
+		fc.Image = new.Image
+	}
+	if new.Tag != "" {
+		fc.Tag = new.Tag
+	}
+	if new.SyncProviderArgs != nil && len(new.SyncProviderArgs) > 0 {
+		fc.SyncProviderArgs = append(fc.SyncProviderArgs, new.SyncProviderArgs...)
+	}
+}
+
+func (fc *FlagSourceConfigurationSpec) ToEnvVars() []corev1.EnvVar {
+	envs := []corev1.EnvVar{}
+
+	if fc.MetricsPort != defaultMetricPort {
+		envs = append(envs, corev1.EnvVar{
+			Name:  FlagdMetricPortEnvVar,
+			Value: fmt.Sprintf("%d", fc.MetricsPort),
+		})
+	}
+
+	if fc.Port != defaultPort {
+		envs = append(envs, corev1.EnvVar{
+			Name:  FlagdPortEnvVar,
+			Value: fmt.Sprintf("%d", fc.Port),
+		})
+	}
+
+	if fc.Evaluator != defaultEvaluator {
+		envs = append(envs, corev1.EnvVar{
+			Name:  FlagdEvaluatorEnvVar,
+			Value: fc.Evaluator,
+		})
+	}
+
+	if fc.SocketPath != defaultSocketPath {
+		envs = append(envs, corev1.EnvVar{
+			Name:  FlagdSocketPathEnvVar,
+			Value: fc.SocketPath,
+		})
+	}
+	return envs
+}
+
+// FlagSourceConfigurationStatus defines the observed state of FlagSourceConfiguration
+type FlagSourceConfigurationStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+//+kubebuilder:resource:shortName="fsc"
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+//+kubebuilder:storageversion
+
+// FlagSourceConfiguration is the Schema for the FlagSourceConfigurations API
+type FlagSourceConfiguration struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   FlagSourceConfigurationSpec   `json:"spec,omitempty"`
+	Status FlagSourceConfigurationStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// FlagSourceConfigurationList contains a list of FlagSourceConfiguration
+type FlagSourceConfigurationList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []FlagSourceConfiguration `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&FlagSourceConfiguration{}, &FlagSourceConfigurationList{})
+}

apis/core/v1alpha1/zz_generated.deepcopy.go

@@ -37,6 +37,7 @@ type FeatureFlagConfigurationSpec struct {
 	// +optional
 	// +nullable
 	SyncProvider *FeatureFlagSyncProvider `json:"syncProvider"`
+	// FlagDSpec [DEPRECATED]: superseded by FlagSourceConfiguration
 	// +optional
 	// +nullable
 	FlagDSpec *FlagDSpec `json:"flagDSpec"`