New Repo: knative-extensions/backstage-plugins
aliok opened this issue · comments
Use this issue type to request a new repo in knative-extensions
(or
knative
, which may require additional discussion).
Repo information
Org: knative-extensions
Repo: backstage-plugins
Go module (Optional): knative.dev/$REPONAME
Purpose (Description):
Backstage, the internal developer portal, could be a very useful way to spread the usage of Knative Eventing.
While we're working on Event Discovery (knative/eventing#4892, project) feature, we realized it can be very useful if the developers can discover the EventTypes in Backstage, with their metadata (docs, schema, etc.).
Similarly, it might make sense to show the sources/sinks/services/etc.. Perhaps in a topology view with connections, in a list view without connections but discoverable.
Furthermore, this integration can be even extended to an integration with Knative Functions. It can be possible to select an EventType and create a consumer/producer template. The outcome would be a Knative Functions project with some of the implementation filled for the EventType.
Eventing issue: knative/eventing#7110
Sponsoring WG:
Eventing WG cc @pierDipi
Actions to fulfill
This area is used to track the repo creation process.
The requestor and sponsoring WG lead should perform the steps listed below and cross out the checkmarks when done.
The TOC is involved only in the TOC Gate steps.
- Add this issue to the TOC project board for review. You are responsible for moving your entry on the board to "Needs Discussion" or "In Progress" as you move forward in this checklist.
You may not be able to use the Projects quick menu on this page. In that case, go to the project board and use the Add cards interface.
- Send a PR adding entries for this repo in
/peribolos/knative-extensions.yaml
. Please mind the alphabetical order when adding to a list (#1464).- Add the repository and a description.
- Grant
Knative Admin
theadmin
privilege. - Grant the sponsoring WG the
write
privilege.
TOC Gate: Once the TOC has approved the above, it will merge and Peribolos will create an empty repository.
-
(golang) Send a PR to add aliases for
knative.dev/$REPONAME
import paths (sample). : knative/docs#5787 -
Have a lead from the sponsoring WG bootstrap the Git repository by using an
appropriate "template" repository (basic,
sample-controller,
sample-source). --> As the repository was already created by Peribolos, I pushed initial files manually: knative-extensions/backstage-plugins@ddc18ecFollow the instructions from Creating a repository from a template
-
Send a PR adding the repo to knobots. Then run the community files update action to propagate new OWNER_ALIASES. --> knative-extensions/knobots#350, knative-extensions/backstage-plugins#4, knative-extensions/backstage-plugins#3
-
Add your GitHub Team to the
OWNERS
file for your repo. --> knative-extensions/backstage-plugins#4 -
Set up prow for a new repo --> knative/infra#295
-
Bootstrap your CI jobs using hack project (look at other extensions repos for reference)
-
Create a sample PR to verify Prow (e.g., edit the boilerplate README)
-
Verify that within 24 hours the appropriate branch protections have been applied
requiringtide
to pass before PRs are merged. -
(optional) Send a PR adding the repo to CLOMonitor (more information). --> knative-extensions/backstage-plugins#31
Please note that, there's a POC which will be the basis of this work: https://github.com/openshift-knative/knative-eventing-backstage-poc
+1 from Eventing WG
In this case, the prefix eventing-
is not applicable since the scope touches Function, so we see this repository more for Knative within Backstage
+1
+1
@dprotaso @kvmware @davidhadas please if you can take a look, and review async. Thanks!
+1
You have quorum you're good
+1
Hmm, can we actually create the repo as "backstage-plugins" (plural)?
/close
Thanks folks. This work is done