Go to file
Mahmut Bulut e72d87ecf3
Changelog config (#161)
* Changelog config

* Reword documentation
2020-01-29 15:07:03 +01:00
.github Use `actions/checkout@master` in Clippy check (#159) 2020-01-28 10:10:38 +01:00
bastion Changelog config (#161) 2020-01-29 15:07:03 +01:00
bastion-executor Cleanup and format 2020-01-18 23:06:43 +01:00
bastion-utils Add missing readme reference to cargo.toml 2020-01-05 22:31:14 +01:00
img Bastion docs 2019-11-10 23:10:22 +01:00
lightproc use pointer cast instead of transmuting 2020-01-19 00:05:00 +01:00
.auto-changelog Changelog config (#161) 2020-01-29 15:07:03 +01:00
.gitignore Remove unnecessary ignore config 2019-10-06 05:04:28 +09:00
CHANGELOG.md Updated the changelog. (#106) 2019-11-28 02:26:17 +01:00
Cargo.toml Switched to usage of crate bastion-utils 2020-01-05 19:18:20 +01:00
LICENSE-APACHE Change license to use Apache-2.0/MIT 2019-08-26 23:45:57 +02:00
LICENSE-MIT Change license to use Apache-2.0/MIT 2019-08-26 23:45:57 +02:00
README.md Use original GitHub actions 2019-12-20 16:30:03 +01:00

README.md



Highly-available Distributed* Fault-tolerant Runtime

Latest Release Crates.io
License Crates.io
Build Status Build Status
Downloads Crates.io
Discord

Bastion is a highly-available, fault-tolerant runtime system with dynamic, dispatch-oriented, lightweight process model. It supplies actor-model-like concurrency with a lightweight process implementation and utilizes all of the system resources efficiently guaranteeing of at-most-once message delivery.

Please note that Bastion is not production-ready yet and might break some backward compatibility for now.

Usage

Bastion comes with a default one-for-one strategy root supervisor. You can use this to launch automatically supervised tasks.

Features

  • Message-based communication makes this project a lean mesh of actor system.
    • Without web servers, weird shenanigans, forced trait implementations, and static dispatch.
  • Runtime fault-tolerance makes it a good candidate for distributed systems.
    • If you want the smell of Erlang and the powerful aspects of Rust. That's it!
  • Completely asynchronous runtime with NUMA-aware and cache-affine SMP executor.
    • Exploiting hardware locality wherever it is possible. It is designed for servers.
  • Supervision system makes it easy to manage lifecycles.
    • Kill your application in certain condition or restart you subprocesses whenever a certain condition is met.

Guarantees

  • At most once delivery for all the messages.
  • Completely asynchronous system design.
  • Asynchronous program boundaries with fort.
  • Dynamic supervision of supervisors (adding a subtree later during the execution)
  • Lifecycle management both at futures and lightproc layers.
  • Faster middleware development.
  • Above all "fault-tolerance".

Why Bastion?

If one of the questions below answered with yes, then Bastion is just for you:

  • Do I need fault-tolerancy in my project?
  • Do I hate to implement weird Actor traits?
  • I shouldn't need a webserver to run an actor system, right?
  • Do I want to make my existing code unbreakable?
  • Do I have some trust issues with orchestration systems?
  • Do I want to implement my own application lifecycle?

Get Started

Check the getting started example in bastion/examples

Examples cover possible use cases of the crate.

Include bastion to your project with:

bastion = "0.3"

For more information please check Bastion Documentation

Architecture of the Runtime

Runtime is structured by the user. Only root supervision comes in batteries-included fashion. Worker code, worker group redundancy, supervisors and their supervision strategies are defined by the user.

You can see architecture of the framework HERE.

Projects using Bastion

If you are using Bastion open a PR so we can include it in our showcase.

  • SkyNet (a Discord bot which is resending deleted messages)
    • Skynet is running since 0.1.3 release of Bastion on the cloud and haven't killed yet.
  • In AWS Lambdas we have used Bastion to enable retry mechanism and try different parsing strategies for data to be processed.

License

Licensed under either of

at your option.

Documentation

Official documentation is hosted on docs.rs.

Getting Help

Please head to our Discord or use StackOverflow

Discussion and Development

We use Discord for development discussions. Also please don't hesitate to open issues on GitHub ask for features, report bugs, comment on design and more! More interaction and more ideas are better!

Contributing to Bastion Open Source Helpers

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

A detailed overview on how to contribute can be found in the CONTRIBUTING guide on GitHub.


* Currently, we are working on distributed properties and protocol.