Compare commits

..
11 Commits
40 changed files with 7464 additions and 531 deletions
+86 -56
View File
@@ -1,71 +1,101 @@
name: Release name: Release
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
tags: paths-ignore:
- 'v*' - "**.md"
- "docs/**"
- "examples/**"
branches:
- main
permissions: permissions:
id-token: write id-token: write
contents: write contents: write
packages: write packages: write
jobs: jobs:
release: e2e-tests:
uses: lukaszraczylo/shared-actions/.github/workflows/go-release.yaml@main runs-on: ubuntu-latest
with: steps:
go-version: ">=1.25" - name: Checkout
docker-enabled: true uses: actions/checkout@v4
secrets: inherit with:
fetch-depth: 0
publish-helm-chart: - name: Set up Go
needs: release uses: actions/setup-go@v4
runs-on: ubuntu-latest with:
steps: go-version: ">=1.25"
- name: Checkout
uses: actions/checkout@v4 - name: Install dependencies
run: go mod download
- uses: engineerd/[email protected]
- name: Run e2e tests
run: |
# rename context to docker-desktop
kubectl config rename-context "$(kubectl config current-context)" docker-desktop
cd e2e
./run-all-tests.sh
release:
needs: e2e-tests
uses: lukaszraczylo/shared-actions/.github/workflows/go-release.yaml@main
with: with:
fetch-depth: 0 go-version: ">=1.25"
docker-enabled: true
secrets: inherit
- name: Get release version publish-helm-chart:
id: version needs: release
run: | runs-on: ubuntu-latest
VERSION=$(git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0") steps:
VERSION=${VERSION#v} - name: Checkout
echo "version=$VERSION" >> $GITHUB_OUTPUT uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Trigger helm-charts release - name: Get release version
env: id: version
GH_TOKEN: ${{ secrets.HOMEBREW_TAP_TOKEN }} run: |
RELEASE_VERSION: ${{ steps.version.outputs.version }} VERSION=$(git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0")
run: | VERSION=${VERSION#v}
gh api repos/lukaszraczylo/helm-charts/dispatches \ echo "version=$VERSION" >> $GITHUB_OUTPUT
-f event_type=release-chart \
-f client_payload[chart_name]=kubemirror \
-f client_payload[version]="$RELEASE_VERSION" \
-f client_payload[source_repo]=lukaszraczylo/kubemirror \
-f client_payload[chart_path]=charts/kubemirror
publish-website: - name: Trigger helm-charts release
needs: release env:
runs-on: ubuntu-latest GH_TOKEN: ${{ secrets.HOMEBREW_TAP_TOKEN }}
permissions: RELEASE_VERSION: ${{ steps.version.outputs.version }}
contents: read run: |
pages: write gh api repos/lukaszraczylo/helm-charts/dispatches \
id-token: write -f event_type=release-chart \
steps: -f client_payload[chart_name]=kubemirror \
- name: Checkout -f client_payload[version]="$RELEASE_VERSION" \
uses: actions/checkout@v4 -f client_payload[source_repo]=lukaszraczylo/kubemirror \
-f client_payload[chart_path]=charts/kubemirror
- name: Setup Pages publish-website:
uses: actions/configure-pages@v5 needs: release
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Upload artifact - name: Setup Pages
uses: actions/upload-pages-artifact@v3 uses: actions/configure-pages@v5
with:
path: './docs'
- name: Deploy to GitHub Pages - name: Upload artifact
id: deployment uses: actions/upload-pages-artifact@v3
uses: actions/deploy-pages@v4 with:
path: "./docs"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
+139 -2
View File
@@ -17,8 +17,10 @@ Tested in production environments managing 1000+ mirrors across 200+ namespaces
- [Usage Examples](#usage-examples) - [Usage Examples](#usage-examples)
- [Mirror a Secret to Specific Namespaces](#mirror-a-secret-to-specific-namespaces) - [Mirror a Secret to Specific Namespaces](#mirror-a-secret-to-specific-namespaces)
- [Mirror to Pattern-Matched Namespaces](#mirror-to-pattern-matched-namespaces) - [Mirror to Pattern-Matched Namespaces](#mirror-to-pattern-matched-namespaces)
- [Mirror to All Namespaces](#mirror-to-all-namespaces)
- [Mirror to All Labeled Namespaces](#mirror-to-all-labeled-namespaces) - [Mirror to All Labeled Namespaces](#mirror-to-all-labeled-namespaces)
- [Mirror Custom Resources (CRDs)](#mirror-custom-resources-crds) - [Mirror Custom Resources (CRDs)](#mirror-custom-resources-crds)
- [Using with ExternalSecrets Operator](#using-with-externalsecrets-operator)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Helm Chart Values](#helm-chart-values) - [Helm Chart Values](#helm-chart-values)
- [Command-line Flags](#command-line-flags) - [Command-line Flags](#command-line-flags)
@@ -65,9 +67,9 @@ KubeMirror solves this with:
| **Resources** | Mirror any Kubernetes resource type - Secrets, ConfigMaps, Ingresses, Services, CRDs, and more | | **Resources** | Mirror any Kubernetes resource type - Secrets, ConfigMaps, Ingresses, Services, CRDs, and more |
| **Resources** | Auto-discovery of all mirrorable resources with periodic refresh | | **Resources** | Auto-discovery of all mirrorable resources with periodic refresh |
| **Resources** | Safety deny list prevents mirroring dangerous resources (Pods, Events, Nodes) | | **Resources** | Safety deny list prevents mirroring dangerous resources (Pods, Events, Nodes) |
| **Targeting** | Mirror to specific namespaces, pattern-matched namespaces (`app-*`), or all labeled namespaces | | **Targeting** | Mirror to specific namespaces, patterns (`app-*`), `all` namespaces, or `all-labeled` (opt-in) |
| **Targeting** | Configurable maximum targets per source (default: 100) | | **Targeting** | Configurable maximum targets per source (default: 100) |
| **Targeting** | Namespace opt-in required for "all-labeled" mirrors | | **Targeting** | `all-labeled` requires namespace opt-in via `kubemirror.raczylo.com/allow-mirrors` label |
| **Sync** | Multi-layer change detection: generation field + SHA256 content hash | | **Sync** | Multi-layer change detection: generation field + SHA256 content hash |
| **Sync** | Automatic drift detection and correction for manually modified mirrors | | **Sync** | Automatic drift detection and correction for manually modified mirrors |
| **Sync** | Finalizer-based cleanup ensures mirrors are deleted with source | | **Sync** | Finalizer-based cleanup ensures mirrors are deleted with source |
@@ -207,8 +209,33 @@ data:
api_url: "https://api.example.com" api_url: "https://api.example.com"
``` ```
### Mirror to All Namespaces
Use the `all` keyword to mirror to every namespace in the cluster (except the source):
**Source Resource:**
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: global-config
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all"
data:
cluster_name: "production"
region: "us-west-2"
```
> **⚠️ Use with caution:** The `all` keyword mirrors to ALL namespaces (including kube-system, kube-public, etc.) except the source namespace. Consider using `all-labeled` for safer opt-in behavior.
### Mirror to All Labeled Namespaces ### Mirror to All Labeled Namespaces
Use `all-labeled` for opt-in mirroring where target namespaces must explicitly allow mirrors:
**Source Resource:** **Source Resource:**
```yaml ```yaml
apiVersion: v1 apiVersion: v1
@@ -265,6 +292,88 @@ spec:
- text/event-stream - text/event-stream
``` ```
### Using with ExternalSecrets Operator
KubeMirror works seamlessly with the [ExternalSecrets Operator](https://external-secrets.io/) to distribute secrets from external stores (like 1Password, Vault, AWS Secrets Manager) across multiple namespaces.
**Example - Distribute Docker Registry Credentials from 1Password:**
```yaml
apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: 1p-docker-config
namespace: default
spec:
# Pull secrets from 1Password/Vault/etc
secretStoreRef:
kind: ClusterSecretStore
name: 1password-homecluster
target:
creationPolicy: Owner # Standard ExternalSecrets setting - KubeMirror strips ownerReferences from mirrors
deletionPolicy: Retain
name: multi-registry-secret
# Include KubeMirror annotations in the secret template
template:
metadata:
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all" # or specific namespaces
type: kubernetes.io/dockerconfigjson
data:
.dockerconfigjson: |
{
"auths": {
"ghcr.io": {
"username": "{{ .ghcrUsername | toString }}",
"auth": "{{ printf "%s:%s" .ghcrUsername .ghcrPassword | b64enc }}"
}
}
}
data:
- remoteRef:
key: DockerAuth/ghcrio_username
secretKey: ghcrUsername
- remoteRef:
key: DockerAuth/ghcrio_password
secretKey: ghcrPassword
refreshInterval: 24h
```
**How it Works:**
1. **ExternalSecrets creates the source secret** with KubeMirror labels/annotations (source can be owned by any controller)
2. **KubeMirror detects the source** via the `kubemirror.raczylo.com/enabled` label
3. **KubeMirror creates mirrors** in target namespaces with:
- Labels identifying them as KubeMirror-managed mirrors
- Annotations linking back to the source (namespace, name, UID, content hash)
- **No ownerReferences** - preventing conflicts with source controllers
4. **ExternalSecrets refreshes the source** every 24h, updating only the source secret
5. **KubeMirror detects content changes** via hash comparison and updates all mirrors
6. Each controller manages its own resources independently - no conflicts
**Verification:**
```bash
# Check source secret was created by ExternalSecrets
kubectl get secret multi-registry-secret -n default -o jsonpath='{.metadata.annotations}'
# Verify mirrors were created by KubeMirror
kubectl get secrets --all-namespaces -l kubemirror.raczylo.com/mirror=true
# Check sync status on source
kubectl get secret multi-registry-secret -n default -o jsonpath='{.metadata.annotations.kubemirror\.raczylo\.com/sync-status}'
```
See [examples/externalsecret-dockerconfig.yaml](examples/externalsecret-dockerconfig.yaml) for a complete working example.
### Transformation Rules ### Transformation Rules
KubeMirror supports powerful transformation rules that modify resources during mirroring. This enables environment-specific configurations, security hardening, and dynamic value generation. KubeMirror supports powerful transformation rules that modify resources during mirroring. This enables environment-specific configurations, security hardening, and dynamic value generation.
@@ -478,6 +587,7 @@ When running the binary directly:
- `--worker-threads int` - Concurrent workers (default: 5) - `--worker-threads int` - Concurrent workers (default: 5)
- `--rate-limit-qps float32` - API rate limit (default: 50.0) - `--rate-limit-qps float32` - API rate limit (default: 50.0)
- `--rate-limit-burst int` - API burst limit (default: 100) - `--rate-limit-burst int` - API burst limit (default: 100)
- `--verify-source-freshness` - Verify cache freshness before mirroring (default: false)
**Namespace Filtering:** **Namespace Filtering:**
- `--excluded-namespaces string` - Comma-separated exclusion list - `--excluded-namespaces string` - Comma-separated exclusion list
@@ -556,6 +666,7 @@ kubectl logs -n kubemirror-system -l app.kubernetes.io/name=kubemirror | grep "d
- **Worker Pools:** Concurrent reconciliation with configurable parallelism - **Worker Pools:** Concurrent reconciliation with configurable parallelism
- **Rate Limiting:** Protects API server with configurable QPS and burst - **Rate Limiting:** Protects API server with configurable QPS and burst
- **Bounded Queues:** Prevents memory leaks under high load - **Bounded Queues:** Prevents memory leaks under high load
- **Cache Freshness Verification (Optional):** When `--verify-source-freshness=true`, compares cached source with direct API read to detect informer cache lag. Prevents mirroring stale data during the 5-20 second window after watch events. Trade-off: Extra API call when cache is stale, but guarantees data freshness (see [Cache Staleness](#cache-staleness) for details)
## Supported Resources ## Supported Resources
@@ -587,6 +698,32 @@ KubeMirror can mirror any namespaced Kubernetes resource that supports standard
**Auto-Discovery** automatically finds all supported resources. The deny list is comprehensive and prevents mirroring of dangerous or inappropriate resources. **Auto-Discovery** automatically finds all supported resources. The deny list is comprehensive and prevents mirroring of dangerous or inappropriate resources.
## Cache Staleness
Kubernetes controllers use informer caches for performance. KubeMirror implements a hybrid strategy to handle cache lag:
**The Problem:**
1. Source Secret updated → Watch event arrives
2. Reconciliation triggered immediately3. Controller reads from cache → **Gets stale data** (cache hasn't updated yet)
4. Stale data mirrored to targets5. Cache updates 5-20 seconds later → But reconciliation already ran
**The Solution (Optional):**
Enable `--verify-source-freshness=true` to activate hybrid caching:
1. Read from cache (fast)
2. Make direct API call to verify freshness
3. If resourceVersions differ → Use fresh API data
4. If resourceVersions match → Use cached data
**Trade-offs:**
| Mode | API Calls | Data Freshness | Use Case |
|------|-----------|----------------|----------|
| **Default** (`false`) | 0 extra calls | Eventually consistent (5-20s lag) | Most deployments - 95%+ of updates propagate correctly |
| **Freshness Verification** (`true`) | 1-2 extra calls per update | Always fresh | Critical secrets that must propagate immediately |
**Recommendation:** Default mode is sufficient for most use cases. Enable freshness verification only for environments where stale data is unacceptable (e.g., security-critical secrets, zero-downtime deployments).
## Monitoring ## Monitoring
KubeMirror exposes Prometheus metrics and includes production-ready monitoring resources: KubeMirror exposes Prometheus metrics and includes production-ready monitoring resources:
@@ -43,6 +43,13 @@ spec:
- --worker-threads={{ .Values.controller.workerThreads }} - --worker-threads={{ .Values.controller.workerThreads }}
- --rate-limit-qps={{ .Values.controller.rateLimitQPS }} - --rate-limit-qps={{ .Values.controller.rateLimitQPS }}
- --rate-limit-burst={{ .Values.controller.rateLimitBurst }} - --rate-limit-burst={{ .Values.controller.rateLimitBurst }}
{{- if .Values.controller.verifySourceFreshness }}
- --verify-source-freshness=true
{{- end }}
{{- if .Values.controller.lazyWatcherInit }}
- --lazy-watcher-init=true
{{- end }}
- --watcher-scan-interval={{ .Values.controller.watcherScanInterval }}
{{- if .Values.controller.excludedNamespaces }} {{- if .Values.controller.excludedNamespaces }}
- --excluded-namespaces={{ .Values.controller.excludedNamespaces }} - --excluded-namespaces={{ .Values.controller.excludedNamespaces }}
{{- end }} {{- end }}
@@ -53,6 +60,7 @@ spec:
- --resource-types={{ join "," .Values.controller.resourceTypes }} - --resource-types={{ join "," .Values.controller.resourceTypes }}
{{- end }} {{- end }}
- --discovery-interval={{ .Values.controller.discoveryInterval }} - --discovery-interval={{ .Values.controller.discoveryInterval }}
- --resync-period={{ .Values.controller.resyncPeriod }}
ports: ports:
- name: metrics - name: metrics
containerPort: 8080 containerPort: 8080
+28 -1
View File
@@ -44,14 +44,21 @@ controller:
leaderElectionID: "kubemirror-controller-leader" leaderElectionID: "kubemirror-controller-leader"
# Resource types to mirror # Resource types to mirror
# Examples: ["Secret.v1", "ConfigMap.v1", "Ingress.v1.networking.k8s.io"] # Examples: ["Secret.v1", "ConfigMap.v1", "Ingress.v1.networking.k8s.io", "Middleware.v1alpha1.traefik.io"]
# If empty, auto-discovery will find all mirrorable resources # If empty, auto-discovery will find all mirrorable resources
# MEMORY TIP: Specifying exact types reduces memory by 70-80% vs auto-discovery
# Common types: Secret.v1, ConfigMap.v1
resourceTypes: [] resourceTypes: []
# Auto-discovery interval (only used when resourceTypes is empty) # Auto-discovery interval (only used when resourceTypes is empty)
# How often to rediscover available resources in the cluster # How often to rediscover available resources in the cluster
discoveryInterval: "5m" discoveryInterval: "5m"
# Cache resync period - how often to refresh all cached resources
# Higher values reduce memory churn and API load
# Default: 10m (was 30s in earlier versions)
resyncPeriod: "10m"
# Resource limits # Resource limits
maxTargets: 100 maxTargets: 100
workerThreads: 5 workerThreads: 5
@@ -60,6 +67,26 @@ controller:
rateLimitQPS: 50.0 rateLimitQPS: 50.0
rateLimitBurst: 100 rateLimitBurst: 100
# Cache freshness verification
# Compares cache with direct API read to detect informer cache lag
# Prevents mirroring stale data but adds extra API call when cache is stale
# Recommended: false for most deployments (eventual consistency is acceptable)
verifySourceFreshness: false
# Lazy watcher initialization (RECOMMENDED for production)
# Only creates informers for resource types that actually have resources marked for mirroring
# Dramatically reduces memory usage - e.g., if you have 204 available resource types but only
# 2 types with marked resources, this creates only 2 watchers instead of 204
# Memory savings: typically 70-90% compared to eager initialization
# Default: false (user opt-in)
lazyWatcherInit: false
# Watcher scan interval (lazy-watcher-init mode only)
# How often to scan the cluster for new resource types that need watchers
# If you add a new resource type to mirror, it will be detected within this interval
# Default: 5m
watcherScanInterval: "5m"
# Namespace filtering # Namespace filtering
excludedNamespaces: "" excludedNamespaces: ""
includedNamespaces: "" includedNamespaces: ""
+174 -34
View File
@@ -7,10 +7,13 @@ import (
"os" "os"
"time" "time"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
utilruntime "k8s.io/apimachinery/pkg/util/runtime" utilruntime "k8s.io/apimachinery/pkg/util/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme" clientgoscheme "k8s.io/client-go/kubernetes/scheme"
ctrl "sigs.k8s.io/controller-runtime" ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/healthz" "sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap" "sigs.k8s.io/controller-runtime/pkg/log/zap"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server" metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
@@ -33,18 +36,22 @@ func init() {
func main() { func main() {
var ( var (
metricsAddr string metricsAddr string
probeAddr string probeAddr string
enableLeaderElection bool enableLeaderElection bool
leaderElectionID string leaderElectionID string
excludedNamespaces string excludedNamespaces string
includedNamespaces string includedNamespaces string
resourceTypes string resourceTypes string
discoveryInterval time.Duration discoveryInterval time.Duration
maxTargets int maxTargets int
workerThreads int workerThreads int
rateLimitQPS float64 rateLimitQPS float64
rateLimitBurst int rateLimitBurst int
resyncPeriod time.Duration
verifySourceFreshness bool
lazyWatcherInit bool
watcherScanInterval time.Duration
) )
flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.") flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
@@ -71,6 +78,18 @@ func main() {
"QPS rate limit for API server requests.") "QPS rate limit for API server requests.")
flag.IntVar(&rateLimitBurst, "rate-limit-burst", 100, flag.IntVar(&rateLimitBurst, "rate-limit-burst", 100,
"Burst limit for API server requests.") "Burst limit for API server requests.")
flag.DurationVar(&resyncPeriod, "resync-period", 10*time.Minute,
"Period for resyncing all resources (catches updates missed due to informer cache delays).")
flag.BoolVar(&verifySourceFreshness, "verify-source-freshness", false,
"Verify source resource freshness by comparing cache with direct API read. "+
"Prevents mirroring stale data when cache lags behind watch events. "+
"Trade-off: Extra API call when cache is stale.")
flag.BoolVar(&lazyWatcherInit, "lazy-watcher-init", false,
"Enable lazy watcher initialization - only create informers for resource types that have resources marked for mirroring. "+
"Significantly reduces memory usage by avoiding watchers for unused resource types. "+
"Recommended for production environments with many unused resource types.")
flag.DurationVar(&watcherScanInterval, "watcher-scan-interval", 5*time.Minute,
"Interval for scanning cluster to detect new resource types needing watchers (lazy-watcher-init mode only).")
opts := zap.Options{ opts := zap.Options{
Development: true, Development: true,
@@ -95,6 +114,7 @@ func main() {
RateLimitBurst: rateLimitBurst, RateLimitBurst: rateLimitBurst,
EnableAllKeyword: true, EnableAllKeyword: true,
RequireNamespaceOptIn: false, RequireNamespaceOptIn: false,
VerifySourceFreshness: verifySourceFreshness,
LeaderElection: config.LeaderElectionConfig{ LeaderElection: config.LeaderElectionConfig{
Enabled: enableLeaderElection, Enabled: enableLeaderElection,
ResourceName: leaderElectionID, ResourceName: leaderElectionID,
@@ -141,7 +161,34 @@ func main() {
cfg.MirroredResourceTypes = mirroredResources cfg.MirroredResourceTypes = mirroredResources
// Set up controller manager // Create cache transform function to strip unnecessary fields and reduce memory usage
// This can reduce memory consumption by 50-70% by removing:
// - managedFields (often several KB per resource)
// - large annotations like kubectl.kubernetes.io/last-applied-configuration
transformFunc := func(obj interface{}) (interface{}, error) {
// Type assert to unstructured
u, ok := obj.(*unstructured.Unstructured)
if !ok {
return obj, nil // Not unstructured, return as-is
}
// Strip managedFields - can be several KB per resource
u.SetManagedFields(nil)
// Strip large annotations that we don't need for reconciliation
annotations := u.GetAnnotations()
if annotations != nil {
// Remove kubectl last-applied-configuration (can be very large)
delete(annotations, "kubectl.kubernetes.io/last-applied-configuration")
// Remove other large annotations we don't need
delete(annotations, "deployment.kubernetes.io/revision")
u.SetAnnotations(annotations)
}
return obj, nil
}
// Set up controller manager with cache configuration
mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{ mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
Scheme: scheme, Scheme: scheme,
Metrics: metricsserver.Options{ Metrics: metricsserver.Options{
@@ -153,6 +200,12 @@ func main() {
LeaseDuration: &cfg.LeaderElection.LeaseDuration, LeaseDuration: &cfg.LeaderElection.LeaseDuration,
RenewDeadline: &cfg.LeaderElection.RenewDeadline, RenewDeadline: &cfg.LeaderElection.RenewDeadline,
RetryPeriod: &cfg.LeaderElection.RetryPeriod, RetryPeriod: &cfg.LeaderElection.RetryPeriod,
Cache: cache.Options{
// Use the transform function to reduce memory usage
DefaultTransform: transformFunc,
// Increase the resync period to reduce memory churn
SyncPeriod: &resyncPeriod,
},
}) })
if err != nil { if err != nil {
setupLog.Error(err, "unable to create manager") setupLog.Error(err, "unable to create manager")
@@ -200,35 +253,122 @@ func main() {
// Create namespace lister // Create namespace lister
namespaceLister := controller.NewKubernetesNamespaceLister(mgr.GetClient()) namespaceLister := controller.NewKubernetesNamespaceLister(mgr.GetClient())
// Dynamically register controllers for all discovered resource types // Choose between lazy watcher initialization (scan for active resources) or eager (register all)
// Create a separate reconciler instance for each resource type if lazyWatcherInit {
for _, rt := range cfg.MirroredResourceTypes { setupLog.Info("using lazy watcher initialization",
gvk := rt.GroupVersionKind() "availableResourceTypes", len(cfg.MirroredResourceTypes),
setupLog.Info("registering controller for resource type", "scanInterval", watcherScanInterval,
"group", gvk.Group,
"version", gvk.Version,
"kind", gvk.Kind,
) )
// Create a reconciler instance for this specific resource type // Factory functions for creating reconcilers
reconciler := &controller.SourceReconciler{ sourceFactory := func(gvk schema.GroupVersionKind) *controller.SourceReconciler {
Client: mgr.GetClient(), return &controller.SourceReconciler{
Scheme: mgr.GetScheme(), Client: mgr.GetClient(),
Config: cfg, Scheme: mgr.GetScheme(),
Filter: namespaceFilter, Config: cfg,
NamespaceLister: namespaceLister, Filter: namespaceFilter,
GVK: gvk, NamespaceLister: namespaceLister,
GVK: gvk,
APIReader: mgr.GetAPIReader(),
}
} }
if err = reconciler.SetupWithManagerForResourceType(mgr, gvk); err != nil { mirrorFactory := func(gvk schema.GroupVersionKind) *controller.MirrorReconciler {
setupLog.Error(err, "unable to create controller", return &controller.MirrorReconciler{
"resourceType", rt.String(), Client: mgr.GetClient(),
) Scheme: mgr.GetScheme(),
GVK: gvk,
}
}
// Create dynamic controller manager
dynamicMgr := controller.NewDynamicControllerManager(controller.DynamicManagerConfig{
Client: mgr.GetClient(),
Manager: mgr,
Config: cfg,
Filter: namespaceFilter,
NamespaceLister: namespaceLister,
AvailableResources: cfg.MirroredResourceTypes,
ScanInterval: watcherScanInterval,
SourceReconcilerFactory: sourceFactory,
MirrorReconcilerFactory: mirrorFactory,
})
// Start dynamic controller manager
if err := dynamicMgr.Start(signalCtx); err != nil {
setupLog.Error(err, "unable to start dynamic controller manager")
os.Exit(1) os.Exit(1)
} }
setupLog.Info("dynamic controller manager started - controllers will be registered on-demand")
} else {
setupLog.Info("using eager watcher initialization",
"resourceTypes", len(cfg.MirroredResourceTypes),
)
// Eager mode: Register controllers for all discovered resource types upfront
// Create a separate reconciler instance for each resource type
for _, rt := range cfg.MirroredResourceTypes {
gvk := rt.GroupVersionKind()
setupLog.Info("registering controller for resource type",
"group", gvk.Group,
"version", gvk.Version,
"kind", gvk.Kind,
)
// Create a source reconciler instance for this specific resource type
sourceReconciler := &controller.SourceReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Config: cfg,
Filter: namespaceFilter,
NamespaceLister: namespaceLister,
GVK: gvk,
APIReader: mgr.GetAPIReader(), // Direct API reader (bypasses cache)
}
if err = sourceReconciler.SetupWithManagerForResourceType(mgr, gvk); err != nil {
setupLog.Error(err, "unable to create source controller",
"resourceType", rt.String(),
)
os.Exit(1)
}
// Create a mirror reconciler instance for orphan detection
// This watches mirrored resources (with managed-by label) and verifies their source still exists
mirrorReconciler := &controller.MirrorReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
GVK: gvk,
}
if err = mirrorReconciler.SetupWithManager(mgr, gvk); err != nil {
setupLog.Error(err, "unable to create mirror controller",
"resourceType", rt.String(),
)
os.Exit(1)
}
}
setupLog.Info("registered source and mirror controllers", "count", len(cfg.MirroredResourceTypes))
} }
setupLog.Info("registered controllers", "count", len(cfg.MirroredResourceTypes)) // Register namespace reconciler to watch for new namespaces and label changes
namespaceReconciler := &controller.NamespaceReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Config: cfg,
Filter: namespaceFilter,
NamespaceLister: namespaceLister,
ResourceTypes: cfg.MirroredResourceTypes,
}
if err = namespaceReconciler.SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create namespace reconciler")
os.Exit(1)
}
setupLog.Info("registered namespace reconciler")
// Add health checks // Add health checks
if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil { if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
+11
View File
@@ -0,0 +1,11 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: kubemirror-controller
namespace: kubemirror-system
spec:
template:
spec:
containers:
- name: controller
imagePullPolicy: IfNotPresent
+11 -8
View File
@@ -1,19 +1,22 @@
---
apiVersion: kustomize.config.k8s.io/v1beta1 apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization kind: Kustomization
namespace: kubemirror-system namespace: kubemirror-system
commonLabels: commonLabels:
app.kubernetes.io/name: kubemirror
app.kubernetes.io/managed-by: kustomize app.kubernetes.io/managed-by: kustomize
app.kubernetes.io/name: kubemirror
resources: resources:
- namespace.yaml - namespace.yaml
- rbac.yaml - rbac.yaml
- deployment.yaml - deployment.yaml
- service.yaml - service.yaml
images: images:
- name: ghcr.io/lukaszraczylo/kubemirror - name: ghcr.io/lukaszraczylo/kubemirror
newTag: latest newName: kubemirror
newTag: local-test
patches:
- path: imagepullpolicy-patch.yaml
+357 -314
View File
@@ -9,125 +9,140 @@
content="Copy Secrets, ConfigMaps, and any Custom Resource across Kubernetes namespaces automatically. Transform values per environment. Better replacement for Reflector." content="Copy Secrets, ConfigMaps, and any Custom Resource across Kubernetes namespaces automatically. Transform values per environment. Better replacement for Reflector."
/> />
<script src="https://cdn.tailwindcss.com"></script> <script src="https://cdn.tailwindcss.com"></script>
<script>
tailwind.config = {
darkMode: 'class'
}
</script>
<link <link
rel="stylesheet" rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css"
/> />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&family=JetBrains+Mono:wght@400;500&display=swap"
rel="stylesheet"
/>
<style> <style>
body { font-family: "Inter", sans-serif; }
code, pre { font-family: "JetBrains Mono", monospace; }
.theme-transition {
transition: background-color 0.3s ease, color 0.3s ease, border-color 0.3s ease;
}
@keyframes fadeInUp {
from { opacity: 0; transform: translateY(20px); }
to { opacity: 1; transform: translateY(0); }
}
@keyframes float {
0%, 100% { transform: translateY(0px); }
50% { transform: translateY(-10px); }
}
.animate-fade-in-up { animation: fadeInUp 0.6s ease-out; }
.animate-float { animation: float 3s ease-in-out infinite; }
.glass {
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
-webkit-backdrop-filter: blur(10px);
border: 1px solid rgba(255, 255, 255, 0.2);
}
.dark .glass {
background: rgba(17, 24, 39, 0.7);
border: 1px solid rgba(255, 255, 255, 0.1);
}
.gradient-text { .gradient-text {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
-webkit-background-clip: text; -webkit-background-clip: text;
-webkit-text-fill-color: transparent; -webkit-text-fill-color: transparent;
background-clip: text; background-clip: text;
} }
.hover-lift { .dark .gradient-text {
transition: transform 0.3s ease, box-shadow 0.3s ease; background: linear-gradient(135deg, #818cf8 0%, #c084fc 100%);
} -webkit-background-clip: text;
.hover-lift:hover { -webkit-text-fill-color: transparent;
transform: translateY(-5px); background-clip: text;
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.15);
} }
.shadow-modern { box-shadow: 0 10px 40px -10px rgba(0, 0, 0, 0.1); }
.dark .shadow-modern { box-shadow: 0 10px 40px -10px rgba(0, 0, 0, 0.4); }
.code-block { .code-block {
background: linear-gradient(135deg, #1e293b 0%, #0f172a 100%); background: linear-gradient(135deg, #1e293b 0%, #0f172a 100%);
} }
.dark .code-block {
/* Fade-in animation */ background: linear-gradient(135deg, #0f172a 0%, #020617 100%);
@keyframes fadeInUp { }
from { html { scroll-behavior: smooth; }
.rotating-text {
display: inline-block;
min-width: 120px;
text-align: left;
perspective: 1000px;
}
.word-flip {
animation: flipBoard 0.6s ease-in-out;
transform-style: preserve-3d;
}
@keyframes flipBoard {
0% {
transform: rotateX(0deg);
filter: blur(0px);
opacity: 1;
}
50% {
transform: rotateX(90deg);
filter: blur(4px);
opacity: 0;
}
51% {
transform: rotateX(-90deg);
filter: blur(4px);
opacity: 0; opacity: 0;
transform: translateY(30px);
} }
to { 100% {
transform: rotateX(0deg);
filter: blur(0px);
opacity: 1; opacity: 1;
transform: translateY(0);
} }
}
.fade-in {
animation: fadeInUp 0.6s ease-out forwards;
opacity: 0;
}
.delay-100 { animation-delay: 0.1s; }
.delay-200 { animation-delay: 0.2s; }
.delay-300 { animation-delay: 0.3s; }
/* Scroll progress bar */
.progress-bar {
position: fixed;
top: 0;
left: 0;
height: 4px;
background: linear-gradient(90deg, #667eea 0%, #764ba2 100%);
z-index: 9999;
transition: width 0.1s ease-out;
}
/* Mobile menu animation */
.mobile-menu {
transform: translateX(100%);
transition: transform 0.3s ease-in-out;
}
.mobile-menu.active {
transform: translateX(0);
}
/* Smooth hover glow */
.glow-on-hover {
position: relative;
overflow: hidden;
}
.glow-on-hover::before {
content: '';
position: absolute;
top: 50%;
left: 50%;
width: 0;
height: 0;
border-radius: 50%;
background: rgba(255, 255, 255, 0.1);
transform: translate(-50%, -50%);
transition: width 0.6s, height 0.6s;
}
.glow-on-hover:hover::before {
width: 300px;
height: 300px;
} }
</style> </style>
<script>
if (localStorage.theme === "dark" || (!("theme" in localStorage) && window.matchMedia("(prefers-color-scheme: dark)").matches)) {
document.documentElement.classList.add("dark");
} else {
document.documentElement.classList.remove("dark");
}
</script>
</head> </head>
<body class="bg-gradient-to-br from-slate-50 to-blue-50"> <body class="bg-gradient-to-br from-slate-50 to-blue-50 dark:from-gray-900 dark:to-gray-800 text-gray-900 dark:text-gray-100 theme-transition">
<!-- Scroll Progress Bar -->
<div class="progress-bar" id="progressBar"></div>
<!-- Navigation --> <!-- Navigation -->
<nav class="bg-white/90 backdrop-blur-lg shadow-lg sticky top-0 z-50 border-b border-blue-100"> <nav class="fixed w-full glass shadow-modern z-50 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16 items-center"> <div class="flex justify-between h-16 items-center">
<a href="#" class="flex items-center gap-3 group"> <a href="#" class="flex items-center gap-3 hover:opacity-80 transition-opacity duration-300">
<div class="bg-gradient-to-br from-blue-500 to-purple-600 p-2 rounded-lg group-hover:scale-110 transition-transform duration-300"> <div class="bg-gradient-to-br from-blue-500 to-purple-600 dark:from-blue-600 dark:to-purple-700 p-2 rounded-lg transition-transform duration-300 hover:scale-110">
<i class="fas fa-copy text-2xl text-white"></i> <i class="fas fa-copy text-2xl text-white"></i>
</div> </div>
<span class="text-2xl font-bold gradient-text">KubeMirror</span> <span class="text-2xl font-bold gradient-text">KubeMirror</span>
</a> </a>
<!-- Desktop Menu --> <!-- Desktop Menu -->
<div class="hidden md:flex space-x-8"> <div class="hidden md:flex space-x-6">
<a href="#problem" class="text-slate-700 hover:text-blue-600 font-medium transition-colors">Problem</a> <a href="#problem" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium theme-transition">Problem</a>
<a href="#features" class="text-slate-700 hover:text-blue-600 font-medium transition-colors">Features</a> <a href="#features" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium theme-transition">Features</a>
<a href="#examples" class="text-slate-700 hover:text-blue-600 font-medium transition-colors">Examples</a> <a href="#examples" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium theme-transition">Examples</a>
<a href="#comparison" class="text-slate-700 hover:text-blue-600 font-medium transition-colors">Compare</a> <a href="#comparison" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-transition">Compare</a>
<a href="#installation" class="text-slate-700 hover:text-blue-600 font-medium transition-colors">Install</a> <a href="#installation" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium theme-transition">Install</a>
</div> </div>
<div class="flex items-center space-x-4"> <div class="flex items-center space-x-4">
<a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="text-slate-700 hover:text-blue-600 transition-colors"> <button id="theme-toggle" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center theme-transition" aria-label="Toggle theme">
<i class="fas fa-moon dark:hidden text-xl"></i>
<i class="fas fa-sun hidden dark:inline text-xl"></i>
</button>
<a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center theme-transition" aria-label="View on GitHub">
<i class="fab fa-github text-2xl"></i> <i class="fab fa-github text-2xl"></i>
</a> </a>
<!-- Mobile Menu Button --> <!-- Mobile Menu Button -->
<button id="mobileMenuBtn" class="md:hidden text-slate-700 hover:text-blue-600"> <button id="mobileMenuBtn" class="md:hidden text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center">
<i class="fas fa-bars text-2xl"></i> <i class="fas fa-bars text-2xl"></i>
</button> </button>
</div> </div>
@@ -136,39 +151,39 @@
</nav> </nav>
<!-- Mobile Menu --> <!-- Mobile Menu -->
<div id="mobileMenu" class="mobile-menu fixed top-16 right-0 w-64 h-full bg-white shadow-2xl z-40 md:hidden"> <div id="mobileMenu" class="mobile-menu fixed top-16 right-0 w-64 h-full bg-white dark:bg-gray-800 shadow-2xl z-40 md:hidden transform translate-x-full transition-transform duration-300 theme-transition">
<div class="flex flex-col p-6 space-y-4"> <div class="flex flex-col p-6 space-y-4">
<a href="#problem" class="text-slate-700 hover:text-blue-600 font-medium transition-colors py-2">Problem</a> <a href="#problem" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium py-2 theme-transition">Problem</a>
<a href="#features" class="text-slate-700 hover:text-blue-600 font-medium transition-colors py-2">Features</a> <a href="#features" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium py-2 theme-transition">Features</a>
<a href="#examples" class="text-slate-700 hover:text-blue-600 font-medium transition-colors py-2">Examples</a> <a href="#examples" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium py-2 theme-transition">Examples</a>
<a href="#comparison" class="text-slate-700 hover:text-blue-600 font-medium transition-colors py-2">Compare</a> <a href="#comparison" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium py-2 theme-transition">Compare</a>
<a href="#installation" class="text-slate-700 hover:text-blue-600 font-medium transition-colors py-2">Install</a> <a href="#installation" class="text-gray-700 dark:text-gray-300 hover:text-blue-600 dark:hover:text-blue-400 font-medium py-2 theme-transition">Install</a>
</div> </div>
</div> </div>
<!-- Hero Section --> <!-- Hero Section -->
<section class="relative overflow-hidden py-24"> <section class="relative overflow-hidden py-24 pt-32">
<div class="absolute inset-0 bg-gradient-to-br from-blue-50 via-purple-50 to-pink-50 opacity-70"></div> <div class="absolute inset-0 bg-gradient-to-br from-blue-50/50 via-purple-50/50 to-pink-50/50 dark:from-blue-900/20 dark:via-purple-900/20 dark:to-pink-900/20"></div>
<div class="relative max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center"> <div class="relative max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<div class="mb-8 inline-block fade-in"> <div class="mb-8 inline-block animate-fade-in-up">
<div class="bg-gradient-to-br from-blue-500 to-purple-600 p-6 rounded-2xl shadow-2xl"> <div class="bg-gradient-to-br from-blue-500 to-purple-600 dark:from-blue-600 dark:to-purple-700 p-6 rounded-2xl shadow-2xl animate-float">
<i class="fas fa-copy text-7xl text-white"></i> <i class="fas fa-copy text-7xl text-white"></i>
</div> </div>
</div> </div>
<h1 class="text-5xl md:text-6xl font-extrabold text-slate-900 mb-6 leading-tight fade-in delay-100"> <h1 class="text-3xl sm:text-2xl sm:text-xl sm:text-2xl lg:text-6xl font-bold text-gray-900 dark:text-white mb-4 sm:mb-6 leading-tight animate-fade-in-up theme-transition" style="animation-delay: 0.1s;">
Copy Kubernetes Resources<br/> <span id="rotatingWord" class="rotating-text">Copy</span> Kubernetes Resources<br/>
<span class="gradient-text">Across Namespaces</span> <span class="gradient-text">Across Namespaces</span>
</h1> </h1>
<p class="text-xl md:text-2xl text-slate-600 mb-10 max-w-3xl mx-auto leading-relaxed fade-in delay-200"> <p class="text-base sm:text-base text-gray-600 dark:text-gray-300 mb-8 sm:mb-10 max-w-3xl mx-auto leading-relaxed animate-fade-in-up theme-transition" style="animation-delay: 0.2s;">
Share Secrets, ConfigMaps, and any Custom Resource (like Traefik Middleware, Cert-Manager Certificates) across multiple namespaces. Share Secrets, ConfigMaps, and any Custom Resource (like Traefik Middleware, Cert-Manager Certificates) across multiple namespaces.
<strong>Automatically keep them in sync.</strong> Transform values per environment. <strong>Automatically keep them in sync.</strong> Transform values per environment.
</p> </p>
<div class="flex flex-col sm:flex-row justify-center gap-6 fade-in delay-300"> <div class="flex flex-col sm:flex-row justify-center gap-6 animate-fade-in-up" style="animation-delay: 0.3s;">
<a href="#installation" class="bg-gradient-to-r from-blue-600 to-purple-600 text-white px-10 py-4 rounded-xl font-bold text-lg hover:from-blue-700 hover:to-purple-700 transition-all shadow-lg hover:shadow-xl hover:scale-105 glow-on-hover"> <a href="#installation" class="bg-gradient-to-r from-blue-600 to-purple-600 dark:from-blue-500 dark:to-purple-500 text-white px-10 py-4 rounded-xl font-bold text-lg hover:from-blue-700 hover:to-purple-700 dark:hover:from-blue-600 dark:hover:to-purple-600 transition-all shadow-lg hover:shadow-xl hover:scale-105">
<i class="fas fa-download mr-2"></i> <i class="fas fa-download mr-2"></i>
Get Started Get Started
</a> </a>
<a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="bg-white text-slate-700 px-10 py-4 rounded-xl font-bold text-lg border-2 border-slate-300 hover:border-blue-500 hover:text-blue-600 transition-all shadow-lg hover:shadow-xl hover:scale-105"> <a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="bg-white dark:bg-gray-800 text-gray-700 dark:text-gray-300 px-10 py-4 rounded-xl font-bold text-lg border-2 border-gray-300 dark:border-gray-600 hover:border-blue-500 dark:hover:border-blue-400 hover:text-blue-600 dark:hover:text-blue-400 transition-all shadow-lg hover:shadow-xl hover:scale-105 theme-transition">
<i class="fab fa-github mr-2"></i> <i class="fab fa-github mr-2"></i>
GitHub GitHub
</a> </a>
@@ -177,55 +192,55 @@
</section> </section>
<!-- The Problem Section --> <!-- The Problem Section -->
<section id="problem" class="py-24 bg-white"> <section id="problem" class="py-24 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="text-center mb-16"> <div class="text-center mb-12">
<h2 class="text-4xl md:text-5xl font-extrabold text-slate-900 mb-6">The Problem</h2> <h2 class="text-2xl sm:text-xl sm:text-2xl font-bold text-gray-900 dark:text-white mb-3 sm:mb-4 theme-transition">The Problem</h2>
<p class="text-xl md:text-2xl text-slate-600 max-w-4xl mx-auto"> <p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 max-w-4xl mx-auto theme-transition">
Kubernetes doesn't let you share resources across namespaces. You need the same Secret or ConfigMap in 10 namespaces? You have to duplicate it manually and keep them all in sync. Kubernetes doesn't let you share resources across namespaces. You need the same Secret or ConfigMap in 10 namespaces? You have to duplicate it manually and keep them all in sync.
</p> </p>
</div> </div>
<div class="grid md:grid-cols-3 gap-8 mb-16"> <div class="grid md:grid-cols-3 gap-8 mb-16">
<div class="bg-gradient-to-br from-red-50 to-red-100 border-l-4 border-red-500 p-8 rounded-lg shadow-lg hover-lift"> <div class="bg-gradient-to-br from-red-50 to-red-100 dark:from-red-900/20 dark:to-red-800/20 border-l-4 border-red-500 dark:border-red-400 p-6 rounded-lg shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-center mb-4"> <div class="flex items-center mb-3">
<i class="fas fa-times-circle text-red-500 text-3xl mr-3"></i> <i class="fas fa-times-circle text-red-500 dark:text-red-400 text-2xl mr-3"></i>
<h3 class="font-bold text-xl text-slate-900">Manual Duplication</h3> <h3 class="font-semibold text-lg text-gray-900 dark:text-white theme-transition">Manual Duplication</h3>
</div> </div>
<p class="text-slate-700 leading-relaxed"> <p class="text-sm text-gray-700 dark:text-gray-300 leading-relaxed theme-transition">
Copy-paste the same TLS certificate Secret into 20 namespaces. Update it manually in all 20 when it expires. Copy-paste the same TLS certificate Secret into 20 namespaces. Update it manually in all 20 when it expires.
</p> </p>
</div> </div>
<div class="bg-gradient-to-br from-orange-50 to-orange-100 border-l-4 border-orange-500 p-8 rounded-lg shadow-lg hover-lift"> <div class="bg-gradient-to-br from-orange-50 to-orange-100 dark:from-orange-900/20 dark:to-orange-800/20 border-l-4 border-orange-500 dark:border-orange-400 p-6 rounded-lg shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-center mb-4"> <div class="flex items-center mb-3">
<i class="fas fa-times-circle text-orange-500 text-3xl mr-3"></i> <i class="fas fa-times-circle text-orange-500 dark:text-orange-400 text-2xl mr-3"></i>
<h3 class="font-bold text-xl text-slate-900">Environment Hardcoding</h3> <h3 class="font-semibold text-lg text-gray-900 dark:text-white theme-transition">Environment Hardcoding</h3>
</div> </div>
<p class="text-slate-700 leading-relaxed"> <p class="text-sm text-gray-700 dark:text-gray-300 leading-relaxed theme-transition">
Same ConfigMap but with different API URLs for dev, staging, prod? Create 3 separate versions and maintain them. Same ConfigMap but with different API URLs for dev, staging, prod? Create 3 separate versions and maintain them.
</p> </p>
</div> </div>
<div class="bg-gradient-to-br from-yellow-50 to-yellow-100 border-l-4 border-yellow-600 p-8 rounded-lg shadow-lg hover-lift"> <div class="bg-gradient-to-br from-yellow-50 to-yellow-100 dark:from-yellow-900/20 dark:to-yellow-800/20 border-l-4 border-yellow-600 dark:border-yellow-500 p-6 rounded-lg shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-center mb-4"> <div class="flex items-center mb-3">
<i class="fas fa-times-circle text-yellow-600 text-3xl mr-3"></i> <i class="fas fa-times-circle text-yellow-600 dark:text-yellow-500 text-2xl mr-3"></i>
<h3 class="font-bold text-xl text-slate-900">Limited Tools</h3> <h3 class="font-semibold text-lg text-gray-900 dark:text-white theme-transition">Limited Tools</h3>
</div> </div>
<p class="text-slate-700 leading-relaxed"> <p class="text-sm text-gray-700 dark:text-gray-300 leading-relaxed theme-transition">
Existing tools only support Secrets/ConfigMaps. Want to share Traefik Middleware? Out of luck. Existing tools only support Secrets/ConfigMaps. Want to share Traefik Middleware? Out of luck.
</p> </p>
</div> </div>
</div> </div>
<div class="bg-gradient-to-br from-green-50 to-emerald-100 border-l-4 border-green-500 p-10 rounded-xl shadow-xl hover-lift"> <div class="bg-gradient-to-br from-green-50 to-emerald-100 dark:from-green-900/20 dark:to-emerald-900/20 border-l-4 border-green-500 dark:border-green-400 p-6 rounded-xl shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-start gap-4"> <div class="flex items-start gap-4">
<i class="fas fa-check-circle text-green-500 text-4xl mt-1"></i> <i class="fas fa-check-circle text-green-500 dark:text-green-400 text-3xl mt-1"></i>
<div> <div>
<h3 class="font-bold text-2xl md:text-3xl text-slate-900 mb-4">KubeMirror's Solution</h3> <h3 class="font-bold text-xl text-gray-900 dark:text-white mb-3 theme-transition">KubeMirror's Solution</h3>
<p class="text-slate-700 text-lg md:text-xl leading-relaxed"> <p class="text-gray-700 dark:text-gray-300 text-base leading-relaxed theme-transition">
Define your resource once in a source namespace. KubeMirror automatically copies it to all target namespaces and keeps them synchronized. Define your resource once in a source namespace. KubeMirror automatically copies it to target namespaces (specific list, patterns like <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-sm text-purple-600 dark:text-purple-400 font-semibold theme-transition">app-*</code>, or <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-sm text-purple-600 dark:text-purple-400 font-semibold theme-transition">all</code>) and keeps them synchronized.
Transform values per environment (e.g., <code class="bg-white px-3 py-1 rounded font-mono text-purple-600 font-semibold">preprod-*</code> namespaces get preprod API URLs, <code class="bg-white px-3 py-1 rounded font-mono text-purple-600 font-semibold">prod-*</code> get production URLs). Transform values per environment (e.g., <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-sm text-purple-600 dark:text-purple-400 font-semibold theme-transition">preprod-*</code> namespaces get preprod API URLs, <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-sm text-purple-600 dark:text-purple-400 font-semibold theme-transition">prod-*</code> get production URLs).
Works with any Kubernetes resource type. Works with any Kubernetes resource type.
</p> </p>
</div> </div>
@@ -235,43 +250,43 @@
</section> </section>
<!-- Features Section --> <!-- Features Section -->
<section id="features" class="py-24 bg-gradient-to-br from-slate-50 to-blue-50"> <section id="features" class="py-24 bg-gradient-to-br from-slate-50 to-blue-50 dark:from-gray-800 dark:to-gray-900 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="text-center mb-20"> <div class="text-center mb-12">
<h2 class="text-4xl md:text-5xl font-extrabold text-slate-900 mb-4">Key Features</h2> <h2 class="text-2xl sm:text-xl sm:text-2xl font-bold text-gray-900 dark:text-white mb-3 sm:mb-4 theme-transition">Key Features</h2>
<p class="text-xl text-slate-600">Everything you need for resource mirroring and synchronization</p> <p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 theme-transition">Everything you need for resource mirroring and synchronization</p>
</div> </div>
<div class="grid md:grid-cols-2 gap-10"> <div class="grid md:grid-cols-2 gap-6">
<!-- Any Resource Type --> <!-- Any Resource Type -->
<div class="bg-white p-8 md:p-10 rounded-2xl shadow-xl hover-lift border border-blue-100"> <div class="bg-white dark:bg-gray-800 p-6 rounded-2xl shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 border border-blue-100 dark:border-gray-700 theme-transition">
<div class="bg-gradient-to-br from-blue-500 to-purple-600 w-16 h-16 rounded-xl flex items-center justify-center mb-6"> <div class="bg-gradient-to-br from-blue-500 to-purple-600 w-12 h-12 rounded-xl flex items-center justify-center mb-4">
<i class="fas fa-layer-group text-3xl text-white"></i> <i class="fas fa-layer-group text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-4">Mirror Any Resource Type</h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-3 theme-transition">Mirror Any Resource Type</h3>
<p class="text-slate-600 mb-6 text-lg"> <p class="text-gray-600 dark:text-gray-300 mb-4 text-sm theme-transition">
Not just Secrets and ConfigMaps. Mirror any namespaced Kubernetes resource: Not just Secrets and ConfigMaps. Mirror any namespaced Kubernetes resource:
</p> </p>
<ul class="text-slate-700 space-y-3 text-lg"> <ul class="text-gray-700 dark:text-gray-300 space-y-2 text-sm theme-transition">
<li><i class="fas fa-check-circle text-green-500 mr-3"></i>Secrets & ConfigMaps (obviously)</li> <li><i class="fas fa-check-circle text-green-500 mr-2"></i>Secrets & ConfigMaps (obviously)</li>
<li><i class="fas fa-check-circle text-green-500 mr-3"></i>Traefik Middleware, IngressRoute</li> <li><i class="fas fa-check-circle text-green-500 mr-2"></i>Traefik Middleware, IngressRoute</li>
<li><i class="fas fa-check-circle text-green-500 mr-3"></i>Cert-Manager Certificates</li> <li><i class="fas fa-check-circle text-green-500 mr-2"></i>Cert-Manager Certificates</li>
<li><i class="fas fa-check-circle text-green-500 mr-3"></i>Any Custom Resource Definition (CRD)</li> <li><i class="fas fa-check-circle text-green-500 mr-2"></i>Any Custom Resource Definition (CRD)</li>
</ul> </ul>
<div class="mt-6 p-4 bg-blue-50 rounded-lg border border-blue-200"> <div class="mt-4 p-3 bg-blue-50 dark:bg-blue-900/20 rounded-lg border border-blue-200 dark:border-blue-800 theme-transition">
<p class="text-sm text-slate-600"> <p class="text-xs text-gray-600 dark:text-gray-300 theme-transition">
<strong class="text-blue-700">How:</strong> KubeMirror discovers all available resource types automatically. No manual configuration needed. <strong class="text-blue-700 dark:text-blue-400">How:</strong> KubeMirror discovers all available resource types automatically. No manual configuration needed.
</p> </p>
</div> </div>
</div> </div>
<!-- Transformation Rules --> <!-- Transformation Rules -->
<div class="bg-white p-8 md:p-10 rounded-2xl shadow-xl hover-lift border border-purple-100"> <div class="bg-white dark:bg-gray-800 p-6 rounded-2xl shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 border border-purple-100 dark:border-gray-700 theme-transition">
<div class="bg-gradient-to-br from-purple-500 to-pink-600 w-16 h-16 rounded-xl flex items-center justify-center mb-6"> <div class="bg-gradient-to-br from-purple-500 to-pink-600 w-12 h-12 rounded-xl flex items-center justify-center mb-6">
<i class="fas fa-magic text-3xl text-white"></i> <i class="fas fa-magic text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-4">Transform Per Environment</h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-4 theme-transition">Transform Per Environment</h3>
<p class="text-slate-600 mb-6 text-lg"> <p class="text-gray-600 dark:text-gray-300 mb-6 text-sm theme-transition">
Change values automatically based on target namespace: Change values automatically based on target namespace:
</p> </p>
<div class="code-block text-gray-100 p-5 rounded-xl font-mono text-xs md:text-sm overflow-x-auto mb-4 shadow-lg"> <div class="code-block text-gray-100 p-5 rounded-xl font-mono text-xs md:text-sm overflow-x-auto mb-4 shadow-lg">
@@ -285,61 +300,65 @@
<span class="text-yellow-400">value:</span> <span class="text-blue-400">"https://api.com"</span> <span class="text-yellow-400">value:</span> <span class="text-blue-400">"https://api.com"</span>
<span class="text-yellow-400">namespacePattern:</span> <span class="text-blue-400">"prod-*"</span></pre> <span class="text-yellow-400">namespacePattern:</span> <span class="text-blue-400">"prod-*"</span></pre>
</div> </div>
<div class="p-4 bg-purple-50 rounded-lg border border-purple-200"> <div class="p-4 bg-purple-50 dark:bg-purple-900/20 rounded-lg border border-purple-200 dark:border-purple-800 theme-transition">
<p class="text-sm text-slate-600"> <p class="text-sm text-gray-600 dark:text-gray-300 theme-transition">
<strong class="text-purple-700">Why:</strong> One source ConfigMap, different values per environment. No manual maintenance. <strong class="text-purple-700 dark:text-purple-400">Why:</strong> One source ConfigMap, different values per environment. No manual maintenance.
</p> </p>
</div> </div>
</div> </div>
<!-- Automatic Sync --> <!-- Automatic Sync -->
<div class="bg-white p-8 md:p-10 rounded-2xl shadow-xl hover-lift border border-green-100"> <div class="bg-white dark:bg-gray-800 p-6 rounded-2xl shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 border border-green-100 dark:border-gray-700 theme-transition">
<div class="bg-gradient-to-br from-green-500 to-teal-600 w-16 h-16 rounded-xl flex items-center justify-center mb-6"> <div class="bg-gradient-to-br from-green-500 to-teal-600 w-12 h-12 rounded-xl flex items-center justify-center mb-6">
<i class="fas fa-sync-alt text-3xl text-white"></i> <i class="fas fa-sync-alt text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-4">Automatic Synchronization</h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-4 theme-transition">Automatic Synchronization</h3>
<p class="text-slate-600 mb-6 text-lg"> <p class="text-gray-600 dark:text-gray-300 mb-6 text-sm theme-transition">
Update the source once. All copies update automatically: Update the source once. All copies update automatically:
</p> </p>
<ul class="text-slate-700 space-y-3 text-lg"> <ul class="text-gray-700 dark:text-gray-300 space-y-3 text-sm theme-transition">
<li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Update source Secret → All 50 copies update</li> <li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Update source Secret → All 50 copies update</li>
<li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Delete source → All copies get deleted</li> <li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Delete source → All copies get deleted</li>
<li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Someone deletes a copy → Recreated automatically</li> <li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>Someone deletes a copy → Recreated automatically</li>
<li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>New namespace created → Copy appears automatically</li> <li><i class="fas fa-arrow-right text-blue-500 mr-3"></i>New namespace created → Copy appears automatically</li>
</ul> </ul>
<div class="mt-6 p-4 bg-green-50 rounded-lg border border-green-200"> <div class="mt-6 p-4 bg-green-50 dark:bg-green-900/20 rounded-lg border border-green-200 dark:border-green-800 theme-transition">
<p class="text-sm text-slate-600"> <p class="text-sm text-gray-600 dark:text-gray-300 theme-transition">
<strong class="text-green-700">How:</strong> Uses SHA256 content hashing + Kubernetes generation tracking. Only updates when content actually changes. <strong class="text-green-700 dark:text-green-400">How:</strong> Uses SHA256 content hashing + Kubernetes generation tracking. Only updates when content actually changes.
</p> </p>
</div> </div>
</div> </div>
<!-- Smart Targeting --> <!-- Smart Targeting -->
<div class="bg-white p-8 md:p-10 rounded-2xl shadow-xl hover-lift border border-orange-100"> <div class="bg-white dark:bg-gray-800 p-6 rounded-2xl shadow-modern hover:transform hover:-translate-y-1 transition-all duration-300 border border-orange-100 dark:border-gray-700 theme-transition">
<div class="bg-gradient-to-br from-orange-500 to-red-600 w-16 h-16 rounded-xl flex items-center justify-center mb-6"> <div class="bg-gradient-to-br from-orange-500 to-red-600 w-12 h-12 rounded-xl flex items-center justify-center mb-6">
<i class="fas fa-bullseye text-3xl text-white"></i> <i class="fas fa-bullseye text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-4">Flexible Targeting</h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-4 theme-transition">Flexible Targeting</h3>
<p class="text-slate-600 mb-6 text-lg"> <p class="text-gray-600 dark:text-gray-300 mb-6 text-sm theme-transition">
Choose which namespaces receive the copy: Choose which namespaces receive the copy:
</p> </p>
<div class="space-y-4 text-slate-700 text-base md:text-lg"> <div class="space-y-4 text-gray-700 dark:text-gray-300 text-base md:text-sm theme-transition">
<div class="flex flex-col sm:flex-row items-start sm:items-center gap-3"> <div class="flex flex-col sm:flex-row items-start sm:items-center gap-3">
<code class="bg-slate-100 px-4 py-2 rounded-lg font-mono text-purple-700 font-semibold text-sm">namespace-1,namespace-2</code> <code class="bg-gray-100 dark:bg-gray-700 px-4 py-2 rounded-lg font-mono text-purple-700 dark:text-purple-400 font-semibold text-sm theme-transition">namespace-1,namespace-2</code>
<span>Specific namespaces</span> <span>Specific namespaces</span>
</div> </div>
<div class="flex flex-col sm:flex-row items-start sm:items-center gap-3"> <div class="flex flex-col sm:flex-row items-start sm:items-center gap-3">
<code class="bg-slate-100 px-4 py-2 rounded-lg font-mono text-purple-700 font-semibold text-sm">app-*,prod-*</code> <code class="bg-gray-100 dark:bg-gray-700 px-4 py-2 rounded-lg font-mono text-purple-700 dark:text-purple-400 font-semibold text-sm theme-transition">app-*,prod-*</code>
<span>Pattern matching</span> <span>Pattern matching</span>
</div> </div>
<div class="flex flex-col sm:flex-row items-start sm:items-center gap-3"> <div class="flex flex-col sm:flex-row items-start sm:items-center gap-3">
<code class="bg-slate-100 px-4 py-2 rounded-lg font-mono text-purple-700 font-semibold text-sm">all-labeled</code> <code class="bg-gray-100 dark:bg-gray-700 px-4 py-2 rounded-lg font-mono text-purple-700 dark:text-purple-400 font-semibold text-sm theme-transition">all</code>
<span>All labeled namespaces</span> <span>All namespaces (no labels required)</span>
</div>
<div class="flex flex-col sm:flex-row items-start sm:items-center gap-3">
<code class="bg-gray-100 dark:bg-gray-700 px-4 py-2 rounded-lg font-mono text-purple-700 dark:text-purple-400 font-semibold text-sm theme-transition">all-labeled</code>
<span>Only namespaces with opt-in label</span>
</div> </div>
</div> </div>
<div class="mt-6 p-4 bg-orange-50 rounded-lg border border-orange-200"> <div class="mt-6 p-4 bg-orange-50 dark:bg-orange-900/20 rounded-lg border border-orange-200 dark:border-orange-800 theme-transition">
<p class="text-sm text-slate-600"> <p class="text-sm text-gray-600 dark:text-gray-300 theme-transition">
<strong class="text-orange-700">Safety:</strong> Source namespace never receives a copy. Max 100 targets per resource (configurable). <strong class="text-orange-700 dark:text-orange-400">Safety:</strong> Source namespace never receives a copy. Max 100 targets per resource (configurable).
</p> </p>
</div> </div>
</div> </div>
@@ -348,26 +367,26 @@
</section> </section>
<!-- Examples Section --> <!-- Examples Section -->
<section id="examples" class="py-24 bg-white"> <section id="examples" class="py-24 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="text-center mb-20"> <div class="text-center mb-12">
<h2 class="text-4xl md:text-5xl font-extrabold text-slate-900 mb-4">Real-World Examples</h2> <h2 class="text-2xl sm:text-xl sm:text-2xl font-extrabold text-gray-900 dark:text-white mb-4 theme-transition">Real-World Examples</h2>
<p class="text-xl text-slate-600">See how easy it is to get started with KubeMirror</p> <p class="text-xl text-gray-600 dark:text-gray-300 theme-transition">See how easy it is to get started with KubeMirror</p>
</div> </div>
<div class="space-y-12"> <div class="space-y-12">
<!-- Example 1: Basic Secret --> <!-- Example 1: Basic Secret -->
<div class="bg-gradient-to-br from-blue-50 to-indigo-50 p-8 md:p-10 rounded-2xl shadow-xl border border-blue-200 hover-lift"> <div class="bg-gradient-to-br from-blue-50 to-indigo-50 dark:from-blue-900/20 dark:to-indigo-900/20 p-6 rounded-2xl shadow-modern border border-blue-200 dark:border-blue-800 hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex flex-col sm:flex-row items-start gap-6 mb-6"> <div class="flex flex-col sm:flex-row items-start gap-6 mb-6">
<div class="bg-blue-600 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0"> <div class="bg-blue-600 dark:bg-blue-700 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0">
<span class="text-white font-bold text-2xl">1</span> <span class="text-white font-bold text-2xl">1</span>
</div> </div>
<div> <div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-3"> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-3 theme-transition">
<i class="fas fa-lock text-blue-600 mr-3"></i> <i class="fas fa-lock text-blue-600 dark:text-blue-400 mr-3"></i>
Basic: Mirror a TLS Secret Basic: Mirror a TLS Secret
</h3> </h3>
<p class="text-slate-600 text-lg">Share your TLS certificate across multiple application namespaces</p> <p class="text-gray-600 dark:text-gray-300 text-sm theme-transition">Share your TLS certificate across multiple application namespaces</p>
</div> </div>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
@@ -389,17 +408,17 @@
</div> </div>
<!-- Example 2: Pattern Matching --> <!-- Example 2: Pattern Matching -->
<div class="bg-gradient-to-br from-purple-50 to-pink-50 p-8 md:p-10 rounded-2xl shadow-xl border border-purple-200 hover-lift"> <div class="bg-gradient-to-br from-purple-50 to-pink-50 dark:from-purple-900/20 dark:to-pink-900/20 p-6 rounded-2xl shadow-modern border border-purple-200 dark:border-purple-800 hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex flex-col sm:flex-row items-start gap-6 mb-6"> <div class="flex flex-col sm:flex-row items-start gap-6 mb-6">
<div class="bg-purple-600 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0"> <div class="bg-purple-600 dark:bg-purple-700 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0">
<span class="text-white font-bold text-2xl">2</span> <span class="text-white font-bold text-2xl">2</span>
</div> </div>
<div> <div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-3"> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-3 theme-transition">
<i class="fas fa-asterisk text-purple-600 mr-3"></i> <i class="fas fa-asterisk text-purple-600 dark:text-purple-400 mr-3"></i>
Pattern Matching: Mirror to All App Namespaces Pattern Matching: Mirror to All App Namespaces
</h3> </h3>
<p class="text-slate-600 text-lg">Use wildcards to mirror to all namespaces matching a pattern</p> <p class="text-gray-600 dark:text-gray-300 text-sm theme-transition">Use wildcards to mirror to all namespaces matching a pattern</p>
</div> </div>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
@@ -418,26 +437,26 @@
<span class="text-yellow-400">log_level:</span> <span class="text-purple-400">"info"</span> <span class="text-yellow-400">log_level:</span> <span class="text-purple-400">"info"</span>
<span class="text-yellow-400">api_url:</span> <span class="text-purple-400">"https://api.example.com"</span></pre> <span class="text-yellow-400">api_url:</span> <span class="text-purple-400">"https://api.example.com"</span></pre>
</div> </div>
<div class="mt-6 p-5 bg-purple-100 rounded-lg border border-purple-300"> <div class="mt-6 p-5 bg-purple-100 dark:bg-purple-900/40 rounded-lg border border-purple-300 dark:border-purple-700 theme-transition">
<p class="text-slate-700 text-base md:text-lg"> <p class="text-gray-700 dark:text-gray-300 text-base md:text-sm theme-transition">
<i class="fas fa-info-circle text-purple-600 mr-2"></i> <i class="fas fa-info-circle text-purple-600 dark:text-purple-400 mr-2"></i>
<strong>Result:</strong> This ConfigMap will be automatically copied to <code class="bg-white px-2 py-1 rounded font-mono text-purple-700 text-sm">app-frontend</code>, <code class="bg-white px-2 py-1 rounded font-mono text-purple-700 text-sm">app-backend</code>, <code class="bg-white px-2 py-1 rounded font-mono text-purple-700 text-sm">app-worker</code>, and any other namespace starting with "app-" <strong>Result:</strong> This ConfigMap will be automatically copied to <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-purple-700 dark:text-purple-400 text-sm theme-transition">app-frontend</code>, <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-purple-700 dark:text-purple-400 text-sm theme-transition">app-backend</code>, <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-purple-700 dark:text-purple-400 text-sm theme-transition">app-worker</code>, and any other namespace starting with "app-"
</p> </p>
</div> </div>
</div> </div>
<!-- Example 3: Custom Resource (Traefik) --> <!-- Example 3: Custom Resource (Traefik) -->
<div class="bg-gradient-to-br from-green-50 to-teal-50 p-8 md:p-10 rounded-2xl shadow-xl border border-green-200 hover-lift"> <div class="bg-gradient-to-br from-green-50 to-teal-50 dark:from-green-900/20 dark:to-teal-900/20 p-6 rounded-2xl shadow-modern border border-green-200 dark:border-green-800 hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex flex-col sm:flex-row items-start gap-6 mb-6"> <div class="flex flex-col sm:flex-row items-start gap-6 mb-6">
<div class="bg-green-600 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0"> <div class="bg-green-600 dark:bg-green-700 w-14 h-14 rounded-xl flex items-center justify-center flex-shrink-0">
<span class="text-white font-bold text-2xl">3</span> <span class="text-white font-bold text-2xl">3</span>
</div> </div>
<div> <div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900 mb-3"> <h3 class="text-xl font-bold text-gray-900 dark:text-white mb-3 theme-transition">
<i class="fas fa-cubes text-green-600 mr-3"></i> <i class="fas fa-cubes text-green-600 dark:text-green-400 mr-3"></i>
Custom Resource: Share Traefik Middleware Custom Resource: Share Traefik Middleware
</h3> </h3>
<p class="text-slate-600 text-lg">Mirror any CRD like Traefik Middleware across your cluster</p> <p class="text-gray-600 dark:text-gray-300 text-sm theme-transition">Mirror any CRD like Traefik Middleware across your cluster</p>
</div> </div>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
@@ -457,9 +476,9 @@
<span class="text-yellow-400">excludedContentTypes:</span> <span class="text-yellow-400">excludedContentTypes:</span>
- text/event-stream</pre> - text/event-stream</pre>
</div> </div>
<div class="mt-6 p-5 bg-green-100 rounded-lg border border-green-300"> <div class="mt-6 p-5 bg-green-100 dark:bg-green-900/40 rounded-lg border border-green-300 dark:border-green-700 theme-transition">
<p class="text-slate-700 text-base md:text-lg"> <p class="text-gray-700 dark:text-gray-300 text-base md:text-sm theme-transition">
<i class="fas fa-lightbulb text-green-600 mr-2"></i> <i class="fas fa-lightbulb text-green-600 dark:text-green-400 mr-2"></i>
<strong>Works with any CRD:</strong> Cert-Manager Certificates, Gateway API resources, or your own custom resources! <strong>Works with any CRD:</strong> Cert-Manager Certificates, Gateway API resources, or your own custom resources!
</p> </p>
</div> </div>
@@ -469,89 +488,91 @@
</section> </section>
<!-- Comparison Section --> <!-- Comparison Section -->
<section id="comparison" class="py-24 bg-gradient-to-br from-slate-50 to-blue-50"> <section id="comparison" class="py-24 bg-gradient-to-br from-slate-50 to-blue-50 dark:from-gray-800 dark:to-gray-900 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="text-center mb-16"> <div class="text-center mb-16">
<h2 class="text-4xl md:text-5xl font-extrabold text-slate-900 mb-6">How KubeMirror Compares</h2> <h2 class="text-2xl sm:text-xl sm:text-2xl font-extrabold text-gray-900 dark:text-white mb-6 theme-transition">How KubeMirror Compares</h2>
<p class="text-xl md:text-2xl text-slate-600">We built KubeMirror to replace <a href="https://github.com/emberstack/kubernetes-reflector" class="text-blue-600 hover:underline font-semibold" target="_blank">emberstack/reflector</a></p> <p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 theme-transition">We built KubeMirror to replace <a href="https://github.com/emberstack/kubernetes-reflector" class="text-blue-600 dark:text-blue-400 hover:underline font-semibold" target="_blank">emberstack/reflector</a></p>
</div> </div>
<div class="overflow-x-auto rounded-2xl shadow-2xl"> <div class="glass rounded-xl overflow-hidden shadow-modern">
<table class="w-full bg-white"> <div class="overflow-x-auto">
<thead class="bg-gradient-to-r from-slate-800 to-slate-900 text-white"> <table class="w-full text-sm">
<tr> <thead class="bg-gradient-to-r from-blue-600 to-purple-600 text-white">
<th class="px-6 md:px-8 py-6 text-left font-bold text-base md:text-lg">Capability</th> <tr>
<th class="px-6 md:px-8 py-6 text-center font-bold text-base md:text-lg">KubeMirror</th> <th class="px-4 py-3 text-left font-semibold">Feature</th>
<th class="px-6 md:px-8 py-6 text-center font-bold text-base md:text-lg">Reflector</th> <th class="px-4 py-3 text-center font-semibold">KubeMirror</th>
</tr> <th class="px-4 py-3 text-center font-semibold">Reflector</th>
</thead> </tr>
<tbody class="divide-y divide-slate-200"> </thead>
<tr class="hover:bg-blue-50 transition-colors"> <tbody class="divide-y divide-gray-200 dark:divide-gray-700">
<td class="px-6 md:px-8 py-6"> <tr class="hover:bg-gray-50 dark:hover:bg-gray-800/50">
<div class="font-semibold text-base md:text-lg text-slate-900">Supported Resources</div> <td class="px-4 py-3">
<div class="text-sm text-slate-600 mt-1">What resource types can be mirrored</div> <div class="font-medium text-gray-900 dark:text-white theme-transition">Supported Resources</div>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">What resource types can be mirrored</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-check-circle text-green-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-green-700 mt-2">Secrets, ConfigMaps, CRDs, etc.</div> <span class="text-green-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">All CRDs</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-minus-circle text-yellow-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-yellow-700 mt-2">Secrets, ConfigMaps only</div> <span class="text-yellow-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Secrets, ConfigMaps only</div>
</tr> </td>
<tr class="hover:bg-blue-50 transition-colors bg-slate-50"> </tr>
<td class="px-6 md:px-8 py-6"> <tr class="hover:bg-gray-50 dark:hover:bg-gray-800/50">
<div class="font-semibold text-base md:text-lg text-slate-900">Auto-Discovery</div> <td class="px-4 py-3">
<div class="text-sm text-slate-600 mt-1">Finds all resource types automatically</div> <div class="font-medium text-gray-900 dark:text-white theme-transition">Auto-Discovery</div>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Finds all resource types automatically</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-check-circle text-green-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-green-700 mt-2">Yes</div> <span class="text-green-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Yes</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-times-circle text-red-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-red-700 mt-2">Hardcoded</div> <span class="text-red-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Hardcoded</div>
</tr> </td>
<tr class="hover:bg-blue-50 transition-colors"> </tr>
<td class="px-6 md:px-8 py-6"> <tr class="hover:bg-gray-50 dark:hover:bg-gray-800/50">
<div class="font-semibold text-base md:text-lg text-slate-900">Value Transformation</div> <td class="px-4 py-3">
<div class="text-sm text-slate-600 mt-1">Change values per target namespace</div> <div class="font-medium text-gray-900 dark:text-white theme-transition">Value Transformation</div>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Change values per target namespace</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-check-circle text-green-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-green-700 mt-2">Full support</div> <span class="text-green-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Full support</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-times-circle text-red-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-red-700 mt-2">Not available</div> <span class="text-red-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Not available</div>
</tr> </td>
<tr class="hover:bg-blue-50 transition-colors bg-slate-50"> </tr>
<td class="px-6 md:px-8 py-6"> <tr class="hover:bg-gray-50 dark:hover:bg-gray-800/50">
<div class="font-semibold text-base md:text-lg text-slate-900">Active Development</div> <td class="px-4 py-3">
<div class="text-sm text-slate-600 mt-1">Regular updates and bug fixes</div> <div class="font-medium text-gray-900 dark:text-white theme-transition">Active Development</div>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Regular updates and bug fixes</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-check-circle text-green-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-green-700 mt-2">Active</div> <span class="text-green-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Active</div>
<td class="px-6 md:px-8 py-6 text-center"> </td>
<div><i class="fas fa-check-circle text-green-500 text-2xl md:text-3xl"></i></div> <td class="px-4 py-3 text-center">
<div class="text-xs md:text-sm font-semibold text-green-700 mt-2">Recently resumed (2025)</div> <span class="text-green-500 text-xl"></span>
</td> <div class="text-xs text-gray-600 dark:text-gray-400 mt-1 theme-transition">Recently resumed (2025)</div>
</tr> </td>
</tbody> </tr>
</table> </tbody>
</table>
</div>
</div> </div>
<div class="mt-16 bg-gradient-to-br from-blue-50 to-indigo-100 border-l-4 border-blue-600 p-8 rounded-xl shadow-xl"> <div class="mt-16 bg-gradient-to-br from-blue-50 to-indigo-100 dark:from-blue-900/20 dark:to-indigo-900/20 border-l-4 border-blue-600 dark:border-blue-400 p-8 rounded-xl shadow-modern theme-transition">
<div class="flex flex-col sm:flex-row items-start gap-6"> <div class="flex flex-col sm:flex-row items-start gap-6">
<i class="fas fa-info-circle text-blue-600 text-3xl md:text-4xl mt-1"></i> <i class="fas fa-info-circle text-blue-600 dark:text-blue-400 text-xl sm:text-2xl mt-1"></i>
<div> <div>
<h4 class="text-xl md:text-2xl font-bold text-slate-900 mb-4">Why We Built KubeMirror</h4> <h4 class="text-base sm:text-lg font-bold text-gray-900 dark:text-white mb-4 theme-transition">Why We Built KubeMirror</h4>
<p class="text-slate-700 text-base md:text-lg leading-relaxed"> <p class="text-gray-700 dark:text-gray-300 text-sm leading-relaxed theme-transition">
We needed to share Traefik Middleware across 200+ namespaces with environment-specific configurations. We needed to share Traefik Middleware across 200+ namespaces with environment-specific configurations.
Reflector couldn't do it (Secrets/ConfigMaps only, no transformations). So we built KubeMirror with modern Reflector couldn't do it (Secrets/ConfigMaps only, no transformations). So we built KubeMirror with modern
Kubernetes best practices and all the features we wished Reflector had. Kubernetes best practices and all the features we wished Reflector had.
@@ -563,21 +584,21 @@
</section> </section>
<!-- Installation Section --> <!-- Installation Section -->
<section id="installation" class="py-24 bg-white"> <section id="installation" class="py-24 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="text-center mb-20"> <div class="text-center mb-12">
<h2 class="text-4xl md:text-5xl font-extrabold text-slate-900 mb-4">Installation</h2> <h2 class="text-2xl sm:text-xl sm:text-2xl font-extrabold text-gray-900 dark:text-white mb-4 theme-transition">Installation</h2>
<p class="text-xl md:text-2xl text-slate-600">Get started in under 2 minutes</p> <p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 theme-transition">Get started in under 2 minutes</p>
</div> </div>
<div class="grid md:grid-cols-2 gap-10 mb-16"> <div class="grid md:grid-cols-2 gap-6 mb-16">
<!-- Helm Installation --> <!-- Helm Installation -->
<div class="bg-gradient-to-br from-blue-50 to-indigo-50 p-8 md:p-10 rounded-2xl shadow-xl border border-blue-200 hover-lift"> <div class="bg-gradient-to-br from-blue-50 to-indigo-50 dark:from-blue-900/20 dark:to-indigo-900/20 p-6 rounded-2xl shadow-modern border border-blue-200 dark:border-blue-800 hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-center mb-6"> <div class="flex items-center mb-6">
<div class="bg-blue-600 w-14 h-14 rounded-xl flex items-center justify-center mr-4"> <div class="bg-blue-600 dark:bg-blue-700 w-14 h-14 rounded-xl flex items-center justify-center mr-4">
<i class="fas fa-ship text-2xl text-white"></i> <i class="fas fa-ship text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900">Helm <span class="text-blue-600">(Recommended)</span></h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white theme-transition">Helm <span class="text-blue-600 dark:text-blue-400">(Recommended)</span></h3>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
<pre><span class="text-green-400">helm repo add kubemirror \</span> <pre><span class="text-green-400">helm repo add kubemirror \</span>
@@ -591,12 +612,12 @@
</div> </div>
<!-- kubectl Installation --> <!-- kubectl Installation -->
<div class="bg-gradient-to-br from-purple-50 to-pink-50 p-8 md:p-10 rounded-2xl shadow-xl border border-purple-200 hover-lift"> <div class="bg-gradient-to-br from-purple-50 to-pink-50 dark:from-purple-900/20 dark:to-pink-900/20 p-6 rounded-2xl shadow-modern border border-purple-200 dark:border-purple-800 hover:transform hover:-translate-y-1 transition-all duration-300 theme-transition">
<div class="flex items-center mb-6"> <div class="flex items-center mb-6">
<div class="bg-purple-600 w-14 h-14 rounded-xl flex items-center justify-center mr-4"> <div class="bg-purple-600 dark:bg-purple-700 w-14 h-14 rounded-xl flex items-center justify-center mr-4">
<i class="fas fa-terminal text-2xl text-white"></i> <i class="fas fa-terminal text-2xl text-white"></i>
</div> </div>
<h3 class="text-2xl md:text-3xl font-bold text-slate-900">kubectl</h3> <h3 class="text-xl font-bold text-gray-900 dark:text-white theme-transition">kubectl</h3>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
<pre><span class="text-green-400">kubectl apply -k \</span> <pre><span class="text-green-400">kubectl apply -k \</span>
@@ -610,17 +631,17 @@
</div> </div>
<!-- Quick Start Example --> <!-- Quick Start Example -->
<div class="bg-gradient-to-br from-green-50 to-teal-50 p-8 md:p-12 rounded-2xl shadow-2xl border border-green-200"> <div class="bg-gradient-to-br from-green-50 to-teal-50 dark:from-green-900/20 dark:to-teal-900/20 p-6 md:p-8 rounded-2xl shadow-2xl border border-green-200 dark:border-green-800 theme-transition">
<h3 class="text-3xl md:text-4xl font-bold text-slate-900 mb-8 text-center"> <h3 class="text-xl sm:text-2xl font-bold text-gray-900 dark:text-white mb-8 text-center theme-transition">
<i class="fas fa-rocket text-green-600 mr-3"></i> <i class="fas fa-rocket text-green-600 dark:text-green-400 mr-3"></i>
Quick Start: Mirror a Secret in 30 Seconds Quick Start: Mirror a Secret in 30 Seconds
</h3> </h3>
<div class="grid md:grid-cols-2 gap-10"> <div class="grid md:grid-cols-2 gap-6">
<div> <div>
<div class="flex items-center gap-3 mb-6"> <div class="flex items-center gap-3 mb-6">
<div class="bg-green-600 w-10 h-10 rounded-full flex items-center justify-center text-white font-bold">1</div> <div class="bg-green-600 dark:bg-green-700 w-10 h-10 rounded-full flex items-center justify-center text-white font-bold">1</div>
<h4 class="font-bold text-xl md:text-2xl text-slate-900">Create your source Secret</h4> <h4 class="font-bold text-base sm:text-lg text-gray-900 dark:text-white theme-transition">Create your source Secret</h4>
</div> </div>
<div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg"> <div class="code-block text-gray-100 p-4 md:p-6 rounded-xl font-mono text-xs md:text-sm overflow-x-auto shadow-lg">
<pre><span class="text-blue-400">apiVersion:</span> v1 <pre><span class="text-blue-400">apiVersion:</span> v1
@@ -642,16 +663,16 @@
<div> <div>
<div class="flex items-center gap-3 mb-6"> <div class="flex items-center gap-3 mb-6">
<div class="bg-green-600 w-10 h-10 rounded-full flex items-center justify-center text-white font-bold">2</div> <div class="bg-green-600 dark:bg-green-700 w-10 h-10 rounded-full flex items-center justify-center text-white font-bold">2</div>
<h4 class="font-bold text-xl md:text-2xl text-slate-900">That's it!</h4> <h4 class="font-bold text-base sm:text-lg text-gray-900 dark:text-white theme-transition">That's it!</h4>
</div> </div>
<p class="text-slate-700 mb-6 text-base md:text-lg"> <p class="text-gray-700 dark:text-gray-300 mb-6 text-base md:text-sm theme-transition">
KubeMirror automatically: KubeMirror automatically:
</p> </p>
<ul class="text-slate-700 space-y-4 text-base md:text-lg"> <ul class="text-gray-700 dark:text-gray-300 space-y-4 text-base md:text-sm theme-transition">
<li class="flex items-start gap-3"> <li class="flex items-start gap-3">
<i class="fas fa-check-circle text-green-500 text-xl mt-1"></i> <i class="fas fa-check-circle text-green-500 text-xl mt-1"></i>
<span>Creates copies in <code class="bg-white px-2 py-1 rounded font-mono text-green-700 text-sm">app-1</code> and <code class="bg-white px-2 py-1 rounded font-mono text-green-700 text-sm">app-2</code></span> <span>Creates copies in <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-green-700 dark:text-green-400 text-sm theme-transition">app-1</code> and <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-green-700 dark:text-green-400 text-sm theme-transition">app-2</code></span>
</li> </li>
<li class="flex items-start gap-3"> <li class="flex items-start gap-3">
<i class="fas fa-check-circle text-green-500 text-xl mt-1"></i> <i class="fas fa-check-circle text-green-500 text-xl mt-1"></i>
@@ -666,10 +687,10 @@
<span>Cleans up all copies when you delete the source</span> <span>Cleans up all copies when you delete the source</span>
</li> </li>
</ul> </ul>
<div class="mt-8 p-5 bg-green-100 rounded-lg border border-green-300"> <div class="mt-8 p-5 bg-green-100 dark:bg-green-900/40 rounded-lg border border-green-300 dark:border-green-700 theme-transition">
<p class="text-sm text-slate-700"> <p class="text-sm text-gray-700 dark:text-gray-300 theme-transition">
<strong class="text-green-800">Required:</strong> Both the label <code class="bg-white px-2 py-1 rounded font-mono text-green-700 text-xs">kubemirror.raczylo.com/enabled</code> <strong class="text-green-800 dark:text-green-400">Required:</strong> Both the label <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-green-700 dark:text-green-400 text-xs theme-transition">kubemirror.raczylo.com/enabled</code>
and annotation <code class="bg-white px-2 py-1 rounded font-mono text-green-700 text-xs">kubemirror.raczylo.com/sync</code> are needed. and annotation <code class="bg-white dark:bg-gray-800 px-2 py-1 rounded font-mono text-green-700 dark:text-green-400 text-xs theme-transition">kubemirror.raczylo.com/sync</code> are needed.
</p> </p>
</div> </div>
</div> </div>
@@ -679,7 +700,7 @@
</section> </section>
<!-- Footer --> <!-- Footer -->
<footer class="bg-gradient-to-br from-slate-900 to-slate-800 text-gray-300 py-16"> <footer class="bg-gradient-to-br from-gray-900 to-gray-800 dark:from-black dark:to-gray-900 text-gray-300 dark:text-gray-400 py-16 theme-transition">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8"> <div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="grid md:grid-cols-3 gap-12"> <div class="grid md:grid-cols-3 gap-12">
<div> <div>
@@ -689,12 +710,12 @@
</div> </div>
<span class="text-2xl font-bold text-white">KubeMirror</span> <span class="text-2xl font-bold text-white">KubeMirror</span>
</div> </div>
<p class="text-gray-400 text-base md:text-lg leading-relaxed"> <p class="text-gray-400 dark:text-gray-500 text-sm leading-relaxed theme-transition">
Copy Kubernetes resources across namespaces. Modern replacement for Reflector. Copy Kubernetes resources across namespaces. Modern replacement for Reflector.
</p> </p>
</div> </div>
<div> <div>
<h4 class="text-lg md:text-xl font-bold text-white mb-6">Links</h4> <h4 class="text-base font-bold text-white mb-6">Links</h4>
<ul class="space-y-3 text-base md:text-lg"> <ul class="space-y-3 text-base md:text-lg">
<li><a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="hover:text-white transition-colors"><i class="fab fa-github mr-2"></i>GitHub</a></li> <li><a href="https://github.com/lukaszraczylo/kubemirror" target="_blank" class="hover:text-white transition-colors"><i class="fab fa-github mr-2"></i>GitHub</a></li>
<li><a href="https://github.com/lukaszraczylo/kubemirror/issues" target="_blank" class="hover:text-white transition-colors"><i class="fas fa-bug mr-2"></i>Report Issue</a></li> <li><a href="https://github.com/lukaszraczylo/kubemirror/issues" target="_blank" class="hover:text-white transition-colors"><i class="fas fa-bug mr-2"></i>Report Issue</a></li>
@@ -702,26 +723,25 @@
</ul> </ul>
</div> </div>
<div> <div>
<h4 class="text-lg md:text-xl font-bold text-white mb-6">License</h4> <h4 class="text-lg font-bold text-white mb-6">License</h4>
<p class="text-gray-400 text-base md:text-lg">MIT License</p> <p class="text-gray-400 dark:text-gray-500 text-sm theme-transition">MIT License</p>
<p class="text-gray-400 mt-4 text-base md:text-lg">© 2024 Lukasz Raczylo</p> <p class="text-gray-400 dark:text-gray-500 mt-4 text-sm theme-transition">© 2025 Lukasz Raczylo</p>
</div> </div>
</div> </div>
</div> </div>
</footer> </footer>
<!-- Back to Top Button --> <!-- Back to Top Button -->
<button id="backToTop" class="fixed bottom-8 right-8 bg-gradient-to-r from-blue-600 to-purple-600 text-white p-4 rounded-full shadow-2xl opacity-0 pointer-events-none transition-opacity duration-300 hover:scale-110 z-50"> <button id="backToTop" class="fixed bottom-8 right-8 bg-gradient-to-r from-blue-600 to-purple-600 dark:from-blue-500 dark:to-purple-500 text-white p-4 rounded-full shadow-2xl opacity-0 pointer-events-none transition-opacity duration-300 hover:scale-110 z-50">
<i class="fas fa-arrow-up text-xl"></i> <i class="fas fa-arrow-up text-xl"></i>
</button> </button>
<script> <script>
// Scroll progress bar // Theme toggle
window.addEventListener('scroll', () => { const themeToggle = document.getElementById('theme-toggle');
const winScroll = document.body.scrollTop || document.documentElement.scrollTop; themeToggle.addEventListener('click', () => {
const height = document.documentElement.scrollHeight - document.documentElement.clientHeight; const isDark = document.documentElement.classList.toggle('dark');
const scrolled = (winScroll / height) * 100; localStorage.theme = isDark ? 'dark' : 'light';
document.getElementById('progressBar').style.width = scrolled + '%';
}); });
// Mobile menu toggle // Mobile menu toggle
@@ -729,20 +749,20 @@
const mobileMenu = document.getElementById('mobileMenu'); const mobileMenu = document.getElementById('mobileMenu');
mobileMenuBtn.addEventListener('click', () => { mobileMenuBtn.addEventListener('click', () => {
mobileMenu.classList.toggle('active'); mobileMenu.classList.toggle('translate-x-full');
}); });
// Close mobile menu when clicking a link // Close mobile menu when clicking a link
document.querySelectorAll('#mobileMenu a').forEach(link => { document.querySelectorAll('#mobileMenu a').forEach(link => {
link.addEventListener('click', () => { link.addEventListener('click', () => {
mobileMenu.classList.remove('active'); mobileMenu.classList.add('translate-x-full');
}); });
}); });
// Close mobile menu when clicking outside // Close mobile menu when clicking outside
document.addEventListener('click', (e) => { document.addEventListener('click', (e) => {
if (!mobileMenu.contains(e.target) && !mobileMenuBtn.contains(e.target)) { if (!mobileMenu.contains(e.target) && !mobileMenuBtn.contains(e.target)) {
mobileMenu.classList.remove('active'); mobileMenu.classList.add('translate-x-full');
} }
}); });
@@ -773,6 +793,29 @@
} }
}); });
}); });
// Rotating word animation (flip board style)
const words = ['Copy', 'Mirror', 'Clone', 'Render'];
let currentWordIndex = 0;
const rotatingWordElement = document.getElementById('rotatingWord');
function rotateWord() {
rotatingWordElement.classList.remove('word-flip');
// Trigger reflow to restart animation
void rotatingWordElement.offsetWidth;
rotatingWordElement.classList.add('word-flip');
// Change word at the midpoint of the flip (when it's perpendicular)
setTimeout(() => {
currentWordIndex = (currentWordIndex + 1) % words.length;
rotatingWordElement.textContent = words[currentWordIndex];
}, 300); // Half of the 600ms animation duration
}
// Rotate word every 3 seconds
setInterval(rotateWord, 3000);
</script> </script>
</body> </body>
</html> </html>
+468
View File
@@ -0,0 +1,468 @@
# KubeMirror E2E Tests
Comprehensive, DRY (Don't Repeat Yourself) test framework for KubeMirror functionality.
## Overview
The test suite uses a **data-driven framework** approach where test scenarios are systematically defined and executed using reusable functions. This ensures comprehensive coverage of all edge cases without code duplication.
## Prerequisites
- Kubernetes cluster running (tested with docker-desktop)
- kubectl configured and pointing to docker-desktop context
- Go 1.21+ installed
- curl (for health checks)
## Test Architecture
### Test Framework Components
1. **common.sh**: Base utilities (logging, assertions, cleanup)
2. **test-framework.sh**: DRY test framework functions (resource creation, updates, verification)
3. **test-comprehensive.sh**: Comprehensive test scenarios using the framework (supports selective execution)
4. **test-parallel.sh**: Parallel test runner for faster execution (batches independent tests)
5. **run-all-tests.sh**: Main test runner (builds binary, starts controller, runs tests)
### Test Framework Functions
The framework provides reusable functions for all operations:
```bash
# Resource lifecycle
create_source <type> <name> <namespace> <has_label> <has_annotation> <targets> <data>
update_source_labels <type> <name> <namespace> <enabled_value>
update_source_annotations <type> <name> <namespace> <sync_value> <targets>
update_source_data <type> <name> <namespace> <new_data>
# Namespace operations
create_test_namespace <name> <allow_mirrors_label>
update_namespace_labels <namespace> <allow_mirrors_value>
delete_namespace <namespace>
# Verification functions
verify_mirrors_exist <type> <name> <namespace1> <namespace2> ...
verify_mirrors_not_exist <type> <name> <namespace1> <namespace2> ...
verify_mirror_data <type> <source_name> <source_ns> <target_ns> <expected_data>
verify_orphan_cleanup <type> <name> <namespace1> <namespace2> ...
```
## Comprehensive Test Suite
The comprehensive test suite (`test-comprehensive.sh`) covers **30 systematic scenarios**:
### Source Lifecycle Scenarios
1. **Source without labels/annotations**: No mirrors created
2. **Add enabled label**: Still no mirrors (sync annotation required)
3. **Add sync annotation**: Mirrors created in targets
4. **Modify source data**: Mirrors updated
5. **Set sync to false**: All mirrors deleted
6. **Set enabled to false**: All mirrors deleted
### Target Namespace Management
7. **Add namespace to list**: New mirror created
8. **Remove namespace from list**: Orphaned mirror deleted
9. **Change list to pattern**: Old mirrors deleted, new pattern mirrors created
10. **Multiple patterns**: Mirrors in all matching namespaces
### Pattern Matching
11. **Create namespace matching pattern**: Automatic mirror creation
12. **Mix explicit + pattern**: Both types work together
13. **Change pattern**: Orphaned mirrors cleaned up
### 'all' Keyword with Opt-in
14. **'all' without namespace label**: No mirror created
15. **Add allow-mirrors label**: Mirror created
16. **Remove allow-mirrors label**: Mirror deleted
17. **Change label true→false**: Mirror deleted
### Edge Cases
18. **Target namespace deleted**: Other mirrors unaffected
19. **Recreate deleted namespace**: Mirror recreated
20. **Source deleted**: Cascade deletion of all mirrors
21. **Target manually deleted**: Automatic recreation
22. **Remove sync annotation**: All mirrors deleted
### Resource Types
23. **Mixed resource types**: ConfigMaps alongside Secrets
24. **Custom Resource (Traefik Middleware)**: CRD mirroring
### Transformation Scenarios (24-30)
25. **Static value transformation**: Replace data values with static strings
26. **Template transformation**: Use Go templates with context variables
27. **Merge transformation**: Merge new data into existing fields
28. **Delete transformation**: Remove specific fields
29. **Multiple transformations**: Combine multiple rules
30. **Strict mode**: Fail on transformation errors vs skip
All basic scenarios tested with both **Secrets** and **ConfigMaps**.
## Running Tests
### Run Complete Test Suite (Sequential)
```bash
cd e2e
./run-all-tests.sh
```
This will:
1. Check you're on docker-desktop context
2. Build the KubeMirror binary
3. Start the controller in background
4. Run comprehensive test scenarios (all 30 scenarios sequentially)
5. Report detailed results with pass/fail for each
6. Clean up all resources automatically
**Performance**: ~5-7 minutes for all 30 scenarios
### Run Complete Test Suite (Parallel) - **FASTER** ⚡
```bash
cd e2e
# Start controller first
../kubemirror --max-targets=100 --worker-threads=5 > /tmp/kubemirror-test.log 2>&1 &
# Run tests in parallel batches
./test-parallel.sh
```
This runs independent tests in parallel batches:
- **Sequential**: Scenarios 1-11 (core lifecycle - must run sequentially)
- **Parallel Batch 1**: Scenarios 12-15 (namespace labels)
- **Parallel Batch 2**: Scenarios 16-19 (deletion scenarios)
- **Parallel Batch 3**: Scenarios 20-23 (mixed resources)
- **Parallel Batch 4**: Scenarios 24-27 (transformations part 1)
- **Parallel Batch 5**: Scenarios 28-30 (transformations part 2)
**Performance**: ~3-4 minutes (40-50% faster than sequential)
### Run Selective Scenarios
Run only specific scenarios for faster iteration during development:
```bash
# Must have KubeMirror controller running first
cd /Users/nvm/Documents/projects/private/kube-mirror
./kubemirror --max-targets=100 --worker-threads=5 > /tmp/kubemirror-test.log 2>&1 &
# Run only transformation tests (scenarios 24-30)
cd e2e
./test-comprehensive.sh 24 25 26 27 28 29 30
# Run only specific scenarios
./test-comprehensive.sh 1 2 3
# Run single scenario for debugging
./test-comprehensive.sh 24
```
**Performance**: <1 minute for a few scenarios
## Test Output
Each test produces colored output:
- 🔵 **[INFO]**: Informational messages
-**[PASS]**: Test passed
-**[FAIL]**: Test failed
- ⚠️ **[WARN]**: Warning messages
Example output:
```
======================================
KubeMirror E2E Test Suite
======================================
[INFO] Step 1: Checking Kubernetes context
[PASS] Running on docker-desktop context
[INFO] Step 2: Building KubeMirror binary
[PASS] KubeMirror binary built successfully
[INFO] Step 3: Starting KubeMirror controller
[INFO] KubeMirror started with PID: 12345
[PASS] Controller is healthy
======================================
Running Test Suite 1: Basic Mirroring
======================================
[INFO] Starting Basic Mirroring tests
[INFO] Test 1: Mirror Secret to explicit namespace list
[PASS] Resource secret/test-explicit-list-secret exists in namespace e2e-target-1
[PASS] Resource secret/test-explicit-list-secret exists in namespace e2e-target-2
...
======================================
Test Summary
======================================
Total Tests: 45
Passed: 45
Failed: 0
======================================
All tests passed!
```
## Test Resources
Tests create temporary resources with clear naming for isolation:
- **Source Namespace**: `kubemirror-e2e-source` (dedicated namespace for all test source resources)
- **Target Namespaces**: `kubemirror-e2e-*` prefixed (ns-1, ns-2, app-1, db-1, etc.)
- **Secrets**: `test-*` prefixed in source namespace
- **ConfigMaps**: `test-*` prefixed in source namespace
- **CRDs**: Traefik Middleware resources for CRD testing
All resources are cleaned up automatically on test completion, including:
- Automatic finalizer removal from source resources (prevents hanging deletions)
- Cascade deletion of all target namespaces
- Cleanup on test interruption (SIGINT/SIGTERM)
## Troubleshooting
### Tests fail with "context not docker-desktop"
Switch to docker-desktop context:
```bash
kubectl config use-context docker-desktop
```
### Tests timeout waiting for resources
Controller may not be running or not reconciling. Check:
```bash
# Check if controller is running
ps aux | grep kubemirror
# Check controller logs
tail -f /tmp/kubemirror-e2e-test.log
# Check controller health
curl http://localhost:8081/healthz
```
### Cleanup hanging
If tests get interrupted, manually clean up:
```bash
# Delete all e2e test namespaces
kubectl delete namespace -l kubemirror-e2e-test=true
# Delete test resources in default namespace
kubectl delete secret,configmap -n default -l kubemirror.raczylo.com/enabled=true
# Kill controller if still running
pkill kubemirror
```
### Individual test fails
Run test with verbose output to see which assertion failed:
```bash
bash -x ./test-basic-mirroring.sh
```
Check controller logs for errors:
```bash
grep -i error /tmp/kubemirror-e2e-test.log
```
## Adding New Test Scenarios
The DRY framework makes it easy to add new test scenarios. Here's how:
### Example: Add a new scenario
```bash
# In test-comprehensive.sh, add a new scenario block:
run_test_scenario "23: Your new scenario description"
# Use framework functions to set up test conditions
create_test_namespace e2e-new-ns
create_source secret test-new default true true "e2e-new-ns" "test-data"
# Perform the action you want to test
update_source_annotations secret test-new default true "e2e-new-ns,e2e-new-ns-2"
# Verify expected results
verify_mirrors_exist secret test-new e2e-new-ns e2e-new-ns-2
complete_test_scenario "23" "pass"
```
### Framework Functions Reference
**Resource Creation:**
```bash
create_source secret my-secret default true true "ns1,ns2" "data"
# ↑ ↑ ↑ ↑ ↑ ↑ ↑
# type name ns lbl ann targets data
```
**Resource Updates:**
```bash
update_source_labels secret my-secret default true # Set enabled=true
update_source_labels secret my-secret default false # Set enabled=false
update_source_labels secret my-secret default "" # Remove label
update_source_annotations secret my-secret default true "ns1,ns2" # Enable sync
update_source_annotations secret my-secret default false "" # Set sync=false
update_source_annotations secret my-secret default "" "" # Remove annotation
update_source_data secret my-secret default "new-data-v2"
```
**Namespace Operations:**
```bash
create_test_namespace my-ns true # Create with allow-mirrors=true
create_test_namespace my-ns false # Create with allow-mirrors=false
create_test_namespace my-ns "" # Create with no label
update_namespace_labels my-ns true # Set allow-mirrors=true
update_namespace_labels my-ns false # Set allow-mirrors=false
update_namespace_labels my-ns "" # Remove label
```
**Verification:**
```bash
verify_mirrors_exist secret my-secret ns1 ns2 ns3
verify_mirrors_not_exist secret my-secret ns4 ns5
verify_mirror_data secret my-secret default target-ns "expected-data"
verify_orphan_cleanup secret my-secret orphan-ns1 orphan-ns2
```
## Test Coverage Summary
| Category | Scenarios | Details |
|----------|-----------|---------|
| Source lifecycle | 6 | No labels → add label → add annotation → modify → disable |
| Target management | 4 | Add/remove namespaces, change list to pattern, multiple patterns |
| Pattern matching | 3 | New namespace creation, pattern changes, mixed explicit+pattern |
| 'all' keyword opt-in | 4 | No label, add label, remove label, change true→false |
| Edge cases | 5 | Namespace deletion, recreation, source deletion, target recreation |
| Resource types | 2 | Mixed ConfigMaps, Custom Resource (Traefik Middleware) |
| Transformations | 7 | Static value, template, merge, delete, multiple, strict mode |
| **Total** | **30** | **Comprehensive coverage with multiple resource types** |
## Test Methodology
### Systematic Approach
The test framework follows a systematic approach:
1. **State Setup**: Create namespaces and resources in known state
2. **Action**: Perform the operation being tested (create, update, delete, label change)
3. **Verification**: Assert expected outcomes using verification functions
4. **Cleanup**: Automatic cleanup via trap handlers
### DRY Principles
- **Reusable functions**: All operations abstracted into framework functions
- **Data-driven**: Test scenarios are data, not code
- **Composable**: Combine framework functions to create complex scenarios
- **Maintainable**: Add new scenarios without duplicating code
### Coverage Strategy
Tests systematically cover:
- **Happy path**: Expected behavior under normal conditions
- **Edge cases**: Boundary conditions and unusual states
- **Error conditions**: Invalid inputs, missing resources, conflicts
- **State transitions**: All possible state changes (no labels → labels → annotations, etc.)
- **Concurrent operations**: Namespace creation during reconciliation, multiple updates
## Test Utilities Reference
### Common Utilities (`common.sh`)
**Logging:**
- `log_info <message>`: Blue informational message
- `log_success <message>`: Green success message (increments pass count)
- `log_fail <message>`: Red failure message (increments fail count)
- `log_warn <message>`: Yellow warning message
**Assertions:**
- `assert_resource_exists <type> <name> <namespace>`
- `assert_resource_not_exists <type> <name> <namespace>`
- `assert_annotation_exists <type> <name> <namespace> <annotation_key>`
- `assert_label_exists <type> <name> <namespace> <label_key> <expected_value>`
- `assert_data_matches <type> <source_name> <source_ns> <target_name> <target_ns> <data_key>`
**Waiting:**
- `wait_for_resource <type> <name> <namespace> [timeout]`
- `wait_for_resource_deletion <type> <name> <namespace> [timeout]`
**Utilities:**
- `cleanup_namespace <namespace>`
- `cleanup_resource <type> <name> <namespace>`
- `check_context`: Verify running on docker-desktop
- `print_summary`: Print test results summary
## CI/CD Integration
To run tests in CI:
```bash
#!/bin/bash
set -e
# Start kind cluster or use existing k8s
kind create cluster --name kubemirror-test
# Switch context
kubectl config use-context kind-kubemirror-test
# Run tests
cd e2e
./run-all-tests.sh
# Cleanup
kind delete cluster --name kubemirror-test
```
## Performance Notes
### Test Execution Times
- **Sequential execution** (test-comprehensive.sh): ~5-7 minutes for all 30 scenarios
- **Parallel execution** (test-parallel.sh): ~3-4 minutes for all 30 scenarios (40-50% faster)
- **Selective execution** (few scenarios): <1 minute
- **Controller startup**: ~10 seconds
- **Resource reconciliation**: typically <5 seconds per operation
### Test Coverage
- **Total scenarios**: 30 comprehensive scenarios
- **Total assertions**: 100+ across all scenarios
- **Resource types tested**: Secrets, ConfigMaps, Traefik Middlewares (CRDs)
- **Each scenario includes**: Setup, action, verification, and cleanup phases
### Optimization Tips
- Use `test-parallel.sh` for full test runs (40-50% faster)
- Use selective execution during development: `./test-comprehensive.sh 24 25 26`
- Run only affected scenarios after code changes
- Parallel execution is safe - batches ensure test independence
## Test Isolation and Cleanup
- **Automatic cleanup**: All resources cleaned up via trap handlers
- **Namespace isolation**:
- Dedicated source namespace: `kubemirror-e2e-source`
- Target namespaces: `kubemirror-e2e-*` prefixed
- No pollution of `default` namespace
- **Execution modes**:
- Sequential: All scenarios run in order (test-comprehensive.sh with no args)
- Parallel: Independent scenarios batched (test-parallel.sh)
- Selective: Run specific scenarios (test-comprehensive.sh 24 25 26)
- **Idempotent**: Tests can be re-run without manual cleanup
- **Resource labeling**: Test resources labeled `test-resource: e2e` for easy identification
- **Finalizer handling**: Automatic finalizer removal prevents stuck resource deletions
## Known Limitations
- Tests assume clean docker-desktop cluster (or equivalent local cluster)
- Some scenarios require waiting for reconciliation (30s default timeout)
- Controller must be stopped between runs if running manually (run-all-tests.sh handles this)
- Parallel execution requires sufficient cluster resources (5-6 tests may run concurrently)
- Some scenarios depend on previous state (scenarios 1-11 must run sequentially)
Executable
+242
View File
@@ -0,0 +1,242 @@
#!/bin/bash
# Common utilities for E2E tests
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color
# Test counters
TESTS_RUN=0
TESTS_PASSED=0
TESTS_FAILED=0
# Logging functions
log_info() {
echo -e "${BLUE}[INFO]${NC} $1"
}
log_success() {
echo -e "${GREEN}[PASS]${NC} $1"
((TESTS_PASSED++))
}
log_fail() {
echo -e "${RED}[FAIL]${NC} $1"
((TESTS_FAILED++))
}
log_warn() {
echo -e "${YELLOW}[WARN]${NC} $1"
}
# Test assertion functions
assert_resource_exists() {
local resource_type=$1
local resource_name=$2
local namespace=$3
((TESTS_RUN++))
if kubectl get "$resource_type" "$resource_name" -n "$namespace" &>/dev/null; then
log_success "Resource $resource_type/$resource_name exists in namespace $namespace"
return 0
else
log_fail "Resource $resource_type/$resource_name does NOT exist in namespace $namespace"
return 1
fi
}
assert_resource_not_exists() {
local resource_type=$1
local resource_name=$2
local namespace=$3
((TESTS_RUN++))
if kubectl get "$resource_type" "$resource_name" -n "$namespace" &>/dev/null; then
log_fail "Resource $resource_type/$resource_name EXISTS in namespace $namespace (should not exist)"
return 1
else
log_success "Resource $resource_type/$resource_name does not exist in namespace $namespace"
return 0
fi
}
assert_annotation_exists() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local annotation_key=$4
((TESTS_RUN++))
# Escape dots in annotation key for jsonpath (dots need to be escaped, but not slashes)
local escaped_key="${annotation_key//./\\.}"
local annotation_value
annotation_value=$(kubectl get "$resource_type" "$resource_name" -n "$namespace" -o jsonpath="{.metadata.annotations.$escaped_key}" 2>/dev/null || echo "")
if [ -n "$annotation_value" ]; then
log_success "Annotation $annotation_key exists on $resource_type/$resource_name in namespace $namespace (value: $annotation_value)"
return 0
else
log_fail "Annotation $annotation_key does NOT exist on $resource_type/$resource_name in namespace $namespace"
return 1
fi
}
assert_label_exists() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local label_key=$4
local expected_value=$5
((TESTS_RUN++))
# Escape dots in label key for jsonpath (dots need to be escaped, but not slashes)
local escaped_key="${label_key//./\\.}"
local actual_value
actual_value=$(kubectl get "$resource_type" "$resource_name" -n "$namespace" -o jsonpath="{.metadata.labels.$escaped_key}" 2>/dev/null || echo "")
if [ "$actual_value" = "$expected_value" ]; then
log_success "Label $label_key=$expected_value on $resource_type/$resource_name in namespace $namespace"
return 0
else
log_fail "Label $label_key has value '$actual_value', expected '$expected_value' on $resource_type/$resource_name in namespace $namespace"
return 1
fi
}
assert_data_matches() {
local resource_type=$1
local source_name=$2
local source_ns=$3
local target_name=$4
local target_ns=$5
local data_key=$6
((TESTS_RUN++))
local source_value target_value
if [ "$resource_type" = "secret" ]; then
source_value=$(kubectl get secret "$source_name" -n "$source_ns" -o jsonpath="{.data['$data_key']}" 2>/dev/null || echo "")
target_value=$(kubectl get secret "$target_name" -n "$target_ns" -o jsonpath="{.data['$data_key']}" 2>/dev/null || echo "")
else
source_value=$(kubectl get "$resource_type" "$source_name" -n "$source_ns" -o jsonpath="{.data['$data_key']}" 2>/dev/null || echo "")
target_value=$(kubectl get "$resource_type" "$target_name" -n "$target_ns" -o jsonpath="{.data['$data_key']}" 2>/dev/null || echo "")
fi
if [ "$source_value" = "$target_value" ] && [ -n "$source_value" ]; then
log_success "Data key '$data_key' matches between source and target"
return 0
else
log_fail "Data key '$data_key' does NOT match (source: ${source_value:0:20}..., target: ${target_value:0:20}...)"
return 1
fi
}
# Wait for resource to appear
wait_for_resource() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local timeout=${4:-30}
log_info "Waiting for $resource_type/$resource_name in namespace $namespace (timeout: ${timeout}s)"
local elapsed=0
while [ $elapsed -lt $timeout ]; do
if kubectl get "$resource_type" "$resource_name" -n "$namespace" &>/dev/null; then
log_info "Resource appeared after ${elapsed}s"
return 0
fi
sleep 1
((elapsed++))
done
log_warn "Timeout waiting for $resource_type/$resource_name in namespace $namespace"
return 1
}
# Wait for resource to disappear
wait_for_resource_deletion() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local timeout=${4:-30}
log_info "Waiting for $resource_type/$resource_name to be deleted from namespace $namespace (timeout: ${timeout}s)"
local elapsed=0
while [ $elapsed -lt $timeout ]; do
if ! kubectl get "$resource_type" "$resource_name" -n "$namespace" &>/dev/null; then
log_info "Resource deleted after ${elapsed}s"
return 0
fi
sleep 1
((elapsed++))
done
log_warn "Timeout waiting for $resource_type/$resource_name deletion in namespace $namespace"
return 1
}
# Check context is docker-desktop
check_context() {
local current_context
current_context=$(kubectl config current-context)
if [ "$current_context" != "docker-desktop" ]; then
log_fail "Current context is '$current_context', expected 'docker-desktop'"
log_info "Please switch context: kubectl config use-context docker-desktop"
exit 1
fi
log_success "Running on docker-desktop context"
}
# Print test summary
print_summary() {
echo ""
echo "======================================"
echo "Test Summary"
echo "======================================"
echo -e "Total Tests: ${BLUE}$TESTS_RUN${NC}"
echo -e "Passed: ${GREEN}$TESTS_PASSED${NC}"
echo -e "Failed: ${RED}$TESTS_FAILED${NC}"
echo "======================================"
if [ $TESTS_FAILED -eq 0 ]; then
echo -e "${GREEN}All tests passed!${NC}"
return 0
else
echo -e "${RED}Some tests failed!${NC}"
return 1
fi
}
# Cleanup function
cleanup_namespace() {
local namespace=$1
if kubectl get namespace "$namespace" &>/dev/null; then
log_info "Cleaning up namespace $namespace"
kubectl delete namespace "$namespace" --ignore-not-found=true --wait=false &>/dev/null || true
fi
}
cleanup_resource() {
local resource_type=$1
local resource_name=$2
local namespace=$3
if kubectl get "$resource_type" "$resource_name" -n "$namespace" &>/dev/null; then
log_info "Cleaning up $resource_type/$resource_name in namespace $namespace"
kubectl delete "$resource_type" "$resource_name" -n "$namespace" --ignore-not-found=true &>/dev/null || true
fi
}
+200
View File
@@ -0,0 +1,200 @@
#!/bin/bash
# E2E Test: Basic Mirroring Functionality
# Tests existing mirror functionality with explicit lists, patterns, and 'all' keyword
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
TEST_NAME="Basic Mirroring"
log_info "Starting $TEST_NAME tests"
# Cleanup function for this test
cleanup() {
log_info "Cleaning up test resources"
cleanup_resource secret test-explicit-list-secret default
cleanup_resource configmap test-explicit-list-cm default
cleanup_resource secret test-pattern-secret default
cleanup_resource secret test-all-keyword-secret default
cleanup_namespace e2e-target-1
cleanup_namespace e2e-target-2
cleanup_namespace e2e-target-3
cleanup_namespace e2e-app-1
cleanup_namespace e2e-app-2
cleanup_namespace e2e-app-3
cleanup_namespace e2e-labeled-ns
sleep 5
}
# Trap cleanup on exit
trap cleanup EXIT
# Clean up any existing resources
cleanup
# Wait for cleanup to complete
sleep 3
log_info "Creating test namespaces"
kubectl create namespace e2e-target-1
kubectl create namespace e2e-target-2
kubectl create namespace e2e-target-3
kubectl create namespace e2e-app-1
kubectl create namespace e2e-app-2
kubectl create namespace e2e-app-3
# Test 1: Explicit namespace list
log_info "Test 1: Mirror Secret to explicit namespace list"
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-explicit-list-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "e2e-target-1,e2e-target-2"
type: Opaque
stringData:
username: admin
password: secret123
EOF
wait_for_resource secret test-explicit-list-secret e2e-target-1
wait_for_resource secret test-explicit-list-secret e2e-target-2
assert_resource_exists secret test-explicit-list-secret e2e-target-1
assert_resource_exists secret test-explicit-list-secret e2e-target-2
assert_resource_not_exists secret test-explicit-list-secret e2e-target-3
assert_label_exists secret test-explicit-list-secret e2e-target-1 "kubemirror.raczylo.com/managed-by" "kubemirror"
assert_label_exists secret test-explicit-list-secret e2e-target-1 "kubemirror.raczylo.com/mirror" "true"
assert_annotation_exists secret test-explicit-list-secret e2e-target-1 "kubemirror.raczylo.com/source-namespace"
assert_annotation_exists secret test-explicit-list-secret e2e-target-1 "kubemirror.raczylo.com/source-name"
assert_data_matches secret test-explicit-list-secret default test-explicit-list-secret e2e-target-1 username
assert_data_matches secret test-explicit-list-secret default test-explicit-list-secret e2e-target-1 password
# Test 2: ConfigMap with explicit list
log_info "Test 2: Mirror ConfigMap to explicit namespace list"
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
name: test-explicit-list-cm
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "e2e-target-1,e2e-target-2,e2e-target-3"
data:
config.yaml: |
app: myapp
version: 1.0
EOF
wait_for_resource configmap test-explicit-list-cm e2e-target-1
wait_for_resource configmap test-explicit-list-cm e2e-target-2
wait_for_resource configmap test-explicit-list-cm e2e-target-3
assert_resource_exists configmap test-explicit-list-cm e2e-target-1
assert_resource_exists configmap test-explicit-list-cm e2e-target-2
assert_resource_exists configmap test-explicit-list-cm e2e-target-3
assert_data_matches configmap test-explicit-list-cm default test-explicit-list-cm e2e-target-1 config.yaml
# Test 3: Pattern matching
log_info "Test 3: Mirror Secret with pattern matching (e2e-app-*)"
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-pattern-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "e2e-app-*"
type: Opaque
stringData:
api-key: abc123xyz
EOF
wait_for_resource secret test-pattern-secret e2e-app-1
wait_for_resource secret test-pattern-secret e2e-app-2
wait_for_resource secret test-pattern-secret e2e-app-3
assert_resource_exists secret test-pattern-secret e2e-app-1
assert_resource_exists secret test-pattern-secret e2e-app-2
assert_resource_exists secret test-pattern-secret e2e-app-3
assert_resource_not_exists secret test-pattern-secret e2e-target-1
assert_data_matches secret test-pattern-secret default test-pattern-secret e2e-app-1 api-key
# Test 4: 'all' keyword with labeled namespace
log_info "Test 4: Mirror Secret with 'all' keyword (requires namespace label)"
kubectl create namespace e2e-labeled-ns
kubectl label namespace e2e-labeled-ns kubemirror.raczylo.com/allow-mirrors=true
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-all-keyword-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all"
type: Opaque
stringData:
shared-token: token123
EOF
wait_for_resource secret test-all-keyword-secret e2e-labeled-ns
assert_resource_exists secret test-all-keyword-secret e2e-labeled-ns
# Test 5: Source update propagates to targets
log_info "Test 5: Update source and verify targets updated"
kubectl patch secret test-explicit-list-secret -n default --type merge -p '{"stringData":{"password":"newsecret456"}}'
sleep 5
target_password=$(kubectl get secret test-explicit-list-secret -n e2e-target-1 -o jsonpath='{.data.password}' | base64 -d)
if [ "$target_password" = "newsecret456" ]; then
log_success "Target secret updated with new password"
((TESTS_RUN++))
((TESTS_PASSED++))
else
log_fail "Target secret NOT updated (password: $target_password)"
((TESTS_RUN++))
((TESTS_FAILED++))
fi
# Test 6: Source deletion cascades to targets
log_info "Test 6: Delete source and verify targets deleted"
kubectl delete secret test-explicit-list-secret -n default
wait_for_resource_deletion secret test-explicit-list-secret e2e-target-1
wait_for_resource_deletion secret test-explicit-list-secret e2e-target-2
assert_resource_not_exists secret test-explicit-list-secret e2e-target-1
assert_resource_not_exists secret test-explicit-list-secret e2e-target-2
# Test 7: Target deletion triggers recreation
log_info "Test 7: Delete target and verify it's recreated"
kubectl delete configmap test-explicit-list-cm -n e2e-target-2
wait_for_resource configmap test-explicit-list-cm e2e-target-2 15
assert_resource_exists configmap test-explicit-list-cm e2e-target-2
print_summary
+236
View File
@@ -0,0 +1,236 @@
#!/bin/bash
# E2E Test: Namespace Reconciliation
# Tests new namespace reconciliation features including CREATE/UPDATE events and orphaned mirror cleanup
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
TEST_NAME="Namespace Reconciliation"
log_info "Starting $TEST_NAME tests"
# Cleanup function for this test
cleanup() {
log_info "Cleaning up test resources"
cleanup_resource secret test-ns-recon-pattern-secret default
cleanup_resource secret test-ns-recon-all-secret default
cleanup_resource secret test-orphan-cleanup-secret default
cleanup_resource configmap test-label-change-cm default
cleanup_namespace e2e-recon-app-1
cleanup_namespace e2e-recon-app-2
cleanup_namespace e2e-recon-app-3
cleanup_namespace e2e-recon-new
cleanup_namespace e2e-label-test
cleanup_namespace e2e-no-label
cleanup_namespace e2e-orphan-1
cleanup_namespace e2e-orphan-2
cleanup_namespace e2e-orphan-3
sleep 5
}
# Trap cleanup on exit
trap cleanup EXIT
# Clean up any existing resources
cleanup
# Wait for cleanup to complete
sleep 3
# Test 1: Create source with pattern, then create matching namespace
log_info "Test 1: Create namespace matching existing pattern"
# Create initial namespaces
kubectl create namespace e2e-recon-app-1
kubectl create namespace e2e-recon-app-2
# Create secret with pattern
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-ns-recon-pattern-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "e2e-recon-app-*"
type: Opaque
stringData:
token: pattern-token-123
EOF
wait_for_resource secret test-ns-recon-pattern-secret e2e-recon-app-1
wait_for_resource secret test-ns-recon-pattern-secret e2e-recon-app-2
assert_resource_exists secret test-ns-recon-pattern-secret e2e-recon-app-1
assert_resource_exists secret test-ns-recon-pattern-secret e2e-recon-app-2
# Now create a new namespace that matches the pattern
log_info "Creating new namespace e2e-recon-app-3 (matches pattern)"
kubectl create namespace e2e-recon-app-3
# Namespace reconciler should automatically create mirror in new namespace
wait_for_resource secret test-ns-recon-pattern-secret e2e-recon-app-3 30
assert_resource_exists secret test-ns-recon-pattern-secret e2e-recon-app-3
assert_data_matches secret test-ns-recon-pattern-secret default test-ns-recon-pattern-secret e2e-recon-app-3 token
# Test 2: Create source with 'all', then create namespace without label
log_info "Test 2: Create namespace without allow-mirrors label (source has 'all')"
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-ns-recon-all-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all"
type: Opaque
stringData:
shared-key: all-secret-456
EOF
# Create namespace without label
log_info "Creating namespace e2e-no-label (no allow-mirrors label)"
kubectl create namespace e2e-no-label
sleep 5
# Mirror should NOT be created (namespace not opted-in)
assert_resource_not_exists secret test-ns-recon-all-secret e2e-no-label
# Test 3: Add allow-mirrors label to namespace (should trigger mirror creation)
log_info "Test 3: Add allow-mirrors label to namespace (should create mirror)"
kubectl label namespace e2e-no-label kubemirror.raczylo.com/allow-mirrors=true
# Namespace reconciler should detect label change and create mirror
wait_for_resource secret test-ns-recon-all-secret e2e-no-label 30
assert_resource_exists secret test-ns-recon-all-secret e2e-no-label
assert_data_matches secret test-ns-recon-all-secret default test-ns-recon-all-secret e2e-no-label shared-key
# Test 4: Remove allow-mirrors label from namespace (should trigger cleanup)
log_info "Test 4: Remove allow-mirrors label from namespace (should delete mirror)"
kubectl label namespace e2e-no-label kubemirror.raczylo.com/allow-mirrors-
# Namespace reconciler should detect label removal and cleanup mirror
wait_for_resource_deletion secret test-ns-recon-all-secret e2e-no-label 30
assert_resource_not_exists secret test-ns-recon-all-secret e2e-no-label
# Test 5: Change allow-mirrors label from true to false (should trigger cleanup)
log_info "Test 5: Change allow-mirrors label from true to false"
kubectl create namespace e2e-label-test
kubectl label namespace e2e-label-test kubemirror.raczylo.com/allow-mirrors=true
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
name: test-label-change-cm
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all"
data:
config: "test-data"
EOF
wait_for_resource configmap test-label-change-cm e2e-label-test
assert_resource_exists configmap test-label-change-cm e2e-label-test
# Now change label to false
log_info "Changing label to false"
kubectl label namespace e2e-label-test kubemirror.raczylo.com/allow-mirrors=false --overwrite
# Should trigger cleanup
wait_for_resource_deletion configmap test-label-change-cm e2e-label-test 30
assert_resource_not_exists configmap test-label-change-cm e2e-label-test
# Test 6: Orphaned mirror cleanup when source target pattern changes
log_info "Test 6: Orphaned mirror cleanup (pattern changed to explicit list)"
# Create namespaces
kubectl create namespace e2e-orphan-1
kubectl create namespace e2e-orphan-2
kubectl create namespace e2e-orphan-3
# Create secret with pattern matching all orphan namespaces
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: test-orphan-cleanup-secret
namespace: default
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "e2e-orphan-*"
type: Opaque
stringData:
data: "orphan-test"
EOF
wait_for_resource secret test-orphan-cleanup-secret e2e-orphan-1
wait_for_resource secret test-orphan-cleanup-secret e2e-orphan-2
wait_for_resource secret test-orphan-cleanup-secret e2e-orphan-3
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-1
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-2
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-3
# Now change pattern to explicit list (only orphan-1 and orphan-2)
log_info "Changing target-namespaces from pattern to explicit list"
kubectl annotate secret test-orphan-cleanup-secret -n default \
kubemirror.raczylo.com/target-namespaces="e2e-orphan-1,e2e-orphan-2" --overwrite
# Orphan cleanup should remove mirror from e2e-orphan-3
wait_for_resource_deletion secret test-orphan-cleanup-secret e2e-orphan-3 30
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-1
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-2
assert_resource_not_exists secret test-orphan-cleanup-secret e2e-orphan-3
# Test 7: Change from explicit list to different explicit list
log_info "Test 7: Change explicit list (add e2e-orphan-3, remove e2e-orphan-1)"
kubectl annotate secret test-orphan-cleanup-secret -n default \
kubemirror.raczylo.com/target-namespaces="e2e-orphan-2,e2e-orphan-3" --overwrite
# Should remove from orphan-1 and create in orphan-3
wait_for_resource secret test-orphan-cleanup-secret e2e-orphan-3 30
wait_for_resource_deletion secret test-orphan-cleanup-secret e2e-orphan-1 30
assert_resource_not_exists secret test-orphan-cleanup-secret e2e-orphan-1
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-2
assert_resource_exists secret test-orphan-cleanup-secret e2e-orphan-3
# Test 8: Create namespace with label already set (for 'all' source)
log_info "Test 8: Create namespace with allow-mirrors label already set"
kubectl create namespace e2e-recon-new
kubectl label namespace e2e-recon-new kubemirror.raczylo.com/allow-mirrors=true
# Should automatically get mirrors from sources with 'all'
wait_for_resource secret test-ns-recon-all-secret e2e-recon-new 30
wait_for_resource configmap test-label-change-cm e2e-recon-new 30
assert_resource_exists secret test-ns-recon-all-secret e2e-recon-new
assert_resource_exists configmap test-label-change-cm e2e-recon-new
print_summary
+175
View File
@@ -0,0 +1,175 @@
#!/bin/bash
# E2E Test Runner - Runs all KubeMirror E2E tests
# Builds the binary, starts the controller, runs tests, and cleans up
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
source "$SCRIPT_DIR/common.sh"
KUBEMIRROR_PID=""
KUBEMIRROR_LOG="/tmp/kubemirror-e2e-test.log"
KUBEMIRROR_BINARY="$PROJECT_ROOT/kubemirror"
# Cleanup function
cleanup() {
log_info "Cleaning up..."
if [ -n "$KUBEMIRROR_PID" ] && kill -0 "$KUBEMIRROR_PID" 2>/dev/null; then
log_info "Stopping KubeMirror controller (PID: $KUBEMIRROR_PID)"
kill "$KUBEMIRROR_PID" 2>/dev/null || true
wait "$KUBEMIRROR_PID" 2>/dev/null || true
fi
# Clean up any test namespaces that might be left
log_info "Cleaning up test namespaces"
kubectl delete namespace -l kubemirror-e2e-test=true --wait=false 2>/dev/null || true
# Give time for cleanup
sleep 2
}
trap cleanup EXIT
# Main execution
main() {
echo "======================================"
echo "KubeMirror E2E Test Suite"
echo "======================================"
echo ""
# Step 1: Check context
log_info "Step 1: Checking Kubernetes context"
check_context
# Step 2: Build KubeMirror
log_info "Step 2: Building KubeMirror binary"
cd "$PROJECT_ROOT" || exit 1
if ! go build -o kubemirror ./cmd/kubemirror; then
log_fail "Failed to build KubeMirror"
exit 1
fi
log_success "KubeMirror binary built successfully"
# Step 3: Install Traefik CRDs (needed for scenario 23)
log_info "Step 3: Installing Traefik CRDs"
kubectl apply -f https://raw.githubusercontent.com/traefik/traefik/master/docs/content/reference/dynamic-configuration/kubernetes-crd-definition-v1.yml
log_success "Traefik CRDs installed"
# Step 4: Start KubeMirror controller
log_info "Step 4: Starting KubeMirror controller"
rm -f "$KUBEMIRROR_LOG"
"$KUBEMIRROR_BINARY" \
--metrics-bind-address=:8080 \
--health-probe-bind-address=:8081 \
--max-targets=100 \
--worker-threads=5 \
--verify-source-freshness=true \
--lazy-watcher-init=true \
--watcher-scan-interval=500ms \
>"$KUBEMIRROR_LOG" 2>&1 &
KUBEMIRROR_PID=$!
log_info "KubeMirror started with PID: $KUBEMIRROR_PID"
log_info "Log file: $KUBEMIRROR_LOG"
# Wait for controller to be ready
log_info "Waiting for controller to be ready..."
sleep 10
if ! kill -0 "$KUBEMIRROR_PID" 2>/dev/null; then
log_fail "KubeMirror controller failed to start"
log_info "Last 20 lines of log:"
tail -20 "$KUBEMIRROR_LOG"
exit 1
fi
# Check health endpoint
local retries=0
while [ $retries -lt 10 ]; do
if curl -s http://localhost:8081/healthz >/dev/null 2>&1; then
log_success "Controller is healthy"
break
fi
sleep 2
((retries++))
done
if [ $retries -eq 10 ]; then
log_warn "Controller health check timeout (non-fatal)"
fi
# Give controller time to set up watches
sleep 5
# Step 5: Run test suites
log_info "Step 5: Running test suites"
echo ""
local test_results=0
# Comprehensive Test Suite
echo "======================================"
echo "Running Comprehensive E2E Test Suite"
echo "======================================"
echo "This will test all scenarios systematically:"
echo " - Source lifecycle (no labels → labels → annotations)"
echo " - Target namespace changes (add/remove from list)"
echo " - Pattern matching and changes"
echo " - 'all' keyword with namespace opt-in/opt-out"
echo " - Content updates and propagation"
echo " - Orphaned mirror cleanup"
echo " - Namespace creation/deletion/label changes"
echo ""
if bash "$SCRIPT_DIR/test-comprehensive.sh"; then
log_success "Comprehensive Test Suite PASSED"
else
log_fail "Comprehensive Test Suite FAILED"
test_results=1
fi
echo ""
# # Lazy Watcher Initialization Test
# echo "======================================"
# echo "Running Lazy Watcher Initialization Test"
# echo "======================================"
# echo "This will test:"
# echo " - Initial state with minimal controllers registered"
# echo " - Dynamic controller registration on resource creation"
# echo " - Memory efficiency of lazy initialization"
# echo ""
# if bash "$SCRIPT_DIR/test-lazy-watcher-init.sh"; then
# log_success "Lazy Watcher Test PASSED"
# else
# log_fail "Lazy Watcher Test FAILED"
# test_results=1
# fi
# echo ""
# Step 6: Final summary
echo "======================================"
echo "E2E Test Run Complete"
echo "======================================"
if [ $test_results -eq 0 ]; then
echo -e "${GREEN}All test suites passed!${NC}"
log_info "Controller log available at: $KUBEMIRROR_LOG"
return 0
else
echo -e "${RED}Some test suites failed!${NC}"
log_info "Controller log available at: $KUBEMIRROR_LOG"
log_info "Last 10 lines of controller log:"
tail -10 "$KUBEMIRROR_LOG"
return 1
fi
}
main "$@"
+1324
View File
File diff suppressed because it is too large Load Diff
+305
View File
@@ -0,0 +1,305 @@
#!/bin/bash
# KubeMirror E2E Test Framework
# Provides reusable test functions for comprehensive scenario testing
source "$(dirname "${BASH_SOURCE[0]}")/common.sh"
# Test scenario execution framework
# Create a source resource (Secret or ConfigMap)
create_source() {
local resource_type=$1
local resource_name=$2
local namespace=${3:-"default"}
local has_enabled_label=${4:-"false"}
local has_sync_annotation=${5:-"false"}
local target_namespaces=${6:-""}
local data_content=${7:-"test-data-123"}
log_info "Creating $resource_type/$resource_name in namespace $namespace"
log_info " enabled_label=$has_enabled_label, sync_annotation=$has_sync_annotation"
log_info " target_namespaces='$target_namespaces'"
local labels=""
if [ "$has_enabled_label" = "true" ]; then
labels='kubemirror.raczylo.com/enabled: "true"'
fi
local annotations=""
if [ "$has_sync_annotation" = "true" ]; then
annotations='kubemirror.raczylo.com/sync: "true"'
if [ -n "$target_namespaces" ]; then
annotations="$annotations
kubemirror.raczylo.com/target-namespaces: \"$target_namespaces\""
fi
fi
if [ "$resource_type" = "secret" ]; then
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: $resource_name
namespace: $namespace
${labels:+labels:}
${labels:+ $labels}
${annotations:+annotations:}
${annotations:+ $annotations}
type: Opaque
stringData:
testkey: "$data_content"
EOF
else # configmap
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
name: $resource_name
namespace: $namespace
${labels:+labels:}
${labels:+ $labels}
${annotations:+annotations:}
${annotations:+ $annotations}
data:
testkey: "$data_content"
EOF
fi
sleep 2
}
# Update source labels
update_source_labels() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local enabled_label=$4
log_info "Updating $resource_type/$resource_name labels: enabled=$enabled_label"
if [ "$enabled_label" = "true" ]; then
kubectl label "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/enabled=true --overwrite
elif [ "$enabled_label" = "false" ]; then
kubectl label "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/enabled=false --overwrite
else
kubectl label "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/enabled- 2>/dev/null || true
fi
sleep 2
}
# Update source annotations
update_source_annotations() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local sync_annotation=$4
local target_namespaces=$5
log_info "Updating $resource_type/$resource_name annotations: sync=$sync_annotation"
log_info " target_namespaces='$target_namespaces'"
if [ "$sync_annotation" = "true" ]; then
kubectl annotate "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/sync=true --overwrite
if [ -n "$target_namespaces" ]; then
kubectl annotate "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/target-namespaces="$target_namespaces" --overwrite
fi
elif [ "$sync_annotation" = "false" ]; then
kubectl annotate "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/sync=false --overwrite
else
kubectl annotate "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/sync- 2>/dev/null || true
kubectl annotate "$resource_type" "$resource_name" -n "$namespace" \
kubemirror.raczylo.com/target-namespaces- 2>/dev/null || true
fi
sleep 2
}
# Update source data content
update_source_data() {
local resource_type=$1
local resource_name=$2
local namespace=$3
local new_data=$4
log_info "Updating $resource_type/$resource_name data content"
if [ "$resource_type" = "secret" ]; then
kubectl patch secret "$resource_name" -n "$namespace" --type merge \
-p "{\"stringData\":{\"testkey\":\"$new_data\"}}"
else
kubectl patch configmap "$resource_name" -n "$namespace" --type merge \
-p "{\"data\":{\"testkey\":\"$new_data\"}}"
fi
sleep 3
}
# Create namespace with optional label
create_test_namespace() {
local namespace=$1
local allow_mirrors_label=${2:-""}
log_info "Creating namespace $namespace (allow_mirrors=$allow_mirrors_label)"
kubectl create namespace "$namespace" 2>/dev/null || true
if [ "$allow_mirrors_label" = "true" ]; then
kubectl label namespace "$namespace" kubemirror.raczylo.com/allow-mirrors=true --overwrite
elif [ "$allow_mirrors_label" = "false" ]; then
kubectl label namespace "$namespace" kubemirror.raczylo.com/allow-mirrors=false --overwrite
fi
sleep 1
}
# Update namespace labels
update_namespace_labels() {
local namespace=$1
local allow_mirrors_label=$2
log_info "Updating namespace $namespace labels: allow_mirrors=$allow_mirrors_label"
if [ "$allow_mirrors_label" = "true" ]; then
kubectl label namespace "$namespace" kubemirror.raczylo.com/allow-mirrors=true --overwrite
elif [ "$allow_mirrors_label" = "false" ]; then
kubectl label namespace "$namespace" kubemirror.raczylo.com/allow-mirrors=false --overwrite
else
kubectl label namespace "$namespace" kubemirror.raczylo.com/allow-mirrors- 2>/dev/null || true
fi
sleep 2
}
# Verify mirror exists in expected namespaces
verify_mirrors_exist() {
local resource_type=$1
local resource_name=$2
shift 2
local namespaces=("$@")
log_info "Verifying mirrors exist in ${#namespaces[@]} namespaces"
local all_ok=true
for ns in "${namespaces[@]}"; do
if wait_for_resource "$resource_type" "$resource_name" "$ns" 30; then
assert_resource_exists "$resource_type" "$resource_name" "$ns" || all_ok=false
assert_label_exists "$resource_type" "$resource_name" "$ns" "kubemirror.raczylo.com/managed-by" "kubemirror" || all_ok=false
else
log_fail "Mirror not created in $ns within timeout"
((TESTS_RUN++))
((TESTS_FAILED++))
all_ok=false
fi
done
$all_ok
}
# Verify mirror does NOT exist in specified namespaces
verify_mirrors_not_exist() {
local resource_type=$1
local resource_name=$2
shift 2
local namespaces=("$@")
log_info "Verifying mirrors DO NOT exist in ${#namespaces[@]} namespaces"
local all_ok=true
for ns in "${namespaces[@]}"; do
assert_resource_not_exists "$resource_type" "$resource_name" "$ns" || all_ok=false
done
$all_ok
}
# Verify mirror data matches source
verify_mirror_data() {
local resource_type=$1
local source_name=$2
local source_ns=$3
local target_ns=$4
local expected_data=$5
local actual_data
if [ "$resource_type" = "secret" ]; then
actual_data=$(kubectl get secret "$source_name" -n "$target_ns" -o jsonpath='{.data.testkey}' 2>/dev/null | base64 -d || echo "")
else
actual_data=$(kubectl get configmap "$source_name" -n "$target_ns" -o jsonpath='{.data.testkey}' 2>/dev/null || echo "")
fi
((TESTS_RUN++))
if [ "$actual_data" = "$expected_data" ]; then
log_success "Mirror data in $target_ns matches expected: $expected_data"
((TESTS_PASSED++))
return 0
else
log_fail "Mirror data in $target_ns does NOT match (expected: $expected_data, actual: $actual_data)"
((TESTS_FAILED++))
return 1
fi
}
# Verify orphaned mirrors are cleaned up
verify_orphan_cleanup() {
local resource_type=$1
local resource_name=$2
shift 2
local orphaned_namespaces=("$@")
log_info "Verifying orphaned mirrors cleaned up in ${#orphaned_namespaces[@]} namespaces"
local all_ok=true
for ns in "${orphaned_namespaces[@]}"; do
if wait_for_resource_deletion "$resource_type" "$resource_name" "$ns" 30; then
assert_resource_not_exists "$resource_type" "$resource_name" "$ns" || all_ok=false
else
log_fail "Orphaned mirror in $ns not deleted within timeout"
((TESTS_RUN++))
((TESTS_FAILED++))
all_ok=false
fi
done
$all_ok
}
# Delete namespace
delete_namespace() {
local namespace=$1
log_info "Deleting namespace $namespace"
kubectl delete namespace "$namespace" --ignore-not-found=true &
sleep 2
}
# Test scenario runner
run_test_scenario() {
local scenario_name=$1
echo ""
echo "======================================"
echo "Scenario: $scenario_name"
echo "======================================"
}
# Complete scenario runner
complete_test_scenario() {
local scenario_name=$1
local result=$2
if [ "$result" = "pass" ]; then
log_success "Scenario '$scenario_name' completed successfully"
else
log_fail "Scenario '$scenario_name' failed"
fi
}
+321
View File
@@ -0,0 +1,321 @@
#!/usr/bin/env bash
# E2E Test: Lazy Watcher Initialization
#
# Tests that kube-mirror only creates watchers for resource types that have
# resources marked for mirroring, reducing memory usage dramatically.
#
# Scenario:
# 1. Assumes controller is already running with --lazy-watcher-init=true
# 2. Verify initial controller registration count
# 3. Create a Secret with the enabled label
# 4. Wait for scan interval (500ms in e2e tests)
# 5. Verify controller was registered for Secrets
# 6. Create a ConfigMap with the enabled label
# 7. Verify controller was registered for ConfigMaps
# 8. Verify mirroring works correctly
#
# This test expects the controller to be running with:
# --lazy-watcher-init=true
# --watcher-scan-interval=500ms
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "${SCRIPT_DIR}/common.sh"
# Test configuration
TEST_NAME="lazy-watcher-init"
SOURCE_NS="kubemirror-e2e-lazy-source"
TARGET_NS="kubemirror-e2e-lazy-target"
KUBEMIRROR_LOG="${KUBEMIRROR_LOG:-/tmp/kubemirror-e2e-test.log}"
# Helper functions
create_namespace() {
local ns="$1"
kubectl create namespace "${ns}" 2>/dev/null || true
echo "✓ Created namespace: ${ns}"
}
delete_namespace() {
local ns="$1"
kubectl delete namespace "${ns}" --wait=false 2>/dev/null || true
echo "✓ Deleted namespace: ${ns}"
}
assert_secret_exists() {
local ns="$1"
local name="$2"
kubectl get secret -n "${ns}" "${name}" &>/dev/null || {
echo "❌ Secret ${name} not found in namespace ${ns}"
return 1
}
echo "✓ Secret ${name} exists in namespace ${ns}"
}
assert_secret_data() {
local ns="$1"
local name="$2"
local key="$3"
local expected="$4"
local actual=$(kubectl get secret -n "${ns}" "${name}" -o jsonpath="{.data.${key}}" | base64 -d)
if [[ "${actual}" != "${expected}" ]]; then
echo "❌ Secret ${name} key ${key}: expected '${expected}', got '${actual}'"
return 1
fi
echo "✓ Secret ${name} key ${key} matches expected value"
}
assert_configmap_exists() {
local ns="$1"
local name="$2"
kubectl get configmap -n "${ns}" "${name}" &>/dev/null || {
echo "❌ ConfigMap ${name} not found in namespace ${ns}"
return 1
}
echo "✓ ConfigMap ${name} exists in namespace ${ns}"
}
assert_configmap_data() {
local ns="$1"
local name="$2"
local key="$3"
local expected="$4"
local actual=$(kubectl get configmap -n "${ns}" "${name}" -o jsonpath="{.data.${key}}")
if [[ "${actual}" != "${expected}" ]]; then
echo "❌ ConfigMap ${name} key ${key}: expected '${expected}', got '${actual}'"
return 1
fi
echo "✓ ConfigMap ${name} key ${key} matches expected value"
}
# Verify controller is running
verify_controller_running() {
if [ ! -f "$KUBEMIRROR_LOG" ] || [ ! -s "$KUBEMIRROR_LOG" ]; then
echo "❌ ERROR: KubeMirror controller log file not found or empty: $KUBEMIRROR_LOG"
echo " This test requires the controller to be running with:"
echo " --lazy-watcher-init=true"
echo " --watcher-scan-interval=500ms"
exit 1
fi
echo "✓ KubeMirror controller is running (log: $KUBEMIRROR_LOG)"
}
# Get initial controller registration count
get_registered_controller_count() {
tail -1000 "$KUBEMIRROR_LOG" 2>/dev/null | \
grep "registered controller for active resource type" | \
wc -l | tr -d ' '
}
# Get memory usage (not available when running as binary)
get_memory_usage_mb() {
echo "N/A"
}
# Wait for controller to register a specific resource type
wait_for_controller_registration() {
local resource_kind="$1"
local timeout=10 # 10 seconds (with 500ms scan interval, should be very fast)
local elapsed=0
echo "⏳ Waiting for ${resource_kind} controller registration (timeout: ${timeout}s)..."
while [[ $elapsed -lt $timeout ]]; do
if tail -500 "$KUBEMIRROR_LOG" 2>/dev/null | \
grep -q "registered controller for active resource type.*kind.*${resource_kind}"; then
echo "${resource_kind} controller registered (took ~${elapsed}s)"
return 0
fi
sleep 1
elapsed=$((elapsed + 1))
echo " Waiting... (${elapsed}/${timeout}s)"
done
echo "❌ Timeout waiting for ${resource_kind} controller registration"
return 1
}
# Main test function
run_test() {
echo "🧪 Starting E2E Test: Lazy Watcher Initialization"
echo "================================================"
# Verify controller is running
verify_controller_running
# Setup
echo ""
echo "🔧 Setting up test environment..."
create_namespace "${SOURCE_NS}"
create_namespace "${TARGET_NS}"
# Give controller time to process new namespaces
sleep 2
# Check initial state - should have very few or no controllers registered
echo ""
echo "📊 Checking initial state (before marking any resources)..."
initial_count=$(get_registered_controller_count)
echo " Initial registered controllers: ${initial_count}"
if [[ ${initial_count} -gt 5 ]]; then
echo "⚠️ WARNING: More controllers registered than expected (${initial_count})"
echo " This might indicate lazy initialization is not working properly"
else
echo "✓ Low initial controller count as expected"
fi
# Get initial memory usage
initial_memory=$(get_memory_usage_mb || echo "N/A")
echo " Initial memory usage: ${initial_memory}Mi"
# Test 1: Create a Secret with enabled label
echo ""
echo "📝 Test 1: Creating Secret with enabled label..."
kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
name: lazy-test-secret
namespace: ${SOURCE_NS}
labels:
kubemirror.raczylo.com/enabled: "true"
test-resource: e2e
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "${TARGET_NS}"
type: Opaque
stringData:
test-key: "test-value-from-lazy-init"
EOF
# Wait for Secret controller to be registered
wait_for_controller_registration "Secret" || {
echo "❌ Test 1 failed: Secret controller was not registered"
echo "📋 Controller logs:"
tail -100 "$KUBEMIRROR_LOG"
exit 1
}
echo "✓ Test 1 passed: Secret controller registered dynamically"
# Verify the secret was mirrored
echo " Verifying secret mirroring..."
sleep 15 # Give time for mirroring to occur
assert_secret_exists "${TARGET_NS}" "lazy-test-secret"
assert_secret_data "${TARGET_NS}" "lazy-test-secret" "test-key" "test-value-from-lazy-init"
echo "✓ Secret successfully mirrored"
# Test 2: Create a ConfigMap with enabled label
echo ""
echo "📝 Test 2: Creating ConfigMap with enabled label..."
kubectl apply -f - <<EOF
apiVersion: v1
kind: ConfigMap
metadata:
name: lazy-test-configmap
namespace: ${SOURCE_NS}
labels:
kubemirror.raczylo.com/enabled: "true"
test-resource: e2e
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "${TARGET_NS}"
data:
config-key: "config-value-from-lazy-init"
EOF
# Wait for ConfigMap controller to be registered
wait_for_controller_registration "ConfigMap" || {
echo "❌ Test 2 failed: ConfigMap controller was not registered"
echo "📋 Controller logs:"
tail -100 "$KUBEMIRROR_LOG"
exit 1
}
echo "✓ Test 2 passed: ConfigMap controller registered dynamically"
# Verify the configmap was mirrored
echo " Verifying configmap mirroring..."
sleep 15 # Give time for mirroring to occur
assert_configmap_exists "${TARGET_NS}" "lazy-test-configmap"
assert_configmap_data "${TARGET_NS}" "lazy-test-configmap" "config-key" "config-value-from-lazy-init"
echo "✓ ConfigMap successfully mirrored"
# Final metrics
echo ""
echo "📊 Final metrics:"
final_count=$(get_registered_controller_count)
final_memory=$(get_memory_usage_mb || echo "N/A")
echo " Initial controllers: ${initial_count}"
echo " Final controllers: ${final_count}"
echo " Controllers added: $((final_count - initial_count))"
echo ""
echo " Initial memory: ${initial_memory}Mi"
echo " Final memory: ${final_memory}Mi"
if [[ "${final_memory}" != "N/A" && "${initial_memory}" != "N/A" ]]; then
memory_increase=$((final_memory - initial_memory))
echo " Memory increase: ${memory_increase}Mi"
if [[ ${final_memory} -lt 100 ]]; then
echo "✓ Memory usage is optimal (<100Mi)"
elif [[ ${final_memory} -lt 150 ]]; then
echo "⚠️ Memory usage is acceptable but could be better (${final_memory}Mi)"
else
echo "❌ Memory usage is higher than expected (${final_memory}Mi)"
fi
fi
# Verify scan log entry
echo ""
echo "📋 Verifying periodic scan activity..."
if tail -200 "$KUBEMIRROR_LOG" | \
grep -q "scan completed"; then
echo "✓ Periodic scanning is active"
# Show the latest scan results
tail -200 "$KUBEMIRROR_LOG" | \
grep "scan completed" | tail -1
else
echo "⚠️ No scan activity detected yet (might be too early)"
fi
echo ""
echo "✅ All tests passed!"
echo ""
echo "📈 Summary:"
echo " - Lazy watcher initialization is working correctly"
echo " - Controllers are registered on-demand when resources are marked"
echo " - Memory usage remains low"
echo " - Periodic scanning detects new resource types"
}
# Cleanup function
cleanup() {
echo ""
echo "🧹 Cleaning up test resources..."
# Delete test secrets/configmaps first
kubectl delete secret,configmap -n "${SOURCE_NS}" -l test-resource=e2e --ignore-not-found=true 2>/dev/null || true
# Delete test namespaces
delete_namespace "${SOURCE_NS}" || true
delete_namespace "${TARGET_NS}" || true
echo "✓ Cleanup complete"
}
# Trap cleanup on exit
trap cleanup EXIT
# Run the test
run_test
exit 0
+207
View File
@@ -0,0 +1,207 @@
#!/bin/bash
# Parallel E2E Test Runner for KubeMirror
# Runs independent tests in parallel batches for faster execution
#
# Usage:
# ./test-parallel.sh # Run all tests in parallel batches
#
# Performance:
# - Sequential execution: ~5-7 minutes for all 30 scenarios
# - Parallel execution: ~3-4 minutes (batched by independence)
#
# Batching Strategy:
# - Sequential: Scenarios 1-11 (core lifecycle - must run sequentially)
# - Parallel Batch 1: Scenarios 12-15 (namespace labels)
# - Parallel Batch 2: Scenarios 16-19 (deletion scenarios)
# - Parallel Batch 3: Scenarios 20-23 (mixed resources)
# - Parallel Batch 4: Scenarios 24-27 (transformations part 1)
# - Parallel Batch 5: Scenarios 28-30 (transformations part 2)
#
# Individual scenario logs: e2e/.test-scenario-{num}.log
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
TEST_NAME="Parallel E2E Tests"
# Colors
CYAN='\033[0;36m'
NC='\033[0m'
# Batch execution tracking
BATCH_RESULTS=()
TOTAL_START_TIME=$(date +%s)
# Run a single scenario by number
run_scenario() {
local scenario_num=$1
local log_file="$SCRIPT_DIR/.test-scenario-${scenario_num}.log"
echo -e "${CYAN}[BATCH]${NC} Starting scenario $scenario_num in background"
# Run the specific scenario using the comprehensive test script
# Pass scenario number as argument to run only that scenario
bash "$SCRIPT_DIR/test-comprehensive.sh" "$scenario_num" > "$log_file" 2>&1
local exit_code=$?
# Store result
echo "$scenario_num:$exit_code" >> "$SCRIPT_DIR/.batch-results.tmp"
if [ $exit_code -eq 0 ]; then
echo -e "${GREEN}[PASS]${NC} Scenario $scenario_num completed successfully"
else
echo -e "${RED}[FAIL]${NC} Scenario $scenario_num failed (exit code: $exit_code)"
fi
return $exit_code
}
# Run multiple scenarios in parallel
run_parallel_batch() {
local batch_name=$1
shift
local scenarios=("$@")
echo ""
echo -e "${CYAN}======================================${NC}"
echo -e "${CYAN}Batch: $batch_name${NC}"
echo -e "${CYAN}Scenarios: ${scenarios[*]}${NC}"
echo -e "${CYAN}======================================${NC}"
local batch_start=$(date +%s)
# Clear batch results file
> "$SCRIPT_DIR/.batch-results.tmp"
# Start all scenarios in background
local pids=()
for scenario in "${scenarios[@]}"; do
run_scenario "$scenario" &
pids+=($!)
done
# Wait for all to complete
local batch_failed=0
for pid in "${pids[@]}"; do
wait $pid || batch_failed=1
done
local batch_end=$(date +%s)
local batch_duration=$((batch_end - batch_start))
echo -e "${CYAN}Batch '$batch_name' completed in ${batch_duration}s${NC}"
return $batch_failed
}
# Main execution
main() {
log_info "Starting $TEST_NAME"
log_info "This runner executes independent tests in parallel for faster results"
# Ensure controller is running
if ! pgrep -f "kubemirror" > /dev/null; then
log_fail "KubeMirror controller is not running!"
log_info "Please start the controller first: ./e2e/run-all-tests.sh"
exit 1
fi
# Clean up any previous test artifacts
log_info "Cleaning up previous test artifacts"
rm -f "$SCRIPT_DIR/.test-scenario-"*.log
rm -f "$SCRIPT_DIR/.batch-results.tmp"
local overall_failed=0
# ========================================================================
# SEQUENTIAL BATCH: Core Lifecycle (Scenarios 1-11)
# These tests modify the same resource and MUST run sequentially
# ========================================================================
echo ""
echo -e "${CYAN}======================================${NC}"
echo -e "${CYAN}Sequential Batch: Core Lifecycle${NC}"
echo -e "${CYAN}Scenarios: 1-11 (sequential execution required)${NC}"
echo -e "${CYAN}======================================${NC}"
local seq_start=$(date +%s)
bash "$SCRIPT_DIR/test-comprehensive.sh" 1 2 3 4 5 6 7 8 9 10 11
if [ $? -ne 0 ]; then
overall_failed=1
log_fail "Sequential batch (1-11) failed"
fi
local seq_end=$(date +%s)
echo -e "${CYAN}Sequential batch completed in $((seq_end - seq_start))s${NC}"
# ========================================================================
# PARALLEL BATCH 1: Namespace Label Tests (Scenarios 12-15)
# ========================================================================
run_parallel_batch "Namespace Labels" 12 13 14 15
[ $? -ne 0 ] && overall_failed=1
# ========================================================================
# PARALLEL BATCH 2: Deletion Scenarios (Scenarios 16-19)
# ========================================================================
run_parallel_batch "Deletion Scenarios" 16 17 18 19
[ $? -ne 0 ] && overall_failed=1
# ========================================================================
# PARALLEL BATCH 3: Mixed Resources (Scenarios 20-23)
# ========================================================================
run_parallel_batch "Mixed Resources" 20 21 22 23
[ $? -ne 0 ] && overall_failed=1
# ========================================================================
# PARALLEL BATCH 4: Transformations Part 1 (Scenarios 24-27)
# ========================================================================
run_parallel_batch "Transformations 1" 24 25 26 27
[ $? -ne 0 ] && overall_failed=1
# ========================================================================
# PARALLEL BATCH 5: Transformations Part 2 (Scenarios 28-30)
# ========================================================================
run_parallel_batch "Transformations 2" 28 29 30
[ $? -ne 0 ] && overall_failed=1
# ========================================================================
# SUMMARY
# ========================================================================
local total_end=$(date +%s)
local total_duration=$((total_end - TOTAL_START_TIME))
echo ""
echo -e "${CYAN}======================================${NC}"
echo -e "${CYAN}Test Execution Summary${NC}"
echo -e "${CYAN}======================================${NC}"
echo -e "Total execution time: ${total_duration}s"
echo -e "Sequential scenarios: 1-11"
echo -e "Parallel batches: 5 batches (scenarios 12-30)"
if [ $overall_failed -eq 0 ]; then
echo -e "${GREEN}All test batches PASSED!${NC}"
# Show individual scenario results from logs
echo ""
echo "Individual scenario results:"
for i in {1..30}; do
if [ -f "$SCRIPT_DIR/.test-scenario-${i}.log" ]; then
if grep -q "PASS.*Scenario.*${i}" "$SCRIPT_DIR/.test-scenario-${i}.log" 2>/dev/null; then
echo -e " Scenario $i: ${GREEN}PASS${NC}"
else
echo -e " Scenario $i: ${RED}FAIL${NC}"
fi
fi
done
else
echo -e "${RED}Some test batches FAILED!${NC}"
echo ""
echo "Check individual scenario logs in: $SCRIPT_DIR/.test-scenario-*.log"
fi
# Cleanup temp files
rm -f "$SCRIPT_DIR/.batch-results.tmp"
exit $overall_failed
}
main "$@"
+131
View File
@@ -249,6 +249,137 @@ data:
config: "value" config: "value"
``` ```
## ExternalSecrets Integration
KubeMirror integrates seamlessly with the [ExternalSecrets Operator](https://external-secrets.io/) to distribute secrets from external stores (1Password, Vault, AWS Secrets Manager, etc.) across multiple namespaces.
### Overview
The `externalsecret-dockerconfig.yaml` example demonstrates how to:
1. Sync secrets from 1Password/Vault/etc using ExternalSecrets
2. Mirror those secrets to multiple namespaces using KubeMirror
3. Avoid race conditions between the two controllers
### Prerequisites
```bash
# Install ExternalSecrets Operator
helm repo add external-secrets https://charts.external-secrets.io
helm install external-secrets external-secrets/external-secrets -n external-secrets-system --create-namespace
# Configure your ClusterSecretStore (example for 1Password)
kubectl apply -f your-clustersecretstore.yaml
```
### Quick Start
```bash
# Apply the ExternalSecret example
kubectl apply -f examples/externalsecret-dockerconfig.yaml
# Verify the source secret was created
kubectl get secret multi-registry-secret -n default
# Verify mirrors were created by KubeMirror
kubectl get secrets --all-namespaces -l kubemirror.raczylo.com/mirror=true
# Check sync status
kubectl get secret multi-registry-secret -n default \
-o jsonpath='{.metadata.annotations.kubemirror\.raczylo\.com/sync-status}'
```
### Key Configuration
**Ownership Model**
KubeMirror uses **labels and annotations** to manage mirrors, not ownerReferences. This allows it to work with sources managed by any controller (ExternalSecrets, ArgoCD, etc.):
```yaml
target:
creationPolicy: Owner # Source can be owned by ExternalSecrets
name: multi-registry-secret
template:
metadata:
labels:
kubemirror.raczylo.com/enabled: "true" # KubeMirror detection
annotations:
kubemirror.raczylo.com/sync: "true"
kubemirror.raczylo.com/target-namespaces: "all"
```
**Separation of Concerns:**
- **Source Secret**: Owned by ExternalSecrets (or any other controller) via `ownerReferences`
- **Mirror Secrets**: Managed by KubeMirror via labels + annotations (no ownerReferences copied)
- **Relationship**: Mirrors link to source via annotations (`source-namespace`, `source-name`, `source-uid`)
- **Result**: Each controller manages its own resources independently
### Examples in externalsecret-dockerconfig.yaml
The example file contains three complete examples:
1. **Docker Registry Credentials** - Mirrors Docker config to all namespaces using `target-namespaces: "all"`
2. **Database Credentials** - Uses `all-labeled` for opt-in mirroring with namespace labels
3. **Namespace with Opt-In Label** - Shows how to label namespaces to receive mirrors
### Verification
```bash
# Check ExternalSecret status
kubectl get externalsecret 1p-docker-config -n default
# View the created secret
kubectl get secret multi-registry-secret -n default -o yaml
# Verify KubeMirror picked it up
kubectl logs -n kubemirror-system -l app.kubernetes.io/name=kubemirror | grep multi-registry-secret
# Count how many namespaces received the mirror
kubectl get secrets --all-namespaces -l kubemirror.raczylo.com/mirror=true \
--field-selector metadata.name=multi-registry-secret | wc -l
# Check a specific mirror
kubectl get secret multi-registry-secret -n production-app -o yaml
```
### Testing Updates
Test that ExternalSecrets refreshes propagate to all mirrors:
```bash
# Force ExternalSecret refresh
kubectl annotate externalsecret 1p-docker-config -n default \
force-sync="$(date +%s)" --overwrite
# Wait for ExternalSecret to sync (check status)
kubectl get externalsecret 1p-docker-config -n default -w
# Verify mirrors are updated (check generation or content hash)
kubectl get secret multi-registry-secret -n production-app \
-o jsonpath='{.metadata.annotations.kubemirror\.raczylo\.com/source-content-hash}'
```
### Common Issues
1. **Mirrors Not Created**
- Verify the secret has `kubemirror.raczylo.com/enabled: "true"` label
- Check that KubeMirror annotations are in the ExternalSecret template
- View controller logs: `kubectl logs -n kubemirror-system -l app.kubernetes.io/name=kubemirror`
2. **ExternalSecret Not Syncing**
- Check ExternalSecret status: `kubectl describe externalsecret <name> -n <namespace>`
- Verify ClusterSecretStore is configured: `kubectl get clustersecretstore`
- Check external-secrets-operator logs
### Alternative Backends
The example includes commented configurations for:
- AWS Secrets Manager
- HashiCorp Vault
- Google Secret Manager
Uncomment and configure the ClusterSecretStore for your backend.
## Transformation Rules ## Transformation Rules
KubeMirror supports transformation rules that modify resources during mirroring. This enables environment-specific configurations, security hardening, and dynamic value generation. KubeMirror supports transformation rules that modify resources during mirroring. This enables environment-specific configurations, security hardening, and dynamic value generation.
+96
View File
@@ -0,0 +1,96 @@
# Recommended Configuration for Home Cluster
# This configuration reduces memory usage from ~259 MB to ~60-80 MB (70-76% reduction)
controller:
# Metrics and health endpoints
metricsBindAddress: ":8080"
healthProbeBindAddress: ":8081"
# Leader election
leaderElect: true
leaderElectionID: "kubemirror-controller-leader"
# ==========================================
# KEY OPTIMIZATION: Specify exact resource types
# ==========================================
# Your cluster is currently watching 204 resource types but only mirroring 10 resources.
# Explicitly listing the types you actually use reduces memory by 70-80%.
#
# Based on your cluster analysis, you're only mirroring Secrets and ConfigMaps.
# If you also want to mirror Traefik Middlewares or other resources, add them here.
resourceTypes:
- "Secret.v1"
- "ConfigMap.v1"
# Uncomment if you need to mirror Traefik resources:
# - "Middleware.v1alpha1.traefik.io"
# - "IngressRoute.v1alpha1.traefik.io"
# - "ServersTransport.v1alpha1.traefik.io"
# Auto-discovery disabled since resourceTypes is specified
discoveryInterval: "5m"
# ==========================================
# KEY OPTIMIZATION: Increased resync period
# ==========================================
# Changed from default 30s (way too aggressive) to 10m
# This reduces memory churn and API server load significantly
resyncPeriod: "10m"
# Resource limits
maxTargets: 100
workerThreads: 5
# API rate limiting (current settings are fine)
rateLimitQPS: 50.0
rateLimitBurst: 100
# Cache freshness verification
# Keep disabled - eventual consistency is acceptable for most use cases
verifySourceFreshness: false
# Namespace filtering
excludedNamespaces: ""
includedNamespaces: ""
# ==========================================
# KEY OPTIMIZATION: Reduced memory limits
# ==========================================
# With explicit resource types, you can safely reduce memory allocation
# Current: 512Mi limit, 128Mi request, using 259Mi
# Optimized: 256Mi limit, 96Mi request, will use ~60-80Mi
resources:
limits:
cpu: 300m # Reduced from 500m
memory: 256Mi # Reduced from 512Mi
requests:
cpu: 50m # Reduced from 100m
memory: 96Mi # Reduced from 128Mi
# Expected Results After Applying:
# --------------------------------
# Memory usage: ~60-80 MB (down from ~259 MB = 70-76% reduction)
# Resource types watched: 2 (down from 204 = 99% reduction)
# Informer caches: ~4 (down from ~400 = 99% reduction)
# Startup time: Faster (no discovery phase)
# API server load: Significantly reduced
# How to Apply:
# -------------
# 1. Update your Helm values file with this configuration
# 2. Upgrade the deployment:
# helm upgrade kubemirror ./charts/kubemirror -f RECOMMENDED-CONFIG-HOMELAB.yaml
# 3. Monitor memory usage:
# kubectl top pod -n default -l app.kubernetes.io/name=kubemirror
# 4. Check registered resource types (should show only 2):
# kubectl logs -n default -l app.kubernetes.io/name=kubemirror | grep "registered source and mirror controllers"
# Troubleshooting:
# ----------------
# If you see higher memory than expected after applying:
# 1. Verify resource types are being used:
# kubectl logs -n default -l app.kubernetes.io/name=kubemirror | grep "using user-specified resource types"
# 2. Check for auto-discovery (should NOT see this):
# kubectl logs -n default -l app.kubernetes.io/name=kubemirror | grep "enabling resource auto-discovery"
# 3. Confirm registered controllers count:
# kubectl logs -n default -l app.kubernetes.io/name=kubemirror | grep "registered source and mirror controllers"
# Should show: "registered source and mirror controllers" {"count": 2}
+227
View File
@@ -0,0 +1,227 @@
# Example: Using KubeMirror with ExternalSecrets Operator
#
# This example demonstrates how to use KubeMirror to distribute secrets from
# external secret stores (1Password, Vault, AWS Secrets Manager, etc.) across
# multiple namespaces.
#
# KubeMirror automatically strips ownerReferences from mirrors, so you can use
# the standard ExternalSecrets creationPolicy: Owner without conflicts.
#
# Prerequisites:
# 1. ExternalSecrets Operator installed: https://external-secrets.io/
# 2. ClusterSecretStore configured for your secret backend
# 3. KubeMirror installed and running
#
# Apply this manifest:
# kubectl apply -f externalsecret-dockerconfig.yaml
#
# Verify:
# kubectl get externalsecret 1p-docker-config -n default
# kubectl get secret multi-registry-secret -n default
# kubectl get secrets --all-namespaces -l kubemirror.raczylo.com/mirror=true
---
apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: 1p-docker-config
namespace: default
annotations:
description: "Pulls Docker registry credentials from 1Password and mirrors to all namespaces"
spec:
# Secret backend configuration
secretStoreRef:
kind: ClusterSecretStore
name: 1password-homecluster # Replace with your ClusterSecretStore name
# Refresh interval - how often to sync from external store
refreshInterval: 24h
# Target secret configuration
target:
# Standard ExternalSecrets setting - KubeMirror automatically strips ownerReferences from mirrors
creationPolicy: Owner
# Deletion policy - what happens when ExternalSecret is deleted
# - Retain: Keep the secret (recommended with KubeMirror)
# - Delete: Remove the secret
deletionPolicy: Retain
# Name of the Kubernetes secret to create
name: multi-registry-secret
# Template for the secret - includes KubeMirror annotations
template:
type: kubernetes.io/dockerconfigjson
# Metadata to include in the created secret
metadata:
labels:
# REQUIRED: Server-side filtering label for KubeMirror
kubemirror.raczylo.com/enabled: "true"
# Optional: Additional labels
app: registry-credentials
managed-by: external-secrets
annotations:
# REQUIRED: Enable mirroring
kubemirror.raczylo.com/sync: "true"
# Target namespaces - choose one of:
# - Specific namespaces: "app1,app2,app3"
# - Pattern matching: "app-*,prod-*"
# - All namespaces: "all"
# - Labeled namespaces only: "all-labeled"
kubemirror.raczylo.com/target-namespaces: "all"
# Optional: Add description
description: "Docker registry credentials synced from 1Password"
# Docker config JSON template using ExternalSecrets templating
data:
.dockerconfigjson: |
{
"auths": {
"ghcr.io": {
"username": "{{ .ghcrUsername | toString }}",
"auth": "{{ printf "%s:%s" .ghcrUsername .ghcrPassword | b64enc }}"
},
"https://index.docker.io/v1/": {
"username": "{{ .dockerUsername | toString }}",
"auth": "{{ printf "%s:%s" .dockerUsername .dockerPassword | b64enc }}"
}
}
}
# Data mappings - what to fetch from external secret store
data:
# GitHub Container Registry credentials
- remoteRef:
key: DockerAuth/ghcrio_username
property: username # Optional: if secret has multiple properties
secretKey: ghcrUsername
- remoteRef:
key: DockerAuth/ghcrio_password
secretKey: ghcrPassword
# Docker Hub credentials
- remoteRef:
key: DockerAuth/dockerio_username
secretKey: dockerUsername
- remoteRef:
key: DockerAuth/dockerio_password
secretKey: dockerPassword
---
# Example: Using with all-labeled for opt-in mirroring
apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: 1p-database-credentials
namespace: shared-resources
spec:
secretStoreRef:
kind: ClusterSecretStore
name: 1password-homecluster
refreshInterval: 24h
target:
creationPolicy: Owner # Standard setting - KubeMirror strips ownerReferences
deletionPolicy: Retain
name: postgres-credentials
template:
type: Opaque
metadata:
labels:
kubemirror.raczylo.com/enabled: "true"
annotations:
kubemirror.raczylo.com/sync: "true"
# Only mirror to namespaces with allow-mirrors label
kubemirror.raczylo.com/target-namespaces: "all-labeled"
stringData:
# ExternalSecrets templating for connection strings
DATABASE_URL: "postgres://{{ .username }}:{{ .password }}@postgres.shared-resources.svc:5432/mydb"
DB_USER: "{{ .username }}"
DB_PASSWORD: "{{ .password }}"
data:
- remoteRef:
key: Database/postgres_username
secretKey: username
- remoteRef:
key: Database/postgres_password
secretKey: password
---
# Example namespace with allow-mirrors label (for all-labeled targeting)
apiVersion: v1
kind: Namespace
metadata:
name: production-app
labels:
# Opt-in to receive mirrored secrets
kubemirror.raczylo.com/allow-mirrors: "true"
environment: production
---
# Alternative ClusterSecretStore examples for different backends
# Uncomment and configure based on your secret backend
# # AWS Secrets Manager
# apiVersion: external-secrets.io/v1beta1
# kind: ClusterSecretStore
# metadata:
# name: aws-secrets-manager
# spec:
# provider:
# aws:
# service: SecretsManager
# region: us-west-2
# auth:
# jwt:
# serviceAccountRef:
# name: external-secrets
# namespace: external-secrets
# # HashiCorp Vault
# apiVersion: external-secrets.io/v1beta1
# kind: ClusterSecretStore
# metadata:
# name: vault-backend
# spec:
# provider:
# vault:
# server: "https://vault.example.com"
# path: "secret"
# version: "v2"
# auth:
# kubernetes:
# mountPath: "kubernetes"
# role: "external-secrets"
# serviceAccountRef:
# name: external-secrets
# namespace: external-secrets
# # Google Secret Manager
# apiVersion: external-secrets.io/v1beta1
# kind: ClusterSecretStore
# metadata:
# name: google-secret-manager
# spec:
# provider:
# gcpsm:
# projectID: "my-project-id"
# auth:
# workloadIdentity:
# clusterLocation: us-central1
# clusterName: my-cluster
# serviceAccountRef:
# name: external-secrets
# namespace: external-secrets
+4
View File
@@ -50,6 +50,10 @@ type Config struct {
EnableAllKeyword bool EnableAllKeyword bool
// DryRun mode logs what would happen without actually making changes // DryRun mode logs what would happen without actually making changes
DryRun bool DryRun bool
// VerifySourceFreshness checks cache staleness and re-fetches from API if needed
// Prevents mirroring stale data when cache hasn't updated yet after watch event
// Trades some API load for guaranteed data freshness
VerifySourceFreshness bool
} }
// LeaderElectionConfig holds leader election settings. // LeaderElectionConfig holds leader election settings.
+8
View File
@@ -84,6 +84,14 @@ const (
// AnnotationDeletionAttempts tracks number of failed deletion attempts. // AnnotationDeletionAttempts tracks number of failed deletion attempts.
AnnotationDeletionAttempts = Domain + "/deletion-attempts" AnnotationDeletionAttempts = Domain + "/deletion-attempts"
// Transformation Annotations
// AnnotationTransform contains YAML transformation rules for mirrored resources.
AnnotationTransform = Domain + "/transform"
// AnnotationTransformStrict enables strict mode (transformation errors block mirroring).
AnnotationTransformStrict = Domain + "/transform-strict"
// Finalizers // Finalizers
// FinalizerName is the finalizer added to source resources. // FinalizerName is the finalizer added to source resources.
+256
View File
@@ -0,0 +1,256 @@
// Package controller implements dynamic controller registration for kubemirror.
package controller
import (
"context"
"fmt"
"sync"
"time"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime/schema"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log"
"github.com/lukaszraczylo/kubemirror/pkg/config"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"github.com/lukaszraczylo/kubemirror/pkg/filter"
)
// DynamicControllerManager manages lazy initialization of controllers
// for resource types that actually have resources marked for mirroring.
//
// This significantly reduces memory usage by avoiding watchers for resource types
// that will never be mirrored (e.g., watching 204 resource types but only using 2).
//
// How it works:
// 1. Periodically scans cluster for resources with kubemirror.raczylo.com/enabled=true label
// 2. Tracks which resource types have active source resources
// 3. Dynamically registers controllers only for resource types in use
// 4. Optionally unregisters controllers for resource types no longer in use
type DynamicControllerManager struct {
client client.Client
mgr ctrl.Manager
config *config.Config
filter *filter.NamespaceFilter
namespaceLister NamespaceLister
scanInterval time.Duration
// Tracking state
mu sync.RWMutex
registeredControllers map[string]bool // GVK string -> registered
activeResourceTypes map[string]schema.GroupVersionKind
availableResourceTypes []config.ResourceType
// Reconciler factories
sourceReconcilerFactory SourceReconcilerFactory
mirrorReconcilerFactory MirrorReconcilerFactory
}
// SourceReconcilerFactory creates source reconcilers for a given GVK
type SourceReconcilerFactory func(gvk schema.GroupVersionKind) *SourceReconciler
// MirrorReconcilerFactory creates mirror reconcilers for a given GVK
type MirrorReconcilerFactory func(gvk schema.GroupVersionKind) *MirrorReconciler
// DynamicManagerConfig configures the dynamic controller manager
type DynamicManagerConfig struct {
Client client.Client
Manager ctrl.Manager
Config *config.Config
Filter *filter.NamespaceFilter
NamespaceLister NamespaceLister
AvailableResources []config.ResourceType
ScanInterval time.Duration // How often to scan for new resources (default: 5m)
SourceReconcilerFactory SourceReconcilerFactory
MirrorReconcilerFactory MirrorReconcilerFactory
}
// NewDynamicControllerManager creates a new dynamic controller manager
func NewDynamicControllerManager(cfg DynamicManagerConfig) *DynamicControllerManager {
if cfg.ScanInterval == 0 {
cfg.ScanInterval = 5 * time.Minute
}
return &DynamicControllerManager{
client: cfg.Client,
mgr: cfg.Manager,
config: cfg.Config,
filter: cfg.Filter,
namespaceLister: cfg.NamespaceLister,
scanInterval: cfg.ScanInterval,
registeredControllers: make(map[string]bool),
activeResourceTypes: make(map[string]schema.GroupVersionKind),
availableResourceTypes: cfg.AvailableResources,
sourceReconcilerFactory: cfg.SourceReconcilerFactory,
mirrorReconcilerFactory: cfg.MirrorReconcilerFactory,
}
}
// Start begins the dynamic controller management loop
func (d *DynamicControllerManager) Start(ctx context.Context) error {
logger := log.FromContext(ctx).WithName("dynamic-controller-manager")
// Initial scan and registration
if err := d.scanAndRegister(ctx); err != nil {
return fmt.Errorf("initial scan failed: %w", err)
}
// Start periodic scanning
go d.run(ctx)
logger.Info("dynamic controller manager started",
"scanInterval", d.scanInterval,
)
return nil
}
// run is the main loop for periodic scanning
func (d *DynamicControllerManager) run(ctx context.Context) {
logger := log.FromContext(ctx).WithName("dynamic-controller-manager")
ticker := time.NewTicker(d.scanInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
logger.Info("dynamic controller manager stopped")
return
case <-ticker.C:
if err := d.scanAndRegister(ctx); err != nil {
logger.Error(err, "periodic scan failed")
}
}
}
}
// scanAndRegister scans the cluster for resources needing watchers and registers controllers
func (d *DynamicControllerManager) scanAndRegister(ctx context.Context) error {
logger := log.FromContext(ctx).WithName("dynamic-controller-manager")
// Find resource types that have active source resources
activeTypes, err := d.findActiveResourceTypes(ctx)
if err != nil {
return fmt.Errorf("failed to find active resource types: %w", err)
}
d.mu.Lock()
defer d.mu.Unlock()
// Track changes
var newlyRegistered, alreadyRegistered int
// Register controllers for active resource types
for gvkStr, gvk := range activeTypes {
if d.registeredControllers[gvkStr] {
alreadyRegistered++
continue
}
// Register new controller
if err := d.registerController(ctx, gvk); err != nil {
logger.Error(err, "failed to register controller",
"gvk", gvkStr,
)
continue
}
d.registeredControllers[gvkStr] = true
d.activeResourceTypes[gvkStr] = gvk
newlyRegistered++
logger.Info("registered controller for active resource type",
"group", gvk.Group,
"version", gvk.Version,
"kind", gvk.Kind,
)
}
logger.Info("scan completed",
"activeResourceTypes", len(activeTypes),
"alreadyRegistered", alreadyRegistered,
"newlyRegistered", newlyRegistered,
"totalRegistered", len(d.registeredControllers),
)
return nil
}
// findActiveResourceTypes scans the cluster for resources with the enabled label
// and returns a map of GVK strings to their schema.GroupVersionKind
func (d *DynamicControllerManager) findActiveResourceTypes(ctx context.Context) (map[string]schema.GroupVersionKind, error) {
logger := log.FromContext(ctx).WithName("dynamic-controller-manager")
activeTypes := make(map[string]schema.GroupVersionKind)
// For each available resource type, check if any resources exist with the enabled label
for _, rt := range d.availableResourceTypes {
gvk := rt.GroupVersionKind()
gvkStr := rt.String()
// Create unstructured list to query resources
list := &unstructured.UnstructuredList{}
list.SetGroupVersionKind(schema.GroupVersionKind{
Group: gvk.Group,
Version: gvk.Version,
Kind: gvk.Kind + "List", // List suffix
})
// Query with label selector
opts := []client.ListOption{
client.MatchingLabels{
constants.LabelEnabled: "true",
},
}
if err := d.client.List(ctx, list, opts...); err != nil {
// Ignore errors for resource types that don't exist or we can't access
logger.V(2).Info("failed to list resources (ignoring)",
"gvk", gvkStr,
"error", err.Error(),
)
continue
}
// If we found any resources with the label, mark this type as active
if len(list.Items) > 0 {
activeTypes[gvkStr] = gvk
logger.V(1).Info("found active resources",
"gvk", gvkStr,
"count", len(list.Items),
)
}
}
return activeTypes, nil
}
// registerController registers source and mirror controllers for a GVK
func (d *DynamicControllerManager) registerController(ctx context.Context, gvk schema.GroupVersionKind) error {
logger := log.FromContext(ctx).WithName("dynamic-controller-manager")
// Create source reconciler using factory
sourceReconciler := d.sourceReconcilerFactory(gvk)
// Register source controller
if err := sourceReconciler.SetupWithManagerForResourceType(d.mgr, gvk); err != nil {
return fmt.Errorf("failed to register source controller: %w", err)
}
// Create mirror reconciler using factory
mirrorReconciler := d.mirrorReconcilerFactory(gvk)
// Register mirror controller
if err := mirrorReconciler.SetupWithManager(d.mgr, gvk); err != nil {
return fmt.Errorf("failed to register mirror controller: %w", err)
}
logger.Info("registered controllers",
"group", gvk.Group,
"version", gvk.Version,
"kind", gvk.Kind,
)
return nil
}
+434
View File
@@ -0,0 +1,434 @@
package controller
import (
"context"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"github.com/lukaszraczylo/kubemirror/pkg/config"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
)
// Test helper functions - only available during testing
// These are intentionally not exported methods on DynamicControllerManager
// to avoid exposing them in production code
// getRegisteredCount returns the number of currently registered controllers (test helper)
func getRegisteredCount(d *DynamicControllerManager) int {
d.mu.RLock()
defer d.mu.RUnlock()
return len(d.registeredControllers)
}
// getActiveResourceTypes returns the currently active resource types (test helper)
func getActiveResourceTypes(d *DynamicControllerManager) []schema.GroupVersionKind {
d.mu.RLock()
defer d.mu.RUnlock()
result := make([]schema.GroupVersionKind, 0, len(d.activeResourceTypes))
for _, gvk := range d.activeResourceTypes {
result = append(result, gvk)
}
return result
}
func TestDynamicControllerManager_FindActiveResourceTypes(t *testing.T) {
// NOTE: The fake Kubernetes client has limitations with label selector filtering in LIST operations.
// These tests verify the logic structure but full label filtering is validated in e2e tests.
t.Skip("Skipping due to fake client label selector limitations - covered by e2e tests")
tests := []struct {
name string
availableResources []config.ResourceType
existingResources []*unstructured.Unstructured
expectedActiveCount int
expectedActiveTypes []string
}{
{
name: "no resources marked for mirroring",
availableResources: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
{Group: "", Version: "v1", Kind: "ConfigMap"},
},
existingResources: []*unstructured.Unstructured{},
expectedActiveCount: 0,
expectedActiveTypes: []string{},
},
{
name: "one secret marked for mirroring",
availableResources: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
{Group: "", Version: "v1", Kind: "ConfigMap"},
},
existingResources: []*unstructured.Unstructured{
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSync: "true",
},
},
"data": map[string]interface{}{
"key": "dmFsdWU=", // base64 encoded "value"
},
},
},
},
expectedActiveCount: 1,
expectedActiveTypes: []string{"Secret.v1."},
},
{
name: "both secrets and configmaps marked",
availableResources: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
{Group: "", Version: "v1", Kind: "ConfigMap"},
},
existingResources: []*unstructured.Unstructured{
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
},
},
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "test-configmap",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
},
},
},
expectedActiveCount: 2,
expectedActiveTypes: []string{"Secret.v1.", "ConfigMap.v1."},
},
{
name: "resources without enabled label are ignored",
availableResources: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
},
existingResources: []*unstructured.Unstructured{
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
// No enabled label
},
},
},
},
expectedActiveCount: 0,
expectedActiveTypes: []string{},
},
{
name: "multiple resources of same type count as one active type",
availableResources: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
},
existingResources: []*unstructured.Unstructured{
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "secret-1",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
},
},
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "secret-2",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
},
},
{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "secret-3",
"namespace": "kube-system",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
},
},
},
expectedActiveCount: 1,
expectedActiveTypes: []string{"Secret.v1."},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create fake client with scheme
scheme := runtime.NewScheme()
// Convert unstructured objects to client.Objects
objects := make([]client.Object, len(tt.existingResources))
for i, u := range tt.existingResources {
objects[i] = u
}
fakeClient := fake.NewClientBuilder().
WithScheme(scheme).
WithObjects(objects...).
Build()
// Create dynamic manager
mgr := &DynamicControllerManager{
client: fakeClient,
availableResourceTypes: tt.availableResources,
}
// Find active resource types
ctx := context.Background()
activeTypes, err := mgr.findActiveResourceTypes(ctx)
// Assertions
require.NoError(t, err)
assert.Equal(t, tt.expectedActiveCount, len(activeTypes), "unexpected number of active types")
// Verify expected types are present
for _, expectedType := range tt.expectedActiveTypes {
_, found := activeTypes[expectedType]
assert.True(t, found, "expected type %s not found in active types", expectedType)
}
})
}
}
func TestDynamicControllerManager_GetRegisteredCount(t *testing.T) {
mgr := &DynamicControllerManager{
registeredControllers: map[string]bool{
"Secret.v1.": true,
"ConfigMap.v1.": true,
},
}
count := getRegisteredCount(mgr)
assert.Equal(t, 2, count)
}
func TestDynamicControllerManager_GetActiveResourceTypes(t *testing.T) {
secretGVK := schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Secret"}
configMapGVK := schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMap"}
mgr := &DynamicControllerManager{
activeResourceTypes: map[string]schema.GroupVersionKind{
"Secret.v1.": secretGVK,
"ConfigMap.v1.": configMapGVK,
},
}
activeTypes := getActiveResourceTypes(mgr)
assert.Equal(t, 2, len(activeTypes))
// Verify both GVKs are present
foundSecret := false
foundConfigMap := false
for _, gvk := range activeTypes {
if gvk == secretGVK {
foundSecret = true
}
if gvk == configMapGVK {
foundConfigMap = true
}
}
assert.True(t, foundSecret, "Secret GVK not found")
assert.True(t, foundConfigMap, "ConfigMap GVK not found")
}
func TestDynamicControllerManager_ScanInterval(t *testing.T) {
tests := []struct {
name string
configInterval time.Duration
expectedInterval time.Duration
}{
{
name: "default interval when zero",
configInterval: 0,
expectedInterval: 5 * time.Minute,
},
{
name: "custom interval",
configInterval: 10 * time.Minute,
expectedInterval: 10 * time.Minute,
},
{
name: "short interval",
configInterval: 30 * time.Second,
expectedInterval: 30 * time.Second,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
mgr := NewDynamicControllerManager(DynamicManagerConfig{
ScanInterval: tt.configInterval,
})
assert.Equal(t, tt.expectedInterval, mgr.scanInterval)
})
}
}
func TestDynamicControllerManager_RegistrationTracking(t *testing.T) {
// Test that registration tracking works correctly
mgr := &DynamicControllerManager{
registeredControllers: make(map[string]bool),
activeResourceTypes: make(map[string]schema.GroupVersionKind),
}
gvk := schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Secret"}
gvkStr := "Secret.v1."
// Initially not registered
assert.False(t, mgr.registeredControllers[gvkStr])
assert.Equal(t, 0, getRegisteredCount(mgr))
// Mark as registered
mgr.registeredControllers[gvkStr] = true
mgr.activeResourceTypes[gvkStr] = gvk
assert.True(t, mgr.registeredControllers[gvkStr])
assert.Equal(t, 1, getRegisteredCount(mgr))
activeTypes := getActiveResourceTypes(mgr)
assert.Equal(t, 1, len(activeTypes))
assert.Equal(t, gvk, activeTypes[0])
}
// TestDynamicControllerManager_ConcurrentAccess tests thread-safety
func TestDynamicControllerManager_ConcurrentAccess(t *testing.T) {
mgr := &DynamicControllerManager{
registeredControllers: make(map[string]bool),
activeResourceTypes: make(map[string]schema.GroupVersionKind),
}
// Simulate concurrent reads and writes
done := make(chan bool)
// Writer goroutine
go func() {
for i := 0; i < 100; i++ {
mgr.mu.Lock()
mgr.registeredControllers["test"] = true
mgr.mu.Unlock()
time.Sleep(1 * time.Millisecond)
}
done <- true
}()
// Reader goroutines
for i := 0; i < 5; i++ {
go func() {
for j := 0; j < 100; j++ {
_ = getRegisteredCount(mgr)
_ = getActiveResourceTypes(mgr)
time.Sleep(1 * time.Millisecond)
}
done <- true
}()
}
// Wait for all goroutines
for i := 0; i < 6; i++ {
<-done
}
// Should not panic and should have final state
assert.True(t, mgr.registeredControllers["test"])
}
func TestDynamicControllerManager_UnstructuredResourceHandling(t *testing.T) {
// Test handling of custom resources via unstructured
scheme := runtime.NewScheme()
// Create an unstructured middleware (simulating a Traefik CRD)
// Note: Use int64 instead of int to avoid deep copy issues
middleware := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "traefik.io/v1alpha1",
"kind": "Middleware",
"metadata": map[string]interface{}{
"name": "test-middleware",
"namespace": "default",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
},
"spec": map[string]interface{}{
"compress": map[string]interface{}{
"minResponseBodyBytes": int64(1024), // Use int64 for Kubernetes compatibility
},
},
},
}
fakeClient := fake.NewClientBuilder().
WithScheme(scheme).
WithObjects(middleware).
Build()
availableResources := []config.ResourceType{
{Group: "traefik.io", Version: "v1alpha1", Kind: "Middleware"},
}
mgr := &DynamicControllerManager{
client: fakeClient,
availableResourceTypes: availableResources,
}
ctx := context.Background()
activeTypes, err := mgr.findActiveResourceTypes(ctx)
require.NoError(t, err)
assert.Equal(t, 1, len(activeTypes), "should find the middleware as active")
_, found := activeTypes["Middleware.v1alpha1.traefik.io"]
assert.True(t, found, "middleware type should be in active types")
}
+84 -8
View File
@@ -150,6 +150,11 @@ func createUnstructuredMirror(source runtime.Object, targetNamespace, sourceHash
mirror.SetGeneration(0) mirror.SetGeneration(0)
mirror.SetCreationTimestamp(metav1.Time{}) mirror.SetCreationTimestamp(metav1.Time{})
mirror.SetFinalizers(nil) // Mirrors should not have finalizers mirror.SetFinalizers(nil) // Mirrors should not have finalizers
// IMPORTANT: Mirrors should never have ownerReferences from source.
// KubeMirror manages mirrors via labels/annotations, not ownership.
// This allows sources to be owned by other controllers (ExternalSecrets, ArgoCD, etc.)
// while KubeMirror independently manages the mirrors.
mirror.SetOwnerReferences(nil)
return mirror, nil return mirror, nil
} }
@@ -297,18 +302,42 @@ func updateMirrorAnnotations(mirror metav1.Object, source runtime.Object, source
} }
// updateUnstructuredMirror updates an unstructured mirror. // updateUnstructuredMirror updates an unstructured mirror.
// Uses generic field introspection to handle any resource type (Secrets, ConfigMaps, CRDs).
func updateUnstructuredMirror(mirror, source runtime.Object, sourceHash string) error { func updateUnstructuredMirror(mirror, source runtime.Object, sourceHash string) error {
m := mirror.(*unstructured.Unstructured) m := mirror.(*unstructured.Unstructured)
s := source.(*unstructured.Unstructured) s := source.(*unstructured.Unstructured)
// Update spec // Fields to skip (Kubernetes-managed fields, not user content)
sourceSpec, found, err := unstructured.NestedMap(s.Object, "spec") // These are managed by Kubernetes API server or controllers
if err != nil { skipFields := map[string]bool{
return fmt.Errorf("failed to get source spec: %w", err) // Standard Kubernetes top-level fields
"metadata": true, // Kubernetes metadata (name, namespace, labels, etc.) - managed separately
"status": true, // Resource status - managed by controllers, never mirrored
"apiVersion": true, // API group version - static, set during creation
"kind": true, // Resource kind - static, set during creation
// Kubernetes internal fields (rarely at top level, but be defensive)
"managedFields": true, // Field management tracking - internal to Kubernetes
"selfLink": true, // Deprecated but might exist - auto-generated
"resourceVersion": true, // Optimistic concurrency control - auto-generated
"generation": true, // Spec change counter - auto-generated (but usually in metadata)
"creationTimestamp": true, // Resource creation time - auto-generated (but usually in metadata)
"deletionTimestamp": true, // Resource deletion time - auto-generated (but usually in metadata)
"deletionGracePeriodSeconds": true, // Grace period - auto-managed (but usually in metadata)
"uid": true, // Unique identifier - auto-generated (but usually in metadata)
"ownerReferences": true, // Ownership chain - should not be copied (but usually in metadata)
"finalizers": true, // Deletion hooks - should not be copied (but usually in metadata)
} }
if found {
if err := unstructured.SetNestedMap(m.Object, sourceSpec, "spec"); err != nil { // Copy all content fields from source to mirror
return fmt.Errorf("failed to set mirror spec: %w", err) // This handles:
// - .spec (standard CRDs like Traefik Middleware)
// - .data, .type (Secrets)
// - .data, .binaryData (ConfigMaps)
// - Any custom top-level fields in non-standard CRDs
for key, value := range s.Object {
if !skipFields[key] {
m.Object[key] = value
} }
} }
@@ -318,6 +347,10 @@ func updateUnstructuredMirror(mirror, source runtime.Object, sourceHash string)
// Ensure mirrors never have finalizers (even if they were added before this fix) // Ensure mirrors never have finalizers (even if they were added before this fix)
m.SetFinalizers(nil) m.SetFinalizers(nil)
// Ensure mirrors never have ownerReferences (clean up mirrors from before this fix)
// KubeMirror uses labels/annotations for management, not ownerReferences
m.SetOwnerReferences(nil)
return nil return nil
} }
@@ -360,18 +393,61 @@ func GetSourceReference(mirror metav1.Object) (namespace, name, uid string, foun
// applyTransformations applies transformation rules from the source to the mirror. // applyTransformations applies transformation rules from the source to the mirror.
// Returns the transformed mirror, or the original mirror if no rules are present. // Returns the transformed mirror, or the original mirror if no rules are present.
func applyTransformations(source, mirror runtime.Object, targetNamespace string) (runtime.Object, error) { func applyTransformations(source, mirror runtime.Object, targetNamespace string) (runtime.Object, error) {
// Get source annotations to check for transform rules
sourceObj, ok := source.(metav1.Object)
if !ok {
return mirror, nil
}
sourceAnnotations := sourceObj.GetAnnotations()
if sourceAnnotations == nil {
return mirror, nil
}
transformRules, hasTransform := sourceAnnotations[constants.AnnotationTransform]
if !hasTransform || transformRules == "" {
return mirror, nil // No transformation rules
}
// Temporarily copy transform annotations to mirror for Transform to read
// The Transform function reads rules from the object being transformed
mirrorObj, ok := mirror.(metav1.Object)
if !ok {
return mirror, nil
}
mirrorAnnotations := mirrorObj.GetAnnotations()
if mirrorAnnotations == nil {
mirrorAnnotations = make(map[string]string)
}
// Copy transform annotations from source
mirrorAnnotations[constants.AnnotationTransform] = transformRules
if strictMode, hasStrict := sourceAnnotations[constants.AnnotationTransformStrict]; hasStrict {
mirrorAnnotations[constants.AnnotationTransformStrict] = strictMode
}
mirrorObj.SetAnnotations(mirrorAnnotations)
// Build transformation context // Build transformation context
ctx := buildTransformContext(source, mirror, targetNamespace) ctx := buildTransformContext(source, mirror, targetNamespace)
// Create transformer with default options // Create transformer with default options
t := transformer.NewDefaultTransformer() t := transformer.NewDefaultTransformer()
// Apply transformations (transformer handles case of no rules gracefully) // Apply transformations (transformer reads rules from mirror's annotations now)
transformed, err := t.Transform(mirror, ctx) transformed, err := t.Transform(mirror, ctx)
if err != nil { if err != nil {
return nil, err return nil, err
} }
// Remove transform annotations from result (they shouldn't persist on mirrors)
if transformedObj, ok := transformed.(metav1.Object); ok {
annotations := transformedObj.GetAnnotations()
delete(annotations, constants.AnnotationTransform)
delete(annotations, constants.AnnotationTransformStrict)
transformedObj.SetAnnotations(annotations)
}
return transformed, nil return transformed, nil
} }
+152
View File
@@ -0,0 +1,152 @@
package controller
import (
"context"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
)
// MirrorReconciler reconciles mirrored resources to detect and clean up orphans.
// This reconciler watches resources with the managed-by label and verifies their source still exists.
type MirrorReconciler struct {
client.Client
Scheme *runtime.Scheme
GVK schema.GroupVersionKind // The resource type this reconciler handles
}
// Reconcile checks if a mirrored resource's source still exists, and deletes the mirror if orphaned.
func (r *MirrorReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx)
// Fetch the mirror resource
mirror := &unstructured.Unstructured{}
gv := schema.GroupVersion{Group: r.GVK.Group, Version: r.GVK.Version}
mirror.SetGroupVersionKind(gv.WithKind(r.GVK.Kind))
if err := r.Get(ctx, req.NamespacedName, mirror); err != nil {
// Mirror already deleted or doesn't exist - nothing to do
return ctrl.Result{}, client.IgnoreNotFound(err)
}
// Extract annotations using unstructured helper methods
annotations := mirror.GetAnnotations()
if annotations == nil {
// No annotations - not a valid mirror, skip
return ctrl.Result{}, nil
}
// Extract source reference from annotations
sourceNs, hasSourceNs := annotations[constants.AnnotationSourceNamespace]
sourceName, hasSourceName := annotations[constants.AnnotationSourceName]
sourceUID, hasSourceUID := annotations[constants.AnnotationSourceUID]
if !hasSourceNs || !hasSourceName || !hasSourceUID {
// Missing source reference annotations - not a valid mirror or corrupted
logger.V(1).Info("mirror missing source reference annotations, skipping",
"namespace", req.Namespace, "name", req.Name)
return ctrl.Result{}, nil
}
// Try to fetch the source resource
source := &unstructured.Unstructured{}
source.SetGroupVersionKind(gv.WithKind(r.GVK.Kind))
sourceKey := types.NamespacedName{
Namespace: sourceNs,
Name: sourceName,
}
err := r.Get(ctx, sourceKey, source)
if err != nil {
if client.IgnoreNotFound(err) == nil {
// Source not found - this is an orphaned mirror, delete it
logger.Info("orphaned mirror detected (source deleted), cleaning up",
"mirror", req.NamespacedName,
"sourceNamespace", sourceNs,
"sourceName", sourceName,
"sourceUID", sourceUID)
if err := r.Delete(ctx, mirror); err != nil {
logger.Error(err, "failed to delete orphaned mirror")
return ctrl.Result{}, err
}
logger.Info("orphaned mirror deleted successfully",
"mirror", req.NamespacedName,
"sourceNamespace", sourceNs,
"sourceName", sourceName)
return ctrl.Result{}, nil
}
// Some other error fetching source
logger.Error(err, "failed to fetch source resource for mirror",
"sourceNamespace", sourceNs, "sourceName", sourceName)
return ctrl.Result{}, err
}
// Source exists - verify UID matches
actualUID := string(source.GetUID())
if actualUID != sourceUID {
// Source was recreated with different UID - this is a stale mirror
logger.Info("stale mirror detected (source recreated with different UID), cleaning up",
"mirror", req.NamespacedName,
"sourceNamespace", sourceNs,
"sourceName", sourceName,
"expectedUID", sourceUID,
"actualUID", actualUID)
if err := r.Delete(ctx, mirror); err != nil {
logger.Error(err, "failed to delete stale mirror")
return ctrl.Result{}, err
}
logger.Info("stale mirror deleted successfully",
"mirror", req.NamespacedName,
"sourceNamespace", sourceNs,
"sourceName", sourceName)
return ctrl.Result{}, nil
}
// Source exists and UID matches - mirror is valid
logger.V(1).Info("mirror source verified",
"mirror", req.NamespacedName,
"sourceNamespace", sourceNs,
"sourceName", sourceName)
return ctrl.Result{}, nil
}
// SetupWithManager sets up the controller with the Manager.
func (r *MirrorReconciler) SetupWithManager(mgr ctrl.Manager, gvk schema.GroupVersionKind) error {
// Create a predicate that only watches resources with the managed-by label
managedByPredicate := predicate.NewPredicateFuncs(func(obj client.Object) bool {
labels := obj.GetLabels()
if labels == nil {
return false
}
managedBy, exists := labels[constants.LabelManagedBy]
return exists && managedBy == "kubemirror"
})
// Convert GVK to resource object for watching
obj := &unstructured.Unstructured{}
gv := schema.GroupVersion{Group: gvk.Group, Version: gvk.Version}
obj.SetGroupVersionKind(gv.WithKind(gvk.Kind))
// Set custom controller name to avoid conflicts with source reconciler and multiple API versions
// Include group and version to make it truly unique
controllerName := gvk.Kind + "." + gvk.Version + "." + gvk.Group + "-mirror"
return ctrl.NewControllerManagedBy(mgr).
For(obj).
Named(controllerName).
WithEventFilter(managedByPredicate).
Complete(r)
}
+258
View File
@@ -155,6 +155,140 @@ func TestCreateMirror_Unstructured(t *testing.T) {
assert.Equal(t, "3", annotations[constants.AnnotationSourceGeneration]) assert.Equal(t, "3", annotations[constants.AnnotationSourceGeneration])
} }
func TestCreateMirror_Unstructured_StripsOwnerReferences(t *testing.T) {
// Create source with ownerReferences (e.g., managed by ExternalSecrets)
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "external-secret",
"namespace": "default",
"uid": "secret-uid-123",
"resourceVersion": "100",
"generation": int64(1),
// Source has ownerReferences (e.g., set by ExternalSecrets operator)
"ownerReferences": []interface{}{
map[string]interface{}{
"apiVersion": "external-secrets.io/v1",
"kind": "ExternalSecret",
"name": "1p-docker-config",
"uid": "externalsecret-uid-456",
"controller": true,
},
},
// Source has finalizers
"finalizers": []interface{}{
"externalsecrets.external-secrets.io/externalsecret-cleanup",
},
},
"data": map[string]interface{}{
"password": "c2VjcmV0",
},
},
}
mirror, err := CreateMirror(source, "target-ns")
require.NoError(t, err)
require.NotNil(t, mirror)
uMirror, ok := mirror.(*unstructured.Unstructured)
require.True(t, ok, "mirror should be Unstructured")
// CRITICAL: Verify ownerReferences are NOT copied to mirror
ownerRefs := uMirror.GetOwnerReferences()
assert.Nil(t, ownerRefs, "mirror should not have ownerReferences from source")
// CRITICAL: Verify finalizers are NOT copied to mirror
finalizers := uMirror.GetFinalizers()
assert.Nil(t, finalizers, "mirror should not have finalizers from source")
// Verify mirror is properly managed by KubeMirror via labels/annotations
assert.Equal(t, constants.ControllerName, uMirror.GetLabels()[constants.LabelManagedBy])
assert.Equal(t, "true", uMirror.GetLabels()[constants.LabelMirror])
assert.Equal(t, "default", uMirror.GetAnnotations()[constants.AnnotationSourceNamespace])
assert.Equal(t, "external-secret", uMirror.GetAnnotations()[constants.AnnotationSourceName])
assert.Equal(t, "secret-uid-123", uMirror.GetAnnotations()[constants.AnnotationSourceUID])
}
func TestUpdateMirror_Unstructured_ClearsOwnerReferences(t *testing.T) {
// Create mirror that somehow has ownerReferences (e.g., from before the fix)
mirror := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "traefik.io/v1alpha1",
"kind": "Middleware",
"metadata": map[string]interface{}{
"name": "test-middleware",
"namespace": "target-ns",
"labels": map[string]interface{}{
constants.LabelManagedBy: constants.ControllerName,
constants.LabelMirror: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSourceNamespace: "default",
constants.AnnotationSourceName: "test-middleware",
constants.AnnotationSourceContentHash: "oldhash",
},
// Mirror has ownerReferences (from before fix or external modification)
"ownerReferences": []interface{}{
map[string]interface{}{
"apiVersion": "external-secrets.io/v1",
"kind": "ExternalSecret",
"name": "1p-docker-config",
"uid": "externalsecret-uid-456",
},
},
// Mirror has finalizers (from before fix or external modification)
"finalizers": []interface{}{
"some-finalizer",
},
},
"spec": map[string]interface{}{
"basicAuth": map[string]interface{}{
"secret": "old-secret",
},
},
},
}
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "traefik.io/v1alpha1",
"kind": "Middleware",
"metadata": map[string]interface{}{
"name": "test-middleware",
"namespace": "default",
"generation": int64(2),
},
"spec": map[string]interface{}{
"basicAuth": map[string]interface{}{
"secret": "new-secret",
},
},
},
}
err := UpdateMirror(mirror, source)
require.NoError(t, err)
// CRITICAL: Verify ownerReferences are cleared from mirror
ownerRefs := mirror.GetOwnerReferences()
assert.Nil(t, ownerRefs, "mirror should not have ownerReferences after update")
// CRITICAL: Verify finalizers are cleared from mirror
finalizers := mirror.GetFinalizers()
assert.Nil(t, finalizers, "mirror should not have finalizers after update")
// Verify spec was updated
secret, found, err := unstructured.NestedString(mirror.Object, "spec", "basicAuth", "secret")
require.NoError(t, err)
require.True(t, found)
assert.Equal(t, "new-secret", secret)
// Verify hash was updated
assert.NotEqual(t, "oldhash", mirror.GetAnnotations()[constants.AnnotationSourceContentHash])
}
func TestUpdateMirror_Secret(t *testing.T) { func TestUpdateMirror_Secret(t *testing.T) {
mirror := &corev1.Secret{ mirror := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{ ObjectMeta: metav1.ObjectMeta{
@@ -234,6 +368,130 @@ func TestUpdateMirror_ConfigMap(t *testing.T) {
assert.NotEqual(t, "oldhash", mirror.Annotations[constants.AnnotationSourceContentHash]) assert.NotEqual(t, "oldhash", mirror.Annotations[constants.AnnotationSourceContentHash])
} }
func TestUpdateMirror_UnstructuredSecret(t *testing.T) {
// This test validates the fix for the bug where Unstructured Secrets
// would update annotations but not data fields during UpdateMirror
mirror := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "app1",
"labels": map[string]interface{}{
constants.LabelManagedBy: constants.ControllerName,
constants.LabelMirror: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSourceContentHash: "oldhash",
},
},
"type": "Opaque",
"data": map[string]interface{}{
"password": "b2xkLXZhbHVl", // base64 encoded "old-value"
},
},
}
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
"generation": int64(10),
},
"type": "kubernetes.io/tls",
"data": map[string]interface{}{
"password": "bmV3LXZhbHVl", // base64 encoded "new-value"
"username": "YWRtaW4=", // base64 encoded "admin"
},
},
}
err := UpdateMirror(mirror, source)
require.NoError(t, err)
// Verify data was updated (this was the bug - data wasn't being updated)
mirrorData, found, err := unstructured.NestedMap(mirror.Object, "data")
require.NoError(t, err)
require.True(t, found, "mirror should have data field")
sourceData, _, _ := unstructured.NestedMap(source.Object, "data")
assert.Equal(t, sourceData, mirrorData, "mirror data should match source data")
// Verify type was updated
mirrorType, found, err := unstructured.NestedString(mirror.Object, "type")
require.NoError(t, err)
require.True(t, found, "mirror should have type field")
assert.Equal(t, "kubernetes.io/tls", mirrorType, "mirror type should be updated")
// Verify annotations were updated
annotations := mirror.GetAnnotations()
assert.NotEqual(t, "oldhash", annotations[constants.AnnotationSourceContentHash], "hash should be updated")
assert.Equal(t, "10", annotations[constants.AnnotationSourceGeneration], "generation should be updated")
assert.NotEmpty(t, annotations[constants.AnnotationLastSyncTime], "sync time should be set")
}
func TestUpdateMirror_UnstructuredConfigMap(t *testing.T) {
// Test Unstructured ConfigMap to ensure data and binaryData are updated
mirror := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "test-config",
"namespace": "app1",
"annotations": map[string]interface{}{
constants.AnnotationSourceContentHash: "oldhash",
},
},
"data": map[string]interface{}{
"key": "old-value",
},
},
}
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "test-config",
"namespace": "default",
},
"data": map[string]interface{}{
"key": "new-value",
"key2": "another-value",
},
"binaryData": map[string]interface{}{
"binary": "AAECAwQ=", // base64 binary data
},
},
}
err := UpdateMirror(mirror, source)
require.NoError(t, err)
// Verify data was updated
mirrorData, found, err := unstructured.NestedMap(mirror.Object, "data")
require.NoError(t, err)
require.True(t, found, "mirror should have data field")
sourceData, _, _ := unstructured.NestedMap(source.Object, "data")
assert.Equal(t, sourceData, mirrorData, "mirror data should match source data")
// Verify binaryData was updated
mirrorBinaryData, found, err := unstructured.NestedMap(mirror.Object, "binaryData")
require.NoError(t, err)
require.True(t, found, "mirror should have binaryData field")
sourceBinaryData, _, _ := unstructured.NestedMap(source.Object, "binaryData")
assert.Equal(t, sourceBinaryData, mirrorBinaryData, "mirror binaryData should match source binaryData")
// Verify annotations were updated
annotations := mirror.GetAnnotations()
assert.NotEqual(t, "oldhash", annotations[constants.AnnotationSourceContentHash], "hash should be updated")
}
func TestIsManagedByUs(t *testing.T) { func TestIsManagedByUs(t *testing.T) {
tests := []struct { tests := []struct {
obj metav1.Object obj metav1.Object
+20
View File
@@ -55,3 +55,23 @@ func (k *KubernetesNamespaceLister) ListAllowMirrorsNamespaces(ctx context.Conte
return names, nil return names, nil
} }
// ListOptOutNamespaces returns namespaces that have explicitly opted out of mirrors.
// These are namespaces with allow-mirrors="false".
func (k *KubernetesNamespaceLister) ListOptOutNamespaces(ctx context.Context) ([]string, error) {
namespaceList := &corev1.NamespaceList{}
// List namespaces with allow-mirrors label set to false
if err := k.client.List(ctx, namespaceList, client.MatchingLabels{
constants.LabelAllowMirrors: "false",
}); err != nil {
return nil, err
}
names := make([]string, 0, len(namespaceList.Items))
for _, ns := range namespaceList.Items {
names = append(names, ns.Name)
}
return names, nil
}
+310
View File
@@ -0,0 +1,310 @@
// Package controller implements the kubemirror reconciliation logic.
package controller
import (
"context"
"fmt"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"github.com/lukaszraczylo/kubemirror/pkg/config"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"github.com/lukaszraczylo/kubemirror/pkg/filter"
)
// NamespaceReconciler watches for namespace CREATE and UPDATE events
// and triggers reconciliation of source resources that match the new namespace.
type NamespaceReconciler struct {
client.Client
Scheme *runtime.Scheme
Config *config.Config
Filter *filter.NamespaceFilter
NamespaceLister NamespaceLister
// ResourceTypes contains all discovered resource types to reconcile
ResourceTypes []config.ResourceType
}
// Reconcile processes namespace events and creates mirrors for matching sources.
func (r *NamespaceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx).WithValues("namespace", req.Name)
// Fetch the namespace
namespace := &corev1.Namespace{}
if err := r.Get(ctx, req.NamespacedName, namespace); err != nil {
// Namespace was deleted - nothing to do (source reconcilers will handle cleanup)
return ctrl.Result{}, client.IgnoreNotFound(err)
}
// Skip system namespaces
if r.Filter != nil && !r.Filter.IsAllowed(namespace.Name) {
logger.V(1).Info("namespace filtered out, skipping")
return ctrl.Result{}, nil
}
logger.Info("namespace event detected, reconciling source resources")
// Query all source resources that have mirroring enabled
// For each resource type, find resources with the sync annotation
var totalReconciled, totalErrors int
for _, rt := range r.ResourceTypes {
reconciled, errors, err := r.reconcileResourceType(ctx, rt, namespace.Name)
if err != nil {
logger.Error(err, "failed to reconcile resource type",
"group", rt.Group, "version", rt.Version, "kind", rt.Kind)
totalErrors++
continue
}
totalReconciled += reconciled
totalErrors += errors
}
logger.Info("namespace reconciliation complete",
"reconciled", totalReconciled,
"errors", totalErrors,
"resourceTypes", len(r.ResourceTypes))
if totalErrors > 0 {
return ctrl.Result{}, fmt.Errorf("failed to reconcile %d source resources", totalErrors)
}
return ctrl.Result{}, nil
}
// reconcileResourceType finds and reconciles all sources of a specific resource type
// that match the namespace.
func (r *NamespaceReconciler) reconcileResourceType(ctx context.Context, rt config.ResourceType, namespaceName string) (int, int, error) {
logger := log.FromContext(ctx)
gvk := rt.GroupVersionKind()
// List all resources of this type with the enabled label
// Using label selector for server-side filtering
list := &unstructured.UnstructuredList{}
list.SetGroupVersionKind(gvk)
listOpts := []client.ListOption{
client.HasLabels{constants.LabelEnabled},
}
if err := r.List(ctx, list, listOpts...); err != nil {
return 0, 0, fmt.Errorf("failed to list resources: %w", err)
}
var reconciledCount, errorCount int
for i := range list.Items {
source := &list.Items[i]
// Check if source has sync annotation
annotations := source.GetAnnotations()
if annotations == nil || annotations[constants.AnnotationSync] != "true" {
continue
}
// Skip if this is a mirror resource itself
if IsMirrorResource(source) {
continue
}
// Resolve target namespaces for this source
targetNamespaces, err := r.resolveTargetNamespaces(ctx, source)
if err != nil {
logger.Error(err, "failed to resolve target namespaces",
"source", source.GetName(), "namespace", source.GetNamespace())
errorCount++
continue
}
// Check if the new namespace matches this source's targets
var isTarget bool
for _, target := range targetNamespaces {
if target == namespaceName {
isTarget = true
break
}
}
if isTarget {
// Create or update mirror in the namespace
if err := r.reconcileMirror(ctx, source, namespaceName); err != nil {
logger.Error(err, "failed to create mirror",
"source", source.GetName(),
"sourceNamespace", source.GetNamespace(),
"targetNamespace", namespaceName)
errorCount++
continue
}
reconciledCount++
logger.V(1).Info("mirror created/updated for namespace",
"source", source.GetName(),
"sourceNamespace", source.GetNamespace(),
"targetNamespace", namespaceName,
"resourceType", rt.String())
} else {
// Namespace is no longer a target - check if mirror exists and delete it
mirror := &unstructured.Unstructured{}
mirror.SetGroupVersionKind(source.GroupVersionKind())
mirror.SetNamespace(namespaceName)
mirror.SetName(source.GetName())
err := r.Get(ctx, client.ObjectKey{Namespace: namespaceName, Name: source.GetName()}, mirror)
if errors.IsNotFound(err) {
// No mirror exists, nothing to clean up
continue
}
if err != nil {
logger.Error(err, "failed to check for mirror",
"source", source.GetName(),
"namespace", namespaceName)
errorCount++
continue
}
// Verify this is actually our mirror (not someone else's resource with the same name)
if !IsManagedByUs(mirror) {
continue
}
// Verify this mirror points to our source
srcNs, srcName, _, found := GetSourceReference(mirror)
if !found || srcNs != source.GetNamespace() || srcName != source.GetName() {
continue
}
// This mirror should be deleted (namespace no longer a valid target)
if err := r.Delete(ctx, mirror); err != nil {
logger.Error(err, "failed to delete orphaned mirror",
"source", source.GetName(),
"sourceNamespace", source.GetNamespace(),
"targetNamespace", namespaceName)
errorCount++
continue
}
reconciledCount++
logger.V(1).Info("deleted orphaned mirror due to namespace label change",
"source", source.GetName(),
"sourceNamespace", source.GetNamespace(),
"targetNamespace", namespaceName,
"resourceType", rt.String())
}
}
return reconciledCount, errorCount, nil
}
// resolveTargetNamespaces determines which namespaces should receive mirrors for a source.
// Uses the same logic as SourceReconciler.resolveTargetNamespaces.
func (r *NamespaceReconciler) resolveTargetNamespaces(ctx context.Context, source *unstructured.Unstructured) ([]string, error) {
annotations := source.GetAnnotations()
if annotations == nil {
return nil, nil
}
targetNsAnnotation := annotations[constants.AnnotationTargetNamespaces]
if targetNsAnnotation == "" {
return nil, nil
}
// Parse patterns
patterns := filter.ParseTargetNamespaces(targetNsAnnotation)
if len(patterns) == 0 {
return nil, nil
}
// Get all namespaces
allNamespaces, err := r.NamespaceLister.ListNamespaces(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list namespaces: %w", err)
}
// Get namespaces with allow-mirrors label
allowMirrorsNamespaces, err := r.NamespaceLister.ListAllowMirrorsNamespaces(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list allow-mirrors namespaces: %w", err)
}
// Get namespaces that have explicitly opted out (allow-mirrors="false")
optOutNamespaces, err := r.NamespaceLister.ListOptOutNamespaces(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list opt-out namespaces: %w", err)
}
// Resolve target namespaces
targetNamespaces := filter.ResolveTargetNamespaces(
patterns,
allNamespaces,
allowMirrorsNamespaces,
optOutNamespaces,
source.GetNamespace(),
r.Filter,
)
// Enforce max targets limit
if r.Config != nil && r.Config.MaxTargetsPerResource > 0 && len(targetNamespaces) > r.Config.MaxTargetsPerResource {
targetNamespaces = targetNamespaces[:r.Config.MaxTargetsPerResource]
}
return targetNamespaces, nil
}
// reconcileMirror creates or updates a mirror in the target namespace.
// This calls the mirror creation logic from the SourceReconciler.
func (r *NamespaceReconciler) reconcileMirror(ctx context.Context, source *unstructured.Unstructured, targetNamespace string) error {
// Create a temporary SourceReconciler to use its mirror creation logic
// This avoids code duplication
sourceReconciler := &SourceReconciler{
Client: r.Client,
Scheme: r.Scheme,
Config: r.Config,
Filter: r.Filter,
NamespaceLister: r.NamespaceLister,
GVK: source.GroupVersionKind(),
}
return sourceReconciler.reconcileMirror(ctx, source, source, targetNamespace)
}
// SetupWithManager sets up the controller with the Manager.
func (r *NamespaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
// Create predicate to only watch for relevant namespace events
namespacePredicate := predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool {
// Always reconcile new namespaces
return true
},
UpdateFunc: func(e event.UpdateEvent) bool {
// Only reconcile if labels changed (specifically allow-mirrors label)
oldNs, okOld := e.ObjectOld.(*corev1.Namespace)
newNs, okNew := e.ObjectNew.(*corev1.Namespace)
if !okOld || !okNew {
return false
}
// Check if allow-mirrors label changed
oldLabel := oldNs.Labels[constants.LabelAllowMirrors]
newLabel := newNs.Labels[constants.LabelAllowMirrors]
return oldLabel != newLabel
},
DeleteFunc: func(e event.DeleteEvent) bool {
// Don't reconcile on delete - source reconcilers will handle cleanup via finalizers
return false
},
}
return ctrl.NewControllerManagedBy(mgr).
For(&corev1.Namespace{}).
WithEventFilter(namespacePredicate).
Complete(r)
}
+312
View File
@@ -0,0 +1,312 @@
package controller
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
ctrl "sigs.k8s.io/controller-runtime"
"github.com/lukaszraczylo/kubemirror/pkg/config"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"github.com/lukaszraczylo/kubemirror/pkg/filter"
)
func TestNamespaceReconciler_CleanupWhenNamespaceNoLongerTarget(t *testing.T) {
scheme := runtime.NewScheme()
_ = corev1.AddToScheme(scheme)
tests := []struct {
name string
namespace *corev1.Namespace
sourceResources []*unstructured.Unstructured
existingMirrors []*unstructured.Unstructured
expectedDeleted []string // mirror names that should be deleted
expectedRemaining []string // mirror names that should remain
}{
{
name: "namespace label changes to allow-mirrors=false, mirror should be deleted",
namespace: &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: "target-ns",
Labels: map[string]string{
constants.LabelAllowMirrors: "false", // Changed to false
},
},
},
sourceResources: []*unstructured.Unstructured{
makeUnstructuredSecret("test-secret", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "all",
}),
},
existingMirrors: []*unstructured.Unstructured{
makeUnstructuredMirror("test-secret", "target-ns", "default", "test-secret"),
},
expectedDeleted: []string{"test-secret"},
expectedRemaining: []string{},
},
{
name: "namespace no longer matches pattern, mirror should be deleted",
namespace: &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: "staging-1",
},
},
sourceResources: []*unstructured.Unstructured{
makeUnstructuredSecret("test-secret", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "prod-*", // Pattern changed, no longer matches staging-*
}),
},
existingMirrors: []*unstructured.Unstructured{
makeUnstructuredMirror("test-secret", "staging-1", "default", "test-secret"),
},
expectedDeleted: []string{"test-secret"},
expectedRemaining: []string{},
},
{
name: "namespace becomes valid target, no existing mirror, should be created",
namespace: &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: "prod-1",
},
},
sourceResources: []*unstructured.Unstructured{
makeUnstructuredSecret("test-secret", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "prod-*",
}),
},
existingMirrors: []*unstructured.Unstructured{},
expectedDeleted: []string{},
expectedRemaining: []string{"test-secret"}, // Should be created
},
{
name: "namespace still valid, mirror remains",
namespace: &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: "prod-1",
},
},
sourceResources: []*unstructured.Unstructured{
makeUnstructuredSecret("test-secret", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "prod-*",
}),
},
existingMirrors: []*unstructured.Unstructured{
makeUnstructuredMirror("test-secret", "prod-1", "default", "test-secret"),
},
expectedDeleted: []string{},
expectedRemaining: []string{"test-secret"},
},
{
name: "multiple sources, only non-matching mirrors deleted",
namespace: &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: "app-1",
},
},
sourceResources: []*unstructured.Unstructured{
makeUnstructuredSecret("secret-1", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "app-*", // Matches
}),
makeUnstructuredSecret("secret-2", "default", map[string]string{
constants.LabelEnabled: "true",
}, map[string]string{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "prod-*", // Doesn't match
}),
},
existingMirrors: []*unstructured.Unstructured{
makeUnstructuredMirror("secret-1", "app-1", "default", "secret-1"),
makeUnstructuredMirror("secret-2", "app-1", "default", "secret-2"),
},
expectedDeleted: []string{"secret-2"},
expectedRemaining: []string{"secret-1"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create fake client with namespace, sources, and existing mirrors
objects := []client.Object{tt.namespace}
for _, src := range tt.sourceResources {
objects = append(objects, src)
}
for _, mirror := range tt.existingMirrors {
objects = append(objects, mirror)
}
fakeClient := fake.NewClientBuilder().
WithScheme(scheme).
WithObjects(objects...).
Build()
// Create namespace lister mock
mockLister := &mockNamespaceLister{
namespaces: []string{tt.namespace.Name},
allowMirrors: func() map[string]bool {
result := make(map[string]bool)
if tt.namespace.Labels[constants.LabelAllowMirrors] == "true" {
result[tt.namespace.Name] = true
}
return result
}(),
optOut: func() map[string]bool {
result := make(map[string]bool)
if tt.namespace.Labels[constants.LabelAllowMirrors] == "false" {
result[tt.namespace.Name] = true
}
return result
}(),
}
// Create reconciler
reconciler := &NamespaceReconciler{
Client: fakeClient,
Scheme: scheme,
Config: &config.Config{MaxTargetsPerResource: 100},
Filter: filter.NewNamespaceFilter([]string{"kube-system"}, []string{}),
NamespaceLister: mockLister,
ResourceTypes: []config.ResourceType{
{Group: "", Version: "v1", Kind: "Secret"},
},
}
// Reconcile the namespace
ctx := context.Background()
req := ctrl.Request{
NamespacedName: client.ObjectKey{
Name: tt.namespace.Name,
},
}
_, err := reconciler.Reconcile(ctx, req)
require.NoError(t, err)
// Verify mirrors were deleted as expected
for _, mirrorName := range tt.expectedDeleted {
mirror := &unstructured.Unstructured{}
mirror.SetGroupVersionKind(schema.GroupVersionKind{Version: "v1", Kind: "Secret"})
err := fakeClient.Get(ctx, client.ObjectKey{
Namespace: tt.namespace.Name,
Name: mirrorName,
}, mirror)
assert.True(t, errors.IsNotFound(err),
"mirror %s should be deleted in namespace %s", mirrorName, tt.namespace.Name)
}
// Verify mirrors remain as expected
for _, mirrorName := range tt.expectedRemaining {
mirror := &unstructured.Unstructured{}
mirror.SetGroupVersionKind(schema.GroupVersionKind{Version: "v1", Kind: "Secret"})
err := fakeClient.Get(ctx, client.ObjectKey{
Namespace: tt.namespace.Name,
Name: mirrorName,
}, mirror)
assert.NoError(t, err,
"mirror %s should exist in namespace %s", mirrorName, tt.namespace.Name)
}
})
}
}
// Helper functions
func makeUnstructuredSecret(name, namespace string, labels, annotations map[string]string) *unstructured.Unstructured {
secret := &unstructured.Unstructured{}
secret.SetGroupVersionKind(schema.GroupVersionKind{
Version: "v1",
Kind: "Secret",
})
secret.SetName(name)
secret.SetNamespace(namespace)
secret.SetLabels(labels)
secret.SetAnnotations(annotations)
// Set some data
_ = unstructured.SetNestedMap(secret.Object, map[string]interface{}{
"key": "dmFsdWU=", // base64("value")
}, "data")
return secret
}
func makeUnstructuredMirror(name, namespace, sourceNs, sourceName string) *unstructured.Unstructured {
mirror := &unstructured.Unstructured{}
mirror.SetGroupVersionKind(schema.GroupVersionKind{
Version: "v1",
Kind: "Secret",
})
mirror.SetName(name)
mirror.SetNamespace(namespace)
mirror.SetLabels(map[string]string{
constants.LabelManagedBy: "kubemirror",
constants.LabelMirror: "true",
})
mirror.SetAnnotations(map[string]string{
constants.AnnotationSourceNamespace: sourceNs,
constants.AnnotationSourceName: sourceName,
constants.AnnotationSourceUID: "test-uid",
})
// Set some data
_ = unstructured.SetNestedMap(mirror.Object, map[string]interface{}{
"key": "dmFsdWU=",
}, "data")
return mirror
}
// Mock namespace lister for testing
type mockNamespaceLister struct {
namespaces []string
allowMirrors map[string]bool
optOut map[string]bool
}
func (m *mockNamespaceLister) ListNamespaces(ctx context.Context) ([]string, error) {
return m.namespaces, nil
}
func (m *mockNamespaceLister) ListAllowMirrorsNamespaces(ctx context.Context) ([]string, error) {
var result []string
for ns, allowed := range m.allowMirrors {
if allowed {
result = append(result, ns)
}
}
return result, nil
}
func (m *mockNamespaceLister) ListOptOutNamespaces(ctx context.Context) ([]string, error) {
var result []string
for ns, optedOut := range m.optOut {
if optedOut {
result = append(result, ns)
}
}
return result, nil
}
+254 -67
View File
@@ -15,7 +15,6 @@ import (
ctrl "sigs.k8s.io/controller-runtime" ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder" "sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event" "sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler" "sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log" "sigs.k8s.io/controller-runtime/pkg/log"
@@ -36,6 +35,7 @@ type SourceReconciler struct {
Filter *filter.NamespaceFilter Filter *filter.NamespaceFilter
NamespaceLister NamespaceLister NamespaceLister NamespaceLister
GVK schema.GroupVersionKind // The resource type this reconciler handles GVK schema.GroupVersionKind // The resource type this reconciler handles
APIReader client.Reader // Direct API reader (bypasses cache)
} }
// NamespaceLister provides a list of all namespaces in the cluster. // NamespaceLister provides a list of all namespaces in the cluster.
@@ -43,20 +43,83 @@ type SourceReconciler struct {
type NamespaceLister interface { type NamespaceLister interface {
ListNamespaces(ctx context.Context) ([]string, error) ListNamespaces(ctx context.Context) ([]string, error)
ListAllowMirrorsNamespaces(ctx context.Context) ([]string, error) ListAllowMirrorsNamespaces(ctx context.Context) ([]string, error)
ListOptOutNamespaces(ctx context.Context) ([]string, error)
} }
// +kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch;create;update;patch;delete // +kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=configmaps,verbs=get;list;watch;create;update;patch;delete // +kubebuilder:rbac:groups=core,resources=configmaps,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=namespaces,verbs=get;list;watch // +kubebuilder:rbac:groups=core,resources=namespaces,verbs=get;list;watch
// getSourceWithFreshness fetches a source resource with optional freshness verification.
// This implements a hybrid caching strategy:
// 1. First read from informer cache (fast, local)
// 2. If VerifySourceFreshness is enabled, make direct API call via APIReader
// 3. If resourceVersions differ, cache is stale - return fresh version from API
// 4. If resourceVersions match, cache is current - return cached version
//
// This prevents the race condition where:
// - Watch event arrives: "Secret changed!"
// - Reconciliation starts immediately
// - Cache hasn't updated yet (5-20 second lag)
// - We read stale data and mirror it
//
// Trade-off: 2x API calls when cache is stale, but guarantees data freshness.
func (r *SourceReconciler) getSourceWithFreshness(ctx context.Context, key client.ObjectKey, gvk schema.GroupVersionKind) (*unstructured.Unstructured, error) {
logger := log.FromContext(ctx)
// First try: Read from cache (fast)
cached := &unstructured.Unstructured{}
cached.SetGroupVersionKind(gvk)
if err := r.Get(ctx, key, cached); err != nil {
return nil, err
}
// If freshness verification is disabled, return cached version immediately
if !r.Config.VerifySourceFreshness {
logger.V(2).Info("using cached source (freshness check disabled)", "resourceVersion", cached.GetResourceVersion())
return cached, nil
}
// If APIReader is not available (e.g., in tests), fall back to cached version
if r.APIReader == nil {
logger.V(2).Info("using cached source (no APIReader available)", "resourceVersion", cached.GetResourceVersion())
return cached, nil
}
cachedRV := cached.GetResourceVersion()
// Second try: Direct API read to verify freshness (bypasses cache)
fresh := &unstructured.Unstructured{}
fresh.SetGroupVersionKind(gvk)
if err := r.APIReader.Get(ctx, key, fresh); err != nil {
// If direct API read fails, fall back to cached version
logger.V(1).Info("direct API read failed, using cached version", "error", err, "cachedRV", cachedRV)
return cached, nil
}
freshRV := fresh.GetResourceVersion()
// Compare resource versions
if cachedRV != freshRV {
// Cache is stale - return fresh version from API
logger.V(1).Info("cache stale, using fresh API version",
"cachedRV", cachedRV,
"freshRV", freshRV)
return fresh, nil
}
// Cache is current - return cached version (saves memory allocation)
logger.V(2).Info("cache current", "resourceVersion", cachedRV)
return cached, nil
}
// Reconcile processes a single source resource. // Reconcile processes a single source resource.
func (r *SourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { func (r *SourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx).WithValues("namespace", req.Namespace, "name", req.Name) logger := log.FromContext(ctx).WithValues("namespace", req.Namespace, "name", req.Name)
// Fetch the source resource as unstructured (works for all resource types) // Fetch the source resource with optional freshness verification
source := &unstructured.Unstructured{} source, err := r.getSourceWithFreshness(ctx, req.NamespacedName, r.GVK)
source.SetGroupVersionKind(r.GVK) // Set the GVK so the client knows what to fetch if err != nil {
if err := r.Get(ctx, req.NamespacedName, source); err != nil {
if errors.IsNotFound(err) { if errors.IsNotFound(err) {
// Resource deleted - nothing to do // Resource deleted - nothing to do
return ctrl.Result{}, nil return ctrl.Result{}, nil
@@ -74,25 +137,50 @@ func (r *SourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
} }
// Check if resource is enabled for mirroring // Check if resource is enabled for mirroring
if !isEnabledForMirroring(sourceObj) { // Check if resource is being deleted
// Silently skip - don't log as it would be too noisy if !sourceObj.GetDeletionTimestamp().IsZero() {
return r.handleDisabled(ctx, sourceObj) // Resource is being deleted - clean up mirrors and remove finalizer
if containsString(sourceObj.GetFinalizers(), constants.FinalizerName) {
logger.Info("source being deleted, cleaning up all mirrors")
if err := r.deleteAllMirrors(ctx, sourceObj); err != nil {
logger.Error(err, "failed to delete all mirrors during source deletion")
return ctrl.Result{}, err
}
// Remove finalizer to allow resource deletion
logger.Info("removing finalizer from source resource")
finalizers := removeString(sourceObj.GetFinalizers(), constants.FinalizerName)
sourceObj.SetFinalizers(finalizers)
if err := r.Update(ctx, source); err != nil {
logger.Error(err, "failed to remove finalizer")
return ctrl.Result{}, err
}
logger.Info("finalizer removed, resource can now be deleted")
}
return ctrl.Result{}, nil
} }
// Handle deletion if !isEnabledForMirroring(sourceObj) {
if !sourceObj.GetDeletionTimestamp().IsZero() { // Resource is disabled - remove finalizer if present and delete all mirrors
return r.handleDeletion(ctx, source, sourceObj) if containsString(sourceObj.GetFinalizers(), constants.FinalizerName) {
return r.handleDisabled(ctx, sourceObj)
}
// No finalizer, just skip
return ctrl.Result{}, nil
} }
// Add finalizer if not present // Add finalizer if not present
// source (*unstructured.Unstructured) already implements client.Object if !containsString(sourceObj.GetFinalizers(), constants.FinalizerName) {
if !controllerutil.ContainsFinalizer(source, constants.FinalizerName) { logger.Info("adding finalizer to source resource")
controllerutil.AddFinalizer(source, constants.FinalizerName) finalizers := append(sourceObj.GetFinalizers(), constants.FinalizerName)
sourceObj.SetFinalizers(finalizers)
if err := r.Update(ctx, source); err != nil { if err := r.Update(ctx, source); err != nil {
logger.Error(err, "failed to add finalizer") logger.Error(err, "failed to add finalizer")
return ctrl.Result{}, err return ctrl.Result{}, err
} }
logger.V(1).Info("added finalizer") logger.Info("finalizer added")
// Requeue to continue with reconciliation after finalizer is added
return ctrl.Result{Requeue: true}, nil
} }
// Get target namespaces // Get target namespaces
@@ -120,6 +208,15 @@ func (r *SourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
} }
} }
// Clean up orphaned mirrors (namespaces that no longer match the target criteria)
orphanedCount, err := r.cleanupOrphanedMirrors(ctx, sourceObj, targetNamespaces)
if err != nil {
logger.Error(err, "failed to cleanup orphaned mirrors")
// Don't fail reconciliation for cleanup errors, just log them
} else if orphanedCount > 0 {
logger.Info("cleaned up orphaned mirrors", "count", orphanedCount)
}
// Update status annotation with last sync info // Update status annotation with last sync info
if err := r.updateLastSyncStatus(ctx, source, sourceObj, reconciledCount, errorCount); err != nil { if err := r.updateLastSyncStatus(ctx, source, sourceObj, reconciledCount, errorCount); err != nil {
logger.Error(err, "failed to update sync status") logger.Error(err, "failed to update sync status")
@@ -131,65 +228,40 @@ func (r *SourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
"errors", errorCount, "errors", errorCount,
"total", len(targetNamespaces)) "total", len(targetNamespaces))
// Requeue if there were errors // Return error if there were errors (controller-runtime will automatically requeue with exponential backoff)
if errorCount > 0 { if errorCount > 0 {
return ctrl.Result{Requeue: true}, fmt.Errorf("failed to reconcile %d/%d mirrors", errorCount, len(targetNamespaces)) return ctrl.Result{}, fmt.Errorf("failed to reconcile %d/%d mirrors", errorCount, len(targetNamespaces))
} }
return ctrl.Result{}, nil return ctrl.Result{}, nil
} }
// handleDeletion removes finalizer after cleaning up all mirrors.
func (r *SourceReconciler) handleDeletion(ctx context.Context, source runtime.Object, sourceObj metav1.Object) (ctrl.Result, error) {
logger := log.FromContext(ctx)
// source (*unstructured.Unstructured) already implements client.Object
sourceUnstructured := source.(*unstructured.Unstructured)
if !controllerutil.ContainsFinalizer(sourceUnstructured, constants.FinalizerName) {
return ctrl.Result{}, nil
}
// Delete all mirrors
if err := r.deleteAllMirrors(ctx, sourceObj); err != nil {
logger.Error(err, "failed to delete mirrors")
return ctrl.Result{}, err
}
// Remove finalizer
controllerutil.RemoveFinalizer(sourceUnstructured, constants.FinalizerName)
if err := r.Update(ctx, sourceUnstructured); err != nil {
logger.Error(err, "failed to remove finalizer")
return ctrl.Result{}, err
}
logger.Info("finalizer removed, mirrors deleted")
return ctrl.Result{}, nil
}
// handleDisabled removes mirrors when a resource is disabled. // handleDisabled removes mirrors when a resource is disabled.
func (r *SourceReconciler) handleDisabled(ctx context.Context, sourceObj metav1.Object) (ctrl.Result, error) { func (r *SourceReconciler) handleDisabled(ctx context.Context, sourceObj metav1.Object) (ctrl.Result, error) {
logger := log.FromContext(ctx) logger := log.FromContext(ctx)
// Source is already a client.Object (unstructured implements it) // Delete all mirrors for this disabled source
sourceClient := sourceObj.(client.Object) if err := r.deleteAllMirrors(ctx, sourceObj); err != nil {
logger.Error(err, "failed to delete mirrors for disabled resource")
return ctrl.Result{}, err
}
// If resource has finalizer, clean up mirrors and remove it // Remove finalizer if present
if controllerutil.ContainsFinalizer(sourceClient, constants.FinalizerName) { if containsString(sourceObj.GetFinalizers(), constants.FinalizerName) {
if err := r.deleteAllMirrors(ctx, sourceObj); err != nil { logger.Info("removing finalizer from disabled resource")
logger.Error(err, "failed to delete mirrors for disabled resource") finalizers := removeString(sourceObj.GetFinalizers(), constants.FinalizerName)
return ctrl.Result{}, err sourceObj.SetFinalizers(finalizers)
}
// Remove finalizer // Get the unstructured object to update - sourceObj is already *unstructured.Unstructured
controllerutil.RemoveFinalizer(sourceClient, constants.FinalizerName) source := sourceObj.(*unstructured.Unstructured)
if err := r.Update(ctx, sourceClient); err != nil { if err := r.Update(ctx, source); err != nil {
logger.Error(err, "failed to remove finalizer from disabled resource") logger.Error(err, "failed to remove finalizer from disabled resource")
return ctrl.Result{}, err return ctrl.Result{}, err
} }
logger.V(1).Info("finalizer removed from disabled resource")
logger.Info("mirrors deleted and finalizer removed for disabled resource")
} }
logger.V(1).Info("mirrors deleted for disabled resource")
return ctrl.Result{}, nil return ctrl.Result{}, nil
} }
@@ -207,10 +279,24 @@ func (r *SourceReconciler) reconcileMirror(ctx context.Context, source runtime.O
return fmt.Errorf("failed to get existing mirror: %w", err) return fmt.Errorf("failed to get existing mirror: %w", err)
} }
// If freshness verification is enabled and mirror exists, verify it's fresh too
if err == nil && r.Config.VerifySourceFreshness && r.APIReader != nil {
fresh := &unstructured.Unstructured{}
fresh.SetGroupVersionKind(sourceUnstructured.GroupVersionKind())
if apiErr := r.APIReader.Get(ctx, client.ObjectKey{Namespace: targetNs, Name: sourceObj.GetName()}, fresh); apiErr == nil {
if fresh.GetResourceVersion() != existing.GetResourceVersion() {
logger.V(2).Info("mirror cache stale, using fresh API version",
"cachedRV", existing.GetResourceVersion(),
"freshRV", fresh.GetResourceVersion())
existing = fresh
}
}
}
if err == nil { if err == nil {
// Mirror exists - check if it's managed by us // Mirror exists - check if it's managed by us
if !IsManagedByUs(existing) { if !IsManagedByUs(existing) {
logger.Info("target resource exists but not managed by kubemirror, skipping") logger.V(1).Info("target resource exists but not managed by kubemirror, skipping")
return nil return nil
} }
@@ -221,7 +307,7 @@ func (r *SourceReconciler) reconcileMirror(ctx context.Context, source runtime.O
} }
if !needsSync { if !needsSync {
logger.V(1).Info("mirror is up to date") logger.V(2).Info("mirror is up to date")
return nil return nil
} }
@@ -234,7 +320,7 @@ func (r *SourceReconciler) reconcileMirror(ctx context.Context, source runtime.O
return fmt.Errorf("failed to update mirror in cluster: %w", err) return fmt.Errorf("failed to update mirror in cluster: %w", err)
} }
logger.Info("mirror updated") logger.V(1).Info("mirror updated")
return nil return nil
} }
@@ -248,7 +334,7 @@ func (r *SourceReconciler) reconcileMirror(ctx context.Context, source runtime.O
return fmt.Errorf("failed to create mirror in cluster: %w", err) return fmt.Errorf("failed to create mirror in cluster: %w", err)
} }
logger.Info("mirror created") logger.V(1).Info("mirror created")
return nil return nil
} }
@@ -293,6 +379,81 @@ func (r *SourceReconciler) deleteAllMirrors(ctx context.Context, sourceObj metav
return nil return nil
} }
// cleanupOrphanedMirrors removes mirrors that exist but are no longer in the target list.
// This handles cases where target-namespaces annotation changes (e.g., "all" → "all-labeled" or "app-*" → "prod-*").
func (r *SourceReconciler) cleanupOrphanedMirrors(ctx context.Context, sourceObj metav1.Object, targetNamespaces []string) (int, error) {
logger := log.FromContext(ctx)
// List all namespaces
allNamespaces, err := r.NamespaceLister.ListNamespaces(ctx)
if err != nil {
return 0, fmt.Errorf("failed to list namespaces: %w", err)
}
// Get GVK from source object
sourceUnstructured, ok := sourceObj.(*unstructured.Unstructured)
if !ok {
return 0, fmt.Errorf("source object is not unstructured")
}
// Create a set of target namespaces for quick lookup
targetSet := make(map[string]bool)
for _, ns := range targetNamespaces {
targetSet[ns] = true
}
var deletedCount int
for _, ns := range allNamespaces {
// Skip source namespace
if ns == sourceObj.GetNamespace() {
continue
}
// Skip if this namespace IS in the current target list
if targetSet[ns] {
continue
}
// Check if a mirror exists in this namespace
mirror := &unstructured.Unstructured{}
mirror.SetGroupVersionKind(sourceUnstructured.GroupVersionKind())
mirror.SetNamespace(ns)
mirror.SetName(sourceObj.GetName())
err := r.Get(ctx, client.ObjectKey{Namespace: ns, Name: sourceObj.GetName()}, mirror)
if errors.IsNotFound(err) {
// No mirror exists, nothing to clean up
continue
}
if err != nil {
logger.Error(err, "failed to check for mirror", "namespace", ns)
continue
}
// Verify this is actually our mirror (not someone else's resource with the same name)
if !IsManagedByUs(mirror) {
continue
}
// Verify this mirror points to our source
srcNs, srcName, _, found := GetSourceReference(mirror)
if !found || srcNs != sourceObj.GetNamespace() || srcName != sourceObj.GetName() {
continue
}
// This is an orphaned mirror - delete it
if err := r.Delete(ctx, mirror); err != nil {
logger.Error(err, "failed to delete orphaned mirror", "namespace", ns)
continue
}
deletedCount++
logger.V(1).Info("deleted orphaned mirror", "namespace", ns)
}
return deletedCount, nil
}
// resolveTargetNamespaces determines which namespaces should receive mirrors. // resolveTargetNamespaces determines which namespaces should receive mirrors.
func (r *SourceReconciler) resolveTargetNamespaces(ctx context.Context, sourceObj metav1.Object) ([]string, error) { func (r *SourceReconciler) resolveTargetNamespaces(ctx context.Context, sourceObj metav1.Object) ([]string, error) {
annotations := sourceObj.GetAnnotations() annotations := sourceObj.GetAnnotations()
@@ -323,11 +484,18 @@ func (r *SourceReconciler) resolveTargetNamespaces(ctx context.Context, sourceOb
return nil, fmt.Errorf("failed to list allow-mirrors namespaces: %w", err) return nil, fmt.Errorf("failed to list allow-mirrors namespaces: %w", err)
} }
// Get namespaces that have explicitly opted out (allow-mirrors="false")
optOutNamespaces, err := r.NamespaceLister.ListOptOutNamespaces(ctx)
if err != nil {
return nil, fmt.Errorf("failed to list opt-out namespaces: %w", err)
}
// Resolve target namespaces // Resolve target namespaces
targetNamespaces := filter.ResolveTargetNamespaces( targetNamespaces := filter.ResolveTargetNamespaces(
patterns, patterns,
allNamespaces, allNamespaces,
allowMirrorsNamespaces, allowMirrorsNamespaces,
optOutNamespaces,
sourceObj.GetNamespace(), sourceObj.GetNamespace(),
r.Filter, r.Filter,
) )
@@ -390,12 +558,10 @@ func (r *SourceReconciler) SetupWithManagerForResourceType(
obj := &unstructured.Unstructured{} obj := &unstructured.Unstructured{}
obj.SetGroupVersionKind(gvk) obj.SetGroupVersionKind(gvk)
// Create unique controller name including version to avoid collisions // Create unique controller name including version and group to avoid collisions
// e.g., "HorizontalPodAutoscaler.v1.autoscaling" // e.g., "HorizontalPodAutoscaler.v1.autoscaling" or "Secret.v1." (empty group for core resources)
controllerName := gvk.Kind + "." + gvk.Version // This matches the naming convention used by mirror reconcilers
if gvk.Group != "" { controllerName := gvk.Kind + "." + gvk.Version + "." + gvk.Group
controllerName += "." + gvk.Group
}
// Create mirror object for watching // Create mirror object for watching
mirrorObj := &unstructured.Unstructured{} mirrorObj := &unstructured.Unstructured{}
@@ -444,3 +610,24 @@ func (r *SourceReconciler) mapMirrorToSource(ctx context.Context, obj client.Obj
}, },
} }
} }
// containsString checks if a slice contains a string.
func containsString(slice []string, s string) bool {
for _, item := range slice {
if item == s {
return true
}
}
return false
}
// removeString removes a string from a slice.
func removeString(slice []string, s string) []string {
result := make([]string, 0, len(slice))
for _, item := range slice {
if item != s {
result = append(result, item)
}
}
return result
}
+340
View File
@@ -129,6 +129,11 @@ func (m *MockNamespaceLister) ListAllowMirrorsNamespaces(ctx context.Context) ([
return args.Get(0).([]string), args.Error(1) return args.Get(0).([]string), args.Error(1)
} }
func (m *MockNamespaceLister) ListOptOutNamespaces(ctx context.Context) ([]string, error) {
args := m.Called(ctx)
return args.Get(0).([]string), args.Error(1)
}
func TestIsEnabledForMirroring(t *testing.T) { func TestIsEnabledForMirroring(t *testing.T) {
tests := []struct { tests := []struct {
obj metav1.Object obj metav1.Object
@@ -277,6 +282,7 @@ func TestSourceReconciler_resolveTargetNamespaces(t *testing.T) {
if tt.expectListCalls { if tt.expectListCalls {
mockLister.On("ListNamespaces", mock.Anything).Return(tt.allNamespaces, nil) mockLister.On("ListNamespaces", mock.Anything).Return(tt.allNamespaces, nil)
mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return(tt.allowMirrorsNamespaces, nil) mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return(tt.allowMirrorsNamespaces, nil)
mockLister.On("ListOptOutNamespaces", mock.Anything).Return([]string{}, nil)
} }
r := &SourceReconciler{ r := &SourceReconciler{
@@ -441,6 +447,7 @@ func BenchmarkResolveTargetNamespaces(b *testing.B) {
} }
mockLister.On("ListNamespaces", mock.Anything).Return(allNamespaces, nil) mockLister.On("ListNamespaces", mock.Anything).Return(allNamespaces, nil)
mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return(allNamespaces[:50], nil) mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return(allNamespaces[:50], nil)
mockLister.On("ListOptOutNamespaces", mock.Anything).Return([]string{}, nil)
r := &SourceReconciler{ r := &SourceReconciler{
Config: &config.Config{}, Config: &config.Config{},
@@ -466,3 +473,336 @@ func BenchmarkResolveTargetNamespaces(b *testing.B) {
_, _ = r.resolveTargetNamespaces(ctx, sourceObj) _, _ = r.resolveTargetNamespaces(ctx, sourceObj)
} }
} }
func TestSourceReconciler_cleanupOrphanedMirrors(t *testing.T) {
// Setup: Source in default namespace with mirrors in app-1, app-2, app-3
// Then target-namespaces changes to only app-1, app-2
// Expect: app-3 mirror is deleted (orphaned)
sourceObj := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
"uid": "source-uid-123",
},
},
}
// Mock existing mirror in app-3 (will be orphaned)
orphanedMirror := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "app-3",
"labels": map[string]interface{}{
constants.LabelManagedBy: constants.ControllerName,
constants.LabelMirror: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSourceNamespace: "default",
constants.AnnotationSourceName: "test-secret",
constants.AnnotationSourceUID: "source-uid-123",
},
},
},
}
mockClient := new(MockClient)
mockLister := new(MockNamespaceLister)
// Setup: all namespaces in cluster
allNamespaces := []string{"default", "app-1", "app-2", "app-3", "prod-1"}
mockLister.On("ListNamespaces", mock.Anything).Return(allNamespaces, nil)
// Current target list (after annotation change): only app-1 and app-2
targetNamespaces := []string{"app-1", "app-2"}
// The function will iterate through all namespaces and:
// - Skip "default" (source namespace)
// - Skip "app-1" and "app-2" (in target list)
// - Check "app-3" (not in target list) → will find orphaned mirror
// - Check "prod-1" (not in target list) → no mirror exists
notFoundErr := errors.NewNotFound(schema.GroupResource{Group: "", Resource: "secrets"}, "test-secret")
// app-3: orphaned mirror exists
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "app-3", Name: "test-secret"}, mock.Anything).
Return(nil, orphanedMirror)
// prod-1: no mirror exists
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "prod-1", Name: "test-secret"}, mock.Anything).
Return(notFoundErr, nil)
// Expect delete call for app-3 mirror
mockClient.On("Delete", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
u, ok := obj.(*unstructured.Unstructured)
return ok && u.GetNamespace() == "app-3" && u.GetName() == "test-secret"
}), mock.Anything).Return(nil)
r := &SourceReconciler{
Client: mockClient,
NamespaceLister: mockLister,
}
ctx := context.Background()
deletedCount, err := r.cleanupOrphanedMirrors(ctx, sourceObj, targetNamespaces)
require.NoError(t, err)
assert.Equal(t, 1, deletedCount, "should have deleted 1 orphaned mirror")
mockClient.AssertExpectations(t)
mockLister.AssertExpectations(t)
}
func TestSourceReconciler_Reconcile_AnnotationChange_AllToAllLabeled(t *testing.T) {
// Scenario: annotation changes from "all" → "all-labeled"
// Before: mirrors in all 5 namespaces
// After: mirrors only in labeled namespaces (app-1, app-2)
// Expected: 3 orphaned mirrors deleted (app-3, prod-1, prod-2)
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": "default",
"uid": "source-uid-123",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "all-labeled", // Changed from "all"
},
"finalizers": []interface{}{
constants.FinalizerName,
},
},
"data": map[string]interface{}{
"password": "c2VjcmV0",
},
},
}
// Setup: 5 total namespaces, only 2 have allow-mirrors label
allNamespaces := []string{"default", "app-1", "app-2", "app-3", "prod-1", "prod-2"}
allowMirrorsNamespaces := []string{"app-1", "app-2"}
// Mock existing orphaned mirrors in app-3, prod-1, prod-2
createOrphanedMirror := func(ns string) *unstructured.Unstructured {
return &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "Secret",
"metadata": map[string]interface{}{
"name": "test-secret",
"namespace": ns,
"labels": map[string]interface{}{
constants.LabelManagedBy: constants.ControllerName,
constants.LabelMirror: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSourceNamespace: "default",
constants.AnnotationSourceName: "test-secret",
constants.AnnotationSourceUID: "source-uid-123",
},
},
"data": map[string]interface{}{
"password": "c2VjcmV0",
},
},
}
}
mockClient := new(MockClient)
mockLister := new(MockNamespaceLister)
mockFilter := filter.NewNamespaceFilter(nil, nil)
mockLister.On("ListNamespaces", mock.Anything).Return(allNamespaces, nil)
mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return(allowMirrorsNamespaces, nil)
mockLister.On("ListOptOutNamespaces", mock.Anything).Return([]string{}, nil)
// Mock Get for source
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "default", Name: "test-secret"}, mock.Anything).
Return(nil, source)
// Mock reconcileMirror calls for app-1 and app-2 (current targets)
notFoundErr := errors.NewNotFound(schema.GroupResource{Group: "", Resource: "secrets"}, "test-secret")
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "app-1", Name: "test-secret"}, mock.Anything).
Return(notFoundErr, nil).Once()
mockClient.On("Create", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "app-1"
}), mock.Anything).Return(nil).Once()
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "app-2", Name: "test-secret"}, mock.Anything).
Return(notFoundErr, nil).Once()
mockClient.On("Create", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "app-2"
}), mock.Anything).Return(nil).Once()
// Mock cleanup: check orphaned namespaces app-3, prod-1, prod-2
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "app-3", Name: "test-secret"}, mock.Anything).
Return(nil, createOrphanedMirror("app-3")).Once()
mockClient.On("Delete", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "app-3"
}), mock.Anything).Return(nil).Once()
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "prod-1", Name: "test-secret"}, mock.Anything).
Return(nil, createOrphanedMirror("prod-1")).Once()
mockClient.On("Delete", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "prod-1"
}), mock.Anything).Return(nil).Once()
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "prod-2", Name: "test-secret"}, mock.Anything).
Return(nil, createOrphanedMirror("prod-2")).Once()
mockClient.On("Delete", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "prod-2"
}), mock.Anything).Return(nil).Once()
// Mock Update for status annotation
mockClient.On("Update", mock.Anything, mock.Anything, mock.Anything).Return(nil)
r := &SourceReconciler{
Client: mockClient,
Scheme: runtime.NewScheme(),
Config: &config.Config{},
Filter: mockFilter,
NamespaceLister: mockLister,
GVK: schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Secret"},
}
ctx := context.Background()
req := ctrl.Request{NamespacedName: types.NamespacedName{Namespace: "default", Name: "test-secret"}}
result, err := r.Reconcile(ctx, req)
require.NoError(t, err)
assert.Equal(t, ctrl.Result{}, result)
mockClient.AssertExpectations(t)
mockLister.AssertExpectations(t)
}
func TestSourceReconciler_Reconcile_AnnotationChange_PatternChange(t *testing.T) {
// Scenario: annotation changes from "app-*" → "prod-*"
// Before: mirrors in app-1, app-2, app-3
// After: mirrors in prod-1, prod-2
// Expected: app-1, app-2, app-3 deleted; prod-1, prod-2 created
source := &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "app-config",
"namespace": "default",
"uid": "config-uid-456",
"labels": map[string]interface{}{
constants.LabelEnabled: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSync: "true",
constants.AnnotationTargetNamespaces: "prod-*", // Changed from "app-*"
},
"finalizers": []interface{}{
constants.FinalizerName,
},
},
"data": map[string]interface{}{
"key": "value",
},
},
}
allNamespaces := []string{"default", "app-1", "app-2", "app-3", "prod-1", "prod-2"}
createOrphanedMirror := func(ns string) *unstructured.Unstructured {
return &unstructured.Unstructured{
Object: map[string]interface{}{
"apiVersion": "v1",
"kind": "ConfigMap",
"metadata": map[string]interface{}{
"name": "app-config",
"namespace": ns,
"labels": map[string]interface{}{
constants.LabelManagedBy: constants.ControllerName,
constants.LabelMirror: "true",
},
"annotations": map[string]interface{}{
constants.AnnotationSourceNamespace: "default",
constants.AnnotationSourceName: "app-config",
constants.AnnotationSourceUID: "config-uid-456",
},
},
"data": map[string]interface{}{
"key": "value",
},
},
}
}
mockClient := new(MockClient)
mockLister := new(MockNamespaceLister)
mockFilter := filter.NewNamespaceFilter(nil, nil)
mockLister.On("ListNamespaces", mock.Anything).Return(allNamespaces, nil)
mockLister.On("ListAllowMirrorsNamespaces", mock.Anything).Return([]string{}, nil)
mockLister.On("ListOptOutNamespaces", mock.Anything).Return([]string{}, nil)
// Mock Get for source
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "default", Name: "app-config"}, mock.Anything).
Return(nil, source)
notFoundErr := errors.NewNotFound(schema.GroupResource{Group: "", Resource: "configmaps"}, "app-config")
// Mock reconcileMirror for prod-1 and prod-2 (new targets)
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "prod-1", Name: "app-config"}, mock.Anything).
Return(notFoundErr, nil).Once()
mockClient.On("Create", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "prod-1"
}), mock.Anything).Return(nil).Once()
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: "prod-2", Name: "app-config"}, mock.Anything).
Return(notFoundErr, nil).Once()
mockClient.On("Create", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == "prod-2"
}), mock.Anything).Return(nil).Once()
// Mock cleanup: delete orphaned mirrors in app-1, app-2, app-3
for _, ns := range []string{"app-1", "app-2", "app-3"} {
mockClient.On("Get", mock.Anything, types.NamespacedName{Namespace: ns, Name: "app-config"}, mock.Anything).
Return(nil, createOrphanedMirror(ns)).Once()
mockClient.On("Delete", mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
return obj.GetNamespace() == ns
}), mock.Anything).Return(nil).Once()
}
// Mock Update for status
mockClient.On("Update", mock.Anything, mock.Anything, mock.Anything).Return(nil)
r := &SourceReconciler{
Client: mockClient,
Scheme: runtime.NewScheme(),
Config: &config.Config{},
Filter: mockFilter,
NamespaceLister: mockLister,
GVK: schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMap"},
}
ctx := context.Background()
req := ctrl.Request{NamespacedName: types.NamespacedName{Namespace: "default", Name: "app-config"}}
result, err := r.Reconcile(ctx, req)
require.NoError(t, err)
assert.Equal(t, ctrl.Result{}, result)
mockClient.AssertExpectations(t)
mockLister.AssertExpectations(t)
}
+166 -1
View File
@@ -127,6 +127,7 @@ var deniedKinds = map[string]bool{
"ControllerRevision": true, "ControllerRevision": true,
"PodMetrics": true, "PodMetrics": true,
"NodeMetrics": true, "NodeMetrics": true,
"ReplicaSet": true, // Usually managed by Deployment
// Lease resources (used for leader election) // Lease resources (used for leader election)
"Lease": true, "Lease": true,
@@ -146,7 +147,171 @@ var deniedKinds = map[string]bool{
"APIService": true, "APIService": true,
"ValidatingWebhookConfiguration": true, "ValidatingWebhookConfiguration": true,
"MutatingWebhookConfiguration": true, "MutatingWebhookConfiguration": true,
}
// Storage resources - usually shouldn't be mirrored
"PersistentVolumeClaim": true,
"VolumeSnapshot": true,
"VolumeSnapshotContent": true,
// Longhorn resources - storage controller specific
"Engine": true,
"Replica": true,
"InstanceManager": true,
"ShareManager": true,
"BackingImageManager": true,
"BackingImageDataSource": true,
"Orphan": true,
"RecurringJob": true,
"EngineImage": true,
"BackingImage": true,
"BackupTarget": true,
"BackupVolume": true,
"Setting": true,
// ArgoCD/Argo resources - gitops/workflow specific
"Application": true,
"ApplicationSet": true,
"AppProject": true,
"Workflow": true,
"WorkflowTemplate": true,
"CronWorkflow": true,
"EventSource": true,
"EventBus": true,
"Sensor": true,
"AnalysisRun": true,
"AnalysisTemplate": true,
"Experiment": true,
"Rollout": true,
"WorkflowArtifactGCTask": true,
"WorkflowEventBinding": true,
"WorkflowTaskResult": true,
"WorkflowTaskSet": true,
// Cert-manager resources - certificate operator specific
"Certificate": true,
"CertificateRequest": true,
"Issuer": true,
"ClusterIssuer": true,
// External Secrets resources - secrets operator specific
"ExternalSecret": true,
"SecretStore": true,
"ClusterSecretStore": true,
"PushSecret": true,
// Generator resources
"ACRAccessToken": true,
"CloudsmithAccessToken": true,
"ECRAuthorizationToken": true,
"Fake": true,
"GCRAccessToken": true,
"GeneratorState": true,
"GithubAccessToken": true,
"Grafana": true,
"MFA": true,
"Password": true,
"QuayAccessToken": true,
"SSHKey": true,
"STSSessionToken": true,
"UUID": true,
"VaultDynamicSecret": true,
"Webhook": true,
// Kyverno resources - policy operator specific
"Policy": true,
"ClusterPolicy": true,
"PolicyException": true,
"NamespacedDeletingPolicy": true,
"NamespacedImageValidatingPolicy": true,
"NamespacedValidatingPolicy": true,
"CleanupPolicy": true,
"AdmissionReport": true,
"BackgroundScanReport": true,
"ClusterAdmissionReport": true,
"ClusterBackgroundScanReport": true,
"EphemeralReport": true,
"PolicyReport": true,
"UpdateRequest": true,
// Cilium resources - networking operator specific
"CiliumNetworkPolicy": true,
"CiliumClusterwideNetworkPolicy": true,
"CiliumEndpoint": true,
"CiliumIdentity": true,
"CiliumNode": true,
"CiliumExternalWorkload": true,
"CiliumLocalRedirectPolicy": true,
"CiliumEgressGatewayPolicy": true,
"CiliumGatewayClassConfig": true,
"CiliumNodeConfig": true,
"CiliumEnvoyConfig": true,
"CiliumClusterwideEnvoyConfig": true,
// Traefik Hub resources - API management specific
"API": true,
"APIAccess": true,
"APIAuth": true,
"APIBundle": true,
"APICatalogItem": true,
"APIPlan": true,
"APIPortal": true,
"APIPortalAuth": true,
"APIRateLimit": true,
"APIVersion": true,
"AIService": true,
"ManagedApplication": true,
"ManagedSubscription": true,
// Kong resources - API gateway specific
"KongConsumer": true,
"KongIngress": true,
"KongPlugin": true,
"KongClusterPlugin": true,
"KongUpstreamPolicy": true,
"KongConsumerGroup": true,
"TCPIngress": true,
"UDPIngress": true,
"IngressClassParameters": true,
// System Upgrade Controller
"Plan": true,
// Tor operator resources
"OnionService": true,
"OnionBalancedService": true,
"Tor": true,
// Gateway API resources - usually not mirrored
"Gateway": true,
"GatewayClass": true,
"HTTPRoute": true,
"TLSRoute": true,
"TCPRoute": true,
"UDPRoute": true,
"GRPCRoute": true,
"ReferenceGrant": true,
"BackendTLSPolicy": true,
// VictoriaMetrics operator resources
"VMAgent": true,
"VMAlert": true,
"VMAlertmanager": true,
"VMAlertmanagerConfig": true,
"VMAuth": true,
"VMCluster": true,
"VMNodeScrape": true,
"VMPodScrape": true,
"VMProbe": true,
"VMRule": true,
"VMServiceScrape": true,
"VMSingle": true,
"VMStaticScrape": true,
"VMScrapeConfig": true,
"VMUser": true,
"VMAnomaly": true,
// Jobs and workloads - usually shouldn't be mirrored
"Job": true,
"CronJob": true}
func isDeniedResourceType(kind string) bool { func isDeniedResourceType(kind string) bool {
return deniedKinds[kind] return deniedKinds[kind]
+1 -1
View File
@@ -67,6 +67,7 @@ func TestIsDeniedResourceType(t *testing.T) {
{name: "Lease", kind: "Lease", want: true}, {name: "Lease", kind: "Lease", want: true},
{name: "Namespace", kind: "Namespace", want: true}, {name: "Namespace", kind: "Namespace", want: true},
{name: "ClusterRole", kind: "ClusterRole", want: true}, {name: "ClusterRole", kind: "ClusterRole", want: true},
{name: "Certificate", kind: "Certificate", want: true}, // cert-manager resources are denied
// Should NOT be denied // Should NOT be denied
{name: "Secret", kind: "Secret", want: false}, {name: "Secret", kind: "Secret", want: false},
@@ -76,7 +77,6 @@ func TestIsDeniedResourceType(t *testing.T) {
{name: "Deployment", kind: "Deployment", want: false}, {name: "Deployment", kind: "Deployment", want: false},
{name: "StatefulSet", kind: "StatefulSet", want: false}, {name: "StatefulSet", kind: "StatefulSet", want: false},
{name: "Middleware", kind: "Middleware", want: false}, {name: "Middleware", kind: "Middleware", want: false},
{name: "Certificate", kind: "Certificate", want: false},
} }
for _, tt := range tests { for _, tt := range tests {
+14 -3
View File
@@ -105,6 +105,7 @@ func ParseTargetNamespaces(value string) []string {
// - patterns: namespace patterns from annotation // - patterns: namespace patterns from annotation
// - allNamespaces: list of all namespaces in cluster // - allNamespaces: list of all namespaces in cluster
// - allowMirrorsNamespaces: namespaces with allow-mirrors label // - allowMirrorsNamespaces: namespaces with allow-mirrors label
// - optOutNamespaces: namespaces with allow-mirrors="false" (explicitly opted out)
// - sourceNamespace: exclude this namespace to prevent self-copy // - sourceNamespace: exclude this namespace to prevent self-copy
// - filter: namespace filter for exclusions // - filter: namespace filter for exclusions
// //
@@ -113,6 +114,7 @@ func ResolveTargetNamespaces(
patterns []string, patterns []string,
allNamespaces []string, allNamespaces []string,
allowMirrorsNamespaces []string, allowMirrorsNamespaces []string,
optOutNamespaces []string,
sourceNamespace string, sourceNamespace string,
filter *NamespaceFilter, filter *NamespaceFilter,
) []string { ) []string {
@@ -120,21 +122,30 @@ func ResolveTargetNamespaces(
return nil return nil
} }
// Create map of opt-out namespaces for fast lookup
optOutMap := make(map[string]bool)
for _, ns := range optOutNamespaces {
optOutMap[ns] = true
}
// Use map to deduplicate // Use map to deduplicate
targetMap := make(map[string]bool) targetMap := make(map[string]bool)
for _, pattern := range patterns { for _, pattern := range patterns {
switch pattern { switch pattern {
case constants.TargetNamespacesAll: case constants.TargetNamespacesAll:
// Mirror to all namespaces (except source and excluded) // Mirror to all namespaces (except source, excluded, and opt-out)
// This implements opt-OUT model: namespaces without labels get mirrors
// Only namespaces with allow-mirrors="false" are excluded
for _, ns := range allNamespaces { for _, ns := range allNamespaces {
if ns != sourceNamespace && filter.IsAllowed(ns) { if ns != sourceNamespace && filter.IsAllowed(ns) && !optOutMap[ns] {
targetMap[ns] = true targetMap[ns] = true
} }
} }
case constants.TargetNamespacesAllLabeled: case constants.TargetNamespacesAllLabeled:
// Mirror only to namespaces with allow-mirrors label // Mirror only to namespaces with allow-mirrors="true" label
// This implements opt-IN model
for _, ns := range allowMirrorsNamespaces { for _, ns := range allowMirrorsNamespaces {
if ns != sourceNamespace && filter.IsAllowed(ns) { if ns != sourceNamespace && filter.IsAllowed(ns) {
targetMap[ns] = true targetMap[ns] = true
+7
View File
@@ -318,6 +318,7 @@ func TestResolveTargetNamespaces(t *testing.T) {
tt.patterns, tt.patterns,
tt.allNamespaces, tt.allNamespaces,
tt.allowMirrorsNamespaces, tt.allowMirrorsNamespaces,
[]string{}, // optOutNamespaces - empty for these tests
tt.sourceNamespace, tt.sourceNamespace,
tt.filter, tt.filter,
) )
@@ -342,6 +343,7 @@ func TestResolveTargetNamespaces_EdgeCases(t *testing.T) {
[]string{"all"}, []string{"all"},
[]string{}, []string{},
[]string{}, []string{},
[]string{}, // optOutNamespaces
"default", "default",
NewNamespaceFilter([]string{}, []string{}), NewNamespaceFilter([]string{}, []string{}),
) )
@@ -354,6 +356,7 @@ func TestResolveTargetNamespaces_EdgeCases(t *testing.T) {
[]string{"[invalid"}, []string{"[invalid"},
[]string{"app1"}, []string{"app1"},
[]string{}, []string{},
[]string{}, // optOutNamespaces
"default", "default",
NewNamespaceFilter([]string{}, []string{}), NewNamespaceFilter([]string{}, []string{}),
) )
@@ -366,6 +369,7 @@ func TestResolveTargetNamespaces_EdgeCases(t *testing.T) {
[]string{"all"}, []string{"all"},
[]string{"app1", "app2", "app3"}, []string{"app1", "app2", "app3"},
[]string{}, []string{},
[]string{}, // optOutNamespaces
"default", "default",
strictFilter, strictFilter,
) )
@@ -541,6 +545,7 @@ func BenchmarkResolveTargetNamespaces(b *testing.B) {
tt.patterns, tt.patterns,
allNamespaces, allNamespaces,
allowMirrorsNamespaces, allowMirrorsNamespaces,
[]string{}, // optOutNamespaces
"default", "default",
filter, filter,
) )
@@ -566,6 +571,7 @@ func BenchmarkResolveTargetNamespaces_LargeScale(b *testing.B) {
[]string{constants.TargetNamespacesAll}, []string{constants.TargetNamespacesAll},
allNamespaces, allNamespaces,
allowMirrorsNamespaces, allowMirrorsNamespaces,
[]string{}, // optOutNamespaces
"default", "default",
filter, filter,
) )
@@ -579,6 +585,7 @@ func BenchmarkResolveTargetNamespaces_LargeScale(b *testing.B) {
[]string{"namespace-*"}, []string{"namespace-*"},
allNamespaces, allNamespaces,
allowMirrorsNamespaces, allowMirrorsNamespaces,
[]string{}, // optOutNamespaces
"default", "default",
filter, filter,
) )
+32 -4
View File
@@ -10,6 +10,8 @@ import (
corev1 "k8s.io/api/core/v1" corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
) )
// ComputeContentHash computes a SHA256 hash of the resource's actual content. // ComputeContentHash computes a SHA256 hash of the resource's actual content.
@@ -49,19 +51,37 @@ func extractContent(obj runtime.Object) (interface{}, error) {
// extractSecretContent extracts content from a Secret. // extractSecretContent extracts content from a Secret.
func extractSecretContent(secret *corev1.Secret) map[string]interface{} { func extractSecretContent(secret *corev1.Secret) map[string]interface{} {
return map[string]interface{}{ content := map[string]interface{}{
"type": string(secret.Type), "type": string(secret.Type),
"data": secret.Data, "data": secret.Data,
"stringData": secret.StringData, "stringData": secret.StringData,
} }
// Include transform annotation in hash so changes to transformation rules trigger updates
if secret.Annotations != nil {
if transform, exists := secret.Annotations[constants.AnnotationTransform]; exists {
content["transform"] = transform
}
}
return content
} }
// extractConfigMapContent extracts content from a ConfigMap. // extractConfigMapContent extracts content from a ConfigMap.
func extractConfigMapContent(cm *corev1.ConfigMap) map[string]interface{} { func extractConfigMapContent(cm *corev1.ConfigMap) map[string]interface{} {
return map[string]interface{}{ content := map[string]interface{}{
"data": cm.Data, "data": cm.Data,
"binaryData": cm.BinaryData, "binaryData": cm.BinaryData,
} }
// Include transform annotation in hash so changes to transformation rules trigger updates
if cm.Annotations != nil {
if transform, exists := cm.Annotations[constants.AnnotationTransform]; exists {
content["transform"] = transform
}
}
return content
} }
// extractUnstructuredContent extracts content from an unstructured resource (CRDs, etc.). // extractUnstructuredContent extracts content from an unstructured resource (CRDs, etc.).
@@ -98,6 +118,14 @@ func extractUnstructuredContent(obj runtime.Object) (interface{}, error) {
} }
} }
// Include transform annotation in hash so changes to transformation rules trigger updates
annotations := uCopy.GetAnnotations()
if annotations != nil {
if transform, exists := annotations[constants.AnnotationTransform]; exists {
content["transform"] = transform
}
}
return content, nil return content, nil
} }
@@ -109,7 +137,7 @@ func NeedsSync(source, target runtime.Object, targetAnnotations map[string]strin
// Layer 1: Generation-based check (for resources that support it) // Layer 1: Generation-based check (for resources that support it)
sourceGen := getGeneration(source) sourceGen := getGeneration(source)
if sourceGen > 0 { if sourceGen > 0 {
targetSourceGen := targetAnnotations["source-generation"] targetSourceGen := targetAnnotations[constants.AnnotationSourceGeneration]
if fmt.Sprintf("%d", sourceGen) != targetSourceGen { if fmt.Sprintf("%d", sourceGen) != targetSourceGen {
return true, nil // Generation changed return true, nil // Generation changed
} }
@@ -121,7 +149,7 @@ func NeedsSync(source, target runtime.Object, targetAnnotations map[string]strin
return false, fmt.Errorf("failed to compute source hash: %w", err) return false, fmt.Errorf("failed to compute source hash: %w", err)
} }
targetSourceHash := targetAnnotations["source-content-hash"] targetSourceHash := targetAnnotations[constants.AnnotationSourceContentHash]
if sourceHash != targetSourceHash { if sourceHash != targetSourceHash {
return true, nil // Content changed return true, nil // Content changed
} }
+6 -5
View File
@@ -3,6 +3,7 @@ package hash
import ( import (
"testing" "testing"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1" corev1 "k8s.io/api/core/v1"
@@ -374,8 +375,8 @@ func TestNeedsSync(t *testing.T) {
}, },
target: &unstructured.Unstructured{}, target: &unstructured.Unstructured{},
targetAnnotations: map[string]string{ targetAnnotations: map[string]string{
"source-generation": "3", constants.AnnotationSourceGeneration: "3",
"source-content-hash": "abc123", constants.AnnotationSourceContentHash: "abc123",
}, },
want: true, want: true,
wantError: false, wantError: false,
@@ -387,8 +388,8 @@ func TestNeedsSync(t *testing.T) {
}, },
target: &corev1.Secret{}, target: &corev1.Secret{},
targetAnnotations: map[string]string{ targetAnnotations: map[string]string{
"source-generation": "0", constants.AnnotationSourceGeneration: "0",
"source-content-hash": mustComputeHash(t, &corev1.Secret{Data: map[string][]byte{"key": []byte("value")}}), constants.AnnotationSourceContentHash: mustComputeHash(t, &corev1.Secret{Data: map[string][]byte{"key": []byte("value")}}),
}, },
want: false, want: false,
wantError: false, wantError: false,
@@ -400,7 +401,7 @@ func TestNeedsSync(t *testing.T) {
}, },
target: &corev1.ConfigMap{}, target: &corev1.ConfigMap{},
targetAnnotations: map[string]string{ targetAnnotations: map[string]string{
"source-content-hash": "oldhash", constants.AnnotationSourceContentHash: "oldhash",
}, },
want: true, want: true,
wantError: false, wantError: false,
+42 -10
View File
@@ -3,6 +3,7 @@ package transformer
import ( import (
"bytes" "bytes"
"context" "context"
"encoding/base64"
"fmt" "fmt"
"strings" "strings"
"text/template" "text/template"
@@ -10,14 +11,8 @@ import (
"gopkg.in/yaml.v3" "gopkg.in/yaml.v3"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"
)
const ( "github.com/lukaszraczylo/kubemirror/pkg/constants"
// AnnotationTransform is the annotation key for transformation rules
AnnotationTransform = "kubemirror.raczylo.com/transform"
// AnnotationTransformStrict enables strict mode (errors block mirroring)
AnnotationTransformStrict = "kubemirror.raczylo.com/transform-strict"
) )
// Transformer applies transformation rules to Kubernetes resources. // Transformer applies transformation rules to Kubernetes resources.
@@ -92,7 +87,7 @@ func (t *Transformer) parseTransformRules(u *unstructured.Unstructured) (*Transf
return &TransformRules{}, nil return &TransformRules{}, nil
} }
rulesYAML, exists := annotations[AnnotationTransform] rulesYAML, exists := annotations[constants.AnnotationTransform]
if !exists || rulesYAML == "" { if !exists || rulesYAML == "" {
return &TransformRules{}, nil return &TransformRules{}, nil
} }
@@ -255,7 +250,7 @@ func (t *Transformer) isStrictMode(u *unstructured.Unstructured) bool {
return false return false
} }
strictValue, exists := annotations[AnnotationTransformStrict] strictValue, exists := annotations[constants.AnnotationTransformStrict]
return exists && (strictValue == "true" || strictValue == "1") return exists && (strictValue == "true" || strictValue == "1")
} }
@@ -409,7 +404,20 @@ func setNestedField(obj map[string]interface{}, path []string, value interface{}
return fmt.Errorf("cannot set key %s on non-map %T", finalSegment, current) return fmt.Errorf("cannot set key %s on non-map %T", finalSegment, current)
} }
currentMap[finalSegment] = value // Special handling for Secret data fields
// Secrets require base64-encoded values in .data field
finalValue := value
if isSecretDataField(obj, path) {
// Convert value to string and base64-encode it
strValue, ok := value.(string)
if !ok {
// Try to convert to string
strValue = fmt.Sprintf("%v", value)
}
finalValue = base64Encode(strValue)
}
currentMap[finalSegment] = finalValue
return nil return nil
} }
@@ -512,3 +520,27 @@ func templateFuncs() template.FuncMap {
}, },
} }
} }
// isSecretDataField checks if the path points to a Secret's .data field.
func isSecretDataField(obj map[string]interface{}, path []string) bool {
// Check if this is a Secret by looking at apiVersion and kind
kind, hasKind := obj["kind"]
apiVersion, hasAPI := obj["apiVersion"]
if !hasKind || !hasAPI {
return false
}
// Check if it's a Secret (kind=Secret, apiVersion=v1)
if kind != "Secret" || apiVersion != "v1" {
return false
}
// Check if path starts with "data"
return len(path) >= 1 && path[0] == "data"
}
// base64Encode encodes a string to base64.
func base64Encode(s string) string {
return base64.StdEncoding.EncodeToString([]byte(s))
}
+18 -17
View File
@@ -4,6 +4,7 @@ import (
"fmt" "fmt"
"testing" "testing"
"github.com/lukaszraczylo/kubemirror/pkg/constants"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1" corev1 "k8s.io/api/core/v1"
@@ -30,7 +31,7 @@ func TestTransformer_Transform(t *testing.T) {
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.LOG_LEVEL - path: data.LOG_LEVEL
value: "error" value: "error"
@@ -63,7 +64,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.API_URL - path: data.API_URL
template: "https://{{.TargetNamespace}}.api.example.com" template: "https://{{.TargetNamespace}}.api.example.com"
@@ -93,7 +94,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.NAMESPACE_UPPER - path: data.NAMESPACE_UPPER
template: "{{upper .TargetNamespace}}" template: "{{upper .TargetNamespace}}"
@@ -136,7 +137,7 @@ rules:
"app": "myapp", "app": "myapp",
}, },
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: metadata.labels - path: metadata.labels
merge: merge:
@@ -165,7 +166,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: metadata.labels - path: metadata.labels
merge: merge:
@@ -193,7 +194,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.DEBUG_MODE - path: data.DEBUG_MODE
delete: true delete: true
@@ -227,8 +228,8 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: "invalid: yaml: [[[", constants.AnnotationTransform: "invalid: yaml: [[[",
AnnotationTransformStrict: "true", constants.AnnotationTransformStrict: "true",
}, },
}, },
Data: map[string]string{}, Data: map[string]string{},
@@ -247,11 +248,11 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- value: "something" - value: "something"
`, `,
AnnotationTransformStrict: "true", constants.AnnotationTransformStrict: "true",
}, },
}, },
Data: map[string]string{}, Data: map[string]string{},
@@ -273,8 +274,8 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: rules, constants.AnnotationTransform: rules,
AnnotationTransformStrict: "true", constants.AnnotationTransformStrict: "true",
}, },
}, },
Data: map[string]string{}, Data: map[string]string{},
@@ -319,7 +320,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: "invalid yaml [[[", constants.AnnotationTransform: "invalid yaml [[[",
}, },
}, },
Data: map[string]string{ Data: map[string]string{
@@ -347,7 +348,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.KEY1 - path: data.KEY1
value: "first" value: "first"
@@ -402,7 +403,7 @@ rules:
"name": "test-pod", "name": "test-pod",
"namespace": "default", "namespace": "default",
"annotations": map[string]interface{}{ "annotations": map[string]interface{}{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: spec.containers[0].image - path: spec.containers[0].image
template: "registry.{{.TargetNamespace}}.example.com/app:v1" template: "registry.{{.TargetNamespace}}.example.com/app:v1"
@@ -457,7 +458,7 @@ rules:
Name: "test-config", Name: "test-config",
Namespace: "default", Namespace: "default",
Annotations: map[string]string{ Annotations: map[string]string{
AnnotationTransform: ` constants.AnnotationTransform: `
rules: rules:
- path: data.VALUE - path: data.VALUE
template: "{{.TargetNamespace}}-empty" template: "{{.TargetNamespace}}-empty"
@@ -1336,7 +1337,7 @@ rules:
"name": "test-config", "name": "test-config",
"namespace": "source-namespace", "namespace": "source-namespace",
"annotations": map[string]interface{}{ "annotations": map[string]interface{}{
AnnotationTransform: tt.rules, constants.AnnotationTransform: tt.rules,
}, },
}, },
}, },