eureka README

The project's README from github.com/Netflix/eureka. As one markdown file: README.md.

Eureka

build

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

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

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

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

Please see wiki for detailed documentation.

eureka (Netflix/eureka)

load-balancer
Searching Database…

12.7K ·GitHub
What is this?Eureka is a RESTful service used mainly in AWS cloud environments for service discovery, load balancing, and failover of mid-tier servers, originally built for Netflix's own infrastructure.
Is this a standalone server or a library I embed in my app?Eureka has two parts: a Eureka server for registration and discovery, and a Eureka client (Java-based) that services use to interact with the server, handle load balancing, and failover.
How do I build it?You build it from source, but you need Java 8 (even though source/target compatibility is set to 1.7), and you must check out a tag rather than building off a branch directly.
Do I need Java 8 to build or run this?Yes, building requires Java 8 specifically because of certain dependent libraries, even though the compiled output targets Java 7 compatibility.
Any gotchas when building from source?You must check out a specific tag before building; building directly from an arbitrary branch state is not guaranteed to work.
Who is this really built for?It's built for mid-tier service infrastructure running in AWS, originally designed to meet Netflix's own internal discovery and resiliency needs.
Where can I find detailed docs beyond the README?The project points to its wiki for detailed documentation on setup and usage.
How active is support for this project?Support is community-driven; maintainers periodically review issues, and reports with minimal reproductions get answered faster.
Can I make a big architectural change to Eureka?For any non-trivial or large change, you're expected to open an issue first to align on scope and approach before submitting code.
Creator
Netflix
Size
12.3 MB
Stars
12.7K
Age
14y
Commits · 90 Days