admin
1bc8aadb85
- Streamlined README focused on quick start - Complete examples for all major use cases - Decision tree for choosing right pattern - Comprehensive troubleshooting guide
112 lines
4.1 KiB
Markdown
112 lines
4.1 KiB
Markdown
# ManagedSecret Operator - Documentation Index
|
|
|
|
Quick navigation for the ManagedSecret Operator documentation and examples.
|
|
|
|
## 📖 Main Documentation
|
|
|
|
**[README.md](./README.md)** - Start here!
|
|
- Installation guide
|
|
- Quick start
|
|
- Basic usage examples
|
|
- Troubleshooting
|
|
- Best practices
|
|
|
|
## 📚 Examples
|
|
|
|
**[examples/EXAMPLES-SUMMARY.md](./examples/EXAMPLES-SUMMARY.md)** - Overview of all examples
|
|
- Use case descriptions
|
|
- Decision tree for choosing the right pattern
|
|
- Quick comparison table
|
|
|
|
### Individual Examples
|
|
|
|
1. **[example-1-no-rotation.yaml](./examples/example-1-no-rotation.yaml)**
|
|
- Simple API key without rotation
|
|
- Perfect for: Third-party API keys, static service identifiers
|
|
|
|
2. **[example-2-registry-rotation-simple.yaml](./examples/example-2-registry-rotation-simple.yaml)**
|
|
- Container registry with basic rotation
|
|
- Perfect for: Docker Registry, Harbor, web servers with htpasswd
|
|
|
|
3. **[example-3-postgres-rotation-previous.yaml](./examples/example-3-postgres-rotation-previous.yaml)**
|
|
- PostgreSQL with zero-downtime rotation
|
|
- Perfect for: PostgreSQL, any service needing old password to authenticate
|
|
|
|
4. **[example-4-minio-rotation-previous.yaml](./examples/example-4-minio-rotation-previous.yaml)**
|
|
- MinIO object storage with rotation
|
|
- Perfect for: MinIO, services not auto-reloading credentials
|
|
|
|
5. **[example-5-mysql-rotation-previous.yaml](./examples/example-5-mysql-rotation-previous.yaml)**
|
|
- MySQL with multiple rotation strategies
|
|
- Perfect for: MySQL, MariaDB, MySQL-compatible databases
|
|
|
|
6. **[example-6-comprehensive-multi-service.yaml](./examples/example-6-comprehensive-multi-service.yaml)**
|
|
- Complete application stack
|
|
- Perfect for: Understanding how different strategies work together
|
|
|
|
## 🎯 Quick Links by Use Case
|
|
|
|
### I need to store a secret that never changes
|
|
→ [Example 1: No Rotation](./examples/example-1-no-rotation.yaml)
|
|
|
|
### I need to rotate credentials automatically
|
|
→ [Example 2: Simple Rotation](./examples/example-2-registry-rotation-simple.yaml)
|
|
|
|
### My service needs the old password to change passwords
|
|
→ [Example 3: PostgreSQL](./examples/example-3-postgres-rotation-previous.yaml)
|
|
→ [Example 4: MinIO](./examples/example-4-minio-rotation-previous.yaml)
|
|
→ [Example 5: MySQL](./examples/example-5-mysql-rotation-previous.yaml)
|
|
|
|
### I have a complex multi-service application
|
|
→ [Example 6: Multi-Service](./examples/example-6-comprehensive-multi-service.yaml)
|
|
|
|
## 🚀 Getting Started Path
|
|
|
|
1. Read [README.md](./README.md) - Installation & Quick Start
|
|
2. Review [examples/EXAMPLES-SUMMARY.md](./examples/EXAMPLES-SUMMARY.md) - Understand patterns
|
|
3. Pick the example closest to your use case
|
|
4. Adapt and deploy!
|
|
|
|
## 🔧 Common Tasks
|
|
|
|
### Install the operator
|
|
→ [README.md - Installation Steps](./README.md#installation-steps)
|
|
|
|
### Create your first secret
|
|
→ [README.md - Usage](./README.md#usage)
|
|
|
|
### Understand rotation
|
|
→ [README.md - Secret Rotation](./README.md#secret-rotation)
|
|
|
|
### Troubleshoot issues
|
|
→ [README.md - Troubleshooting](./README.md#troubleshooting)
|
|
|
|
### Set up for production
|
|
→ [README.md - Best Practices](./README.md#best-practices)
|
|
|
|
## 📦 Repository Structure
|
|
|
|
```
|
|
managedsecret-operator/
|
|
├── README.md # Main documentation
|
|
├── INDEX.md # This file
|
|
└── examples/
|
|
├── EXAMPLES-SUMMARY.md # Examples overview
|
|
├── example-1-no-rotation.yaml
|
|
├── example-2-registry-rotation-simple.yaml
|
|
├── example-3-postgres-rotation-previous.yaml
|
|
├── example-4-minio-rotation-previous.yaml
|
|
├── example-5-mysql-rotation-previous.yaml
|
|
└── example-6-comprehensive-multi-service.yaml
|
|
```
|
|
|
|
## 📞 Need Help?
|
|
|
|
1. Check [README.md - Troubleshooting](./README.md#troubleshooting)
|
|
2. Review the examples for similar use cases
|
|
3. Contact your administrator for registry/Vault setup issues
|
|
|
|
---
|
|
|
|
**Version:** 1.0.7
|
|
**Registry:** registry.c5ai.ch/charts/managedsecret-operator |