Skip to content

jboss-fuse/fuse-springboot-circuit-breaker-booster

Repository files navigation

Circuit Breaker - Fuse Booster

Overview

The Fuse circuit breaker booster consists of two related services:

  • A name service that returns a name to greet.

  • A greeting service that invokes the name service to get a name and then returns the Hello, NAME string.

This booster demonstrates inserting the Hystrix circuit breaker between the greeting service and the name service. If the name service becomes unavailable, the circuit breaker instructs the greeting service to follow an alternative behavior and respond to the client immediately, thereby avoiding a blockage or time out condition while waiting for the name service to restart.

Deployment options

You can run this booster in the following modes:

The most effective way to run this booster is to deploy and run the project on OpenShift.

For more details about running this booster on a single-node OpenShift cluster, CI/CD deployments, as well as the rest of the runtime, see the Spring Boot Runtime Guide.

Important
This booster requires Java 8 JDK or later and Maven 3.3.x or later.

Running the booster on a single-node OpenShift cluster

A single-node OpenShift cluster provides you with access to a cloud environment that is similar to a production environment.

If you have a single-node OpenShift cluster, such as Minishift or the Red Hat Container Development Kit, installed and running, you can deploy your booster there.

To deploy this booster to a running single-node OpenShift cluster:

  1. Download the project and extract the archive on your local filesystem.

  2. Log in to your OpenShift cluster:

    $ oc login -u developer -p developer
  3. Create a new OpenShift project for the booster:

    $ oc new-project MY_PROJECT_NAME
  4. Change the directory to the folder that contains the extracted booster application (for example, my_openshift/fuse-springboot-circuit-breaker-booster) :

    $ cd my_openshift/fuse-springboot-circuit-breaker-booster
  5. Build and deploy the project to the OpenShift cluster:

    $ mvn clean -DskipTests fabric8:deploy -Popenshift
  6. In your browser, navigate to the MY_PROJECT_NAME project in the OpenShift console. Wait until you can see that the pods for the name-service application and for the greetings-service application have both started up.

  7. On the project’s Overview page, locate the URL for the fuse-springboot-circuit-breaker-booster application: http://greetings-service-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io.

  8. Click the URL to access the greetings service application and then follow the instructions on that page.

Running the booster on OpenShift Online

To deploy the circuit breaker booster directly to OpenShift Online when you create the project at https://developers.redhat.com/launch:

  1. Go to https://developers.redhat.com/launch.

  2. At the Deployment step, select Use OpenShift Online.

  3. Follow the on-screen instructions to create a new Circuit Breaker project using the Fuse runtime.

Note
As part of the process of creating this booster, https://developers.redhat.com/launch sets up a project with a CI/CD deployment of this booster. You can see the status of this deployment in your single-node OpenShift cluster or OpenShift Online web console.

Running the booster standalone on your machine

To run this booster as a standalone project on your local machine:

  1. Download the project and extract the archive on your local filesystem.

  2. Build the project:

    $ cd PROJECT_DIR
    $ mvn clean package
  3. In two separate shell prompts, run the services:

    $ cd name-service
    $ mvn spring-boot:run -Dserver.port=8081
    $ cd greetings-service
    $ mvn spring-boot:run
  4. Go to http://localhost:8080 and then follow the instructions on that page.