Skip to content

Commit fa790e1

Browse files
authored
Add architecture architecture to documentation (#72)
1 parent dbaa1fc commit fa790e1

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ documentation, we greatly value feedback and contributions from our community.
2525
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
2626
information to effectively respond to your bug report or contribution.
2727

28+
## Architecture Overview
29+
30+
![Architecture diagram](docs/architecture-overview.png?raw=true)
31+
32+
* `pkg/controllers/serviceexport_controller` is watching changes on K8s `ServiceExport` resources (and corresponding services/endpoints). As soon as any change in configuration is detected, it registers all exported service endpoints to corresponding (same namespace/service names) AWS Cloud Map structures (namespace, service, instances).
33+
* `pkg/controllers/cloudmap_controller` is periodically polling for changes in corresponding AWS Cloud Map namespaces (based on namespace "sameness" - a K8s namespace with the same name as a Cloud Map namespace). When new service or endpoints are discovered they are automatically created locally as a `ServiceImport`.
34+
2835
## Getting Started
2936

3037
### Local Setup

docs/architecture-overview.png

59 KB
Loading

0 commit comments

Comments
 (0)