knative-extensions / eventing-kafka-broker

Alternate Kafka Broker implementation.
Apache License 2.0
185 stars 117 forks source link

KafkaChannel .status.conditions.reason should be "one-word, CamelCase representation of the category of cause of the current status" #2232

Closed maschmid closed 9 months ago

maschmid commented 2 years ago

Describe the bug Seeing a KafkaChannel with status

status:
  conditions:
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    status: Unknown
    type: Addressable
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    status: Unknown
    type: ConfigMapUpdated
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    reason: 'failed to resolve Spec.Delivery.DeadLetterSink: address not set for &ObjectReference{Kind:Parallel,Namespace:test-iizggqjx,Name:kcmtbkcpar-dls,UID:,APIVersion:flows.knative.dev/v1,ResourceVersion:,FieldPath:,}'              
    status: "False"
    type: ConfigParsed
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    status: "True"
    type: DataPlaneAvailable
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    status: Unknown
    type: ProbeSucceeded
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    reason: 'failed to resolve Spec.Delivery.DeadLetterSink: address not set for &ObjectReference{Kind:Parallel,Namespace:test-iizggqjx,Name:kcmtbkcpar-dls,UID:,APIVersion:flows.knative.dev/v1,ResourceVersion:,FieldPath:,}'              
    status: "False"
    type: Ready
  - lastTransitionTime: "2022-05-27T14:55:20Z"
    reason: Topic knative-messaging-kafka.test-iizggqjx.kcmtbkcpar-kne-trigger created
    status: "True"
    type: TopicReady

Per https://github.com/kubernetes/community/blob/4c9ef2d/contributors/devel/sig-architecture/api-conventions.md ,

In condition types, and everywhere else they appear in the API, Reason is intended to be a one-word, CamelCase representation of the category of cause of the current status, and Message is intended to be a human-readable phrase or sentence, which may contain specific details of the individual occurrence. Reason is intended to be used in concise output, such as one-line kubectl get output, and in summarizing occurrences of causes, whereas Message is intended to be presented to users in detailed status explanations, such as kubectl describe output.

Expected behavior Error conditions should have single-word CamelCase reason with an optional human-readable message

To Reproduce

Knative release version 1.2.3

Additional context

github-actions[bot] commented 2 years ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

maschmid commented 2 years ago

/remove-lifecycle stale

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

knative-prow-robot commented 1 year ago

This issue or pull request is stale because it has been open for 90 days with no activity.

This bot triages issues and PRs according to the following rules:

You can:

/lifecycle stale

pierDipi commented 1 year ago

/remove-lifecycle stale

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

pierDipi commented 1 year ago

/remove-lifecycle stale

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

maschmid commented 1 year ago

/remove-lifecycle stale

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

maschmid commented 1 year ago

/remove-lifecycle stale

github-actions[bot] commented 10 months ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.