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

Create Backstage Plugin for Odo CLI to Bootstrap Application Development with Devfiles #7091

Open
12 of 20 tasks
mohitsuman opened this issue Sep 20, 2023 · 4 comments
Open
12 of 20 tasks
Labels
area/backstage Issues or PRs related to the Backstage integration kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)).

Comments

@mohitsuman
Copy link

mohitsuman commented Sep 20, 2023

/kind feature

As part of improving the developer experience and enabling efficient application development, we propose creating a Backstage plugin that integrates with the Odo CLI to facilitate the quick and easy bootstrapping of applications using devfiles. Devfiles provide a standardized way to describe development environments, making it easier for developers to get started with projects.

Acceptance Criteria:
To consider this issue complete, the following criteria should be met:

  1. Backstage Plugin Creation:

  2. Integration with Odo CLI:

  3. Application Bootstrap using Devfiles:

  4. Testing and Quality Assurance:

    • Include comprehensive unit and integration tests to verify the functionality of the plugin.
    • Ensure that the plugin functions correctly with a variety of devfile configurations.
  5. Documentation:

    • Document the usage of the Backstage plugin in the official Backstage documentation.
    • Include detailed instructions on how to configure and use the plugin for application development with devfiles. (UPDATE: Work done so far is documented: Template, Custom Extensions, Devfile Builder in React).
  6. Community Engagement:

    • Promote the availability of this new Backstage plugin within relevant communities and forums.
  7. Compatibility:

    • Ensure that the plugin is compatible with the latest versions of Backstage and Odo CLI.

Sub-stories/tasks:

@openshift-ci openshift-ci bot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Sep 20, 2023
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Sep 20, 2023
@rm3l rm3l added kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)). and removed needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. labels Sep 20, 2023
@rm3l
Copy link
Member

rm3l commented Sep 25, 2023

Community Call (2023-09-25)

  • Template => for creating a new repo + new Devfile
  • Plugin for 2 different flows:
    • if project has a Devfile
    • if project does not have a Devfile

@rm3l rm3l added the area/backstage Issues or PRs related to the Backstage integration label Oct 5, 2023
@rm3l
Copy link
Member

rm3l commented Oct 19, 2023

Status Update (as of Oct 19, 2023):

Based on the various discussions that we had, the work has been tackled from two perspectives:

Acceptance Criteria: To consider this issue complete, the following criteria should be met:

  1. Backstage Plugin Creation:

    • Develop a new Backstage plugin dedicated to integrating with the Odo CLI.

A custom action plugin has been implemented in #7116, with the goal of using that to execute odo from a Backstage Template (so it would be a means to integrate the Odo CLI).
It currently assumes the odo binary is installed in the environment the Backstage instance is running in.
As commented out in #7116 (comment), we still need to think of a way to distribute odo alongside the plugin module.
Anyway, to integrate the Devfile Builder Editor (Frontend Plugin) into Backstage, we would need to implement a specific Backend Plugin (#7107). We can think about the odo distribution while working on this specific Backend Plugin..

  • Ensure that the plugin is well-documented and follows best practices for Backstage plugin development.

Done in https://github.com/rm3l/odo-backstage-golden-path-template and https://github.com/rm3l/backstage-odo-devfile-plugin

  • Add plugin to Janus community
  1. Integration with Odo CLI:

    • Implement integration with the Odo CLI, allowing developers to interact with the CLI from within Backstage.
  2. Application Bootstrap using Devfiles:

    • Enable the plugin to support the bootstrapping of applications using devfiles.

Bootstrapping possible via #7114.
See #7114 (comment) for the remaining items.
Not covered yet: creating Devfile for existing applications with already existing source code.

  1. Testing and Quality Assurance:

    • Include comprehensive unit and integration tests to verify the functionality of the plugin.
    • Ensure that the plugin functions correctly with a variety of devfile configurations.
  2. Documentation:

    • Document the usage of the Backstage plugin in the official Backstage documentation.
    • Include detailed instructions on how to configure and use the plugin for application development with devfiles.
  3. Community Engagement:

    • Promote the availability of this new Backstage plugin within relevant communities and forums.
  4. Compatibility:

    • Ensure that the plugin is compatible with the latest versions of Backstage and Odo CLI.

@rm3l rm3l moved this to In Progress 🚧 in odo Project Nov 21, 2023
Copy link
Contributor

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

@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 19, 2024
@rm3l
Copy link
Member

rm3l commented Mar 19, 2024

/remove-lifecycle stale
/lifecycle frozen

@openshift-ci openshift-ci bot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 19, 2024
@rm3l rm3l moved this from In Progress 🚧 to To Do 📝 in odo Project Mar 19, 2024
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/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/High Important issue; should be worked on before any other issues (except priority/Critical issue(s)).
Projects
Status: To Do 📝
Development

No branches or pull requests

2 participants