The chili core is a lightweight distributed architecture for creating microservices with focus on modularity, security and scalability. The backend uses Vert.x with Hazelcast as its cluster manager.
To build chili-core clone this repository with git,
git clone https://github.com/codingchili/chili-core.git
Start the prototype, uses the classpath of all subprojects and prototype/ as the working directory.
gradlew prototype
Builds project jars and run tests
gradlew build
Note: when targeting java 9 the following hacks are needed for Netty/Vert.x
--add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/sun.net.dns=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens=java.base/sun.nio.ch=ALL-UNNAMED
Build a standalone prototype zip
gradlew archivePrototype
To run the prototype from within an IDE, add the 'prototype' gradle task as a run configuration. It is then possible to start and debug from within the IDE.
For information on how to setup the prototype installation look at the README.md in prototype/.
The project consists of two parts. The core, which is a framework built on top of the vertx toolkit. The purpose of wrapping vertx in a framework is to increase productivity. This is done by providing common functionality that can be used to build microservices on. With all the logic packed into core, it is possible to create distributed microservices capable of handling authentication, request routing and storage in 66 lines of code. If you are interested in vertx, I recommend using it directly instead. This framework is intended to improve productivity in a very specific use case. In order to achieve this it is much more invasive than the vertx toolkit.
Additionally, on top of the services developed using the core, an online game will be implemented.
- Built on the high-performance reactive toolkit vertx
- Uses clustering to improve scalability
- Support for a variety of storage options
- A distributed logging system and logging aggregator
- Highly adaptable and flexible with a configuration system
- High availability with support for multiple transports
- Text based protocols with JSON
- Adopts the microservice pattern
The complete feature list may change during development.
- Programmers seeking to create microservices productively in a very specific use case.
- Aspiring game, web-app or mobile-app developers with an interest in backend development.
- Transport & protocol independent implementation
- Logging system for data analysis and real time monitoring
- Authentication based on hmac tokens.
- A router for routing external connections into the clustered event bus.
- Statistics API that builds on top of the logging system
- Interchangeable storage options with indexing and query support
The configuration directory 'conf' must be in the same directory as the jar file or on the classpath. Configuration may also be done programmatically using com.codingchili.core.configuration.files.Configurations.
The configuration structure
├── conf/
│ ├──system/
│ │ ├── launcher.json
│ │ ├── validator.json
│ │ ├── security.json
│ │ ├── storage.json
│ │ ├── system.json
- conf/system/ contains framework configuration.
- Default configuration may be generated using --reconfigure.
- Configuration of services typically reside in conf/services/
- The configuration for the prototype is a good starting point.
All configuration files are loaded by their respective service with support for reloading changes at runtime. Minimally the framework configuration in conf/system/ must exist as it is required by the launcher.
The core uses some great software, such as
- eclipse/vert.x - reactive: eventbus, clustering and networking
- hazelcast/hazelcast - cluster management, data store
- npgall/cqengine - in-vm indexed collections with query support
- elastic/elasticsearch - distributed data indexing
- mongodb/mongo - document database
- EsotericSoftware/kryo - serialization library
- EsotericSoftware/reflectasm - fast reflections library
Applications currently using chili-core
- flashcards - Progressive web app for studying with flashcards.
- etethereum-ingest - Ethereum block/transaction import utility.
Issues and PR's are welcome with 💙.
The MIT License (MIT) Copyright (c) 2017 Robin Duda
See: License