Flinkboot

The Bootstrapping & Reliability Framework for Apache Flink.

---

Flinkboot eliminates operational boilerplate and prevents runtime failures before stream pipelines reach TaskManagers:

• Fail-Fast Configuration: Validates parameters at launch (Jakarta Validation, YAML, environment variables) so misconfigured jobs never hit the cluster.
• Zero-Boilerplate Runtime: Bootstraps pre-tuned StreamExecutionEnvironment instances (RocksDB, checkpoints, restart strategies, local Web UI) in a single call.
• Zero-Kryo Assertions: Enforces POJO compliance in unit tests (assertThat(Event.class).isPojo()) to eliminate silent fallbacks to slow Kryo serialization.

Learn more on flinkboot.com.

---

Quick Example

Declare your runtime environment in YAML:

# job-configuration.yaml
name: "StreamJob"
environment:
  execution:
    parallelism: 2
  checkpointing:
    interval: "PT10S"
    mode: "EXACTLY_ONCE"
  local-web-ui:
    enabled: true
    port: 8080

Bootstrap and run your pipeline:

public class MyFlinkJob {
    public static void main(String[] args) throws Exception {
        Flinkboot boot = Flinkboot.initialize(args);
        JobProperties job = boot.configuration(JobProperties.class);

        StreamExecutionEnvironment env = boot.executionEnvironment(job);

        env.fromElements("Hello", "Flinkboot").print();
        env.execute(job.name());
    }
}

---

Documentation & References

• Documentation — Official documentation and production guides.
• Quickstart Template — Standalone runnable project with simulated streams and live Web UI.
• Contributing Guide — Guidelines for reporting issues, submitting pull requests, and coding standards.
• Changelog — Release notes and user-facing change history.

---

Contributors

Every bug fix, test addition, and architectural improvement from the community makes Flinkboot more reliable for everyone running Flink in production.

Sincere appreciation to all contributors who have shaped and strengthened this codebase.

---

Apache®, Apache Flink®, Apache Kafka®, and Apache Fluss™ are trademarks of the Apache Software Foundation. Flinkboot is an independent open-source project and is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.