https://github.com/bastion-rs/bastion/blob/master/README.md Skip to content Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Project management - + Integrations - + GitHub Sponsors - + Customer stories- + Security - * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Nonprofit - + Education - [ ] [search-key] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} bastion-rs / bastion * Sponsor Sponsor bastion-rs/bastion * Notifications * Star 1.8k * Fork 65 * Code * Issues 45 * Pull requests 7 * Actions * Projects 1 * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Security * Insights Permalink master Switch branches/tags [ ] Branches Tags Nothing to show {{ refName }} default View all branches Nothing to show {{ refName }} default View all tags bastion/README.md Go to file * Go to file T * Go to line L * * Copy path @fosdickio fosdickio Updating the Bastion architecture image and adding it to README.md. See ... Latest commit ac238b3 Mar 1, 2021 History #215 (#215) for more information. (#311) 8 contributors Users who have contributed to this file @vertexclique @JohnTitor @r3v2d0g @enkore @oScape @fossabot @fosdickio @0xflotus 197 lines (155 sloc) 8.8 KB Raw Blame [bastion] --------------------------------------------------------------------- Highly-available Distributed Fault-tolerant Runtime Latest Release Crates.io License Crates.io Doc [Bastion] Documentation (Bastion) Doc [Bastion Executor] Documentation (Bastion Executor) Doc [LightProc] Documentation (LightProc) Build Status Build Status Downloads Crates.io Discord [6874747073] --------------------------------------------------------------------- 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. --------------------------------------------------------------------- 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. * Automatic member discovery, cluster formation and custom message passing between cluster members. + Using zeroconf or not, launch your bastion cluster from everywhere, with a single actor block. * Proactive IO system which doesn't depend on anything other than futures. + Bastion's proactive IO has scatter/gather operations, io_uring support and much more... Guarantees * At most once delivery for all 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. * Fault tolerance above all. Why Bastion? If you answer any of the questions below with yes, then Bastion is just for you: * Do I want proactive IO? * Do I need fault-tolerance 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? Bastion Ecosystem Bastion Ecosystem is here to provide you a way to customize it. If you don't need to, or if you are a newcomers, you can install and use Bastion without knowing how everything works under the hood. We hope to find you on this section soon. Nuclei Nuclei is proactive IO system that can be independently used without executor restriction. It is also powering Bastion's IO system. You can learn more about Nuclei here, check out Nuclei's repo for more sophisticated use cases. LightProc LightProc is Lightweight Process abstraction for Rust. It uses futures with lifecycle callbacks to implement Erlang like processes and contains basic pid to identify processes. All panics inside futures are propagated to upper layers. Bastion Executor Bastion Executor is NUMA-aware SMP based Fault-tolerant Executor, highly-available and async communication oriented. It's independent of it's framework implementation. It uses lightproc to encapsulate and provide fault-tolerance to your future based workloads. You can use your futures with lightproc to run your workloads on Bastion Executor without the need to have framework. Agnostik Agnostik is a layer between your application and the executor for your async stuff. It lets you switch the executors smooth and easy without having to change your applications code. Valid features are runtime_bastion (default), runtime_tokio, runtime_asyncstd and runtime_nostd (coming soon). 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.4" 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. Supervision strategies define how child actor failures are handled, how often a child can fail, and how long to wait before a child actor is recreated. As the name suggests, One-For-One strategy means the supervision strategy is applied only to the failed child. All-For-One strategy means that the supervision strategy is applied to all the actor siblings as well. One-for-one supervision is used at the root supervisor, while child groups may have different strategies like rest-for-one or one-for-all. Bastion Architecture License Licensed under either of * Apache License, Version 2.0 (LICENSE-APACHE or http:// www.apache.org/licenses/LICENSE-2.0) * MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) 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. License FOSSA Status FOSSA Status [ ] Go * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.