Akka/Spray for Large-Scale Production Deployments
Scala Java
Latest commit dd5e86a Feb 15, 2017 @thefourtheye thefourtheye committed with Harikiranvuyyuru #388: refactor readConfigs(file) (#389)
Fixes: #388
Permalink
Failed to load latest commit information.
.github Create PULL_REQUEST_TEMPLATE.md Jun 9, 2016
docs #342 Default HttpEndpointResolver (#396) Feb 10, 2017
project #399 Fixed Codacy API tokens and plugin version. (#402) Feb 10, 2017
samples #349: Refined JSON marshaller APIs and moved to squbs-ext. (#365) Dec 29, 2016
squbs-actormonitor Akka http client (#303) Nov 10, 2016
squbs-actorregistry Update: #379 return CompletionStage in ActorLookup (#387) Feb 8, 2017
squbs-admin #345 #376 #315 #392 Pipeline changes (#393) Feb 10, 2017
squbs-ext #345 #376 #315 #392 Pipeline changes (#393) Feb 10, 2017
squbs-httpclient #342 Default HttpEndpointResolver (#396) Feb 10, 2017
squbs-pattern #383: replace map with foreach (#382) Jan 31, 2017
squbs-pipeline #345 #376 #315 #392 Pipeline changes (#393) Feb 10, 2017
squbs-testkit #369: Made CustomTestKit scan resources in src/main/resources, too. (#… Jan 25, 2017
squbs-unicomplex #388: refactor readConfigs(file) (#389) Feb 15, 2017
squbs-zkcluster Akka http client (#303) Nov 10, 2016
.gitignore setup pgp Oct 8, 2015
.travis.yml #399 Fixed Codacy API tokens and plugin version. (#402) Feb 10, 2017
AUTHORS.txt SQUBS-560: New open source headers and file cleanup, compile cleanup,… Jul 2, 2015
CONTRIBUTING.md Update discussion chat link Jun 9, 2016
LICENSE.txt SQUBS-560: New open source headers and file cleanup, compile cleanup,… Jul 2, 2015
README.md #345 #376 #315 #392 Pipeline changes (#393) Feb 10, 2017
build.sbt #345 #376 #315 #392 Pipeline changes (#393) Feb 10, 2017
credentials.sbt.enc setup pgp Oct 8, 2015
jvmopts #207: PersistentBuffer feature for Akka Streams May 21, 2016
pubring.gpg.enc setup pgp Oct 8, 2015
scalastyle-config.xml #273: Code, tests, and documentation supporting the FlowDefinition re… Oct 26, 2016
secring.gpg.enc setup pgp Oct 8, 2015
sonar-project.properties use scapegoat to replace findbugs Jul 13, 2015
version.sbt Update version to 0.9.0-SNAPSHOT (#280) Oct 14, 2016

README.md

image

Join the chat at https://gitter.im/paypal/squbs Build Status Codacy Badge Codacy Coverage Maven Central License

squbs (pronounced "skewbs")is a software container and a suite of components enabling standardization and operationalization of Akka and Spray applications/services in a large scale, managed, cloud environment. It standardizes how Akka/Spray applications are deployed in different environments and how they are hooked up to the operational environments of large, internet-scale organizations.

squbs Components

  1. Unicomplex: The micro-container that bootstraps and standardizes the deployment of Akka/Spray applications and how they are configured, allowing teams other than PD to understand the configuration and tweak the configuration of applications, partly at runtime, as needed. In addition, the Unicomplex encourages coexistence of different modules, called cubes, and/or operational tooling in a flexible, loosely-coupled fashion that will not incur any code change in order to include new ops tooling or drop out/change some ops tooling. For instance, in cases where we have mixed cloud environments such as private and public cloud needing different operational tools, the same codebase will work with both allowing deployment-time addition of environment-specific tooling.

  2. TestKit: Used to help test applications written for squbs, or even Akka applications altogether. It provides unit test and small scale load testing facilities that can be run as part of CI.

  3. ZKCluster: A ZooKeeper-based, datacenter-aware clustering library allowing clustered applications or services to span datacenter and hold the availability characteristics across data centers. This is needed for applications that need intra-cluster communications.

  4. HttpClient: An operationalized, simplified client that supports both environment and endpoint resolution to fit into different operational environments (QA, Prod) as well as organizational requirements (Topo, direct).

  5. Pattern: A set of programming patterns and DSLs provided to users.

    1. Orchestration DSL allowing developers to describe their orchestration sequence in an extremely concise manner while running the whole orchestration asynchronously, thus largely simplifying code and reduces latency for the application.
    2. Asynchronous systems depend heavily on timeouts and fixed timeouts are never right. TimeoutPolicy allows users to set policy (like 2.5 sigma) instead of fixed timeout values and takes care of the heuristics by itself allowing systems to adapt to their operating conditions.
    3. Spray doesn't have friendly API for Java, the spray.japi package provides a few of Helpers and Factories to help Java developers to construct spray entities easily.
    4. Validation provides a Spray directive for data validation by using Accord Validation Library.
    5. PersistentBuffer provides a high-performance Akka Streams flow buffer component that persists its content to a memory-mapped file and recovers the content after failure and restart.
  6. ActorRegistry: A core lookup facility allowing actors of loosely-coupled modules to find each others, or even to model different services as actors.

  7. ActorMonitor: An add-on operational module that uses JMX to report the stats and behavior of actors in the system. These stats can be seen by any JMX tooling

  8. Pipeline: An infrastructure allowing sequencing and plugging in of request/response filters. These are used, for instance, for security, rate limiting, logging, etc. Each of the components have virtually no dependency on each others. They are truly loosely coupled. Developers and organizations are free to pick and choose the components needed for their environment.

  9. Console: A drop-in module allowing web access to system and application stats through a simple web and service interface returning pretty-printed JSON.

Getting Started

The easiest way to getting started is to create a project from one of the squbs templates. The followings are currently available Activator templates:

Also check out these slightly more advanced samples.

Documentation

Contributing to squbs

Thank you very much for contributing to squbs. Please read the contribution guidelines for the process.

License

squbs is licensed under the Apache License, v2.0