Spring Cloud Netflix

https://docs.spring.io/spring-cloud-netflix/reference/4.3/
Admin
Spring Cloud Netflix provides Netflix OSS integrations for Spring Boot applications, enabling...
Tokens:6,249
Snippets:68
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure Peer-Aware Eureka Servers

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Configuration examples for setting up multiple Eureka server instances that synchronize registrations. Uses Spring profiles to define peer hostnames and service URLs.

```yaml
---
spring:
  profiles: peer1
eureka:
  instance:
    hostname: peer1
  client:
    serviceUrl:
      defaultZone: https://peer2/eureka/

---
spring:
  profiles: peer2
eureka:
  instance:
    hostname: peer2
  client:
    serviceUrl:
      defaultZone: https://peer1/eureka/
```

--------------------------------

### Customize Eureka RestTemplate RequestConfig

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Provides a Java configuration to customize the `RequestConfig` for the underlying Apache HttpClient 5 used by the Eureka HTTP Client. This example disables the protocol upgrade feature.

```java
@Configuration
public class RestClientConfiguration {

	@Bean
	EurekaClientHttpRequestFactorySupplier.RequestConfigCustomizer requestConfigCustomizer() {
		return builder -> builder.setProtocolUpgradeEnabled(false);
	}

}
```

--------------------------------

### Configure Secure Eureka Instance Communication

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Enables secure communication (HTTPS) for Eureka instances by disabling non-secure ports and enabling secure ports. This ensures that Eureka publishes instance information favoring secure connections and that the Discovery Client returns URIs starting with 'https'.

```yaml
eureka:
  instance:
    nonSecurePortEnabled: false
    securePortEnabled: true
```

--------------------------------

### Minimal Eureka Client Application (Java)

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

A basic Spring Boot application demonstrating how to include the Eureka Client. By having the 'spring-cloud-starter-netflix-eureka-client' dependency on the classpath, the application automatically registers with the Eureka Server. Configuration is required to specify the Eureka server's location.

```java
@SpringBootApplication
@RestController
public class Application {

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

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


}
```

--------------------------------

### Initialize a Eureka Server with Spring Boot

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

A minimal implementation of a Eureka server using the @EnableEurekaServer annotation. This serves as the entry point for the service registry application.

```java
@SpringBootApplication
@EnableEurekaServer
public class Application {

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

--------------------------------

### Configure Gradle Dependencies for Eureka Server

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Configures the Spring Boot Gradle plugin and imports the Spring Cloud BOM to ensure correct dependency resolution for the Eureka server.

```gradle
buildscript {
  dependencies {
    classpath("org.springframework.boot:spring-boot-gradle-plugin:{spring-boot-docs-version}")
  }
}

apply plugin: "spring-boot"

dependencyManagement {
  imports {
    mavenBom "org.springframework.cloud:spring-cloud-dependencies:{spring-cloud-version}"
  }
}
```

--------------------------------

### Discover Service Instances using Spring Cloud DiscoveryClient

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Shows how to use Spring Cloud's generic DiscoveryClient interface to find service instances. It retrieves a list of instances for a given service ID and returns the URI of the first instance found.

```java
@Autowired
private DiscoveryClient discoveryClient;

public String serviceUrl() {
    List<ServiceInstance> list = discoveryClient.getInstances("STORES");
    if (list != null && list.size() > 0 ) {
        return list.get(0).getUri();
    }
    return null;
}
```

--------------------------------

### Discover Service URL using EurekaClient

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Demonstrates how to use the native Netflix EurekaClient to find service instances registered with Eureka. It retrieves the next available instance for a given service name and returns its home page URL.

```java
@Autowired
private EurekaClient discoveryClient;

public String serviceUrl() {
    InstanceInfo instance = discoveryClient.getNextServerFromEureka("STORES", false);
    return instance.getHomePageUrl();
}
```

--------------------------------

### Configure Eureka for AWS Deployment

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Customizes EurekaInstanceConfigBean to make the Eureka instance AWS-aware when deployed on AWS. It uses AmazonInfo to automatically build the data center information.

```java
@Bean
@Profile("!default")
public EurekaInstanceConfigBean eurekaInstanceConfig(InetUtils inetUtils) {
  EurekaInstanceConfigBean bean = new EurekaInstanceConfigBean(inetUtils);
  AmazonInfo info = AmazonInfo.Builder.newBuilder().autoBuild("eureka");
  bean.setDataCenterInfo(info);
  return bean;
}
```

--------------------------------

### Add Jersey Client Dependencies for EurekaClient

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Specifies the Maven dependencies required to use Jersey Client as the underlying HTTP client for EurekaClient. This includes jersey-client, jersey-core, and jersey-apache-client4.

```xml
<dependencies>
    <dependency>
        <groupId>com.sun.jersey</groupId>
        <artifactId>jersey-client</artifactId>
    </dependency>
    <dependency>
        <groupId>com.sun.jersey</groupId>
        <artifactId>jersey-core</artifactId>
    </dependency>
    <dependency>
        <groupId>com.sun.jersey.contribs</groupId>
        <artifactId>jersey-apache-client4</artifactId>
    </dependency>
</dependencies>
```

--------------------------------

### Add JAXB Dependencies for JDK 11

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Provides the necessary Maven dependency for the JAXB runtime, which is required for Eureka server functionality when running on JDK 11 or higher.

```xml
<dependency>
	<groupId>org.glassfish.jaxb</groupId>
	<artifactId>jaxb-runtime</artifactId>
</dependency>
```

--------------------------------

### Configure Eureka Instance for Cloud Foundry

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Sets the hostname and non-secure port for Eureka instances when running in Cloud Foundry. This configuration uses Cloud Foundry specific placeholders to ensure instances correctly register with the global router.

```yaml
eureka:
  instance:
    hostname: ${vcap.application.uris[0]}
    nonSecurePort: 80
```

--------------------------------

### Configure Eureka Instance Status and Health URLs

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Sets the paths for the status page and health check endpoints for a Eureka instance. These are typically `/info` and `/health` respectively, aligning with Spring Boot Actuator defaults. These paths are included in metadata consumed by clients.

```yaml
eureka:
  instance:
    statusPageUrlPath: ${server.servletPath}/info
    healthCheckUrlPath: ${server.servletPath}/health
```

--------------------------------

### Configure Standalone Eureka Server

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

YAML configuration to run a Eureka server in standalone mode. It disables client-side registration and registry fetching to prevent unnecessary peer connection attempts.

```yaml
server:
  port: 8761

eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
```

--------------------------------

### Configure Eureka Client TLS Authentication

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Enables client-side TLS authentication for Eureka clients by configuring key and trust stores. The `eureka.client.tls.enabled` property must be set to true. If `eureka.client.tls.trust-store` is omitted, the JVM default trust store is used. Default store types are PKCS12, and omitted passwords imply empty passwords.

```yaml
eureka:
  client:
    tls:
      enabled: true
      key-store: <path-of-key-store>
      key-store-type: PKCS12
      key-store-password: <key-store-password>
      key-password: <key-password>
      trust-store: <path-of-trust-store>
      trust-store-type: PKCS12
      trust-store-password: <trust-store-password>
```

--------------------------------

### Override Eureka Instance URLs

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Allows explicit configuration of the status page URL, health check URL, and home page URL for Eureka instances using placeholders. This is useful when running behind a proxy or when specific URL structures are required.

```yaml
eureka:
  instance:
    statusPageUrl: https://${eureka.hostname}/info
    healthCheckUrl: https://${eureka.hostname}/health
    homePageUrl: https://${eureka.hostname}/
```

--------------------------------

### Eureka Client Configuration (YAML)

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Configuration for a Spring Cloud Netflix Eureka Client to locate the Eureka Server. The 'eureka.client.serviceUrl.defaultZone' property specifies the URL of the Eureka server. This property is case-sensitive and uses camel case.

```yaml
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
```

--------------------------------

### Configure Spring Security for Eureka Server

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Configures a SecurityFilterChain to secure the Eureka server. It enables HTTP Basic authentication and explicitly disables CSRF protection for the /eureka/** endpoints to allow client registration.

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

--------------------------------

### Configure Eureka Client Timeouts

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Sets custom connection, connection request, and socket timeouts for both RestTemplate and RestClient used by the Eureka HTTP Client. All timeout properties are specified in milliseconds. Default timeouts are set to 3 minutes.

```yaml
eureka:
  client:
    restclient:
      timeout:
        connect-timeout: 5000
        connect-request-timeout: 8000
        socket-timeout: 10000
    rest-template-timeout:
      connect-timeout: 5000
      connect-request-timeout: 8000
      socket-timeout: 10000
```

--------------------------------

### Customize Eureka Instance ID with YAML

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Overrides the default Eureka instance ID using properties in application.yml. It demonstrates using Spring Cloud variables like vcap.application.instance_id and random.value for unique identification.

```yaml
eureka:
  instance:
    instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}
```

--------------------------------

### Enable Eureka Client Health Checks

Source: https://docs.spring.io/spring-cloud-netflix/reference/4.3/spring-cloud-netflix.html

Enables Eureka health checks for the client, which propagates the application's current health status to Eureka. This ensures that other applications do not send traffic to instances that are not in the 'UP' state.

```yaml
eureka:
  client:
    healthcheck:
      enabled: true
```
Tokens:
Raw