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

Document Warning State #317

Merged
merged 3 commits into from
Dec 12, 2023
Merged

Document Warning State #317

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ec1410
Document Warning State
muralov Dec 12, 2023
126f016
Improve for review comments
muralov Dec 12, 2023
814d3a8
Improve doc for second review
muralov Dec 12, 2023
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
14 changes: 9 additions & 5 deletions api/operator/v1alpha1/eventing_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,15 @@ type Eventing struct {

// EventingStatus defines the observed state of Eventing.
type EventingStatus struct {
ActiveBackend BackendType `json:"activeBackend"`
BackendConfigHash int64 `json:"specHash"`
State string `json:"state"`
PublisherService string `json:"publisherService,omitempty"`
Conditions []kmetav1.Condition `json:"conditions,omitempty"`
ActiveBackend BackendType `json:"activeBackend"`
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this correct right now? It might change together with: #267

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is independen from the issue. The owner of the issue should add more details as the issue is completed, I'd say.

// 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 it is in the process of deploying of the resources.
muralov marked this conversation as resolved.
Show resolved Hide resolved
grischperl marked this conversation as resolved.
Show resolved Hide resolved
State string `json:"state"`
PublisherService string `json:"publisherService,omitempty"`
Conditions []kmetav1.Condition `json:"conditions,omitempty"`
}

// EventingSpec defines the desired state of Eventing.
Expand Down
8 changes: 6 additions & 2 deletions docs/user/02-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ The CustomResourceDefinition (CRD) `eventings.operator.kyma-project.io` describe

View the complete [Eventing CRD](https://github.com/kyma-project/eventing-manager/blob/main/config/crd/bases/operator.kyma-project.io_eventings.yaml) including detailed descriptions for each field.

The CRD is equipped with validation rules and defaulting, so the CR is automatically filled with sensible defaults. You can override the defaults. The validation rules provide guidance when you edit the CR.
The CRD is equipped with validation rules and defaulting, so the CR is automatically filled with default values.

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.

## Examples

Expand Down Expand Up @@ -69,6 +73,6 @@ 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 | |
| **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 it is in the process of deploying of the resources. |

<!-- TABLE-END -->