eureka Documentation

Technical Documentation: Netflix/eureka

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

Eureka

Eureka is a RESTful (Representational State Transfer) service that is primarily used in the AWS cloud for the purpose of
discovery, load balancing and failover of middle-tier servers. It plays a critical role in Netflix mid-tier infra.

Building Copy Chapter

The build requires java8 because of some required libraries that are java8 (servo), but the source and target
compatibility are still set to 1.7. Note that tags should be checked out to perform a build.

Contributing Copy Chapter

For any non-trivial change (or a large LoC-wise change), please open an issue first to make sure there's alignment on
the scope, the approach, and the viability.

Support Copy Chapter

Community-driven mostly, feel free to open an issue with your question, the maintainers are looking over these
periodically. Issues with the most minimal repro possible have the highest chance of being answered.

Documentation Copy Chapter

Please see wiki for detailed documentation.

Overview (`eureka-client-archaius2/README.md`) Copy Section

This is a version of eureka-client that has been ported to use Archaius 2.x as the backing configuration system. Please note that this client is still work in progress. This client is also only java8 compatible (as Archaius 2.x is only java8 compatible).

Overview (`eureka-client-jersey2/README.md`) Copy Section

Please note that this jersey2 compatible Eureka client (eureka-client-jersey2) is created and maintained by the community. Netflix does not currently use this library internally.

Overview (`eureka-core-jersey2/README.md`) Copy Section

Please note that this jersey2 compatible Eureka core (eureka-core-jersey2) is created and maintained by the community. Netflix does not currently use this library internally.

Overview (`eureka-examples/README.md`) Copy Section

Example Overview Copy Chapter

The eureka example requires 3 participants:

• a centralized eureka server for registration and discovery
• an example service to register with eureka that exposes a REST endpoint
• an example client that discovers the example service via discovery, and then queries the example service on it's
  registered REST endpoint.

Setting up the Eureka server Copy Section

1. Edit eureka-server.properties and uncomment the two settings that makes the demo server start up faster (via disabling safeguards)
2. Build the application.
3. The above build also sets up all the libraries needed for running the demo service and the demo client.
4. Copy the WAR artifact to your tomcat deployment directory under _$TOMCAT_HOME/webapps/

JAVA_OPTS="
-Deureka.waitTimeInMsWhenSyncEmpty=0
-Deureka.numberRegistrySyncRetries=0"

6. Start your tomcat server. Access http://localhost:8080/eureka to verify the information there. Your server's eureka client should register itself in 30 seconds and you should see that information there.

Running the examples directly Copy Section

1. Start up a local eureka server
2. Run the example service first with ./gradlew :eureka-examples:runExampleService and wait until you see "Service started and ready to process requests.." indicating that is had registered with eureka.
3. Run the example client with ./gradlew :eureka-examples:runExampleClient.

Running the examples as an app Copy Section

1. Start up a local eureka server
2. Build a zip distribution with ./gradlew :eureka-examples:distZip
3. In the distribution run ./bin/ExampleEurekaService and wait until you see "Service started and ready to process requests.." indicating that is had registered with eureka.
4. In the distribution run ./bin/ExampleEurekaClient to run the example client.

Examples Provided Copy Chapter

ExampleEurekaService Copy Section

An example service that registers itself with eureka. (Note: prefer the DI version of creation in ExampleEurekaGovernatedService).

ExampleEurekaGovernatedService Copy Section

The same as the ExampleEurekaService, where Governator/Guice is used to initialize everything. The gradle javaExec for this is ./gradlew :eureka-examples:runExampleGovernatedService and the distribution generated script is ./bin/ExampleEurekaGovernatedService

ExampleEurekaClient Copy Section

An example use case of the eureka client to find a particular application/vip (in this case the example service) via eureka for communication.

Overview (`eureka-client/src/main/java/com/netflix/discovery/shared/resolver/README.md`) Copy Section

Much of the code in this package are still experimental and subject to major refactoring down the line.
They should not be exposed through the normal eureka-client APIs, so use directly at your own risk.

Overview (`eureka-client/src/main/java/com/netflix/discovery/shared/transport/README.md`) Copy Section

Much of the code in this package are still experimental and subject to major refactoring down the line.
They should not be exposed through the normal eureka-client APIs, so use directly at your own risk.

--- METRICS ---

• Files Extracted: 7
• Estimated Token Budget: ~1395 tokens
• Canonical Reference: https://codewiki.google/github.com/Netflix/eureka