Spring Cloud Netflix Documentation

Spring Cloud Netflix provides capabilities for service discovery within a Spring ecosystem. Key features include:

• Service Discovery (Client): Eureka instances can be registered and clients can discover instances using Spring-managed beans.
• Service Discovery (Server): An embedded Eureka server can be created using declarative Java configuration.

Spring Cloud Netflix provides the following core capabilities:

• Service Discovery: Eureka instances can be registered and clients can discover instances using Spring-managed beans.
• Embedded Eureka Server: An embedded Eureka server can be created using declarative Java configuration.

To run your own Eureka discovery server, add the spring-cloud-starter-netflix-eureka-server dependency to your project and annotate your main configuration class with @EnableEurekaServer.

@EnableEurekaServer
@SpringBootApplication
public class EurekaServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(EurekaServerApplication.class, args);
    }
}

To enable a Spring Boot application to act as a Eureka client (registering with a discovery server and discovering other services), add the spring-cloud-starter-netflix-eureka-client dependency to your project.

By default, the client will attempt to contact a Eureka server at http://localhost:8761. This default location is controlled by the configuration key eureka.client.serviceUrl.defaultZone.

@SpringBootApplication
@RestController
public class Application {

  @RequestMapping("/")
  public String home() {
    return "Hello World";
  }

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
}

The spring-cloud-build module includes a docs profile that uses Antora to build documentation from AsciiDoc sources located in modules/ROOT/.

To generate the documentation site, run the following command:

./mvnw -pl docs -P docs antora:antora

You can configure Spring Cloud Netflix features by specifying properties in any of the following locations:

1. application.properties file
2. application.yml file
3. Command line switches

Note that this list of properties is not exhaustive, as additional JAR files on your classpath may contribute further properties, and you can also define custom properties.

You can import the project into Eclipse using two different methods:

Using m2e plugin (Recommended)

Use the m2e Eclipse plugin for Maven support. If you encounter errors related to POMs, ensure m2e is up to date or manually add the spring profile to your settings.xml to resolve Spring repositories.

Without m2e plugin

If you do not use m2e, you can generate Eclipse-specific project metadata using the eclipse:eclipse goal, then import the projects via File > Import > Existing Projects.

$ ./mvnw eclipse:eclipse

To create a Eureka Discovery Server, add the Eureka Server starter to your project and annotate your main application class with @EnableEurekaServer.

@SpringBootApplication
@EnableEurekaServer
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

To secure the Eureka Server, add spring-boot-starter-security to your classpath. You must explicitly disable CSRF protection for the /eureka/** endpoints so that Eureka clients can still communicate with the server.

@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
    http.authorizeHttpRequests((authz) -> authz
        .anyRequest().authenticated())
        .httpBasic(withDefaults());
    http.csrf().ignoringRequestMatchers("/eureka/**");
    return http.build();
}