Skip to content

Commit

Permalink
Document Eventing States More Detailed
Browse files Browse the repository at this point in the history
  • Loading branch information
@muralov
muralov committed Feb 6, 2024
1 parent e980a57 commit 2736ae6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion api/operator/v1alpha1/eventing_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ type EventingStatus struct {
BackendConfigHash int64 `json:"specHash"`
// 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 and NATS module is not installed or EventMesh secret is missing in the cluster.
// 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.
State string `json:"state"`
PublisherService string `json:"publisherService,omitempty"`
Expand Down
13 changes: 12 additions & 1 deletion docs/user/02-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ Use the following sample CRs as guidance. Each can be applied immediately when y
| **conditions.​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 and 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. |
| **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. |

<!-- TABLE-END -->

<h3>More Details about Eventing CR state</h3>
In the table below there is more information about 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. As indicated in the table, warnings are set in all cases where user action is required, e.g. the user needs to install the NATS module or create an EventMesh secret.

| Backend Config | Backend State | State |
|---------------------------|---------------------------|----------------|
| available | no NATS backend available | Warning|
| not available | | Warning |
| available | no EventMesh secret | Warning |
| available | error cases not caused by a user | Error |
| available | creating/updating eventing module | Processing |

0 comments on commit 2736ae6

Please sign in to comment.