chore(readme): document full crd

Signed-off-by: SkalaNetworks <contact@skala.network>

Author: SkalaNetworks

Makefile

@@ -92,11 +92,11 @@ cleanup-test-e2e: ## Tear down the Kind cluster used for e2e tests
 
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint linter
-	"$(GOLANGCI_LINT)" run
+	"$(GOLANGCI_LINT)" run --timeout 5m
 
 .PHONY: lint-fix
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
-	"$(GOLANGCI_LINT)" run --fix
+	"$(GOLANGCI_LINT)" run --fix --timeout 5m
 
 .PHONY: lint-config
 lint-config: golangci-lint ## Verify golangci-lint linter configuration

README.md

@@ -7,6 +7,44 @@ The **VirtualMachine Snapshot Scheduler** is a Kubernetes operator designed to a
 - **Retention Management**: Automatically deletes old snapshots based on a maximum count or TTL (Time to Live).
 - **Disable Schedule**: Disable snapshot creation by setting `disabled: true` while maintaining existing snapshots.
 - **Leader Election**: Supports high availability with leader election.
+- **CRD Configuration**: Fully configurable with simple YAML manifests.
+
+## Example CRD Configuration
+```yaml
+apiVersion: snapscheduler.kubevirt.io/v1alpha1
+kind: VirtualMachineSnapshotSchedule
+metadata:
+  name: example-schedule
+  namespace: default
+spec:
+  # Standard cron expression for scheduling snapshots
+  # Also supports descriptors (@daily, @monthly, @yearly...
+  schedule: "0 2 * * *"
+  
+  # Selection of VirtualMachines to snapshot
+  # Supports both matchLabels and matchExpressions
+  virtualMachineSelector:
+    matchLabels:
+      vm.kubevirt.io/name: my-vm
+    matchExpressions:
+    - key: environment
+      operator: In
+      values:
+      - production
+  
+  # Retention policies (can be used together)
+  maxCount: 7    # Keep only the last 7 snapshots
+  ttl: "168h"    # Keep snapshots for 7 days (e.g., 24h, 1h, 30m)
+  
+  # Template for the created VirtualMachineSnapshot objects
+  snapshotTemplate:
+    metadata:
+      labels:
+        backup-type: scheduled
+        
+  # Set to true to pause the schedule without deleting it
+  disabled: false
+```
 
 ## Usage
 To enable scheduled snapshots for your VirtualMachines, create a `VirtualMachineSnapshotSchedule` resource.

charts/vmsnapshot-scheduler/Chart.yaml

@@ -2,13 +2,5 @@ apiVersion: v2
 name: vmsnapshot-scheduler
 description: A Helm chart to deploy the vmsnapshot-scheduler
 type: application
-
 version: 0.1.0
-appVersion: "0.1.0"
-
-keywords:
-  - kubernetes
-  - operator
-
-annotations:
-  kubebuilder.io/generated-by: kubebuilder
+appVersion: "0.1.0"

charts/vmsnapshot-scheduler/values.yaml

@@ -53,22 +53,14 @@ enableOwnerReferences: false
 ## Additional arguments for the manager
 args: []
 
-## Helper RBAC roles for managing custom resources
-##
-rbacHelpers:
-  # Install convenience admin/editor/viewer roles for CRDs
-  enable: false
-
 ## Controller metrics endpoint.
 ## Enable to expose /metrics endpoint with RBAC protection.
-##
 metrics:
   enable: true
   # Metrics server port
   port: 8443
 
 ## Custom Resource Definitions
-##
 crd:
   # Install CRDs with the chart
   enable: true
@@ -77,7 +69,6 @@ crd:
 
 ## Prometheus ServiceMonitor for metrics scraping.
 ## Requires prometheus-operator to be installed in the cluster.
-##
 serviceMonitor:
   enable: false