IBM Cloud Architecture - Microservices Reference Application for Netflix OSS

Netflix OSS on Bluemix - Spring Cloud Config

Description

This project contains a packaged Spring Config config server for use in a Netflix OSS-based microservices architecture. This enables individual microservices to be configured dynamically.
The repository builds the config server component into a runnable JAR that can either be used directly in Cloud Foundry or built into a Docker image (with the Dockerfile provided).

This repository, and its parent reference application, are built to enable deployment and learning of building and operating microservices-based applications on the IBM Cloud, but due to the OSS-based nature of the components involved, this reference application can be deployed to any cloud or on-premises environment as desired.

Parent Reference Application

This project is part of the IBM Cloud Architecture - Microservices Reference Application for Netflix OSS suite.

For full reference application overviews and deployment guidance, please refer to the root repository above. The overall project consists of multiple sub projects:

• Standard Netflix OSS-based microservice architecture components, like Eureka and Zuul
• Sample Spring Boot applications which provide a REST API and communication between each other.
• Deployment pipeline and automation guidance

The Microservices Reference Application for Netflix OSS is maintained by the IBM Cloud Lab Services and Cloud Solution Engineering teams.

APIs in this application:

There are no explicit APIs exposed by Config.

Pre-requisites:

• Install Java JDK 1.8 and ensure it is available in your PATH
• (Optional) A local Docker instance (either native or docker-machine based) running on localhost to host container(s). Click for instructions.
• (Optional) Apache Maven is used for an alternate build system. Click for instructions.

Build the Application Component

1. Run one of the provided build scripts to compile the Java code, package it into a runnable JAR, and build the Docker image. Run either
   ./build-microservice.sh [-d]
   or
   ./build-microservice.sh -m [-d]
   to run the Gradle or Maven builds, respectively. Specify the -d flag to build the Docker image in addition to the runnable JAR. Both build packages produce the same output, however both build files are provided for convenience of the user. The default Gradle build instructions use a Gradle wrapper requiring no further installation. The Maven build instructions require Maven to be installed locally.

Run the Application Component Locally

1. You will need a local Eureka application instance running to connect to, from which Zuul will proxy requests to additional service instances.

2. You can now run either the JAR file or the Docker image locally.

   1.1. To run the JAR file locally, you can simply pass parameters to the Java command in the command prompt:
   java -jar docker/app.jar
   1.2. To run the Docker file locally, you can pass the same paramters to start the local Docker image:
   docker run -p 8888:8888 spring-config:latest

3. Verify there is a Config Server service visible in your Eureka Dashboard at http://localhost:8761/.

Run the Application Component on Bluemix

1. You will need a Eureka application instance running to connect to. Make note of this fully-qualified URL. (eg http://netflix-eureka-cloudarch.mybluemix.net/eureka/)

2. Edit the Bluemix Response File to select your desired external public route, application domain, and other operational details. The default values in the .bluemixrc are acceptable to deploy in to the US-South Bluemix region.

3. To deploy Config Server as a container group onto the Bluemix Container Service, execute the following script and pass in the previously-noted Eureka location:
   ./deploy-container-group.sh http://netflix-eureka-cloudarch.mybluemix.net/eureka/

   This script will create a clustered group of homogeneous containers, with additional management capabilities provided by Bluemix. The parameter passed into the script is the location of the Eureka service discovery container group, so that the Config Server container group can register with it upon startup.

4. The script will complete rather quickly, but the creation of the necessary Container Group and clustered containers may take a few moments. To check on the status of your Config Container Group, you can run the following command:
   cf ic group ls | grep spring-config

   Once you see a value for Status of CREATE_COMPLETED, your Zuul Proxy instance will now be publicly accessible through the URL configured in the Bluemix response file.

Validate the Application Component Deployment

1. Validate that the Eureka user interface appears after a few seconds of the application being started.
2. Verify that there is a registered config-server microservice registered with Eureka, visible in the Eureka Dashboard.