Knative Backstage plugin article #5897
Conversation
Signed-off-by: Ali Ok <aliok@redhat.com>
knative-prow
bot
added
the
do-not-merge/work-in-progress
knative-prow
bot
removed
the
do-not-merge/work-in-progress
knative-prow
bot
added
the
approved
knative-prow
bot
added
the
size/M
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Ali Ok <aliok@redhat.com>
Signed-off-by: Ali Ok <aliok@redhat.com>
Signed-off-by: Ali Ok <aliok@redhat.com>
|
|
||
| ## Demo and quick start | ||
|
|
||
| If you would like to see the plugin in action, you can install the backend in your Kubernetes cluster and the plugin in your Backstage instance. |
There was a problem hiding this comment.
Do we have a link for some how-tos for this?
There was a problem hiding this comment.
I think here is the link to the tutorial on how to install the demo https://github.com/aliok/knative-backstage-demo?tab=readme-ov-file#installation
And how to run the backend plugin
https://github.com/knative-extensions/backstage-plugins?tab=readme-ov-file#running-the-backstage-plugin
|
|
||
| ## Contact | ||
|
|
||
| If you have any questions or feedback, please feel free to reach out to us. You can find us in the [CNCF Slack](https://cncf.slack.io) in the [#knative](https://cloud-native.slack.com/archives/C04LGHDR9K7) channel. |
There was a problem hiding this comment.
The cncf slack link is invalid. https://communityinviter.com/apps/cloud-native/cncf or https://cloud-native.slack.com should be the correct one.
|  | ||
| *Knative EventTypes shown as APIs in Backstage* | ||
|
|
||
| Knative Triggers can be pointing at any [Addressable](https://knative.dev/docs/concepts/duck-typing/#addressable) or at even a URL directly. Since Backstage side won't know how to handle these, the plugin will only show the trigger's subscriber if it is already registered in Backstage. For this relation, we use the [`backstage.io/kubernetes-id`](https://backstage.io/docs/features/kubernetes/configuration#surfacing-your-kubernetes-components-as-part-of-an-entity) annotation in the Backstage entity and the Kubernetes resource. |
There was a problem hiding this comment.
| Knative Triggers can be pointing at any [Addressable](https://knative.dev/docs/concepts/duck-typing/#addressable) or at even a URL directly. Since Backstage side won't know how to handle these, the plugin will only show the trigger's subscriber if it is already registered in Backstage. For this relation, we use the [`backstage.io/kubernetes-id`](https://backstage.io/docs/features/kubernetes/configuration#surfacing-your-kubernetes-components-as-part-of-an-entity) annotation in the Backstage entity and the Kubernetes resource. | |
| Knative Triggers can be pointing at any [Addressable](https://knative.dev/docs/concepts/duck-typing/#addressable){:target="_blank"} or at even a URL directly. Since Backstage side won't know how to handle these, the plugin will only show the trigger's subscriber if it is already registered in Backstage. For this relation, we use the [`backstage.io/kubernetes-id`](https://backstage.io/docs/features/kubernetes/configuration#surfacing-your-kubernetes-components-as-part-of-an-entity){:target="_blank"} annotation in the Backstage entity and the Kubernetes resource. |
There was a problem hiding this comment.
Thanks, applied manually
knative-prow-robot
added
the
needs-rebase
Co-authored-by: Christoph Stäbler <cstabler@redhat.com>
Co-authored-by: Christoph Stäbler <cstabler@redhat.com>
Co-authored-by: Christoph Stäbler <cstabler@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
Co-authored-by: Leo Li <leoli@redhat.com>
knative-prow-robot
removed
the
needs-rebase
Signed-off-by: Ali Ok <aliok@redhat.com>
|
|
||
| [Backstage](https://backstage.io/){:target="_blank"} is a platform for building developer portals. It provides a unified way to manage and visualize the different resources that developers use in their daily work. | ||
|
|
||
| However, Backstage is not your next generation Kubernetes dashboard. It is not designed to replace the Kubernetes dashboard or any other Kubernetes management tool. |
There was a problem hiding this comment.
I think we should drop the use of However as it is there twice in the first paragraph here and may be try something like "While Backstage is not designed as a next generation Kubernetes Dashboard , it can visualize and partially manage Knative resources. These resources would be read-only and focused on what's relevant to developers.
|
|
||
| However, Backstage is not your next generation Kubernetes dashboard. It is not designed to replace the Kubernetes dashboard or any other Kubernetes management tool. | ||
|
|
||
| With these in mind, our vision is to provide a way to visualize and partially manage Knative resources in Backstage. However, these are to be considered as read-only resources and we aim to show |
There was a problem hiding this comment.
I think we should drop the use of However as it is there twice in the first paragraph here and may be try something like "While Backstage is not designed as a next generation Kubernetes Dashboard , it can visualize and partially manage Knative resources. These resources would be read-only and focused on what's relevant to developers.
|
|
||
| [The Event Mesh plugin](https://github.com/knative-extensions/backstage-plugins){:target="_blank"} is a Backstage plugin that allows you to view and manage Knative Eventing resources. The plugin talks to a special backend that runs in the Kubernetes cluster and communicates with the Kubernetes API server. | ||
|
|
||
| The plugin is not designed to be the ultimate tool for managing Knative Eventing resources. It is designed to be a developer-friendly tool that allows developers to visualize and partially manage the resources that are relevant to them. Given these constraints, the plugin is designed to be read-only, at least for the time being. |
There was a problem hiding this comment.
This whole part seems to be the repeat of earlier intro paragraph. Should we eliminate it?
|
|
||
| This plugin leverages Backstage's [entity provider](https://backstage.io/docs/features/software-catalog/external-integrations/#custom-entity-providers){:target="_blank"} and [entity processor](https://backstage.io/docs/features/software-catalog/external-integrations/#custom-processors){:target="_blank"} concept. The entity provider is responsible for fetching the resources from the backend and the entity processor is responsible for processing the resources and making them available to the frontend. The provider is the part that talks to the custom backend. | ||
|
|
||
| The plugin fetches Knative EventType, Broker, and Trigger resources from the backend. Actually, it doesn't fetch the resources as is since the Kubernetes resources are not particularly designed for using them in this kind of UI, but it fetches better suited representations of the resources where some fields are ignored, some aggregated, and some transformed. |
There was a problem hiding this comment.
This reads contradictory as first sentence said fetches and second says it doesn't fetch. :(
The plugin fetches Knative EventType, Broker, and Trigger resources from the backend. Instead of directly fetching the raw Kubernetes resources, it gathers a more user-friendly representation of the data. This means certain fields are excluded, some are combined for clarity, and others are transformed to be easier to understand within this interface.
|
|
||
| If you would like to see the plugin in action, you can [install](https://github.com/knative-extensions/backstage-plugins?tab=readme-ov-file#running-the-backstage-plugin){:target="_blank"} the backend in your Kubernetes cluster and the plugin in your Backstage instance. | ||
|
|
||
| However, if you want a quick look at the plugin, you can check out the [demo video](https://www.youtube.com/watch?v=4h1j1v8KrY0){:target="_blank"}. |
There was a problem hiding this comment.
For a quicker look, check out the demo video
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aliok, creydr The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Looks like I am too late :) |
Preview https://deploy-preview-5897--knative.netlify.app/blog/articles/knative-backstage-plugins/