feat: initial controller implementation

Signed-off-by: Bence Csati <bence.csati@axoflow.com>

Author: csatib02

charts/logging-operator/charts/logging-operator-crds/templates/logging.banzaicloud.io_axosyslogs.yaml

@@ -20,10 +20,6 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: Control namespace
-      jsonPath: .spec.controlNamespace
-      name: ControlNamespace
-      type: string
     - description: Number of problems
       jsonPath: .status.problemsCount
       name: Problems
@@ -40,14 +36,14 @@ spec:
             type: object
           spec:
             properties:
-              controlNamespace:
-                type: string
-                x-kubernetes-validations:
-                - message: Value is immutable, please recreate the resource
-                  rule: self == oldSelf
               destinations:
                 items:
-                  type: string
+                  properties:
+                    config:
+                      type: string
+                    name:
+                      type: string
+                  type: object
                 type: array
               logPaths:
                 items:
@@ -58,8 +54,6 @@ spec:
                       type: string
                   type: object
                 type: array
-            required:
-            - controlNamespace
             type: object
           status:
             properties:

charts/logging-operator/crds/logging.banzaicloud.io_axosyslogs.yaml

@@ -17,10 +17,6 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: Control namespace
-      jsonPath: .spec.controlNamespace
-      name: ControlNamespace
-      type: string
     - description: Number of problems
       jsonPath: .status.problemsCount
       name: Problems
@@ -37,14 +33,14 @@ spec:
             type: object
           spec:
             properties:
-              controlNamespace:
-                type: string
-                x-kubernetes-validations:
-                - message: Value is immutable, please recreate the resource
-                  rule: self == oldSelf
               destinations:
                 items:
-                  type: string
+                  properties:
+                    config:
+                      type: string
+                    name:
+                      type: string
+                  type: object
                 type: array
               logPaths:
                 items:
@@ -55,8 +51,6 @@ spec:
                       type: string
                   type: object
                 type: array
-            required:
-            - controlNamespace
             type: object
           status:
             properties:

charts/logging-operator/templates/clusterrole.yaml

@@ -156,6 +156,7 @@ rules:
 - apiGroups:
   - logging.banzaicloud.io
   resources:
+  - axosyslogs
   - clusterflows
   - clusteroutputs
   - flows
@@ -181,6 +182,7 @@ rules:
 - apiGroups:
   - logging.banzaicloud.io
   resources:
+  - axosyslogs/status
   - clusterflows/status
   - clusteroutputs/status
   - flows/status

config/crd/bases/logging.banzaicloud.io_axosyslogs.yaml

@@ -17,10 +17,6 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: Control namespace
-      jsonPath: .spec.controlNamespace
-      name: ControlNamespace
-      type: string
     - description: Number of problems
       jsonPath: .status.problemsCount
       name: Problems
@@ -37,14 +33,14 @@ spec:
             type: object
           spec:
             properties:
-              controlNamespace:
-                type: string
-                x-kubernetes-validations:
-                - message: Value is immutable, please recreate the resource
-                  rule: self == oldSelf
               destinations:
                 items:
-                  type: string
+                  properties:
+                    config:
+                      type: string
+                    name:
+                      type: string
+                  type: object
                 type: array
               logPaths:
                 items:
@@ -55,8 +51,6 @@ spec:
                       type: string
                   type: object
                 type: array
-            required:
-            - controlNamespace
             type: object
           status:
             properties:

config/rbac/role.yaml

@@ -149,6 +149,7 @@ rules:
 - apiGroups:
   - logging.banzaicloud.io
   resources:
+  - axosyslogs
   - clusterflows
   - clusteroutputs
   - flows
@@ -174,6 +175,7 @@ rules:
 - apiGroups:
   - logging.banzaicloud.io
   resources:
+  - axosyslogs/status
   - clusterflows/status
   - clusteroutputs/status
   - flows/status

controllers/logging/axosyslog_controller.go

@@ -13,3 +13,58 @@
 // limitations under the License.
 
 package controllers
+
+import (
+	"context"
+
+	"github.com/go-logr/logr"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	"github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
+)
+
+// NewAxoSyslogReconciler creates a new AxoSyslogReconciler instance
+func NewAxoSyslogReconciler(client client.Client, log logr.Logger) *AxoSyslogReconciler {
+	return &AxoSyslogReconciler{
+		Client: client,
+		Log:    log,
+	}
+}
+
+type AxoSyslogReconciler struct {
+	client.Client
+	Log logr.Logger
+}
+
+// +kubebuilder:rbac:groups=logging.banzaicloud.io,resources=axosyslogs,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups=logging.banzaicloud.io,resources=axosyslogs/status,verbs=get;update;patch
+// +kubebuilder:rbac:groups="",resources=configmaps;secrets,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups="",resources=services;persistentvolumeclaims;serviceaccounts;pods,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=clusterroles;clusterrolebindings;roles;rolebindings,verbs=get;list;watch;create;update;patch;delete
+
+// Reconciles axosyslog resource
+func (r *AxoSyslogReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	log := r.Log.WithValues("axosyslog", req.NamespacedName)
+
+	log.V(1).Info("Reconciling AxoSyslog")
+
+	var axosyslog v1beta1.AxoSyslog
+	if err := r.Get(ctx, req.NamespacedName, &axosyslog); err != nil {
+		return ctrl.Result{}, client.IgnoreNotFound(err)
+	}
+
+	if err := axosyslog.SetDefaults(); err != nil {
+		return ctrl.Result{}, err
+	}
+
+	return ctrl.Result{}, nil
+}
+
+func SetupAxoSyslogWithManager(mgr ctrl.Manager, logger logr.Logger) error {
+	return ctrl.NewControllerManagedBy(mgr).
+		For(&v1beta1.AxoSyslog{}).
+		Named("AxoSyslogController").
+		Complete(NewAxoSyslogReconciler(mgr.GetClient(), logger))
+}

docs/configuration/crds/v1beta1/axosyslog_types.md

@@ -19,12 +19,7 @@ AxoSyslog is the Schema for the AxoSyslogs API
 
 AxoSyslogSpec defines the desired state of AxoSyslog
 
-### controlNamespace (string, required) {#axosyslogspec-controlnamespace}
-
-ControlNamespace is the namespace where the AxoSyslog StatefulSet and related components will be deployed 
-
-
-### destinations ([]string, optional) {#axosyslogspec-destinations}
+### destinations ([]Destination, optional) {#axosyslogspec-destinations}
 
 Destinations is a list of destinations to be rendered in the AxoSyslog configuration 
 
@@ -41,7 +36,7 @@ LogPath defines a single log path that will be rendered in the AxoSyslog configu
 
 ### destination (string, optional) {#logpath-destination}
 
-name of a destionation to be used in the log path 
+name of a destination to be used in the log path 
 
 
 ### filterx (string, optional) {#logpath-filterx}
@@ -112,7 +107,7 @@ AxoSyslogList contains a list of AxoSyslog
 ###  (metav1.TypeMeta, required) {#axosysloglist-}
 
 
-### metadata (metav1.ListMeta, required) {#axosysloglist-metadata}
+### metadata (metav1.ListMeta, optional) {#axosysloglist-metadata}
 
 
 ### items ([]AxoSyslog, required) {#axosysloglist-items}

main.go

@@ -51,16 +51,15 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 
-	telemetryv1alpha1 "github.com/kube-logging/telemetry-controller/api/telemetry/v1alpha1"
-
 	extensionsControllers "github.com/kube-logging/logging-operator/controllers/extensions"
-	loggingControllers "github.com/kube-logging/logging-operator/controllers/logging"
+	controllers "github.com/kube-logging/logging-operator/controllers/logging"
 	extensionsv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/extensions/api/v1alpha1"
 	config "github.com/kube-logging/logging-operator/pkg/sdk/extensions/extensionsconfig"
 	loggingv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1alpha1"
 	loggingv1beta1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
 	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/types"
 	"github.com/kube-logging/logging-operator/pkg/webhook/podhandler"
+	telemetryv1alpha1 "github.com/kube-logging/telemetry-controller/api/telemetry/v1alpha1"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -194,7 +193,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	loggingReconciler := loggingControllers.NewLoggingReconciler(mgr.GetClient(), mgr.GetEventRecorderFor("logging-operator"), ctrl.Log.WithName("logging"))
+	loggingReconciler := controllers.NewLoggingReconciler(mgr.GetClient(), mgr.GetEventRecorderFor("logging-operator"), ctrl.Log.WithName("logging"))
 
 	if err := (&extensionsControllers.EventTailerReconciler{
 		Client: mgr.GetClient(),
@@ -213,23 +212,28 @@ func main() {
 		os.Exit(1)
 	}
 
-	if err := loggingControllers.SetupLoggingWithManager(mgr, ctrl.Log.WithName("manager")).Complete(loggingReconciler); err != nil {
+	if err := controllers.SetupLoggingWithManager(mgr, ctrl.Log.WithName("manager")).Complete(loggingReconciler); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Logging")
 		os.Exit(1)
 	}
 
-	if err := loggingControllers.SetupLoggingRouteWithManager(mgr, ctrl.Log.WithName("logging-route")); err != nil {
+	if err := controllers.SetupLoggingRouteWithManager(mgr, ctrl.Log.WithName("logging-route")); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "LoggingRoute")
 		os.Exit(1)
 	}
 
 	if enableTelemetryControllerRoute {
-		if err := loggingControllers.SetupTelemetryControllerWithManager(mgr, ctrl.Log.WithName("telemetry-controller")); err != nil {
+		if err := controllers.SetupTelemetryControllerWithManager(mgr, ctrl.Log.WithName("telemetry-controller")); err != nil {
 			setupLog.Error(err, "unable to create controller", "controller", "TelemetryController")
 			os.Exit(1)
 		}
 	}
 
+	if err := controllers.SetupAxoSyslogWithManager(mgr, ctrl.Log.WithName("axosyslog")); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "AxoSyslog")
+		os.Exit(1)
+	}
+
 	if os.Getenv("ENABLE_WEBHOOKS") == "true" {
 		if err := loggingv1beta1.SetupWebhookWithManager(mgr, loggingv1beta1.APITypes()...); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "v1beta1.logging")
@@ -399,9 +403,9 @@ func cleanupFinalizers(ctx context.Context, client client.Client) {
 	}
 
 	finalizers := []string{
-		loggingControllers.FluentdConfigFinalizer,
-		loggingControllers.SyslogNGConfigFinalizer,
-		loggingControllers.TelemetryControllerFinalizer,
+		controllers.FluentdConfigFinalizer,
+		controllers.SyslogNGConfigFinalizer,
+		controllers.TelemetryControllerFinalizer,
 	}
 	for _, logging := range loggingList.Items {
 		for _, finalizer := range finalizers {

pkg/sdk/logging/api/v1beta1/axosyslog_types.go

@@ -20,7 +20,6 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:path=axosyslogs,scope=Namespaced,categories=logging-all
 // +kubebuilder:storageversion
-// +kubebuilder:printcolumn:name="ControlNamespace",type="string",JSONPath=".spec.controlNamespace",description="Control namespace"
 // +kubebuilder:printcolumn:name="Problems",type="integer",JSONPath=".status.problemsCount",description="Number of problems"
 
 // AxoSyslog is the Schema for the AxoSyslogs API
@@ -34,24 +33,18 @@ type AxoSyslog struct {
 
 // AxoSyslogSpec defines the desired state of AxoSyslog
 type AxoSyslogSpec struct {
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable, please recreate the resource"
-
-	// ControlNamespace is the namespace where the AxoSyslog StatefulSet and related components will be deployed
-	ControlNamespace string `json:"controlNamespace"`
-
 	// LogPaths is a list of log paths to be rendered in the AxoSyslog configuration
 	LogPaths []LogPath `json:"logPaths,omitempty"`
 
 	// Destinations is a list of destinations to be rendered in the AxoSyslog configuration
-	Destinations []string `json:"destinations,omitempty"`
+	Destinations []Destination `json:"destinations,omitempty"`
 }
 
 // LogPath defines a single log path that will be rendered in the AxoSyslog configuration
 type LogPath struct {
 	// filterx block to be rendered within the log path
 	Filterx string `json:"filterx,omitempty"`
-	// name of a destionation to be used in the log path
+	// name of a destination to be used in the log path
 	Destination string `json:"destination,omitempty"`
 }
 
@@ -90,10 +83,21 @@ type OTLPSource struct {
 // AxoSyslogList contains a list of AxoSyslog
 type AxoSyslogList struct {
 	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitzero"`
+	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []AxoSyslog `json:"items"`
 }
 
 func init() {
 	SchemeBuilder.Register(&AxoSyslog{}, &AxoSyslogList{})
 }
+
+func (a *AxoSyslog) SetDefaults() error {
+	if a.Spec.LogPaths == nil {
+		a.Spec.LogPaths = []LogPath{}
+	}
+	if a.Spec.Destinations == nil {
+		a.Spec.Destinations = []Destination{}
+	}
+
+	return nil
+}