# netflix/eureka architecture

> Architecture diagram of the GitHub repository netflix/eureka, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/netflix/eureka
- Repository: https://github.com/netflix/eureka

## Overview

##### Project type and purpose
- Eureka is a distributed, RESTful service-discovery system (server + client libraries) used in AWS for service registration, health-checking, load balancing, and failover.
- It is an open-source tool/library (Java, Gradle multi-module) that provides both a server cluster component and client integrations (HTTP transport, configuration, AWS metadata, Jersey1/2).

##### File structure
- Top-level modules (each a Gradle subproject):
– eureka-client        (core client API + discovery logic)
– eureka-client-archaius2  (Archaius2-based config extension)
– eureka-client-jersey2    (Jersey2 HTTP transport layer)
– eureka-core          (server core: registry, lease, replication, clustering business logic)
– eureka-core-jersey2  (Jersey2-based server transport/resources)
– eureka-server        (opinionated server bootstrap)
– eureka-server-governator (Guice/Governator-based server bootstrap)
– eureka-resources     (static web UI assets: JSP/CSS/JS)
– eureka-examples      (sample client & server usage)
– eureka-test-utils    (test harness for client & server integration tests)
- Cross-cutting concerns: AWS metadata integration under appinfo/aws and discovery/shared/resolver/aws.
- Build/CI: Gradle wrapper, Nebula-based CI workflows, codequality/checkstyle, Gradle settings.

##### Key architectural patterns & components (from README + code)
- Client-Server pattern: Eureka clients register themselves and poll the server for registry updates.
- Masterless server cluster: Each Eureka server node holds an in-memory registry and replicates updates to peers.
- Pluggable HTTP transport: Jersey1/2 HTTP clients and servers.
- Config abstraction: Archaius1/2, ProviderFactories for AWS metadata.
- Extensibility: multiple modules isolate config, transport, bootstrap, and test harness.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Services
    AWS[(AWS Metadata Service)]:::external

    %% Client Libraries
    subgraph "Eureka Client Libraries"
        direction TB
        ClientCore["Eureka Client Core\n(discovery API & logic)"]:::client
        ClientHTTP["Eureka Client HTTP Transport\n(Jersey2)"]:::transport
        ClientConfig["Eureka Client Config Extension\n(Archaius2)"]:::transport
    end

    %% Server Cluster
    subgraph "Eureka Server Cluster"
        direction TB
        Core["Eureka Server Core\n(registry, lease, replication & clustering logic)"]:::server
        ServerREST["Eureka Server REST Transport & Resources\n(Jersey2)"]:::transport
        BootSpring["Eureka Server Bootstrap\n(Spring-opinionated)"]:::server
        BootGuice["Eureka Server Bootstrap\n(Guice/Governator-based)"]:::server
        UI["Static UI Resources\n(JSP, CSS, JS)"]:::external
    end

    %% Users, Samples, Tests
    Admin["Admin/UI User"]:::external
    Samples["Sample Applications"]:::external
    Tests["Test Harness & Utilities"]:::external

    %% CI & Quality Configuration
    subgraph "CI & Quality Configuration"
        direction TB
        NebCI["nebula-ci.yml"]:::external
        NebSnap["nebula-snapshot.yml"]:::external
        NebPub["nebula-publish.yml"]:::external
        Check["checkstyle.xml"]:::external
    end

    %% Build & Gradle Configuration
    subgraph "Build & Gradle Configuration"
        direction TB
        TopBuild["build.gradle\nsettings.gradle\ngradle.properties"]:::external
        Wrapper["Gradle Wrapper\n(gradlew, gradlew.bat,\ngradle/wrapper/)"]:::external
    end

    %% Flows
    AWS -->|"Provides metadata"| ClientCore
    ClientCore -->|"Uses HTTP transport"| ClientHTTP
    ClientCore -->|"Uses config extension"| ClientConfig
    ClientHTTP -->|"POST register/heartbeat"| ServerREST
    ClientHTTP -->|"GET registry"| ServerREST
    ServerREST -->|"Delegates to"| Core
    Core -.->|"Peer replication"| Core
    Admin -->|"Accesses UI"| UI
    UI -->|"Served by"| ServerREST
    Samples -->|"Illustrates flows"| ClientCore
    Samples -->|"Illustrates flows"| ServerREST
    Tests -->|"Integration tests on"| ClientCore
    Tests -->|"Integration tests on"| ServerREST

    %% Click Events
    click ClientCore "https://github.com/netflix/eureka/tree/master/eureka-client/"
    click ClientHTTP "https://github.com/netflix/eureka/tree/master/eureka-client-jersey2/"
    click ClientConfig "https://github.com/netflix/eureka/tree/master/eureka-client-archaius2/"
    click Core "https://github.com/netflix/eureka/tree/master/eureka-core/"
    click ServerREST "https://github.com/netflix/eureka/tree/master/eureka-core-jersey2/"
    click BootSpring "https://github.com/netflix/eureka/tree/master/eureka-server/"
    click BootGuice "https://github.com/netflix/eureka/tree/master/eureka-server-governator/"
    click UI "https://github.com/netflix/eureka/tree/master/eureka-resources/"
    click Samples "https://github.com/netflix/eureka/tree/master/eureka-examples/"
    click Tests "https://github.com/netflix/eureka/tree/master/eureka-test-utils/"
    click NebCI "https://github.com/netflix/eureka/blob/master/.github/workflows/nebula-ci.yml"
    click NebSnap "https://github.com/netflix/eureka/blob/master/.github/workflows/nebula-snapshot.yml"
    click NebPub "https://github.com/netflix/eureka/blob/master/.github/workflows/nebula-publish.yml"
    click Check "https://github.com/netflix/eureka/blob/master/codequality/checkstyle.xml"
    click TopBuild "https://github.com/netflix/eureka/blob/master/build.gradle"
    click TopBuild "https://github.com/netflix/eureka/blob/master/settings.gradle"
    click TopBuild "https://github.com/netflix/eureka/blob/master/gradle.properties"
    click Wrapper "https://github.com/netflix/eureka/tree/master/gradlew"
    click Wrapper "https://github.com/netflix/eureka/blob/master/gradlew.bat"
    click Wrapper "https://github.com/netflix/eureka/tree/master/gradle/wrapper/"

    %% Styles
    classDef client fill:#ADD8E6,stroke:#000
    classDef server fill:#90EE90,stroke:#000
    classDef transport fill:#FFA500,stroke:#000
    classDef external fill:#D3D3D3,stroke:#000
```
