Flamingock library configuration
Flamingock provides flexible configuration options to support a variety of environments and workflows — from local setups to cloud-native distributed systems.
Configuration is divided into two distinct scopes:
-
Setup configuration defines how Flamingock discovers and organizes change units. This is configured using the
@Flamingock
annotation. -
Runtime configuration includes optional parameters such as locking, metadata, author, etc., and can be provided via builder or (depending on the environment) a file.
What you can configure
Area | Description | Link |
---|---|---|
⭐ Setup & stages | Organize changes into ordered stages - Essential | Setup & stages |
⭐ Target systems | Configure target systems for your changes - Essential | Target systems |
⭐ Audit store | Configure audit storage - Essential | Audit stores |
Global dependency injection | Dependency injection to Changes and environment | Context and dependencies |
Cloud Edition | Cloud-specific setup: token, env, service | Cloud Edition |
Framework integration | Integration with frameworks (currently Spring Boot) | Spring Boot integration |
Lock | Distributed locking and timing options | Lock configuration |
Extra | Metadata, default author, enable/disable | Additional configuration |
Each of these topics is explained in its own section.
Applying runtime configuration
Runtime configuration (everything except the pipeline) can be applied in the following ways:
Runtime environment | Builder | File |
---|---|---|
Standalone | ✅ | ❌ (coming soon) |
Springboot | ✅ | ✅(framework native) |
You can combine both approaches. If a property is defined in both, the builder value takes precedence.
Next steps
Start with the essential configurations marked with ⭐, then explore additional options based on your needs:
Essential configurations (start here)
- ⭐ Setup & stages - Define how changes are organized and discovered
- ⭐ Target systems - Configure systems where changes will be applied
- ⭐ Audit stores - Set up audit storage (not needed for Cloud Edition)
Additional configurations
- Global dependency injection - Configure dependency resolution
- Framework integration - Spring Boot integration
- Lock configuration - Distributed locking options
- Additional configuration - Metadata, author, and other settings
Choose your edition
- ☁️ Cloud Edition - Fully-featured managed solution
- 🧪 Community Edition - Community audit stores (feature-limited)