Skip to content
This repository has been archived by the owner on Jul 19, 2021. It is now read-only.

Commit

Permalink
technical debt section
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenpeeters committed May 30, 2018
1 parent dff7ce8 commit b2d4bb5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,14 @@ The following capabilities are removed:
## HTTP API

This Agent exposes an HTTP api for starting and stopping of instances and the managemnt of buckets. This API is implemented by the [Agent API](https://github.com/ICTU/agent-api) library. This library can be reused by different Agent implementations as it only implements the API (contract) between the Dashboard and the 'Agent'.
**The HTTP API is marked as technical debt. See the 'Technical Debt' section below.


## MQTT

### Subscriptions

This component doesn't subscribe to topics.
This component doesn't subscribe to topics. See the 'Technical Debt' section below.

### Publications

Expand Down Expand Up @@ -128,3 +129,8 @@ This component publishes information on the following topics
- /agent/docker/pulling

Publishes information about pulling Docker images.

## Technical debt

This component currently contains some technical debt. Effort has been made to decouple component interactions by introducting MQTT as a message broker. This way all direct HTTP calls have been removed. The only remnant of this pre-MQTT era is the Agent HTTP API. In future developments the agent should accept MQTT messages, replacing the HTTP API completely.
Chaning from HTTP to MQTT also impacts the Dashboard, since it calls the HTTP API.

0 comments on commit b2d4bb5

Please sign in to comment.