diff --git a/api/operator/v1alpha1/eventing_types.go b/api/operator/v1alpha1/eventing_types.go index a6111468..f6933809 100644 --- a/api/operator/v1alpha1/eventing_types.go +++ b/api/operator/v1alpha1/eventing_types.go @@ -96,7 +96,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"` diff --git a/docs/user/02-configuration.md b/docs/user/02-configuration.md index 902add5a..21d7e5ff 100644 --- a/docs/user/02-configuration.md +++ b/docs/user/02-configuration.md @@ -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. | + +