https://github.com/outerfire/microservice-development

microservice development
https://github.com/outerfire/microservice-development

golang microservices redis robotframework

Last synced: 7 months ago
JSON representation

microservice development

• Host: GitHub
• URL: https://github.com/outerfire/microservice-development
• Owner: OuterFire
• Created: 2025-03-03T13:49:12.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-03-14T15:54:15.000Z (10 months ago)
• Last Synced: 2025-06-07T13:44:29.233Z (8 months ago)
• Topics: golang, microservices, redis, robotframework
• Language: Go
• Homepage:
• Size: 502 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

          
# Introduction

The purpose of this repository is to showcase the end to end lifecycle of microservice development.

**Key points:**

* **Golang** programing language used to develop the microservices. 

* **Robot framework** in addition of **python libraries** to test **functional** and **robustness** test cases.

* **Kubernetes Cluster: Minikube** utilization to deploy the microservices.

* **Docker** to build microservice images which then will be used in the helm chart deployment.

* **Helm** to package the microservices into helm charts that can be easily deployed on the Kubernetes cluster.

# Other Documents

For more internal documents found in **documents/** folder: 

* [Install Guide](documents/InstallGuide.md#installation-guide)

  * [Build docker images](documents/InstallGuide.md#1-build-docker-images)

  * [Build helm chart](documents/InstallGuide.md#2-build-the-helm-chart)

  * [Install helm chart](documents/InstallGuide.md#3-installation)

* [Interface Guide](documents/InterfaceGuide#interfaces)

  * [Event Message Interface](documents/InterfaceGuide#1-event-message-em---interface)

  * [Event Message Interface](documents/InterfaceGuide#2-notification-message-nm---interface)

* [Sequence](documents/Sequence.md)

* Demo Recording: https://youtube.com/

# Deployment

Deployment view of the microservices running in kubernetes cluster.



Pod view of the deployed microservices:



### event-producer microservice interfaces:

| interface name | full name                           | producer           | consumer       |

|----------------|-------------------------------------|--------------------|----------------|

|         | event-producer.event-message        | application - http | event-producer |

|         | event-producer.notification-message | event-producer     | event-consumer |

### event-consumer microservice interfaces:

| interface name | full name                           | producer           | consumer       |

|----------------|-------------------------------------|--------------------|----------------|

|         | event-consumer.notification-message | event-producer     | event-consumer |

The deployment view consists of **4 microservices**.

- 3 microservices in blue (**event-producer**, **event-consumer**, **event-simulator**) which are developed in this repository.

- 1 microservice in green (**redis**) a dependency, which is an **external microservice** found in the following artifactory:

  - https://artifacthub.io/packages/helm/bitnami/redis.

## Description

### Event Producer Microservice

The **event-producer microservice** consists of 2 interfaces and has a dependency on the redis microservice.

- The Event Message (EM) interface and the Notification Message (NM) interface.

- The event-producer has a client connection to the redis microservice using the following dependency:

  - github.com/redis/go-redis/v9

  

- The usecase of the redis client connection is to create a redis stream called NotificationStream.

  - Stream created on:

       1. Start up.

       2. Pod restart.

       3. If the client connection has been lost. 

- Another usecase of the redis client is to send events to the redis stream using the Notification Message interface.

The event sent to the redis stream is defined by the Notification Message interface and consists of the following data

`{"id": 123, "description": "hello world", "timestamp": "2025-02-25T22:06:25.478310425Z"}`. This event is sent to redis

when a http request is sent to the `/event` endpoint defined by the Event Message (EM) interface. 

### Event Consumer Microservice

The **event-consumer microservice** implements the Notification Message (NM) interface and has a dependency on the redis microservice.

- The event-consumer has a client connection to the redis microservice using the following dependency:

  - github.com/redis/go-redis/v9

- The usecase for this redis client connection is to consume an event from the redis stream generated by the event-producer microservice.

The event consumed will look like this `{"id": 123, "description": "hello world", "timestamp": "2025-02-25T22:06:25.478310425Z"}` as defined

by the Notification Message (NM) interface. When a Notification Message is consumed from the redis stream it is unmarshalled, logged and then acknowledged. 

### Event Simulator Microservice - (traffic simulator)

The **event-simulator microservice** is optional, It's used to **simulate user traffic** to the Event Message (EM) interface.

- You can use curl to send a http requests to the Event Message (EM) interface instead.

### Redis Microservice - (external microservice)

The **redis microservice** is a dependency service used by **event-producer microservice** and the **event-consumer microservice**.

The redis stream feature is utilized.