Cloud Native App Demo

A full stack cloud native app demo. Developed for the Fast Feedback session of Civo's Devops Bootcamp. This is a hard fork of Google's Microservice Demo, but modified to build out and run easily on multiple providers.

Prerequisites

A Civo account
The following installed locally
- A public Docker Repository (Docker.IO,(Quay, etc)
- Docker
- Make
- kubectl
- skaffold

Setup

Copy Makefile.env.sample to Makefile.env, add your Civo CLI key
Update the BUILD_REPO in Makefile to point to your personal repository
Run make k3s-list to verify your local environment is setup and the Civo key provided works

App Info

Online Boutique is a cloud-native microservices demo application. Online Boutique consists of a 10-tier microservices application. The application is a web-based e-commerce app where users can browse items, add them to the cart, and purchase them.

Screenshots

Home Page	Checkout Screen

Quickstart (Civo)

Clone this repository.

git clone https://github.com/ssmiller25/cloudnativeapp.git
cd cloudnativeapp

Provision the Prod and Dev Civo Clusters to demo fast feedback taks.

make civo-up

Deploy a dev instance - environment with for just your user

make dev

or to override the username

USERNAME=smiller make dev

NOTE: When you deploy the development environment, it will run a Kubernetes cluster in your Civo account until you stop it. In order to avoid unexpected charges, make sure to delete your cluster when you're done.

Wait for the Pods to be ready. Namespace will be cnapp-

kubectl get pods -n cnapp-smiller

After a few minutes, you should see:

NAME                                     READY   STATUS    RESTARTS   AGE
adservice-76bdd69666-ckc5j               1/1     Running   0          2m58s
cartservice-66d497c6b7-dp5jr             1/1     Running   0          2m59s
checkoutservice-666c784bd6-4jd22         1/1     Running   0          3m1s
currencyservice-5d5d496984-4jmd7         1/1     Running   0          2m59s
emailservice-667457d9d6-75jcq            1/1     Running   0          3m2s
frontend-6b8d69b9fb-wjqdg                1/1     Running   0          3m1s
loadgenerator-665b5cd444-gwqdq           1/1     Running   0          3m
paymentservice-68596d6dd6-bf6bv          1/1     Running   0          3m
productcatalogservice-557d474574-888kr   1/1     Running   0          3m
recommendationservice-69c56b74d4-7z8r5   1/1     Running   0          3m1s
redis-cart-5f59546cdd-5jnqf              1/1     Running   0          2m58s
shippingservice-6ccc89f8fd-v686r         1/1     Running   0          2m58s

Port Forward to the frontend

kubectl port-forward -n cnapp-smiller svc/frontend 8080:80

Browse to http://localhost:8080 and shoudl see the frontend of the app

Pipeline Tests

This procedures are normally run from a CI/CD pipeline, but can be tested manually

Deploy a dev instance triggered by PR - will include ingress

PR=1234 make pr

Determine the rontend IP address of the development cluster using the frontend's EXTERNAL_IP.

kubectl get ingress frontend -n cnapp-pr-1234 -o jsonpath="{.status.loadBalancer.ingress[0].ip}{\"\n\"}"

Browse to the PR developemnt instance

http:///

Deploy the production instance - will also include ingress

make prod

Determine the rontend IP address of the production cluster using the frontend's EXTERNAL_IP.

kubectl get ingress frontend -n cnapp-prod -o jsonpath="{.status.loadBalancer.ingress[0].ip}{\"\n\"}"

Browse to the PR developemnt instance

http:///

Teardown

Teardown BOTH prod and dev environments

make civo-down

NOTE: If you don't shut down your clusters your account will continue to be charged for them.

Other Deployment Options

Workload Identity: See these instructions.
Istio: See these instructions.
Anthos Service Mesh: ASM requires Workload Identity to be enabled in your GKE cluster. See the workload identity instructions to configure and deploy the app. Then, use the service mesh guide.
non-GKE clusters (Minikube, Kind): see the Development Guide
Memorystore: See these instructions to replace the in-cluster redis database with hosted Google Cloud Memorystore (redis).

Architecture

Online Boutique is composed of 11 microservices written in different languages that talk to each other over gRPC. See the Development Principles doc for more information.

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.

Features

Kubernetes/GKE: The app is designed to run on Kubernetes (both locally on "Docker for Desktop", as well as on the cloud with GKE).
gRPC: Microservices use a high volume of gRPC calls to communicate to each other.
Istio: Application works on Istio service mesh.
OpenCensus Tracing: Most services are instrumented using OpenCensus trace interceptors for gRPC/HTTP.
Cloud Operations (Stackdriver): Many services are instrumented with Profiling, Tracing and Debugging. In addition to these, using Istio enables features like Request/Response Metrics and Context Graph out of the box. When it is running out of Google Cloud, this code path remains inactive.
Skaffold: Application is deployed to Kubernetes with a single command using Skaffold.
Synthetic Load Generation: The application demo comes with a background job that creates realistic usage patterns on the website using Locust load generator.

Local Development

If you would like to contribute features or fixes to this app, see the Development Guide on how to build this demo locally.

Demos featuring Online Boutique

Take the first step toward SRE with Cloud Operations Sandbox
Deploying the Online Boutique sample application on Anthos Service Mesh
Anthos Service Mesh Workshop: Lab Guide
KubeCon EU 2019 - Reinventing Networking: A Deep Dive into Istio's Multicluster Gateways - Steve Dake, Independent
Google Cloud Next'18 SF
- Day 1 Keynote showing GKE On-Prem
- Day 3 Keynote showing Stackdriver APM (Tracing, Code Search, Profiler, Google Cloud Build)
- Introduction to Service Management with Istio
Google Cloud Next'18 London – Keynote showing Stackdriver Incident Response Management

This is not an official Google project.

kaihoffman / cloudnativeapp