feat[#1]: append data into crds

Author: siddh34

Dockerfile

@@ -0,0 +1,23 @@
+# Build stage
+FROM golang:1.24-alpine AS builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
+COPY *.go ./
+
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o file-monitor-controller .
+
+# Final stage
+FROM alpine:latest
+
+RUN apk --no-cache add ca-certificates
+
+WORKDIR /root/
+
+COPY --from=builder /app/file-monitor-controller .
+
+CMD ["./file-monitor-controller"]

README.md

@@ -1 +1,130 @@
-# file-monitor-kube-controller
+# file-monitor-kube-controller
+
+A Kubernetes controller that monitors file system changes and updates Custom Resource Definitions (CRDs) with file information such as inode, file name, size, and modification time.
+
+## Features
+
+- Queries Kubernetes CRDs using the k8s.io/client-go library
+- Monitors file system changes in specified paths
+- Updates CRD status with file information (inode, name, size, modification time)
+- Supports both in-cluster and out-of-cluster configurations
+- Namespace-aware file monitoring
+
+## Prerequisites
+
+- Go 1.24 or later
+- Kubernetes cluster (for deployment)
+- kubectl configured to access your cluster
+
+## Installation
+
+1. **Install the CRD:**
+   ```bash
+   kubectl apply -f filemonitor-crd.yaml
+   ```
+
+2. **Deploy the controller:**
+   ```bash
+   kubectl apply -f deployment.yaml
+   ```
+
+3. **Create a FileMonitor resource:**
+   ```bash
+   kubectl apply -f example-filemonitor.yaml
+   ```
+
+## Usage
+
+### Running locally (development)
+
+1. **Build the application:**
+   ```bash
+   go build -o file-monitor-controller
+   ```
+
+2. **Run the controller:**
+   ```bash
+   ./file-monitor-controller
+   ```
+
+### Running in Kubernetes
+
+1. **Build and push Docker image:**
+   ```bash
+   docker build -t your-registry/file-monitor-controller:latest .
+   docker push your-registry/file-monitor-controller:latest
+   ```
+
+2. **Update the deployment image:**
+   ```bash
+   # Edit deployment.yaml to use your image
+   kubectl apply -f deployment.yaml
+   ```
+
+## CRD Structure
+
+The FileMonitor CRD has the following structure:
+
+```yaml
+apiVersion: sentinalfs.io/v1
+kind: FileMonitor
+metadata:
+  name: example-file-monitor
+  namespace: default
+spec:
+  path: "/tmp"           # Path to monitor
+  namespace: "default"   # Target namespace
+status:
+  files:                 # Updated by controller
+  - name: "example.txt"
+    inode: 12345
+    size: 1024
+    modTime: "2025-01-13T10:00:00Z"
+    path: "/tmp/example.txt"
+    isDir: false
+```
+
+## Controller Functionality
+
+The controller performs the following operations in a continuous loop:
+
+1. **Query CRDs:** Lists all FileMonitor resources across namespaces
+2. **Namespace-specific queries:** Queries CRDs in specific namespaces
+3. **File information updates:** Updates CRD status with current file information
+4. **Error handling:** Gracefully handles missing CRDs and API errors
+
+## Key Functions
+
+- `queryCRDs()`: Queries all CRDs across all namespaces
+- `queryCRDsInNamespace()`: Queries CRDs in a specific namespace
+- `updateCRDWithFileInfo()`: Updates CRD status with file information
+- `initKubernetesClients()`: Initializes both regular and dynamic K8s clients
+
+## Configuration
+
+The controller automatically detects the runtime environment:
+- **In-cluster:** Uses service account credentials
+- **Local development:** Uses kubeconfig from `~/.kube/config`
+
+## RBAC Permissions
+
+The controller requires the following permissions:
+- Get, list, watch, create, update, patch, delete on `filemonitors` resources
+- Get, update, patch on `filemonitors/status`
+- Create, patch on `events` for logging
+
+## Monitoring
+
+The controller logs its operations including:
+- CRD discovery and enumeration
+- File system monitoring events
+- Error conditions and retries
+- Status updates
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Test thoroughly
+5. Submit a pull request

daemonset.yaml

@@ -0,0 +1,65 @@
+apiVersion: apps/v1
+kind: DaemonSet
+metadata:
+  name: file-monitor-controller
+  namespace: default
+  labels:
+    app: file-monitor-controller
+spec:
+  selector:
+    matchLabels:
+      app: file-monitor-controller
+  template:
+    metadata:
+      labels:
+        app: file-monitor-controller
+    spec:
+      serviceAccountName: file-monitor-controller
+      containers:
+      - name: controller
+        image: file-monitor-controller:latest
+        imagePullPolicy: IfNotPresent
+        env:
+        - name: WATCH_NAMESPACE
+          value: ""
+        resources:
+          limits:
+            cpu: 200m
+            memory: 128Mi
+          requests:
+            cpu: 100m
+            memory: 64Mi
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: file-monitor-controller
+  namespace: default
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: file-monitor-controller
+rules:
+- apiGroups: ["sentinalfs.io"]
+  resources: ["filemonitors"]
+  verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
+- apiGroups: ["sentinalfs.io"]
+  resources: ["filemonitors/status"]
+  verbs: ["get", "update", "patch"]
+- apiGroups: [""]
+  resources: ["events"]
+  verbs: ["create", "patch"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: file-monitor-controller
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: file-monitor-controller
+subjects:
+- kind: ServiceAccount
+  name: file-monitor-controller
+  namespace: default

example-filemonitor.yaml

@@ -0,0 +1,8 @@
+apiVersion: sentinalfs.io/v1
+kind: FileMonitor
+metadata:
+  name: example-file-monitor
+  namespace: default
+spec:
+  path: "/tmp"
+  namespace: "default"

filemonitor-crd.yaml

@@ -0,0 +1,61 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: filemonitors.sentinalfs.io
+spec:
+  group: sentinalfs.io
+  versions:
+  - name: v1
+    served: true
+    storage: true
+    schema:
+      openAPIV3Schema:
+        type: object
+        properties:
+          spec:
+            type: object
+            properties:
+              path:
+                type: string
+                description: "The file system path to monitor"
+              namespace:
+                type: string
+                description: "The namespace this monitor belongs to"
+            required:
+            - path
+            - namespace
+          status:
+            type: object
+            properties:
+              files:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    name:
+                      type: string
+                    inode:
+                      type: integer
+                      format: int64
+                    size:
+                      type: integer
+                      format: int64
+                    modTime:
+                      type: string
+                      format: date-time
+                    path:
+                      type: string
+                    isDir:
+                      type: boolean
+                  required:
+                  - name
+                  - inode
+                  - size
+                  - modTime
+                  - path
+                  - isDir
+  scope: Namespaced
+  names:
+    plural: filemonitors
+    singular: filemonitor
+    kind: FileMonitor

go.mod

@@ -0,0 +1,49 @@
+module fileMonitorKubeController
+
+go 1.24.5
+
+require (
+	k8s.io/apimachinery v0.33.2
+	k8s.io/client-go v0.33.2
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/emicklei/go-restful/v3 v3.11.0 // indirect
+	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonreference v0.20.2 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/gnostic-models v0.6.9 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/x448/float16 v0.8.4 // indirect
+	golang.org/x/net v0.38.0 // indirect
+	golang.org/x/oauth2 v0.27.0 // indirect
+	golang.org/x/sys v0.31.0 // indirect
+	golang.org/x/term v0.30.0 // indirect
+	golang.org/x/text v0.23.0 // indirect
+	golang.org/x/time v0.9.0 // indirect
+	google.golang.org/protobuf v1.36.5 // indirect
+	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/api v0.33.2 // indirect
+	k8s.io/klog/v2 v2.130.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20250318190949-c8a335a9a2ff // indirect
+	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
+	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
+	sigs.k8s.io/randfill v1.0.0 // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.6.0 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
+)