Steeltoe MusicStore Sample Application
This repo tree contains a sample app illustrating how to use all of the Steeltoe components together in a ASP.NET Core application. This application is based on the ASP.NET Core reference app MusicStore provided by Microsoft.
In creating this application, we took the Microsoft reference application and broke it up into multiple independent services:
- MusicStoreUI - provides the UI to the MusicStore application and all of its services.
- MusicStoreService - provides a RESTful API to the MusicStore and its backend Music database.
- OrderService - provides a RESTful API for Order processing service and its backend Order database.
- ShoppingCartService - provides a RESTful api to a ShoppingCart service and its backend ShoppingCart database.
Note: The OrderService and ShoppingCartService are independent from the Music application and could be used in any other application requiring those basic services.
This application makes use of the following Steeltoe components:
- Spring Cloud Config Server Client for centralized application configuration
- Spring Cloud Eureka Server Client for service discovery
- Steeltoe Connector for connecting to MySql using EFCore
- Steeltoe CircuitBreaker to help prevent cascading failures from lower level service failures
- Steeltoe Management for enabling management actuator endpoints that can be used by the Pivotal Apps Manager
- Optionally uses Steeltoe Redis Connector to connect to a Redis cache for Session storage. Note: This is required if you want to scale the MusicStoreUI component to multiple instances.
- Optionally uses Steeltoe Redis DataProtection provider to the cause the DataProtection KeyRing to be stored in a Redis cache. Note: This is also required if you want to scale the MusicStoreUI component to multiple instances.
- Optionally uses Hystrix Dashboard for monitoring Circuit Breakers
The default is to NOT use a Redis cache for Session storage or DataProtection KeyRing storage. Details on how to enable it are provided below.
- Clone the Samples repo. (i.e. git clone https://github.com/SteeltoeOSS/Samples)
Pre-requisites - Local
- Installed .NET Core SDK.
- You need running instances of the following external services on your local machine:
- Spring Cloud Config Server - listening @
- Spring Cloud Eureka Server - listening @
- MySql Database Server - listening @
- Redis Cache - Optional, can be used for Session state backing store and KeyRing storage.
You have a three options to choose from in order to get these services up and running locally:
- Use Docker images
- Install each service manually.
Currently, the simplest way to get these up and running is to use the first option above:
Pre-requisites - Using Docker images
docker-compose up(currently only works if using Linux containers)
Building & Running MusicStore App - Locally
Once you have the pre-requisite services up and running then you are ready to build and run the various MusicStore services locally. The simplest way is to use the provided
run*.cmd or run*.sh files.
For example, to startup the MusicStoreService:
Its probably best to startup the
ShoppingCartService first and then follow up with the
run*.* commands will
dotnet run -f netcoreapp2.1 (i.e. target .NET Core).
If all the services startup cleanly, you should be able to hit: http://localhost:5555/ to see the Music Store.
Debugging/Developing Locally on Windows
You should have no problem using the provided solution to launch the individual services in the debugger and set break points and walk through code as needed.
Pre-requisites - CloudFoundry
- Install Pivotal Cloud Foundry
- Install Spring Cloud Services
- Install .NET Core SDK.
- Install Redis service if you want to use Redis for Session storage and KeyRing storage.
- Install Pivotal Apps Manager 1.11+ if you want to access Management endpoints from Apps Manager.
Setup Services on CloudFoundry
As mentioned above, the application is dependent on the following services:
- Spring Cloud Config Server
- Spring Cloud Eureka Server
- MySql Database Server - Default database used by all MusicStore services.
- Redis Cache - Optional! Note you have to specifically build/publish MusicStoreUI service to use Redis (Details below).
Note: Redis Cache is required if you want to scale the MusicStoreUI app to multiple instances (e.g. cf scale musicui -i 2+). Redis is not required to scale the other microservices.
Before pushing the application to CloudFoundry you need to create those services. If you plan on using Redis, set the environment variable USE_REDIS_CACHE=true before running these command.
Note: MySQL v2 uses different naming conventions by default than v1. If your environment uses MySQL v2, you may need to alter the createCloudFoundryServices script accordingly!
cf target -o myOrg -s mySpace
- Optionally -
This will create all of the services needed by the application. Specifically, it creates:
- mStoreConfig - Spring Cloud Config Server instance
- mStoreRegistry - Spring Cloud Eureka Server instance
- mStoreAccountsDB - MySql database instance for Users and Roles (Identity)
- mStoreOrdersDB - MySql database instance for Orders
- mStoreCartDB - MySql database instance for ShoppingCarts
- mStoreStoreDB - MySql database instance for MusicStore
- mStoreRedis(optionally) - Redis cache instance used by MusicStoreUI for storing Session state
Note: The Spring Cloud Config Server instance created by the above script configures the Config Server instance to use the git repo: https://github.com/SteeltoeOSS/musicStore-config.git. This repo contains the same configuration files as those found in
Samples/MusicStore/config. No changes are required to the application configuration files before pushing the app to CloudFoundry.
Note: If you wish to change what github repo the Config server instance uses, you can modify config-server.json before using the
Building & Pushing App - CloudFoundry
Once the services have been created and ready on CloudFoundry (i.e. check via
cf services) then you can use the provided
push*.cmd or push*.sh commands to startup the individual application services on CloudFoundry. For example to start the ShoppingCart service:
pushShoppingCartService.cmd win10-x64 netcoreapp2.1or
./pushShoppingCartService.sh ubuntu.14.04-x64 netcoreapp2.1
Note: If you wish to use the Redis cache for storing Session state, you will have to set ENVIRONMENT variable
DefineConstants=USE_REDIS_CACHE before building and pushing the MusicUI application.
Each of the
dotnet publish the MusicStore service targeting the
runtime you specify. They then push the MusicStore service using the appropriate CloudFoundry manifest found in the projects directory (e.g.
Note: If you are using self-signed certificates it is possible that you might run into SSL certificate validation issues when pushing these apps. The simplest way to fix this:
- Disable certificate validation for the Spring Cloud Config Client. You can do this by editing
spring:cloud:config:validate_certificates=false. You will need to do this for each of the applications.
Once you have pushed all the applications to Cloud Foundry, if you do a
cf a, you should see the following applications:
- musicui - Music store User Interface
- musicstore - Music store database micro-service
- orderprocessing - Order processing micro-service
- shoppingcart - Shopping cart micro-service
name requested state instances memory disk urls musicstore started 1/1 1G 1G musicstore.apps.testcloud.com musicui started 1/1 1G 1G musicui.apps.testcloud.com orderprocessing started 1/1 1G 1G orderprocessing.apps.testcloud.com shoppingcart started 1/1 1G 1G shoppingcart.apps.testcloud.com
All MusicStore services (i.e. MusicStoreUI, OrderService, etc.) have their own database instance for persisting data. When a MusicStore service is started locally, it will always drop and recreate its database upon startup. When a MusicStore service is started on CloudFoundry, only the first instance (i.e. CF_INSTANCE_INDEX=0) will drop and recreate its database. Note then, the service is not fully ready until the first instance has finished initializing its database, even though other instances are ready.