Dynamic plugin #64

aliok · 2024-05-31T07:07:58Z

Changes

🎁 Made the plugin dynamic
Backstage has a WIP proposal to allow plugins to be loaded dynamically. While this is not done in upstream Backstage yet, Janus IDP has implemented this feature.
With this PR, we make the plugin dynamic so that it can be used by Janus IDP without changing the source code of Backstage.

For testing, you can clone my fork of Janus Showcase, using the feature-dynamic-plugin-works-now branch: https://github.com/aliok/backstage-showcase/tree/feature-dynamic-plugin-works-now

I've overridden the Git ignore rules to check in the generated files, so you should be able to simply do yarn install and yarn start to start the showcase and see the plugin working. However, please note that it requires a couple of things:

Knative Eventing and event mesh backend installed on your Kubernetes cluster
SA and token setup
Event mesh accessible from Backstage backend (you may use port forwarding)
Some resources (broker, trigger, eventType) available on the cluster

Essentially the same steps from https://github.com/aliok/knative-backstage-demo?tab=readme-ov-file#starting-up until the "Start Backstage" step.

Screenshot:

Next steps:

GitHub action to release the dynamic plugin on upstream knative-extensions org

Signed-off-by: Ali Ok <aliok@redhat.com>

knative-prow · 2024-05-31T07:08:00Z

@aliok: The label(s) kind/<kind> cannot be applied, because the repository doesn't have them.

In response to this:

Changes

/kind

Fixes #

Release Note
Docs

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

knative-prow · 2024-05-31T07:08:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aliok

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:

~~OWNERS~~ [aliok]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Ali Ok <aliok@redhat.com>

…xport-dynamic` command overrides it Signed-off-by: Ali Ok <aliok@redhat.com>

Signed-off-by: Ali Ok <aliok@redhat.com>

aliok · 2024-06-05T11:31:23Z

Going to do the release scripts in another problem, because I see there are some issues.

Signed-off-by: Ali Ok <aliok@redhat.com>

backstage/plugins/knative-event-mesh-backend/src/dynamic/index.ts

Cali0707 · 2024-06-05T13:38:46Z

@Zaperex could you take a look at this PR?

backstage/plugins/knative-event-mesh-backend/src/dynamic/index.ts

pierDipi · 2024-06-06T11:41:06Z

/lgtm

Zaperex

Hi @aliok, sorry I didn't submit this review in time. The PR looks good overall, just some nits about the way the new module is setup, and the lack of documentation for the new backend installation.

I made a separate PR to address those issues here: #67

Zaperex · 2024-06-06T13:20:34Z

backstage/plugins/knative-event-mesh-backend/src/module.ts

+    register(env) {
+        env.registerInit({
+            deps: {
+                catalog: catalogProcessingExtensionPoint,


Suggested change

catalog: catalogProcessingExtensionPoint,

catalog: catalogProcessingExtensionPoint,

catalogApi: catalogServiceRef,

Zaperex · 2024-06-06T13:21:11Z

backstage/plugins/knative-event-mesh-backend/src/module.ts

+                const catalogApi = new CatalogClient({
+                    discoveryApi: discovery,
+                });
+
+                const knativeEventMeshProcessor = new KnativeEventMeshProcessor(catalogApi, loggerToWinstonLogger(logger));


Suggested change

const catalogApi = new CatalogClient({

discoveryApi: discovery,

});

const knativeEventMeshProcessor = new KnativeEventMeshProcessor(catalogApi, loggerToWinstonLogger(logger));

const knativeEventMeshProcessor = new KnativeEventMeshProcessor(catalogApi, loggerToWinstonLogger(logger));

Also heads up, but for your processor, you should change the CatalogClient to CatalogApi since CatalogClient is a class not a type/interface.

Zaperex · 2024-06-06T13:34:15Z

backstage/plugins/knative-event-mesh-backend/src/module.ts

+import {CatalogClient} from "@backstage/catalog-client";
+import {catalogProcessingExtensionPoint} from '@backstage/plugin-catalog-node/alpha';


Suggested change

import {CatalogClient} from "@backstage/catalog-client";

import {catalogProcessingExtensionPoint} from '@backstage/plugin-catalog-node/alpha';

import { catalogServiceRef, catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';

Zaperex · 2024-06-06T13:37:02Z

backstage/plugins/knative-event-mesh-backend/src/module.ts

+                scheduler: coreServices.scheduler,
+                discovery: coreServices.discovery,
+            },
+            async init({catalog, config, logger, scheduler, discovery}) {


Suggested change

async init({catalog, config, logger, scheduler, discovery}) {

async init({ catalogApi, catalog, config, logger, scheduler }) {

Dynamic plugin preliminary work

f8364b3

Signed-off-by: Ali Ok <aliok@redhat.com>

knative-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2024

knative-prow bot requested review from Cali0707 and pierDipi May 31, 2024 07:08

knative-prow bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 31, 2024

aliok added 8 commits May 31, 2024 10:46

Alpha magic

647a496

Signed-off-by: Ali Ok <aliok@redhat.com>

Updates to yarn.lock

de49a4a

Signed-off-by: Ali Ok <aliok@redhat.com>

README file for the dynamic plugin

c1d6abe

Signed-off-by: Ali Ok <aliok@redhat.com>

Move README file for the dynamic plugin in a separate file as `yarn e…

23cb02c

…xport-dynamic` command overrides it Signed-off-by: Ali Ok <aliok@redhat.com>

Copy over dynamic README file into dist-dynamic

b4ba536

Signed-off-by: Ali Ok <aliok@redhat.com>

Update plugin readme file with a reference to the dynamic plugin readme

e89289d

Signed-off-by: Ali Ok <aliok@redhat.com>

Fix linter complaints

4c9e096

Signed-off-by: Ali Ok <aliok@redhat.com>

Fix dynamic readme copying script

c5b96ba

Signed-off-by: Ali Ok <aliok@redhat.com>

aliok changed the title ~~[WIP] Dynamic plugin preliminary work~~ Dynamic plugin preliminary work Jun 5, 2024

knative-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 5, 2024

aliok changed the title ~~Dynamic plugin preliminary work~~ Dynamic plugin Jun 5, 2024

Do not check in ignored file

98e1c5e

Signed-off-by: Ali Ok <aliok@redhat.com>

pierDipi reviewed Jun 5, 2024

View reviewed changes

backstage/plugins/knative-event-mesh-backend/src/dynamic/index.ts Show resolved Hide resolved

aliok commented Jun 6, 2024

View reviewed changes

backstage/plugins/knative-event-mesh-backend/src/dynamic/index.ts Show resolved Hide resolved

Update backstage/plugins/knative-event-mesh-backend/src/dynamic/index.ts

83bb64f

knative-prow bot assigned pierDipi Jun 6, 2024

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jun 6, 2024

knative-prow bot merged commit 5273de6 into knative-extensions:main Jun 6, 2024
16 checks passed

Zaperex reviewed Jun 6, 2024

View reviewed changes

Zaperex mentioned this pull request Jun 6, 2024

chore: update knative backend plugin for new backend and add docs #67

Merged

aliok deleted the 2024-05-31-dynamic-plugin branch June 6, 2024 14:49

aliok mentioned this pull request Jun 14, 2024

Dynamic plugin #27

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dynamic plugin #64

Dynamic plugin #64

aliok commented May 31, 2024 •

edited

Loading

knative-prow bot commented May 31, 2024

Changes

knative-prow bot commented May 31, 2024

aliok commented Jun 5, 2024

Cali0707 commented Jun 5, 2024

pierDipi commented Jun 6, 2024

Zaperex left a comment

Zaperex Jun 6, 2024

Zaperex Jun 6, 2024

Zaperex Jun 6, 2024 •

edited

Loading

Zaperex Jun 6, 2024

Zaperex Jun 6, 2024

	catalog: catalogProcessingExtensionPoint,
	catalog: catalogProcessingExtensionPoint,
	catalogApi: catalogServiceRef,

		import {CatalogClient} from "@backstage/catalog-client";
		import {catalogProcessingExtensionPoint} from '@backstage/plugin-catalog-node/alpha';

	import {CatalogClient} from "@backstage/catalog-client";
	import {catalogProcessingExtensionPoint} from '@backstage/plugin-catalog-node/alpha';
	import { catalogServiceRef, catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';

	async init({catalog, config, logger, scheduler, discovery}) {
	async init({ catalogApi, catalog, config, logger, scheduler }) {

Dynamic plugin #64

Dynamic plugin #64

Conversation

aliok commented May 31, 2024 • edited Loading

Changes

knative-prow bot commented May 31, 2024

Changes

knative-prow bot commented May 31, 2024

aliok commented Jun 5, 2024

Cali0707 commented Jun 5, 2024

pierDipi commented Jun 6, 2024

Zaperex left a comment

Choose a reason for hiding this comment

Zaperex Jun 6, 2024

Choose a reason for hiding this comment

Zaperex Jun 6, 2024

Choose a reason for hiding this comment

Zaperex Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

Zaperex Jun 6, 2024

Choose a reason for hiding this comment

Zaperex Jun 6, 2024

Choose a reason for hiding this comment

aliok commented May 31, 2024 •

edited

Loading

Zaperex Jun 6, 2024 •

edited

Loading