Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 3.36 KB

README.md

File metadata and controls

76 lines (51 loc) · 3.36 KB
Raw

Reefer Container Shipment solution - EDA reference implementation

The IBM Event Driven architecture reference implementation solution illustrates the deployment of real time analytics on event streams in the context of container shipment in an event driven architecture with event backbone, functions as service and evnt-driven microservices, and aims to illustrate the different event driven patterns like event sourcing, CQRS and Saga. There is a lot of content, so consider this to be a living book, for better reading experience go to the book view.

TL;DR

If you want to just get the code, build and run we propose running locally with Minikube or Docker-compose.

To build and run the solution locally we are delivering some scripts which should help you to quickly get the solution cloned, built and deployed. Those bash scripts are under the scripts folder of this project.

git clone https://github.com/ibm-cloud-architecture/refarch-kc.git

cd refarch
./scripts/clone.sh
  • To assess your environment and build the docker images needed for build:
./scripts/prepareEnv

For docker-compose we recommend reading this note for Minikube this separate note

Running in a local Kubernetes environment

The scripts provided in scripts/localk8s/ can be used to deploy to a local (vanilla) Kubernetes environment, such as a cluster provided by Docker Desktop.

Prereqs:

  • Helm (Helm v3 is recommended),
  • A Kubernetes cluster, and sufficient permissions to create namespaces, service accounts etc.

For more information, see the README for the scripts.

Building this booklet locally

The content of this repository is written with markdown files, built with Gatsby. For more information, see the README for the docs.

  1. Install NodeJS (https://nodejs.org/)
  2. git clone https://github.com/ibm-cloud-architecture/refarch-kc.git (or your forked repository if you plan to edit)
  3. cd refarch-kc/docs
  4. npm install
  5. npm run dev
  6. 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-kc directory.

Contribute

As this implementation solution is part of the Event Driven architeture reference architecture, the contribution policies apply the same way here.

Contributors:

Please contact me for any questions.