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

Implement Backstage Custom Action for odo init #7116

Closed
4 of 6 tasks
Tracked by #7114
rm3l opened this issue Oct 13, 2023 · 1 comment
Closed
4 of 6 tasks
Tracked by #7114

Implement Backstage Custom Action for odo init #7116

rm3l opened this issue Oct 13, 2023 · 1 comment
Assignees
Labels
area/backstage Issues or PRs related to the Backstage integration kind/user-story An issue of user-story kind priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)).
Milestone

Comments

@rm3l
Copy link
Member

rm3l commented Oct 13, 2023

As a Backstage contributor contributing a template to my organization, I want to have a set of custom actions allowing me to execute odo from Backstage So that my template could provide additional functionality.
For example, my template could prompt users to select a Devfile, and then using this information, the template could include action steps to generate a starter project off of the Devfile selected, using odo init.

Acceptance Criteria

  • It should accept as input: devfile name, version and starter project
  • It should be easily installable into any Backstage instance, e.g., using an NPM package
  • It should expose a devfile:odo:component:init custom action executing odo init
  • Optionally, it could expose a generic devfile:odo:command custom action executing any odo command
  • It should take care of security, as we will be executing commands from user input.

Remaining:

  • Question of how to distribute the odo binary with this custom action plugin. Currently, we assume the integrator has to install odo in the environment the Backstage instance is running in

Related Epic: #7114

@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Oct 13, 2023
@rm3l rm3l added kind/user-story An issue of user-story kind area/backstage Issues or PRs related to the Backstage integration and removed needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. labels Oct 13, 2023
@rm3l rm3l added this to the v3.16.0 🚀 milestone Oct 19, 2023
@rm3l
Copy link
Member Author

rm3l commented Oct 19, 2023

Marking this as complete. I created a custom action plugin and published it. For now, this is available as a POC under my personal GH and NPM accounts: https://github.com/rm3l/backstage-odo-devfile-plugin/blob/main/packages/scaffolder-odo-actions-backend/README.md

We'll create additional issues based on the next steps about this.

Remaining things to do:

/close

@rm3l rm3l closed this as completed Oct 19, 2023
@rm3l rm3l self-assigned this Oct 19, 2023
@rm3l rm3l added the priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)). label Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/backstage Issues or PRs related to the Backstage integration kind/user-story An issue of user-story kind priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)).
Projects
Archived in project
Development

No branches or pull requests

1 participant