Integration with Netflix OSS components
Java CSS JavaScript FreeMarker HTML Shell Other
Latest commit ca244c5 Jan 23, 2017 @ryanjbaxter ryanjbaxter committed on GitHub Merge pull request #1637 from tmack8001/zuul-route-constructor-custom…
…-sensitive-headers

ZuulProperties.ZuulRoute consturctor missing explicitly setting of customSensitiveHeaders boolean
Permalink
Failed to load latest commit information.
.mvn Update tp mvn 3.3.9 Jun 4, 2016
docs fix spell error Jan 9, 2017
eclipse Add eclipse formatting and cleanup configuration Jan 14, 2015
scripts Updated e2e tests with new brewery parameters Aug 16, 2016
spring-cloud-netflix-core addressing issues/1636 ZuulProperties.ZuulRoute consturctor missing e… Jan 22, 2017
spring-cloud-netflix-dependencies Upgrade Ribbon to 2.2.2 Jan 10, 2017
spring-cloud-netflix-eureka-client Add test to make sure eureka.instance.*virtualHostName can be set pro… Dec 16, 2016
spring-cloud-netflix-eureka-server Remove mocks for application event listeners. Jan 12, 2017
spring-cloud-netflix-hystrix-amqp Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-netflix-hystrix-dashboard Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-netflix-hystrix-stream Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-netflix-sidecar Create `sidecar.hostname` and `sidecar.ipAddress` (#1561) Jan 9, 2017
spring-cloud-netflix-spectator Update to Boot 1.5.0 Dec 12, 2016
spring-cloud-netflix-turbine-stream Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-netflix-turbine Fix Eureka Ribbon Auto Config conditions. Nov 29, 2016
spring-cloud-starter-archaius Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-atlas Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-eureka-server Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-eureka Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-feign Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-hystrix-dashboard Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-hystrix Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-ribbon Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-spectator Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-turbine-amqp Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-turbine-stream Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-turbine Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
spring-cloud-starter-zuul Bump to 1.3.0.BUILD-SNAPSHOT Oct 27, 2016
.gitignore add *.swp *.swo to .gitignore (#1181) Aug 16, 2016
.settings.xml Re-instate .settings.xml for Travis May 12, 2016
.travis.yml quote var Jun 15, 2016
Guardfile Add link to github in rendered docs Mar 20, 2015
LICENSE.txt Added LICENSE.txt Aug 20, 2015
README.adoc Updating generated README Nov 22, 2016
asciidoctor.css Fix comment pre-amble in README Sep 29, 2014
circle.yml circleci updates Aug 9, 2016
mvnw Ensure version is scraped from parent pom Sep 20, 2016
mvnw.cmd Add Maven wrapper Aug 14, 2015
pom.xml Update to spring-cloud-build 1.3.1.BUILD-SNAPSHOT Jan 10, 2017

README.adoc

CircleCI
Codecov
Codacy code quality

This project provides Netflix OSS integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your application and build large distributed systems with battle-tested Netflix components. The patterns provided include Service Discovery (Eureka), Circuit Breaker (Hystrix), Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).

Features

  • Service Discovery: Eureka instances can be registered and clients can discover the instances using Spring-managed beans

  • Service Discovery: an embedded Eureka server can be created with declarative Java configuration

  • Circuit Breaker: Hystrix clients can be built with a simple annotation-driven method decorator

  • Circuit Breaker: embedded Hystrix dashboard with declarative Java configuration

  • Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations

  • Client Side Load Balancer: Ribbon

  • External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions)

  • Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation

Building

Basic Compile and Test

To build the source you will need to install JDK 1.8.

Spring Cloud uses Maven for most build-related activities, and you should be able to get off the ground quite quickly by cloning the project you are interested in and typing

$ ./mvnw install
Note
You can also install Maven (>=3.3.3) yourself and run the mvn command in place of ./mvnw in the examples below. If you do that you also might need to add -P spring if your local Maven settings do not contain repository declarations for spring pre-release artifacts.
Note
Be aware that you might need to increase the amount of memory available to Maven by setting a MAVEN_OPTS environment variable with a value like -Xmx512m -XX:MaxPermSize=128m. We try to cover this in the .mvn configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control.

For hints on how to build the project look in .travis.yml if there is one. There should be a "script" and maybe "install" command. Also look at the "services" section to see if any services need to be running locally (e.g. mongo or rabbit). Ignore the git-related bits that you might find in "before_install" since they’re related to setting git credentials and you already have those.

The projects that require middleware generally include a docker-compose.yml, so consider using Docker Compose to run the middeware servers in Docker containers. See the README in the scripts demo repository for specific instructions about the common cases of mongo, rabbit and redis.

Note
If all else fails, build with the command from .travis.yml (usually ./mvnw install).

Documentation

The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources from src/main/asciidoc. As part of that process it will look for a README.adoc and process it by loading all the includes, but not parsing or rendering it, just copying it to ${main.basedir} (defaults to ${basedir}, i.e. the root of the project). If there are any changes in the README it will then show up after a Maven build as a modified file in the correct place. Just commit it and push the change.

Working with the code

If you don’t have an IDE preference we would recommend that you use Spring Tools Suite or Eclipse when working with the code. We use the m2eclipse eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better.

Importing into eclipse with m2eclipse

We recommend the m2eclipse eclipse plugin when working with eclipse. If you don’t already have m2eclipse installed it is available from the "eclipse marketplace".

Note
Older versions of m2e do not support Maven 3.3, so once the projects are imported into Eclipse you will also need to tell m2eclipse to use the right profile for the projects. If you see many different errors related to the POMs in the projects, check that you have an up to date installation. If you can’t upgrade m2e, add the "spring" profile to your settings.xml. Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your settings.xml.

Importing into eclipse without m2eclipse

If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command:

$ ./mvnw eclipse:eclipse

The generated eclipse projects can be imported by selecting import existing projects from the file menu.

Adding Project Lombok Agent

Spring Cloud uses Project Lombok to generate getters and setters etc. Compiling from the command line this shouldn’t cause any problems, but in an IDE you need to add an agent to the JVM. Full instructions can be found in the Lombok website. The sign that you need to do this is a lot of compiler errors to do with missing methods and fields, e.g.

The method getInitialStatus() is undefined for the type EurekaInstanceConfigBean    EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka   line 120    Java Problem
The method getInitialStatus() is undefined for the type EurekaInstanceConfigBean    EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka   line 121    Java Problem
The method setNonSecurePort(int) is undefined for the type EurekaInstanceConfigBean EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka   line 112    Java Problem
The type EurekaInstanceConfigBean.IdentifyingDataCenterInfo must implement the inherited abstract method DataCenterInfo.getName()   EurekaInstanceConfigBean.java   /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka   line 131    Java Problem
The method getId() is undefined for the type ProxyRouteLocator.ProxyRouteSpec   PreDecorationFilter.java    /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/zuul/filters/pre line 60 Java Problem
The method getLocation() is undefined for the type ProxyRouteLocator.ProxyRouteSpec PreDecorationFilter.java    /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/zuul/filters/pre line 55 Java Problem

Importing into Intellij

Spring Cloud projects use annotation processing, particularly Lombok, which requires configuration or you will encounter compile problems. It also needs a specific version of maven and a profile enabled. Intellij 14.1+ requires some configuration to ensure these are setup properly.

  1. Click Preferences, Plugins. Ensure Lombok is installed

  2. Click New, Project from Existing Sources, choose your spring-cloud project directory

  3. Choose Maven, and select Environment Settings. Ensure you are using Maven 3.3.3

  4. In the next screen, Select the profile spring click Next until Finish.

  5. Click Preferences, "Build, Execution, Deployment", Compiler, Annotation Processors. Click Enable Annotation Processing

  6. Click Build, Rebuild Project, and you are ready to go!

Importing into other IDEs

Maven is well supported by most Java IDEs. Refer to you vendor documentation.

Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.

Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.

Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the Spring Cloud Build project. If using IntelliJ, you can use the Eclipse Code Formatter Plugin to import the same file.

  • Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.

  • Add the ASF license header comment to all new .java files (copy from existing files in the project)

  • Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).

  • Add some Javadocs and, if you change the namespace, some XSD doc elements.

  • A few unit tests would help a lot as well — someone has to do it.

  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).

  • When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number).