Skip to content

structure-old.md

Latest commit

 

History

History
70 lines (55 loc) · 2.33 KB

structure-old.md

File metadata and controls

70 lines (55 loc) · 2.33 KB

Introduction

  • Overview: Brief introduction to Flamingock, its evolution from Mongock, and its cloud-native focus.
  • Key Features: Highlight the most important features (Auditing & Rollback, Cloud-Native, Extended System Support, etc.).
  • Use Cases: Practical examples of where Flamingock can be applied (e.g., database versioning, configuration management, etc.).

Concepts

  • Change Units & Auditing: Explanation of how Flamingock handles changes and versions across systems.
  • Runner: Explain the runner.
  • Driver: Explain Driver
  • Cloud: Explain cloud mechanism
  • Rollback: Detailed explanation of auditing features and rollback mechanisms, including how to query and restore previous states.
  • Workflows and stages: Overview of Flamingock's advanced workflow management, including sequential, parallel, and combined workflows, and stages
  • Template: Explanation of templates.
  • Distributed Locking: How Flamingock handles synchronization and locking in distributed environments. Etc.

Getting Started

  • Installation: Guide for setting up Flamingock cloud and client, including both cloud and fallback local driver options.
  • Quick Start Guide: A hands-on tutorial for quickly integrating Flamingock into an existing project or system.
  • Configuration: Configuration options for setting up Flamingock, including environment variables and default settings.

Architectural overview

  • Provide the architectural overview with the cloud integration
  • Transaction Handling: How transactions are managed to ensure data integrity in the cloud.
  • Maybe, showing with a secondry focus, the integration with local driver as an alternative

Runners

  • Standalone: Explain standalone runner
  • Spring Boot v3: Explain Spring Boot v3 runner
  • Spring Boot v3: Explain Spring Boot v4 runner

Templates

  • Explain

Features

  • GraalVM: Explanation of how Flamingock handles changes and versions across systems.
  • Workflows: Explanation workflows and stages
  • Custom injections
  • Transactions
  • Events
  • Multitenant
  • Etc

Testing

  • Explain

CLI

  • Explain

Local drivers

  • MongoDB V3
  • MongoDB Sync4
  • MongoDB Spring Data V2
  • etc

Resources

  • Explains

Migration from Mongock

  • Explains

FAQ

  • Explains

Contributing

  • Explains

Changelog

  • History of changes or links to github releases. We need to keep also the updated about new features and changes in the server