# apolloconfig/apollo architecture

> Architecture diagram of the GitHub repository apolloconfig/apollo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/apolloconfig/apollo
- Repository: https://github.com/apolloconfig/apollo

## Overview

Apollo is a centralized configuration-management system. Administrators manage applications, clusters, namespaces, and key/value items through the Portal; changes are published as versioned releases, then configuration clients can receive updates in real time. The tree and excerpts support the Portal search and business-service responsibilities, release/namespace handling, audit, and config-service notification/synchronization areas. Several server subsystems are represented at their exact tree paths but were not sampled, so their internal calls are not asserted.

Main entry points: [`apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller`](https://github.com/apolloconfig/apollo/tree/master/apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller) (Admin endpoints), [`apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java`](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java) (Release management), [`apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java`](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java) (App and namespace), [`apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java`](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java) (Admin API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_portal["Portal and APIs"]
  node_portal_api["Portal interface"]
  node_global_search["Global search"]
  node_portal_roles["Role permissions"]
  node_openapi["Open API consumers"]
  node_admin_api["Admin API"]
end

subgraph group_admin["Configuration administration"]
  node_admin_controllers["Admin endpoints"]
  node_app_namespace["App and namespace"]
  node_items["Configuration items<br/>[ItemService.java]"]
  node_release["Release management"]
  node_biz_config["Business settings<br/>[BizConfig.java]"]
end

subgraph group_delivery["Release delivery"]
  node_config_api["Config endpoints"]
  node_incremental_sync["Incremental sync"]
  node_release_message["Release messages"]
end

subgraph group_platform["Audit and discovery"]
  node_audit["Operation audit"]
  node_discovery["Service discovery"]
end

node_operator(("Administrator"))
node_database[("MySQL")]
node_config_clients(("Configuration clients"))

node_operator -.->|"manages configuration"| node_portal_api
node_portal_api -.->|"uses admin API"| node_admin_api
node_admin_api -.->|"routes requests"| node_admin_controllers
node_admin_controllers -.->|"manages namespaces"| node_app_namespace
node_admin_controllers -.->|"manages items"| node_items
node_admin_controllers -.->|"publishes changes"| node_release
node_admin_controllers -.->|"checks permissions"| node_portal_roles
node_global_search -->|"searches items"| node_admin_api
node_release -->|"uses namespace"| node_app_namespace
node_app_namespace -->|"sends invalidation"| node_release_message
node_app_namespace -.->|"persists namespace"| node_database
node_release -.->|"persists releases"| node_database
node_items -.->|"persists items"| node_database
node_release_message -.->|"notifies changes"| node_config_api
node_config_api -.->|"serves updates"| node_incremental_sync
node_incremental_sync -.->|"delivers configuration"| node_config_clients
node_release -.->|"records operations"| node_audit
node_discovery -.->|"locates services"| node_config_api
node_biz_config -->|"sets item limits"| node_items
node_openapi -->|"uses role service"| node_portal_roles

click node_portal_api "https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/PortalManagementController.java"
click node_global_search "https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/GlobalSearchService.java"
click node_portal_roles "https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/SystemRoleManagerService.java"
click node_openapi "https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/service/ConsumerService.java"
click node_admin_api "https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java"
click node_admin_controllers "https://github.com/apolloconfig/apollo/tree/master/apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller"
click node_app_namespace "https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java"
click node_items "https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ItemService.java"
click node_release "https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java"
click node_biz_config "https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/config/BizConfig.java"
click node_config_api "https://github.com/apolloconfig/apollo/tree/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/controller"
click node_incremental_sync "https://github.com/apolloconfig/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/service/config/DefaultIncrementalSyncService.java"
click node_release_message "https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/message/ReleaseMessageScanner.java"
click node_audit "https://github.com/apolloconfig/apollo/blob/master/apollo-audit/apollo-audit-impl/src/main/java/com/ctrip/framework/apollo/audit/service/ApolloAuditLogService.java"
click node_discovery "https://github.com/apolloconfig/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/service/DatabaseDiscoveryService.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_portal_api,node_global_search,node_portal_roles,node_openapi,node_admin_api,node_config_clients toneBlue
class node_admin_controllers,node_app_namespace,node_items,node_release,node_biz_config,node_database toneAmber
class node_config_api,node_incremental_sync,node_release_message toneMint
class node_audit,node_discovery toneRose
class node_operator toneIndigo
```

## Components

### Portal and APIs

- [Portal interface](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/PortalManagementController.java): `apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/PortalManagementController.java`
- [Global search](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/GlobalSearchService.java): `apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/GlobalSearchService.java`
- [Role permissions](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/SystemRoleManagerService.java): `apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/SystemRoleManagerService.java`
- [Open API consumers](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/service/ConsumerService.java): `apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/service/ConsumerService.java`
- [Admin API](https://github.com/apolloconfig/apollo/blob/master/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java): `apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java`

### Configuration administration

- [Admin endpoints](https://github.com/apolloconfig/apollo/tree/master/apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller): `apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller`
- [App and namespace](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java): `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java`
- [Configuration items](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ItemService.java): `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ItemService.java`
- [Release management](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java): `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java`
- [Business settings](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/config/BizConfig.java): `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/config/BizConfig.java`

### Release delivery

- [Config endpoints](https://github.com/apolloconfig/apollo/tree/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/controller): `apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/controller`
- [Incremental sync](https://github.com/apolloconfig/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/service/config/DefaultIncrementalSyncService.java): `apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/service/config/DefaultIncrementalSyncService.java`
- [Release messages](https://github.com/apolloconfig/apollo/blob/master/apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/message/ReleaseMessageScanner.java): `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/message/ReleaseMessageScanner.java`

### Audit and discovery

- [Operation audit](https://github.com/apolloconfig/apollo/blob/master/apollo-audit/apollo-audit-impl/src/main/java/com/ctrip/framework/apollo/audit/service/ApolloAuditLogService.java): `apollo-audit/apollo-audit-impl/src/main/java/com/ctrip/framework/apollo/audit/service/ApolloAuditLogService.java`
- [Service discovery](https://github.com/apolloconfig/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/service/DatabaseDiscoveryService.java): `apollo-configservice/src/main/java/com/ctrip/framework/apollo/metaservice/service/DatabaseDiscoveryService.java`

### Other components

- **Administrator**
- **MySQL**
- **Configuration clients**

## Connections

- Administrator → Portal interface: manages configuration (evidence: `README.md`)
- Portal interface → Admin API: uses admin API
- Admin API → Admin endpoints: routes requests
- Admin endpoints → App and namespace: manages namespaces (evidence: `apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller/ItemController.java`)
- Admin endpoints → Configuration items: manages items (evidence: `apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller/ItemController.java`)
- Admin endpoints → Release management: publishes changes (evidence: `apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller/ItemController.java`)
- Admin endpoints → Role permissions: checks permissions
- Global search → Admin API: searches items (evidence: `apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/service/GlobalSearchService.java`)
- Release management → App and namespace: uses namespace (evidence: `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java`)
- App and namespace → Release messages: sends invalidation (evidence: `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/NamespaceService.java`)
- App and namespace → MySQL: persists namespace
- Release management → MySQL: persists releases
- Configuration items → MySQL: persists items
- Release messages → Config endpoints: notifies changes (evidence: `README.md`)
- Config endpoints → Incremental sync: serves updates
- Incremental sync → Configuration clients: delivers configuration (evidence: `README.md`)
- Release management → Operation audit: records operations
- Service discovery → Config endpoints: locates services
- Business settings → Configuration items: sets item limits (evidence: `apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ItemService.java`)
- Open API consumers → Role permissions: uses role service (evidence: `apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/service/ConsumerService.java`)
