Document Eventing States More Detailed #328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyma-bot
added
area/documentation
NHingerl
reviewed
Dec 14, 2023
marcobebway
requested review from
a team
and removed request for
marcobebway
k15r
requested changes
Dec 15, 2023
docs/user/02-configuration.md
Outdated
|
|
||
| Warnings indicate that user action is required, that is, the user must install the NATS module or create an EventMesh Secret. | ||
|
|
||
| | Backend Config | Backend State | State | |
There was a problem hiding this comment.
the idea of this ticket was to clearly document which combination of settings will cause what sort of state
eg:
EV-configuration backend: NATS
NATS cluster: not available
resulting EV-STATE: ? (no events will be accepted / dispatched)
EV backend: NATS
NATSCluster: available (even if the NATS-module is currently being deleted)
Eventing: READY (events will still be accepted / dispatched)
....
There was a problem hiding this comment.
Second case you mentioned is still under development. I either document and wait until Marco is finished, or Marco will document it here. What do do think?
NHingerl
reviewed
Dec 18, 2023
muralov
force-pushed
the
doc-more-about-state
branch
from
54b42e1
to
415d571
Compare
muralov
force-pushed
the
doc-more-about-state
branch
from
415d571
to
05411aa
Compare
k15r
requested changes
Feb 14, 2024
docs/user/02-configuration.md
Outdated
|
|
||
| Warnings indicate that user action is required, that is, the user must install the NATS module or create an EventMesh Secret. | ||
|
|
||
| | Backend Config | Backend State | Backend Type | Eventing State | Addition comment | |
There was a problem hiding this comment.
Imho it would be easier to grep if we would sort the table by impact on event flow.
muralov
force-pushed
the
doc-more-about-state
branch
from
05411aa
to
779208d
Compare
k15r
reviewed
Feb 15, 2024
docs/user/02-configuration.md
Outdated
Comment on lines
90
to
96
| | exists | Error (NATS ist unavailable or cannot be connected) | NATS | Warning | no events will be accepted / dispatched | | ||
| | missing | | NATS/EventMesh | Warning | no events will be accepted / dispatched | | ||
| | exists | Error (secret for EventMesh missing) | EventMesh | Warning | no events will be accepted / dispatched | | ||
| | exists | Error (cases not caused by a user, e.g. cannot create EPP deployment or cannot start subscription manager although backend is available) | NATS/EventMesh | Error | no events will be accepted / dispatched | | ||
| | exists | Processing (mainly happens during initialization and backend switching) | NATS/EventMesh | Processing | no events will be accepted / dispatched | | ||
| | exists | Missing | NATS | Warning | no events will be accepted / dispatched | | ||
| | exists | Warning (NATS deletion blocked) | NATS | Ready | events will be accepted / dispatched | |
There was a problem hiding this comment.
Suggested change
| | exists | Error (NATS ist unavailable or cannot be connected) | NATS | Warning | no events will be accepted / dispatched | | |
| | missing | | NATS/EventMesh | Warning | no events will be accepted / dispatched | | |
| | exists | Error (secret for EventMesh missing) | EventMesh | Warning | no events will be accepted / dispatched | | |
| | exists | Error (cases not caused by a user, e.g. cannot create EPP deployment or cannot start subscription manager although backend is available) | NATS/EventMesh | Error | no events will be accepted / dispatched | | |
| | exists | Processing (mainly happens during initialization and backend switching) | NATS/EventMesh | Processing | no events will be accepted / dispatched | | |
| | exists | Missing | NATS | Warning | no events will be accepted / dispatched | | |
| | exists | Warning (NATS deletion blocked) | NATS | Ready | events will be accepted / dispatched | | |
| | exists | Warning (NATS deletion blocked) | NATS | Ready | events will be accepted / dispatched | | |
| | exists | Processing (mainly happens during initialization and backend switching) | NATS/EventMesh | Processing | no events will be accepted / dispatched | | |
| | exists | Error (NATS ist unavailable or cannot be connected) | NATS | Warning | no events will be accepted / dispatched | | |
| | missing | | NATS/EventMesh | Warning | no events will be accepted / dispatched | | |
| | exists | Missing | NATS | Warning | no events will be accepted / dispatched | | |
| | exists | Error (secret for EventMesh missing) | EventMesh | Warning | no events will be accepted / dispatched | | |
| | exists | Error (cases not caused by a user, e.g. cannot create EPP deployment or cannot start subscription manager although backend is available) | NATS/EventMesh | Error | no events will be accepted / dispatched | |
NHingerl
approved these changes
Feb 15, 2024
k15r
approved these changes
Feb 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
More detailed documentation of the Eventin CR state