Skip to content

Commit 901d23a

Browse files
authored
docs: sync documentation to wiki (#24)
1 parent b684a4f commit 901d23a

5 files changed

Lines changed: 1236 additions & 116 deletions

File tree

wiki/Documentation-Index.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ This directory contains comprehensive documentation for the DevStack Core projec
6969
- Performance metrics and security validation
7070
- Production readiness assessment
7171

72+
- **[NEW_TESTS_SUMMARY.md](./NEW_TESTS_SUMMARY.md)** - Extended test suite summary
73+
- New test suites added to the project
74+
- Coverage of Vault, PostgreSQL, PgBouncer, Observability
75+
- 40+ new test cases across 4 suites
76+
- Test statistics and implementation details
77+
7278
### Architecture & Design
7379

7480
- **[ARCHITECTURE.md](./ARCHITECTURE.md)** - Complete architecture deep-dive
@@ -188,7 +194,7 @@ This directory contains comprehensive documentation for the DevStack Core projec
188194

189195
### API Development Patterns
190196

191-
- **[../reference-apps/API_PATTERNS.md](../reference-apps/API_PATTERNS.md)** - API design patterns
197+
- **[.API-Patterns](.API-Patterns)** - API design patterns
192198
- Code-first vs API-first development
193199
- Pattern implementations
194200
- Synchronization strategies
@@ -206,21 +212,21 @@ This directory contains comprehensive documentation for the DevStack Core projec
206212

207213
Located in the project root and `.github/`:
208214
- [README.md](../README.md) - Main project documentation
209-
- [CONTRIBUTING.md](../.github/CONTRIBUTING.md) - Contribution guidelines
210-
- [SECURITY.md](../.github/SECURITY.md) - Security policy and reporting
215+
- [CONTRIBUTING.md](../Contributing-Guide) - Contribution guidelines
216+
- [SECURITY.md](../Secrets-Rotation) - Security policy and reporting
211217
- [CODE_OF_CONDUCT.md](../.github/CODE_OF_CONDUCT.md) - Community standards
212-
- [CHANGELOG.md](../.github/CHANGELOG.md) - Version history
218+
- [CHANGELOG.md](../Changelog) - Version history
213219

214220
### Component Documentation
215221

216222
- **Reference Applications**
217-
- [Reference Apps Overview](../reference-apps/README.md)
223+
- [Reference Apps Overview](.Development-Workflow)
218224
- [FastAPI Code-First](../reference-apps/fastapi/README.md)
219225
- [FastAPI API-First](../reference-apps/fastapi-api-first/README.md)
220226
- [Go Reference API](../reference-apps/golang/README.md)
221227
- [Node.js Reference API](../reference-apps/nodejs/README.md)
222228
- [Rust Reference API](../reference-apps/rust/README.md)
223-
- [API Patterns](../reference-apps/API_PATTERNS.md)
229+
- [API Patterns](.API-Patterns)
224230

225231
- **Testing Infrastructure**
226232
- [Tests Overview](../tests/README.md)
@@ -268,14 +274,14 @@ Core documentation files are automatically synced from `docs/` to `wiki/` direct
268274
- `docs/ARCHITECTURE.md``wiki/Architecture-Overview.md`
269275
- `docs/SERVICE_CATALOG.md``wiki/Service-Catalog.md`
270276
- `README.md``wiki/Home.md`
271-
- `.github/CHANGELOG.md``wiki/Changelog.md`
277+
- `Changelog``wiki/Changelog.md`
272278
- And other core documentation files
273279

274280
**Important:** Always update the source file in `docs/`, not the wiki copy. Changes only reach `main` via merged PRs, which trigger the wiki sync workflow.
275281

276282
## Contributing to Documentation
277283

278-
See [CONTRIBUTING.md](../.github/CONTRIBUTING.md) for guidelines on:
284+
See [CONTRIBUTING.md](../Contributing-Guide) for guidelines on:
279285
- Documentation style guide
280286
- Review process
281287
- Testing documentation changes
@@ -341,13 +347,13 @@ See [CONTRIBUTING.md](../.github/CONTRIBUTING.md) for guidelines on:
341347

342348
- **Monthly:** Review for accuracy
343349
- **Quarterly:** Update test results
344-
- **Per Release:** Update .github/CHANGELOG.md
350+
- **Per Release:** Update Changelog
345351
- **As Needed:** Security documentation
346352

347353
## Need Help?
348354

349355
- 📖 Start with [README.md](../README.md)
350-
- 🔒 Security questions? See [SECURITY.md](../.github/SECURITY.md)
356+
- 🔒 Security questions? See [SECURITY.md](../Secrets-Rotation)
351357
- 🧪 Testing questions? See [tests/README.md](../tests/README.md)
352-
- 🚀 API questions? See [reference-apps/README.md](../reference-apps/README.md)
353-
- 🤝 Want to contribute? See [CONTRIBUTING.md](../.github/CONTRIBUTING.md)
358+
- 🚀 API questions? See [reference-apps/README.md](.Development-Workflow)
359+
- 🤝 Want to contribute? See [CONTRIBUTING.md](../Contributing-Guide)

wiki/Home.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ A comprehensive, self-contained development environment providing Git hosting (F
1414
## ✨ Key Features
1515

1616
- **🚀 [Complete Infrastructure](#️-architecture)** - Everything you need: Git, databases, caching, messaging, secrets, observability
17-
- **🎯 [Service Profiles](./docs/SERVICE_PROFILES.md)** - Choose your stack: minimal (2GB), standard (4GB), or full (6GB) with observability
17+
- **🎯 [Service Profiles](Service-Configuration)** - Choose your stack: minimal (2GB), standard (4GB), or full (6GB) with observability
1818
- **🍎 [Apple Silicon Optimized](#-prerequisites)** - Native ARM64 support via Colima's Virtualization.framework
19-
- **🔒 [Vault-First Security](./docs/VAULT.md)** - All credentials managed by HashiCorp Vault with AppRole authentication
19+
- **🔒 [Vault-First Security](Vault-Integration)** - All credentials managed by HashiCorp Vault with AppRole authentication
2020
- **🛡️ [AppRole Authentication](#-security--approle-authentication)** - Zero hardcoded secrets, least-privilege access for all core services
2121
- **🔐 [TLS/SSL Support](./docs/TLS_CERTIFICATE_MANAGEMENT.md)** - Dual-mode TLS with automated certificate generation via Vault PKI
2222
- **📦 [Zero Cloud Dependencies](#-zero-cloud-dependencies)** - Runs entirely on your Mac, perfect for offline development
23-
- **🛠️ [Easy Management](./docs/PYTHON_MANAGEMENT_SCRIPT.md)** - Single CLI script with 21 commands for all operations
24-
- **📚 [Reference Apps](./reference-apps/README.md)** - Production-quality examples in Python, Go, Node.js, TypeScript, and Rust
25-
- **🔍 [Full Observability](./docs/OBSERVABILITY.md)** - Built-in Prometheus, Grafana, and Loki for monitoring and logging
23+
- **🛠️ [Easy Management](CLI-Reference)** - Single CLI script with 21 commands for all operations
24+
- **📚 [Reference Apps](Development-Workflow)** - Production-quality examples in Python, Go, Node.js, TypeScript, and Rust
25+
- **🔍 [Full Observability](Health-Monitoring)** - Built-in Prometheus, Grafana, and Loki for monitoring and logging
2626

2727
## 🚀 Quick Start
2828

@@ -109,7 +109,7 @@ Choose the profile that fits your needs:
109109
./devstack health
110110
```
111111

112-
**See [Service Profiles Guide](./docs/SERVICE_PROFILES.md) for detailed information.**
112+
**See [Service Profiles Guide](Service-Configuration) for detailed information.**
113113

114114
## 🛡️ Security & AppRole Authentication
115115

@@ -170,7 +170,7 @@ curl -X POST $VAULT_ADDR/v1/auth/approle/login \
170170
# 6. Start service with fetched credentials
171171
```
172172

173-
**See [Vault Integration Guide](./docs/VAULT.md) for complete details.**
173+
**See [Vault Integration Guide](Vault-Integration) for complete details.**
174174

175175
## 🏗️ Architecture
176176

@@ -217,13 +217,13 @@ All reference apps demonstrate:
217217
- Health checks and metrics
218218
- TLS/SSL support
219219

220-
**See [Reference Apps Overview](./reference-apps/README.md) for details.**
220+
**See [Reference Apps Overview](Development-Workflow) for details.**
221221

222222
## 💻 Usage
223223

224224
### Management Commands
225225

226-
The `devstack` script provides all essential operations:
226+
The `manage-devstack` script provides all essential operations:
227227

228228
```bash
229229
# Service management
@@ -391,40 +391,40 @@ DevStack Core is optimized for **local development** while maintaining patterns
391391
## 📚 Documentation
392392

393393
### Getting Started
394-
- **[Installation Guide](./docs/INSTALLATION.md)** - Comprehensive setup with troubleshooting
395-
- **[Quick Start Tutorial](./docs/USAGE.md)** - Step-by-step usage guide
396-
- **[Service Profiles](./docs/SERVICE_PROFILES.md)** - Profile selection and configuration
394+
- **[Installation Guide](Installation)** - Comprehensive setup with troubleshooting
395+
- **[Quick Start Tutorial](Quick-Start-Guide)** - Step-by-step usage guide
396+
- **[Service Profiles](Service-Configuration)** - Profile selection and configuration
397397

398398
### Core Documentation
399-
- **[Architecture Overview](./docs/ARCHITECTURE.md)** - System design with diagrams
400-
- **[Services Guide](./docs/SERVICES.md)** - Detailed service configurations
401-
- **[Management Script](./docs/MANAGEMENT.md)** - Complete CLI reference
402-
- **[Python CLI Guide](./docs/PYTHON_MANAGEMENT_SCRIPT.md)** - Modern Python CLI documentation
399+
- **[Architecture Overview](Architecture-Overview)** - System design with diagrams
400+
- **[Services Guide](Service-Overview)** - Detailed service configurations
401+
- **[Management Script](Management-Commands)** - Complete CLI reference
402+
- **[Python CLI Guide](CLI-Reference)** - Modern Python CLI documentation
403403

404404
### Infrastructure
405-
- **[Vault Integration](./docs/VAULT.md)** - PKI setup and secrets management
406-
- **[Redis Cluster](./docs/REDIS.md)** - Cluster architecture and operations
407-
- **[Observability Stack](./docs/OBSERVABILITY.md)** - Prometheus, Grafana, Loki setup
405+
- **[Vault Integration](Vault-Integration)** - PKI setup and secrets management
406+
- **[Redis Cluster](Redis-Cluster)** - Cluster architecture and operations
407+
- **[Observability Stack](Health-Monitoring)** - Prometheus, Grafana, Loki setup
408408

409409
### Development
410-
- **[Reference Apps Overview](./reference-apps/README.md)** - Multi-language examples
411-
- **[Best Practices](./docs/BEST_PRACTICES.md)** - Development patterns
410+
- **[Reference Apps Overview](Development-Workflow)** - Multi-language examples
411+
- **[Best Practices](Best-Practices)** - Development patterns
412412
- **[Testing Guide](./tests/README.md)** - Testing infrastructure
413413
- **[Test Coverage](./tests/TEST_COVERAGE.md)** - Coverage metrics (571+ tests across 4 test suites)
414-
- **[Testing Approach](./docs/TESTING_APPROACH.md)** - Best practices for running tests
414+
- **[Testing Approach](Testing-Guide)** - Best practices for running tests
415415
- **[Task 2.1 Testing](./docs/.private/TASK_2.1_TESTING.md)** - Backup system test suite (63 tests)
416416

417417
### Operations
418-
- **[Troubleshooting](./docs/TROUBLESHOOTING.md)** - Common issues and solutions
419-
- **[Performance Tuning](./docs/PERFORMANCE_TUNING.md)** - Optimization strategies
420-
- **[Disaster Recovery](./docs/DISASTER_RECOVERY.md)** - Backup and restore procedures
421-
- **[Security Assessment](./docs/SECURITY_ASSESSMENT.md)** - Security hardening
418+
- **[Troubleshooting](Common-Issues)** - Common issues and solutions
419+
- **[Performance Tuning](Debugging-Techniques)** - Optimization strategies
420+
- **[Disaster Recovery](Disaster-Recovery)** - Backup and restore procedures
421+
- **[Security Assessment](Certificate-Management)** - Security hardening
422422

423423
### Project
424-
- **[FAQ](./docs/FAQ.md)** - Frequently asked questions
425-
- **[Changelog](./.github/CHANGELOG.md)** - Version history
426-
- **[Contributing](./.github/CONTRIBUTING.md)** - Contribution guidelines
427-
- **[Security Policy](./.github/SECURITY.md)** - Security reporting
424+
- **[FAQ](FAQ)** - Frequently asked questions
425+
- **[Changelog](./Changelog)** - Version history
426+
- **[Contributing](./Contributing-Guide)** - Contribution guidelines
427+
- **[Security Policy](./Secrets-Rotation)** - Security reporting
428428

429429
## 🤝 Contributing
430430

@@ -446,7 +446,7 @@ We welcome contributions! Here's how to get started:
446446
- Use conventional commit messages
447447
- Ensure CI/CD checks pass
448448

449-
**See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for detailed guidelines.**
449+
**See [CONTRIBUTING.md](./Contributing-Guide) for detailed guidelines.**
450450

451451
## 🐛 Issues and Support
452452

@@ -457,8 +457,8 @@ We welcome contributions! Here's how to get started:
457457
- System information (OS, Colima version, etc.)
458458

459459
**Need help?**
460-
1. Check the [FAQ](./docs/FAQ.md)
461-
2. Review [Troubleshooting Guide](./docs/TROUBLESHOOTING.md)
460+
1. Check the [FAQ](FAQ)
461+
2. Review [Troubleshooting Guide](Common-Issues)
462462
3. Search [existing issues](https://github.com/NormB/devstack-core/issues)
463463
4. Ask in [Discussions](https://github.com/NormB/devstack-core/discussions)
464464

@@ -485,7 +485,7 @@ Built with excellent open-source software:
485485
- [Prometheus](https://prometheus.io/) - Monitoring system
486486
- [Grafana](https://grafana.com/) - Observability platform
487487

488-
**See complete list:** [ACKNOWLEDGEMENTS.md](./docs/ACKNOWLEDGEMENTS.md)
488+
**See complete list:** [ACKNOWLEDGEMENTS.md](Acknowledgements)
489489

490490
---
491491

wiki/Installation.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -737,9 +737,31 @@ tail -5 .env
737737

738738
**What Just Happened:**
739739
1. **Vault configured** a secrets storage system
740-
2. **25-character random passwords** generated for each service
741-
3. **Passwords stored securely** in Vault (not in plain text files)
742-
4. **TLS certificate system** set up (for HTTPS connections)
740+
2. **AppRole authentication enabled** - Each service gets its own role-id and secret-id
741+
3. **Service policies created** - PostgreSQL, MySQL, MongoDB, Redis, RabbitMQ, Forgejo
742+
4. **AppRole credentials stored** in `~/.config/vault/approles/<service>/role-id` and `secret-id`
743+
5. **25-character random passwords** generated for each service
744+
6. **Passwords stored securely** in Vault (not in plain text files)
745+
7. **TLS certificate system** set up (for HTTPS connections)
746+
747+
**AppRole Authentication:**
748+
- **role-id**: Identifies which service is connecting (like a username)
749+
- **secret-id**: Proves the service is authorized (like a password)
750+
- **Service tokens**: Short-lived (1 hour) tokens generated from AppRole login
751+
- **Least privilege**: Each service can only access its own credentials
752+
753+
**Where Credentials Are Stored:**
754+
```
755+
~/.config/vault/
756+
├── approles/
757+
│ ├── postgres/role-id # PostgreSQL AppRole credentials
758+
│ ├── postgres/secret-id
759+
│ ├── mysql/role-id # MySQL AppRole credentials
760+
│ ├── mysql/secret-id
761+
│ └── ... # (7 services total with AppRole)
762+
├── ca/ # TLS certificates
763+
└── root-token # Vault root token (for management)
764+
```
743765

744766
**7.2 Restart Services to Load Credentials:**
745767

0 commit comments

Comments
 (0)