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.

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

It is not clear why Eventing optional components are optional #4535

Open
pierDipi opened this issue Dec 2, 2021 · 4 comments
Open

It is not clear why Eventing optional components are optional #4535

pierDipi opened this issue Dec 2, 2021 · 4 comments
Labels
hacktoberfest Issues that can be picked up by contributors for Hacktoberfest! kind/bug Categorizes issue or PR as related to a bug. kind/eventing lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/high

Comments

@pierDipi
Copy link
Member

pierDipi commented Dec 2, 2021

Users have been reporting multiple times that their Broker or Channel setup doesn't work because the documentation reports that Broker and Channel layers are optional like in knative/eventing#5944.

Those optional components are required to follow the next steps, so I'm proposing to remove the Optional word in the heading and instead add a sentence explaining why a Broker or Channel layer might be optional and what you can't do without that particular layer.

Expected Behavior

  • There is no confusion

Steps to Reproduce the Problem

  1. Install required components only
  2. Follow the create a Broker page: https://knative.dev/docs/eventing/broker/create-mtbroker/

Additional Info

Install information:

  • Platform (GKE, IKS, AKS, etc.): All
  • Knative Version: All

/kind eventing

@pierDipi pierDipi added the kind/bug Categorizes issue or PR as related to a bug. label Dec 2, 2021
@limylily
Copy link

limylily commented Dec 2, 2021

It is recommended to modify the document.

Both the Channel layer and the Broker layer need to be installed, but you can choose one of multiple options to install.

Is there a corresponding relationship between multiple options? For example, whether installing NATS Channel for the Channel layer and Apache Kafka Broker for the Broker layer can test successfully?

@pierDipi
Copy link
Member Author

pierDipi commented Dec 2, 2021

I agree a clarification may be helpful.

Is there a corresponding relationship between multiple options? For example, whether installing NATS Channel for the Channel layer and Apache Kafka Broker for the Broker layer can test successfully?

This is possible, you can use multiple layers in the same cluster.

The only relationship that they have is that they all conform to the shared spec: https://github.com/knative/specs/tree/main/specs/eventing that allows multiple layers to be integrated and communicate with each other in a loosely coupled way.

@github-actions
Copy link

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.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 11, 2022
@pierDipi
Copy link
Member Author

/remove-lifecycle stale

@knative-prow-robot knative-prow-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 11, 2022
@abrennan89 abrennan89 added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label May 19, 2022
@abrennan89 abrennan89 self-assigned this Jul 28, 2022
@snneji snneji moved this to In design in Docs WG Roadmap Aug 30, 2022
@abrennan89 abrennan89 removed their assignment Sep 26, 2022
@abrennan89 abrennan89 moved this from In design to Ready to work in Docs WG Roadmap Sep 26, 2022
@abrennan89 abrennan89 moved this from Ready to work to Icebox in Docs WG Roadmap Sep 26, 2022
@abrennan89 abrennan89 added priority/high hacktoberfest Issues that can be picked up by contributors for Hacktoberfest! and removed priority/medium labels Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Issues that can be picked up by contributors for Hacktoberfest! kind/bug Categorizes issue or PR as related to a bug. kind/eventing lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/high
Projects
None yet
Development

No branches or pull requests

5 participants