Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Fix Eventing State doc formatting #502

Merged
merged 3 commits into from
Feb 22, 2024
Merged

doc: Fix Eventing State doc formatting #502

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8af2571
doc: Fix Eventing State doc formatting
muralov Feb 19, 2024
c787271
Improve for code review comment
muralov Feb 20, 2024
9a4c085
Make as a part of the config section
muralov Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/user/02-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,27 @@ View the complete [Eventing CRD](https://github.com/kyma-project/eventing-manage

The CRD is equipped with validation rules and defaulting, so the CR is automatically filled with default values.

The validation rules provide guidance when you edit the CR. For example, you are not allowed to delete an existing backend.

You can override the defaults. However, you must make sure that a backend is set; otherwise the Eventing Manager does not create any resources and goes into warning state.

The validation rules provide guidance when you edit the CR. For example, you are not allowed to delete an existing backend.
### Impact of the Backend to the Eventing CR State and Event Flow
The following table provides more details on the overall state of the Eventing CR:
- The <b>Backend State</b> column describes the state of the NATS backend or EventMesh Secret existence.
- The <b>Backend Config</b> describes whether the Eventing CR that has been specified by a user or is not available.
- The <b>Eventing State</b> describes the overall state of the Eventing CR.

Warnings indicate that user action is required, that is, the user must install the NATS module or create an EventMesh Secret.

| Backend Type | Backend Config | Backend State | Eventing State | Impact on Event Flow |
|----------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------|
| NATS/EventMesh | missing | n/a | Warning | No events will be accepted or dispatched |
| NATS/EventMesh | exists | Processing (mainly happens during initialization and backend switching) | Processing | No events will be accepted or dispatched |
| NATS | exists | Warning (NATS deletion blocked) | Ready | Events will be accepted or dispatched |
| NATS | exists | Error (NATS ist unavailable or cannot be connected) | Warning | No events will be accepted or dispatched |
| NATS | exists | Missing | Warning | No events will be accepted or dispatched |
| EventMesh | exists | Error (secret for EventMesh missing) | Warning | No events will be accepted or dispatched |
| NATS/EventMesh | exists | Error (cases not caused by a user, such as cannot create EPP deployment or cannot start subscription manager although backend is available) | Error | No events will be accepted or dispatched |

## Examples

Expand Down Expand Up @@ -73,24 +91,6 @@ Use the following sample CRs as guidance. Each can be applied immediately when y
| **conditions.&#x200b;type** (required) | string | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
| **publisherService** | string | |
| **specHash** (required) | integer | |
| **state** (required) | string | Can have one of the following values: `Ready`, `Error`, `Processing`, `Warning`. `Ready` state is set when all the resources are deployed successfully and backend is connected. It gets `Warning` state in case backend is not specified, NATS module is not installed or EventMesh secret is missing in the cluster. `Error` state is set when there is an error. `Processing` state is set if recources are being created or changed. See the next section for more details. |
| **state** (required) | string | Can have one of the following values: `Ready`, `Error`, `Processing`, `Warning`. `Ready` state is set when all the resources are deployed successfully and backend is connected. It gets `Warning` state if backend is not specified, NATS module is not installed or EventMesh secret is missing in the cluster. `Error` state is set when there is an error not caused by a user. `Processing` state is set when eventing is initiliazed or backend is being switched. |

<!-- TABLE-END -->

<h3>More Details About Eventing CR State</h3>
The following table provides more details on the overall state of the Eventing CR:
- The <b>State</b> column has the overall state of the Eventing CR.
- The <b>Backend Config</b> column is part of the eventing CR that is either available or mistakenly not specified by a user.
- The <b>Backend State</b> column describes the state of the NATS backend or EventMesh Secret existence.

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 | Impact on event flow |
|---------------------------|---------------------------|----------------|----------------|----------|
| 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 |