refarch-cloudnative-wfd-menu

Microservices Reference Application - What's For Dinner Menu Service

This project is part of the 'IBM Cloud Architecture - Microservices Reference Application for Netflix OSS' suite, available at https://github.com/ibm-cloud-architecture/refarch-cloudnative-netflix

Introduction

This project is built to demonstrate how to build a Spring Boot application for use in a microservices-based architecture:

• Leverage Spring Boot framework to build a microservices application.
• Integrate with Netflix Eureka and Ribbon framework.
• This service will aggregated downstream service calls for information on Appetizers, Entrees, and Desserts.
• Deployment options for local, Cloud Foundry, or Docker Container-based runtimes (including IBM Container Service on Bluemix).

APIs in this application

You can use cURL or Chrome POSTMAN to send get/post/put/delete requests to the application.

• Get current menu options for Appetizers, Entrees, and Desserts
  http://<hostname>/menu

Pre-requisite:

• You need a Docker machine running on localhost to host container(s). Click for instructions.

Build the application

1. Clone git repository.

   git clone https://github.com/ibm-cloud-architecture/refarch-cloudnative-wfd-menu
   cd refarch-cloudnative-wfd-menu
   

2. Build the application. A utility script is provided to easily build using either Gradle (default) or Maven. You can optionally specify the -d parameter to build the associated Docker image as well. The default Gradle build instructions use a Gradle wrapper requiring no further installation. The Maven build instructions require Maven to be installed locally.

2.1 Build the application using Gradle: ./build-microservice.sh [-d]

2.2 Build the application using Maven: ./build-microservice.sh -m [-d]

Run Menu Service on localhost

In this section you will deploy the Spring Boot application to run on your localhost.

1. Setup Eureka to run locally.

2. Run the required downstream services:
   2.1. Appetizer 2.2. Entree 2.3. Desserts

3. Run the application on localhost (assuming default Gradle build). If Eureka is not running locally, you will need to pass the location of the Eureka server as a command-line paramter.

   java [-Deureka.client.serviceUrl.defaultZone=http://eureka-host:port/eureka/] -jar build/libs/wfd-menu-0.0.1-SNAPSHOT.jar
   

4. Validate.

   curl http://localhost:8180/menu
   {"entrees":{"order":2,"menu":["Steak","Chicken","Fish"],"type":"dinner"},"desserts":{"order":3,"menu":["Chocolate Cake","Banoffee","Ice Cream"],"type":"dessert"},"appetizers":{"order":1,"menu":["Hummus","Crab Cakes","Mozzerella Sticks"],"type":"appetizer"}}
   

Run Menu Service application on local Docker container

In this section you will deploy the Spring Boot application to run in a local docker container.

1. Build service and container image:

   ./build-microservice.sh -d
   

2. If not done so already, Setup Eureka to run locally.

3. Run the required downstream services:
   3.1. Appetizer 3.2. Entree 3.3. Desserts

4. Start the application in docker container.

   docker run -d -p 8180:8180 --name wfd-menu --rm --env "eureka.client.serviceUrl.defaultZone=http://eureka-host:port/eureka/"  wfd-menu
   

5. Validate.

   curl http://{docker-host}:8180/menu
   {"entrees":{"order":2,"menu":["Steak","Chicken","Fish"],"type":"dinner"},"desserts":{"order":3,"menu":["Chocolate Cake","Banoffee","Ice Cream"],"type":"dessert"},"appetizers":{"order":1,"menu":["Hummus","Crab Cakes","Mozzerella Sticks"],"type":"appetizer"}}
   

Deploy Menu Service to Cloud Foundry runtime, on IBM Bluemix

1. Log in to your Bluemix account.

   cf login -a <bluemix-api-endpoint> -u <your-bluemix-user-id>
   

2. Set target to use your Bluemix Org and Space.

   cf target -o <your-bluemix-org> -s <your-bluemix-space>
   

3. Setup Eureka on Bluemix.

4. Run the required downstream services:
   4.1. Appetizer 4.2. Entree 4.3. Desserts

5. Create a user-provided service for Eureka, so the services running in Cloud Foundry can bind to it:

   cf create-user-provided-service eureka-service-discovery -p "{\"uri\": \"http://{eureka-host}/eureka/\"}"
   

6. Start the application in a Cloud Foundry runtime on IBM Bluemix.

The following commands push the service code to Bluemix and creates a Cloud Foundry application. It then sets the desired Spring Boot profile for the application to configure itself correctly, as well as binds the user-provided service with the Eureka endpoint information. Finally, it restages the application code to ensure it receives all the configuration changes and then starts the application.

NOTE: There is no need for a port in the Eureka parameter, as the Container Group running Eureka is listening on port 80 (the default HTTP port) and will forward to the necessary port of 8761 that Eureka is listening on.

```
cf push -p build/libs/wfd-menu-0.0.1-SNAPSHOT.jar -d mybluemix.net -n wfd-menu-{your-bluemix-user-id} --no-start

cf set-env wfd-menu SPRING_PROFILES_ACTIVE cloud

cf bind-service wfd-menu eureka-service-discovery

cf restage wfd-menu

cf start wfd-menu
```

7. Validate.

   curl http://wfd-menu-{your-bluemix-user-id}.mybluemix.net/menu
   {"entrees":{"order":2,"menu":["Steak","Chicken","Fish"],"type":"dinner"},"desserts":{"order":3,"menu":["Chocolate Cake","Banoffee","Ice Cream"],"type":"dessert"},"appetizers":{"order":1,"menu":["Hummus","Crab Cakes","Mozzerella Sticks"],"type":"appetizer"}}
   

Deploy Menu Service to Docker Container, on IBM Bluemix

1. Log in to your Bluemix account.

   cf login -a <bluemix-api-endpoint> -u <your-bluemix-user-id>
   

2. Set target to use your Bluemix Org and Space.

   cf target -o <your-bluemix-org> -s <your-bluemix-space>
   

3. Log in to IBM Containers plugin.

   cf ic init
   

4. Tag and push the local docker image to bluemix private registry.

   docker tag wfd-microservice registry.ng.bluemix.net/$(cf ic namespace get)/wfd-microservice:latest
   docker push registry.ng.bluemix.net/$(cf ic namespace get)/wfd-microservice:latest
   

5. Setup Eureka on Bluemix.

6. Run the required downstream services:
   6.1. Appetizer 6.2. Entree 6.3. Desserts

7. Start the application in an IBM Bluemix Container. Replace {eureka-host} with the public route configured in the deployment of Eureka to Bluemix.

NOTE: There is no need for a port in the Eureka parameter, as the Container Group running Eureka is listening on port 80 (the default HTTP port) and will forward to the necessary port of 8761 that Eureka is listening on.
cf ic group create -p 8180 -m 256 --min 1 --auto --name wfd-menu-group -e "--env "eureka.client.serviceUrl.defaultZone=http://eureka-host/eureka/" -n wfd-menu-$(cf ic namespace get) -d mybluemix.net registry.ng.bluemix.net/$(cf ic namespace get)/wfd-menu:latest

8. Validate.

   curl http://wfd-menu-$(cf ic namespace get).mybluemix.net/menu
   {"entrees":{"order":2,"menu":["Steak","Chicken","Fish"],"type":"dinner"},"desserts":{"order":3,"menu":["Chocolate Cake","Banoffee","Ice Cream"],"type":"dessert"},"appetizers":{"order":1,"menu":["Hummus","Crab Cakes","Mozzerella Sticks"],"type":"appetizer"}}