|
| 1 | +# pgskipper-operator Examples |
| 2 | + |
| 3 | +This directory contains example projects demonstrating various use cases for pgskipper-operator. |
| 4 | + |
| 5 | +## Available Examples |
| 6 | + |
| 7 | +### [Spring Boot Failover Testing](spring-boot-failover-test/) |
| 8 | + |
| 9 | +A comprehensive testing environment to reproduce and analyze PostgreSQL failover behavior with Spring Boot applications using HikariCP connection pooling. |
| 10 | + |
| 11 | +**Features:** |
| 12 | +- PostgreSQL HA cluster with automatic failover |
| 13 | +- Spring Boot application with connection monitoring |
| 14 | +- Failover testing scripts |
| 15 | +- Detailed metrics and monitoring |
| 16 | +- HikariCP connection pool optimization |
| 17 | + |
| 18 | +**Use Cases:** |
| 19 | +- Testing application behavior during database failover |
| 20 | +- Validating connection pool configurations |
| 21 | +- Analyzing reconnection patterns and timing |
| 22 | +- Developing failover-resilient applications |
| 23 | + |
| 24 | +**Quick Start:** |
| 25 | +```bash |
| 26 | +cd spring-boot-failover-test |
| 27 | +helmfile sync |
| 28 | +``` |
| 29 | + |
| 30 | +See the [full documentation](spring-boot-failover-test/README.md) for detailed instructions. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Contributing Examples |
| 35 | + |
| 36 | +If you have an example demonstrating a specific use case for pgskipper-operator, please feel free to contribute it! Each example should include: |
| 37 | + |
| 38 | +1. **README.md** - Clear documentation with prerequisites, setup instructions, and usage |
| 39 | +2. **helmfile.yaml** or deployment manifests - Reproducible deployment configuration |
| 40 | +3. **Application code** - If applicable, well-documented source code |
| 41 | +4. **.gitignore** - To exclude build artifacts and sensitive data |
| 42 | + |
| 43 | +## Support |
| 44 | + |
| 45 | +For issues or questions about these examples: |
| 46 | +- Check the individual example's documentation |
| 47 | +- Review the main [pgskipper-operator documentation](../../README.md) |
| 48 | +- Open an issue in the [GitHub repository](https://github.com/Netcracker/pgskipper-operator/issues) |
0 commit comments