vault-sync-operator

Vault Sync Operator Documentation

This directory contains detailed documentation for the Vault Sync Operator.

Documents

Project Summary

Complete development summary including architecture, features, and implementation details.

Multi-Cluster Deployment Guide

Comprehensive guide for deploying the operator across multiple Kubernetes clusters with shared Vault infrastructure.

Secret Rotation Detection

Intelligent detection and handling of Kubernetes secret changes to optimize performance and reduce Vault load.

Performance Optimizations

Rate limiting, batch operations, and memory optimization features for high-scale deployments.

CI/CD Pipeline

Complete guide to the GitHub Actions CI/CD pipeline for automated testing, building, and releasing.

Architecture Overview

The Vault Sync Operator follows standard Kubernetes operator patterns:

┌─────────────────────────────────────────────────────────────┐
│                    Kubernetes Cluster                       │
│                                                             │
│  ┌─────────────────┐    ┌─────────────────┐                │
│  │   Deployment    │    │     Secret      │                │
│  │   with Vault    │    │   with Vault    │                │
│  │   Annotations   │    │   Annotations   │                │
│  └─────────────────┘    └─────────────────┘                │
│           │                       │                        │
│           │       watches         │                        │
│           └───────────┼───────────┘                        │
│                       │                                    │
│           ┌─────────────────┐                              │
│           │  Vault Sync     │                              │
│           │  Operator       │                              │
│           └─────────────────┘                              │
│                       │                                    │
└───────────────────────┼────────────────────────────────────┘
                        │
            ┌─────────────────┐
            │  HashiCorp      │
            │  Vault Server   │
            └─────────────────┘

The operator watches both Deployments and Secrets with vault-sync.io/path annotations and syncs referenced secret data to Vault using Kubernetes authentication.