Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

docs: Stop-gap info about filtering by stage, project,service #7155

Merged
merged 6 commits into from
Mar 25, 2022
Merged

docs: Stop-gap info about filtering by stage, project,service #7155

merged 6 commits into from
Mar 25, 2022

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Mar 15, 2022

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

@StackScribe StackScribe requested a review from a team as a code owner March 15, 2022 01:43
Signed-off-by: Meg McRoberts <[email protected]>
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
Copy link
Member

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

Copy link
Contributor Author

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.

Copy link
Member

@grabnerandi grabnerandi left a 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

@StackScribe StackScribe requested a review from grabnerandi March 16, 2022 08:17
Copy link
Member

@grabnerandi grabnerandi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@oleg-nenashev oleg-nenashev left a 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
Copy link

codecov bot commented Mar 17, 2022

Codecov Report

Merging #7155 (c4d5282) into master (f640e2c) will decrease coverage by 0.08%.
The diff coverage is n/a.

@@            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     
Impacted Files Coverage Δ
shipyard-controller/nats/pullsubscription.go 57.14% <0.00%> (-10.08%) ⬇️
shipyard-controller/handler/sequencewatcher.go 60.24% <0.00%> (-9.53%) ⬇️
shipyard-controller/handler/evaluationmanager.go 78.57% <0.00%> (-8.58%) ⬇️
...trigger-sequence/ktb-trigger-sequence.component.ts 72.10% <0.00%> (-2.30%) ⬇️
...-controller/handler/sequencehooks/sequencestate.go 66.06% <0.00%> (-0.72%) ⬇️
api/handlers/metadata.go 85.52% <0.00%> (-0.38%) ⬇️
webhook-service/lib/curl_executor.go 94.87% <0.00%> (-0.37%) ⬇️
cli/cmd/create_project.go 62.12% <0.00%> (ø)
resource-service/common/git.go 55.42% <0.00%> (ø)
shipyard-controller/models/eventscope.go 55.55% <0.00%> (ø)
... and 30 more
Flag Coverage Δ
distributor 70.76% <ø> (ø)
helm-service 49.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@mowies mowies changed the title Stop-gap info about filtering by stage, project,service docs: Stop-gap info about filtering by stage, project,service Mar 21, 2022
@oleg-nenashev oleg-nenashev added the doc documentation label Mar 25, 2022
Copy link
Member

@oleg-nenashev oleg-nenashev left a 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

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@oleg-nenashev oleg-nenashev merged commit ee03d92 into keptn:master Mar 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
doc documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants