feat: add flagd CRD with ingress support

Makefile

@@ -255,4 +255,6 @@ helm-package: set-helm-overlay generate release-manifests helm
 install-mockgen:
 	go install github.com/golang/mock/[email protected]
 mockgen: install-mockgen
-	mockgen -source=controllers/common/flagd-injector.go -destination=controllers/common/mock/flagd-injector.go -package=commonmock
+	mockgen -source=./common/flagdinjector/flagdinjector.go -destination=./common/flagdinjector/mock/flagd-injector.go -package=commonmock
+	mockgen -source=./controllers/core/flagd/controller.go -destination=controllers/core/flagd/mock/mock.go -package=commonmock
+	mockgen -source=./controllers/core/flagd/resources/interface.go -destination=controllers/core/flagd/resources/mock/mock.go -package=commonmock

PROJECT

@@ -67,4 +67,13 @@ resources:
   kind: FeatureFlagSource
   path: github.com/open-feature/open-feature-operator/apis/core/v1beta1
   version: v1beta1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: openfeature.dev
+  group: core
+  kind: Flagd
+  path: github.com/open-feature/open-feature-operator/apis/core/v1beta1
+  version: v1beta1
 version: "3"

apis/core/v1beta1/flagd_types.go

@@ -0,0 +1,120 @@
+/*
+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 v1beta1
+
+import (
+	v1 "k8s.io/api/core/v1"
+	networkingv1 "k8s.io/api/networking/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// FlagdSpec defines the desired state of Flagd
+type FlagdSpec struct {
+	// Replicas defines the number of replicas to create for the service
+	// +optional
+	Replicas *int32 `json:"replicas,omitempty"`
+
+	// ServiceType represents the type of Service to create.
+	// Must be one of: ClusterIP, NodePort, LoadBalancer, and ExternalName.
+	// Default: ClusterIP
+	// +optional
+	// +kubebuilder:default=ClusterIP
+	// +kubebuilder:validation:Enum:=ClusterIP;NodePort;LoadBalancer;ExternalName
+	ServiceType v1.ServiceType `json:"serviceType,omitempty"`
+
+	// ServiceAccountName the service account name for the flagd deployment
+	// +optional
+	ServiceAccountName string `json:"serviceAccountName,omitempty"`
+
+	// OtelCollectorUri defines the OpenTelemetry collector URI to enable OpenTelemetry Tracing in flagd.
+	// +optional
+	OtelCollectorUri string `json:"otelCollectorUri"`
+
+	// FeatureFlagSource references to a FeatureFlagSource from which the created flagd instance retrieves
+	// the feature flag configurations
+	FeatureFlagSource string `json:"featureFlagSource"`
+
+	// Ingress
+	// +optional
+	Ingress IngressSpec `json:"ingress"`
+}
+
+// IngressSpec defines the options to be used when deploying the ingress for flagd
+type IngressSpec struct {
+	// Enabled enables/disables the ingress for flagd
+	Enabled bool `json:"enabled,omitempty"`
+
+	// Annotations the annotations to be added to the ingress
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
+
+	// Hosts list of hosts to be added to the ingress
+	// +optional
+	Hosts []string `json:"hosts,omitempty"`
+
+	// TLS configuration for the ingress
+	TLS []networkingv1.IngressTLS `json:"tls,omitempty"`
+
+	// IngressClassName defines the name if the ingress class to be used for flagd
+	// +optional
+	IngressClassName *string `json:"ingressClassName,omitempty"`
+
+	// PathType is the path type to be used for the ingress rules
+	// +optional
+	PathType networkingv1.PathType `json:"pathType,omitempty"`
+
+	// FlagdPath is the path to be used for accessing the flagd flag evaluation API
+	// +optional
+	FlagdPath string `json:"flagdPath,omitempty"`
+
+	// OFREPPath is the path to be used for accessing the OFREP API
+	// +optional
+	OFREPPath string `json:"ofrepPath"`
+
+	// SyncPath is the path to be used for accessing the sync API
+	// +optional
+	SyncPath string `json:"syncPath"`
+}
+
+// FlagdStatus defines the observed state of Flagd
+type FlagdStatus struct {
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// Flagd is the Schema for the flagds API
+type Flagd struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   FlagdSpec   `json:"spec,omitempty"`
+	Status FlagdStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// FlagdList contains a list of Flagd
+type FlagdList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Flagd `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Flagd{}, &FlagdList{})
+}

chart/open-feature-operator/.gitignore

@@ -4,3 +4,4 @@ templates/crds/*.yaml
 # the following files are not generated, they are special cases
 !templates/namespace.yaml
 !templates/admissionregistration.k8s.io_v1_validatingwebhookconfiguration_open-feature-operator-validating-webhook-configuration.yaml
+!templates/rbac.authorization.k8s.io_v1_clusterrole_open-feature-operator-manager-role.yaml

chart/open-feature-operator/README.md

@@ -126,24 +126,37 @@ The command removes all the Kubernetes components associated with the chart and
 | `flagdProxyConfiguration.image.tag`        | Sets the tag for the flagd-proxy deployment.                                    | `v0.5.0`                           |
 | `flagdProxyConfiguration.debugLogging`     | Controls the addition of the `--debug` flag to the container startup arguments. | `false`                            |
 
+### Flagd configuration
+
+| Name                                  | Description                                                                     | Value                        |
+| ------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
+| `flagdConfiguration.port`             | Sets the port to expose the flagd API on.                                       | `8013`                       |
+| `flagdConfiguration.ofrepPort`        | Sets the port to expose the ofrep API on.                                       | `8016`                       |
+| `flagdConfiguration.syncPort`         | Sets the port to expose the sync API on.                                        | `8015`                       |
+| `flagdConfiguration.managementPort`   | Sets the port to expose the management API on.                                  | `8014`                       |
+| `flagdConfiguration.image.repository` | Sets the image for the flagd deployment.                                        | `ghcr.io/open-feature/flagd` |
+| `flagdConfiguration.image.tag`        | Sets the tag for the flagd deployment.                                          | `v0.10.1`                    |
+| `flagdConfiguration.debugLogging`     | Controls the addition of the `--debug` flag to the container startup arguments. | `false`                      |
+
 ### Operator resource configuration
 
-| Name                                                                      | Description                                              | Value                                        |
-| ------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------- |
-| `controllerManager.kubeRbacProxy.image.repository`                        | Sets the image for the kube-rbac-proxy.                  | `gcr.io/kubebuilder/kube-rbac-proxy`         |
-| `controllerManager.kubeRbacProxy.image.tag`                               | Sets the version tag for the kube-rbac-proxy.            | `v0.14.1`                                    |
-| `controllerManager.kubeRbacProxy.resources.limits.cpu`                    | Sets cpu resource limits for kube-rbac-proxy.            | `500m`                                       |
-| `controllerManager.kubeRbacProxy.resources.limits.memory`                 | Sets memory resource limits for kube-rbac-proxy.         | `128Mi`                                      |
-| `controllerManager.kubeRbacProxy.resources.requests.cpu`                  | Sets cpu resource requests for kube-rbac-proxy.          | `5m`                                         |
-| `controllerManager.kubeRbacProxy.resources.requests.memory`               | Sets memory resource requests for kube-rbac-proxy.       | `64Mi`                                       |
-| `controllerManager.manager.image.repository`                              | Sets the image for the operator.                         | `ghcr.io/open-feature/open-feature-operator` |
-| `controllerManager.manager.image.tag`                                     | Sets the version tag for the operator.                   | `v0.5.4`                                     |
-| `controllerManager.manager.resources.limits.cpu`                          | Sets cpu resource limits for operator.                   | `500m`                                       |
-| `controllerManager.manager.resources.limits.memory`                       | Sets memory resource limits for operator.                | `128Mi`                                      |
-| `controllerManager.manager.resources.requests.cpu`                        | Sets cpu resource requests for operator.                 | `10m`                                        |
-| `controllerManager.manager.resources.requests.memory`                     | Sets memory resource requests for operator.              | `64Mi`                                       |
-| `controllerManager.replicas`                                              | Sets number of replicas of the OpenFeature operator pod. | `1`                                          |
-| `managerConfig.flagsValidatonEnabled`                                     | Enables the validating webhook for FeatureFlag CR.       | `true`                                       |
-| `managerConfig.controllerManagerConfigYaml.health.healthProbeBindAddress` | Sets the bind address for health probes.                 | `:8081`                                      |
-| `managerConfig.controllerManagerConfigYaml.metrics.bindAddress`           | Sets the bind address for metrics.                       | `127.0.0.1:8080`                             |
-| `managerConfig.controllerManagerConfigYaml.webhook.port`                  | Sets the bind address for webhook.                       | `9443`                                       |
+| Name                                                                      | Description                                                                                                                      | Value                                        |
+| ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| `controllerManager.kubeRbacProxy.image.repository`                        | Sets the image for the kube-rbac-proxy.                                                                                          | `gcr.io/kubebuilder/kube-rbac-proxy`         |
+| `controllerManager.kubeRbacProxy.image.tag`                               | Sets the version tag for the kube-rbac-proxy.                                                                                    | `v0.14.1`                                    |
+| `controllerManager.kubeRbacProxy.resources.limits.cpu`                    | Sets cpu resource limits for kube-rbac-proxy.                                                                                    | `500m`                                       |
+| `controllerManager.kubeRbacProxy.resources.limits.memory`                 | Sets memory resource limits for kube-rbac-proxy.                                                                                 | `128Mi`                                      |
+| `controllerManager.kubeRbacProxy.resources.requests.cpu`                  | Sets cpu resource requests for kube-rbac-proxy.                                                                                  | `5m`                                         |
+| `controllerManager.kubeRbacProxy.resources.requests.memory`               | Sets memory resource requests for kube-rbac-proxy.                                                                               | `64Mi`                                       |
+| `controllerManager.manager.image.repository`                              | Sets the image for the operator.                                                                                                 | `ghcr.io/open-feature/open-feature-operator` |
+| `controllerManager.manager.image.tag`                                     | Sets the version tag for the operator.                                                                                           | `v0.5.4`                                     |
+| `controllerManager.manager.resources.limits.cpu`                          | Sets cpu resource limits for operator.                                                                                           | `500m`                                       |
+| `controllerManager.manager.resources.limits.memory`                       | Sets memory resource limits for operator.                                                                                        | `128Mi`                                      |
+| `controllerManager.manager.resources.requests.cpu`                        | Sets cpu resource requests for operator.                                                                                         | `10m`                                        |
+| `controllerManager.manager.resources.requests.memory`                     | Sets memory resource requests for operator.                                                                                      | `64Mi`                                       |
+| `controllerManager.replicas`                                              | Sets number of replicas of the OpenFeature operator pod.                                                                         | `1`                                          |
+| `managerConfig.flagsValidatonEnabled`                                     | Enables the validating webhook for FeatureFlag CR.                                                                               | `true`                                       |
+| `managerConfig.flagdResourceEnabled`                                      | Enables the controller for the Flagd CR and adds the required permissions to create/update/delete Service and Ingress resources. | `true`                                       |
+| `managerConfig.controllerManagerConfigYaml.health.healthProbeBindAddress` | Sets the bind address for health probes.                                                                                         | `:8081`                                      |
+| `managerConfig.controllerManagerConfigYaml.metrics.bindAddress`           | Sets the bind address for metrics.                                                                                               | `127.0.0.1:8080`                             |
+| `managerConfig.controllerManagerConfigYaml.webhook.port`                  | Sets the bind address for webhook.                                                                                               | `9443`                                       |