Skip to content

Update readme and highlight event processing #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ruhan1 merged 1 commit into from
Sep 5, 2025
Merged

Update readme and highlight event processing #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 13 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,20 @@ storage-service-api/mp-rest/url: http://localhost
repo-service-api/mp-rest/url: http://localhost
```

### Environment Variables
## Event Processing

The service processes two types of Kafka events and maintains consistency across repository group hierarchies:

- `KAFKA_BOOTSTRAP_SERVERS`: Kafka broker addresses
- `STORAGE_SERVICE_API_MP_REST_URL`: Storage service URL
- `REPO_SERVICE_API_MP_REST_URL`: Repository service URL
> **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.

### File Events (`file-event` topic)
- Triggers metadata cleanup when POM files or package tarballs are uploaded/deleted
- Automatically clears corresponding metadata files in hosted repositories
- **Group Propagation**: Updates cascade through all repository groups containing the affected repository

### Promote Events (`promote-complete` topic)
- Handles promotion completion events
- Manages metadata updates across repository groups

## Development

Expand Down Expand Up @@ -110,22 +119,6 @@ docker-compose up
mvn quarkus:dev
```

## Event Processing

The service processes two types of Kafka events and maintains consistency across repository group hierarchies:

> **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.

### File Events (`file-event` topic)
- Triggers metadata cleanup when POM files or package tarballs are uploaded/deleted
- Automatically clears corresponding metadata files in hosted repositories
- **Group Propagation**: Updates cascade through all repository groups containing the affected repository

### Promote Events (`promote-complete` topic)
- Handles promotion completion events
- Manages metadata updates across repository groups


## Monitoring & Observability

- **OpenTelemetry**: Distributed tracing support
Expand Down