/rapids-rivers-ponds

Primary LanguageJavaScript

rapids-rivers-streams

Example implementation of Fred George style microservices architecture

Overview

This project illustrates one way to implement the rapids, rivers, ponds approad to microservice architecture using AWS technology components.

Here, we'll use Kinesis for our main event bus (rapids). We'll use a simple stream reader to pick off events and publish them to an SNS topic, and use filter topic subscriptions to populate SQS queues (rivers), with services consuming messages from the rivers. Services may persist events or data derived from events or produced by application logic in datastores of choice (ponds).

This project provides a control plane stream used to subscribe rivers to topics and create queues on demand for rivers, a stream for the rivers, and a simple CLI to kick the tires.

Here's a sample CLI session:

lappy:cli ds$ node cmd.js --rapids Rapids-dev --control-stream Control-dev
stage not specified - default to dev
cmd > help

  Commands:

    help [command...]             Provides help for a given command.
    exit                          Exits application.
    send <event> <source> [data]  Publish event with optional data
    subscribe <river> <topic>     Subscribe a river to a topic
    readfrom <river>              Get a batch of messages
    listsubs <river>              List subscriptions for a river
    unsubscribe <river> <topic>   Remove a topic from a river subscription
    topics                        List topics
    advertise <topic>             Advertise a topic others may consume

cmd > topics
[]
cmd > advertise ViewPage
cmd > topics
[ 'ViewPage' ]
cmd > subscribe r1 ViewPage
cmd > readfrom r1
[]
cmd > send ViewPage TheSource '{"name":"Sally"}'
cmd > readfrom r1
[ { Type: 'Notification',
    MessageId: 'ff1848ec-05af-5830-8545-1dbd5c35af3a',
    TopicArn: 'arn:aws:sns:us-east-1:nnnn:Rapids-dev',
    Message: '{"eventType":"ViewPage","eventDomain":"TheSource","payload":{"name":"Sally"},"timestamp":"2019-05-11T23:14:31.550Z","eventId":"7dcfc14f-a197-4769-b8e0-aff2c76b8bd7"}',
    Timestamp: '2019-05-11T23:14:34.874Z',
    SignatureVersion: '1',
    Signature: 'M7AwFkffkQWBL959j3E/Os/+RjiAj3/xQCh95GJDIvX6IQBdhb1rj2IinzpaKpl/aouOMMUM7oMJe3J7xLdXzIKHhB+hIvj1rfunewCzbBo3fxJZ3ckPEUy/Wlxl42Th/5S1hMHdr6uE9nuDGN6fLMahfcEFcKUVKfAAChengnjWolCvZD3sskc7XxDkRlofru6I1sEWzDRt/v+IBsDAdn46mRCRTNjXfiim3KvpEeExH6Pov1SaJegTgJLv6q8OhRNeWyAHVMudWUtnHHYA5uCu24lOj/iw6xeqnXYAegq6oTaAjIcyxQSNheIB8xXMEQsCoHDBxYFGy0BiC3X4aw==',
    SigningCertURL: 'https://sns.us-east-1.amazonaws.com/SimpleNotificationService-6aad65c2f9911b05cd53efda11f913f9.pem',
    UnsubscribeURL: 'https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:nnnn:Rapids-dev:02e9f8e3-0d20-4023-bd33-e87f3f93a776',
    MessageAttributes: { event_type: [Object] } } ]
cmd > listsubs r1
[ 'ViewPage' ]
cmd > unsubscribe r1 ViewPage
cmd > listsubs r1
[]

Event structure

When writing events to the rapids, we need some standard metadata to enable routing events to interested consumers and their associated rivers.

We'll assume a JSON event structure that includes some standard fields:

  • eventDomain - Domain of the event emitter. Think of this in terms of business domain
  • eventName - Name of the event
  • payload - event content
  • timestamp - ISO 8601 UTC timestamp
  • eventId - uuid

Deploying Rapids and Rivers

To deploy the rapids and rivers infrastructure:

aws cloudformation create-stack --stack-name rapids-and-rivers-inf \
--template-body file://cfn/rapids-and-rivers-inf.yml \
--parameters ParameterKey=Stage,ParameterValue=dev \
ParameterKey=KMSKeyAlias,ParameterValue=alias/MyKey

To deploy the control plane (from one of the implementation directories):

cd control-plane
make

After the stack is created, add the control-plane-ControlProcExecutionRole role created by the stack (e.g. control-plane-ControlProcExecutionRole-12HRI62O6O2AL) as a key user in the key policy associated with the key alias.

To deploy the data plane:

cd data-plane
make

After the stack is created, add the data-plane-StreamProcExecutionRole and data-plane-BatchForRiverExecutionRole roles (e.g. data-plane-BatchForRiverExecutionRole-15YN3FWW1AJCE and data-plane-StreamProcExecutionRole-1RYF2VTIUJE6H) as key users in the key policy associated with the key alias.

Also, you must add sns as a user of the key to allow it to write to encrypted queues. Add this to the key policy:

{
    "Sid": "Allow Amazon SNS to use this key",
    "Effect": "Allow",
    "Principal": {
        "Service": "sns.amazonaws.com"
    },
    "Action": [
        "kms:Decrypt",
        "kms:GenerateDataKey*"
    ],
    "Resource": "*"
}

CLI

Use the cli to send events and commands.

node cmd.js --rapids Rapids-dev --control-stream Control-dev
cmd >

To subscribe to a topic:

subscribe <river> <topic>

To send a view page event:

cmd > send ViewPage TheSource '{"name":"Sally"}'

Scenario

In progress...

From the video, we'll ape the travel scenario where Sally views a page, and an offer engine assembles offers based on events consumed and produced by membership, segmentation, location, and brand services.

For this scenario, we'll have rivers for the services and offers engine, and a single rapids. The rapids will be a Kinesis stream, the rivers SQS queues. We'll also have a river for those interested in consuming offers.

The scenario is this:

  • An event conveying Sally is looking at a page is emitted.
    • The location and brand services respond to the event with some baseline offer events.
    • The segmenation service responds to the event by emitting an event stating Sally is a Road Warrior
    • The membership services response by emitting an event stating Sally is a Platinum member
  • The location and services emit a new offers based on Sally being a Road Warrior
  • The location service emits a new offer based on SAlly being both a Road Warrior and a Platimum member
  • The offer engine will buffer offers for some amount of time, then emit offers

Background

Notes from Fred George's Implementing Micro Service Architecture talk

Microservices are:

  • Tiny
  • Loosely coupled (including flow)
  • Multiple versions simultaneously running ok
  • Self-execution monitoring of seach service
  • Publish interesting stuff
  • "Application" is the wrong concept; think in terms of service and systems

Rapids, Rivers, and Ponds

  • Rapids - Every event, implemented as a bus
  • Rivers - themed events, services hook in
  • Static databases - data warehoses, reporting - ponds

High-Performance Bus

  • App events
  • Logs
  • Service events

Tech components

  • Kafka for the bus
  • Rapids - Zero MQ, themed queues, can chain them

Services

  • Listen to rivers
  • Publish to the rapids

Async Services

  • Service - expresses a need to the bus
  • Other services - willing to respond to that need
  • Multiple responses might be available, service expressing need selects solution

This architecture supports experimentation

  • Enable experimentation without changing existing code

Design

  • Events, not Entities
  • History, not Current

Cloud of Signals

  • What are the patterns
  • Producers, consumers

Observations

  • Services become disposable
  • Loosely coupled via READful JSON packets or DB
  • Self monitoring services replaces unit tests
  • Business monitoring replaces acceptance tests
  • Services language agnostic

Living Software System

  • Long-lived systems, short-lived services (human body, cells)
  • Extremely dynamic with continuous deployments
  • Accept it is complex (especially for testing)
    • Acceptance test on business outcomes
  • Radical impacts to dev processes
  • There will be a learning curve