This project provides a deployment configuration for an online shop application built using microservices architecture. The application consists of several microservices that communicate with each other over gRPC and HTTP. Each microservice is deployed as a separate Docker container.
Online Boutique is composed of 11 microservices written in different languages that talk to each other over gRPC.
Find Protocol Buffers Descriptions at the ./pb directory.
| Service | Language | Description |
|---|---|---|
| frontend | Go | Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically. |
| cartservice | C# | Stores the items in the user's shopping cart in Redis and retrieves it. |
| productcatalogservice | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| currencyservice | Node.js | Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service. |
| paymentservice | Node.js | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| shippingservice | Go | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock) |
| emailservice | Python | Sends users an order confirmation email (mock). |
| checkoutservice | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. |
| recommendationservice | Python | Recommends other products based on what's given in the cart. |
| adservice | Java | Provides text ads based on given context words. |
| loadgenerator | Python/Locust | Continuously sends requests imitating realistic user shopping flows to the frontend. |
Before you can deploy the application, you need to have the following tools installed:
- Kubernetes CLI (kubectl)
- Helm
- Docker
You also need to have access to a Kubernetes cluster. If you don't have a Kubernetes cluster, you can create one using a cloud provider, such as Google Cloud Platform or AWS.
- Clone this repository to your local machine.
- Navigate to the project directory.
- Run the
deploy.shscript to deploy the application. The script will create Kubernetes resources for each microservice, including deployments, services, and ingresses.
Once the deployment is complete, you can access the application by navigating to the URL of the ingress controller. The ingress controller URL is defined in the deploy.sh script.
Cleaning Up
To clean up the deployment, run the cleanup.sh script. The script will delete all Kubernetes resources created by the deploy.sh script.
Contributions to this project are welcome. If you would like to contribute, please submit a pull request.
Mahmoud M.Abdelwahab
This project is licensed under the MIT License. See the LICENSE file for details.