-
Notifications
You must be signed in to change notification settings - Fork 244
docs: Stop-gap info about filtering by stage, project,service #7155
Conversation
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
distributor/README.md
Outdated
A distributor queries event messages from NATS and sends the events to services that have a subscription to the event topic. | ||
Thus, each service has its own distributor that is configured by the two environment variables: | ||
A distributor subscribes a Keptn service with the Keptn Control Plane. | ||
More specifically, it queries event messages from NATS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The distributor not only supports subscribing to NATS (thats true when the keptn service runs in the same local k8s cluster as the keptn control plane). The distributor also supports subscriptions via the Keptn Subscription API - this means that the distributor can also be used by Keptn SErvices that run in remote "execution planes". I would add this details as it is important that the distributor supports both local and remote subscriptions. One is done directly via NATS - > the other one via the API
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
THANK YOU! This is exactly the sort of richness that we need in these docs! See if you approve of my fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added one comment. other than that everything looks good
Signed-off-by: Meg McRoberts <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All edits look good
Codecov Report
@@ Coverage Diff @@
## master #7155 +/- ##
==========================================
- Coverage 58.59% 58.51% -0.09%
==========================================
Files 528 528
Lines 30801 30724 -77
Branches 1508 1503 -5
==========================================
- Hits 18049 17979 -70
+ Misses 11486 11475 -11
- Partials 1266 1270 +4
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will merge once the CI passes
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
This PR adds a bit of information about filtering by stage, project, or service.
This a stop-gap measure until we can create reference pages for the values.yaml file
and Distributor (see keptn/keptn.github.io#1092 and keptn/keptn.github.io#1094 )
@grabnerandi Please check to see that I reproduced your words correctly. In particular, confirm that these values are set in the values.yaml file and passed to the Distributor from there. We can do a lot more when we do reference pages --