Skip to content

Commit bd5c442

Browse files
authored
Update readme (#63)
1 parent d145d97 commit bd5c442

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

README.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,20 @@ storage-service-api/mp-rest/url: http://localhost
5959
repo-service-api/mp-rest/url: http://localhost
6060
```
6161
62-
### Environment Variables
62+
## Event Processing
63+
64+
The service processes two types of Kafka events and maintains consistency across repository group hierarchies:
6365
64-
- `KAFKA_BOOTSTRAP_SERVERS`: Kafka broker addresses
65-
- `STORAGE_SERVICE_API_MP_REST_URL`: Storage service URL
66-
- `REPO_SERVICE_API_MP_REST_URL`: Repository service URL
66+
> **Important**: When a metadata file is updated in any repository, the service automatically propagates these changes up through the entire group hierarchy. For example, if a POM file is uploaded to a hosted repository, the metadata will be regenerated not only for that repository but also for all groups that contain it, all the way up to the root group.
67+
68+
### File Events (`file-event` topic)
69+
- Triggers metadata cleanup when POM files or package tarballs are uploaded/deleted
70+
- Automatically clears corresponding metadata files in hosted repositories
71+
- **Group Propagation**: Updates cascade through all repository groups containing the affected repository
72+
73+
### Promote Events (`promote-complete` topic)
74+
- Handles promotion completion events
75+
- Manages metadata updates across repository groups
6776

6877
## Development
6978

@@ -110,22 +119,6 @@ docker-compose up
110119
mvn quarkus:dev
111120
```
112121

113-
## Event Processing
114-
115-
The service processes two types of Kafka events and maintains consistency across repository group hierarchies:
116-
117-
> **Important**: When a metadata file is updated in any repository, the service automatically propagates these changes up through the entire group hierarchy. For example, if a POM file is uploaded to a hosted repository, the metadata will be regenerated not only for that repository but also for all groups that contain it, all the way up to the root group.
118-
119-
### File Events (`file-event` topic)
120-
- Triggers metadata cleanup when POM files or package tarballs are uploaded/deleted
121-
- Automatically clears corresponding metadata files in hosted repositories
122-
- **Group Propagation**: Updates cascade through all repository groups containing the affected repository
123-
124-
### Promote Events (`promote-complete` topic)
125-
- Handles promotion completion events
126-
- Manages metadata updates across repository groups
127-
128-
129122
## Monitoring & Observability
130123

131124
- **OpenTelemetry**: Distributed tracing support

0 commit comments

Comments
 (0)