madhur/refarch-eda

Event-Driven Architecture Reference Architecture solution implementation and guidances.

Event Driven Reference Architecture

This project represents the body of knowledge around event-driven architecture and can be considered as a live book, we are writing from our consulting engagements. All the content is visible as a BOOK format here.

The content of this repository was the source of the event-driven reference architecture in the IBM Garage architecture center visible here. This git repository is maintained on a weekly basis and includes more content not yet formally published to IBM sites. As we are implementing the end to end solution we are updating this main git repository to keep best practices accurate.

Building this booklet locally

The content of this repository is written with markdown files, packaged with MkDocs and can be built into a book-readable format by MkDocs build processes.

1. Install MkDocs locally following the official documentation instructions.
2. Install Material plugin for mkdocs: pip install mkdocs-material
3. git clone https://github.com/ibm-cloud-architecture/refarch-eda.git (or your forked repository if you plan to edit)
4. cd refarch-eda
5. mkdocs serve
6. Go to http://127.0.0.1:8000/ in your browser.

Building this booklet locally but with docker

In some cases you might not want to alter your Python setup and rather go with a docker image instead. This requires docker is running locally on your computer though.

• docker pull squidfunk/mkdocs-material
• git clone https://github.com/ibm-cloud-architecture/refarch-eda.git (or your forked repository if you plan to edit)
• docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
• Go to http://127.0.0.1:8000/ in your browser.

Pushing the book to GitHub Pages

1. Ensure that all your local changes to the master branch have been committed and pushed to the remote repository.
   1. git push origin master
2. Ensure that you have the latest commits to the gh-pages branch, so you can get others' updates.

   git checkout gh-pages
   git pull origin gh-pages
   
   git checkout master

3. Run mkdocs gh-deploy from the root refarch-eda directory.

---

Contribute

We welcome your contributions. There are multiple ways to contribute: report bugs and improvement suggestion, improve documentation and contribute code. We really value contributions and to maximize the impact of code contributions we request that any contributions follow these guidelines:

The contributing guidelines are in this note.

Project Status

• [10/2018] Started
• [11/2018] Implement ship simulator and stream analytics proof of concepts
• [01/2019] Publish content to IBM Architecture center
• [02/2019] Enhance design pattern and move content as book layout
• [03/2019] Work on event-driven pattern and skill journey
• [06/2019] Minikube deployment
• [07/2019] Labs skill journey

Contributors

• Lead developer Jerome Boyer
• Lead offerings Andy Gibbs
• [IBM Streams Analytics team]
  • Martin Siegenthaler
  • David Engebretsen
  • Francis Parr
• [IBM Decision Insight team]
  • Jose De Freitas
• IBM Garage team:
  • Hemankita Perabathini
  • John Martin
  • [Wil Plannel]
• IBM Lab Services
  • Sila Kissuu
  • Zach Silverstein

Please contact me for any questions.