diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 8ecd7c4a38..106bf56f79 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -6,80 +6,101 @@ description: Roadmap of Backstage ## The Backstage Roadmap -Backstage is currently under rapid development. This page details the project’s +Backstage is currently under rapid development. This page details the project's public roadmap, the result of ongoing collaboration between the core maintainers and the broader Backstage community. -The Backstage roadmap lays out both [“what’s next”](#whats-next) and -[“future work”](#future-work). With "next" we mean features planned for release -within the ongoing quarter from January through March 2022. With "future" we -mean features in the radar, but not yet scheduled. +The Backstage roadmap lays out both [“what's next”](#whats-next) and ["future +work"](#future-work). With "next" we mean features planned for release within +the ongoing quarter from January through March 2022. With "future" we mean +features on the radar, but not yet scheduled. -| [What's next](#whats-next) | [Future work](#future-work) | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Backstage 1.0 (and following versions)](#backstage-10-and-following-versions)
[Backstage Security Audit](#backstage-security-audit)
[Moving to Incubation in CNCF](#moving-to-incubation-in-cncf) | Backend Services
Security Plan (and Strategy)
TechDocs Addon framework
Composable Homepage 1.0
GraphQL
Telemetry
Improved UX design | +| [What's next](#whats-next) | [Future work](#future-work) | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| [Ease of onboarding](#ease-of-onboarding)
[Search 1.0](#search-1.0)
[TechDocs Addon framework](#techdocs-addon-framework)
[Backend Services (initial)](#backend-services-initial)
[Backstage Security Audit](#backstage-security-audit)
[SIGs for contributors](#sigs-for-contributors) | Security Plan (and Strategy)
Composable Homepage 1.0
GraphQL
Telemetry
Improved UX design | The long-term roadmap (12 - 36 months) is not detailed in the public roadmap. Third-party contributions are also not currently included in the roadmap. Let us -know about any ongoing developments and we’re happy to include them here as well. +know about any ongoing developments and we're happy to include them here as +well. -## What’s next +## What's next The feature set below is planned for the ongoing quarter, and grouped by theme. -The list order doesn’t necessarily reflect priority, and the development/release +The list order doesn't necessarily reflect priority, and the development/release cycle will vary based on maintainer schedules. -### Backstage 1.0 (and following versions) +### Ease of onboarding -During the first quarter of 2022, we plan to finalize and release version 1.0 of -the Backstage platform (which includes Core, -[Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), -[Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) -and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). -Included as part of this milestone: +A faster (with less development) and easier setup of a proof-of-concept +deployment, as part of the onboarding experience, has been a common and loud +suggestion from new adopters as well as analysts looking at Backstage. -- Deciding on the cadence of minor/weekly/daily releases to provide clarity on - the frequency and expectations for future versions of the platform and its - defining modules. -- Establish the support model to set the expectations from the adopters in their - respective use cases. +With this initiative we plan to start facing this important topic with the most +commonly used and challenging tasks. More in particular we plan to reduce the +effort required to go from zero to production in installing and customizing +Backstage, as well as reducing the effort required to populate the Software +Catalog. + +More iterations will be required in the following quarters, but this will be a +good improvement in the onboarding experience, especially for the benefit of new +adopters. + +### Search 1.0 + +Fix the few remaining issues to get Backstage Search platform up to 1.0 +([here](https://github.com/backstage/backstage/milestone/27) and +[here](https://github.com/backstage/backstage/milestone/28)). + +### TechDocs Addon framework + +Addons are TechDocs features that are added on top of the base docs-like-code +experience. An example would be a feature that showed comments on the page. We +plan to add an Addon framework and open source a selection of the Addons that we +use internally at Spotify. Further Addons can then be added by the Community. + +### Backend Services (initial) + +To better scale and maintain the Backstage instances, a backend services system +is planned to be introduced as part of the software architecture. This layer of +backend services will help in decoupling the various modules (e.g. Catalog and +Scaffolder) from the frontend experience. + +In this quarter we plan to start designing the new architecture, together with +the first experimentation and development of the software components. ### Backstage Security Audit +This is the continuation of the initiative started in the previous quarter. This +quarter will see the publication of the report describing the outcome of the +audit, together the first fixes and the development of some of the changes +required to address the vulnerabilities. + This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third-party companies in auditing -the platform and highlighting potential vulnerabilities. The benefit for the -adopters is clear: We want Backstage to be as secure as possible, and we want to -make it reliable through a specific initiative. This initiative in particular is -done together, and with the support of, the -[Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). +the platform. The benefit for the adopters is clear: we want Backstage to be as +secure as possible, and we want to make it reliable through a specific +initiative. -### Moving to Incubation in CNCF +This initiative is done together with, and with the support of, the [Cloud +Native Computing Foundation (CNCF)](https://www.cncf.io/). -The progress of the request can be seen -[here](https://github.com/cncf/toc/pull/717). +### SIGs for contributors + +The request to better coordinate the increasing number of contributions coming +from the various adopters' developers is loud and clear. We think that the +community is mature enough to start launching the SIGs (Special Interest Groups) +following the successful model of Kubernetes. ## Future work -The following feature list doesn’t represent a commitment to develop, and the -list order doesn’t reflect any priority or importance, but these features are on -the maintainers’ radar, with clear interest expressed by the community. +The following feature list doesn't represent a commitment to develop, and the +list order doesn't reflect any priority or importance, but these features are on +the maintainers' radar, with clear interest expressed by the community. -- **Backend Services:** To better scale and maintain the Backstage instances, a - backend layer of services is planned to be introduced as part of the software - architecture. This layer of backend services will help in decoupling the - various modules (e.g. Catalog and Scaffolder) from the frontend experience. - **Security Plan (and Strategy):** The purpose of the Security Strategy is to move another step along the path to maturing the platform, setting the expectations of any adopters from a security standpoint. -- **Search 1.0:** Fix the few remaining issues to get Backstage Search platform - up to 1.0 ([here](https://github.com/backstage/backstage/milestone/27) and - [here](https://github.com/backstage/backstage/milestone/28)). -- **TechDocs Addon framework and Addons:** Addons are TechDocs features that are - added on top of the base docs like code experience. An example would be a - feature that showed comments on the page. We plan to add an Addon framework - and open source a selection of the Addons that we use internally at Spotify. - Further Addons can then be added by the Community. - **Composable Homepage 1.0:** Driving this to 1.0 by adding some composable components. - **[GraphQL](https://graphql.org/) support:** Introduce the ability to query @@ -107,51 +128,5 @@ guidelines to get started. If you have specific questions about the roadmap, please create an [issue](https://github.com/backstage/backstage/issues/new/choose), ping us on -[Discord](https://discord.gg/qxsEfa8Vq8), or -[book time](http://calendly.com/spotify-backstage) with the Spotify team. - -## Completed milestones - -Read more about the completed (and released) features for reference. - -- [[Search] ElasticSearch integration](https://backstage.io/docs/features/search/search-engines#elasticsearch) -- [[Search] TechDocs search capabilities](https://backstage.io/docs/features/search/how-to-guides#how-to-index-techdocs-documents) -- [TechDocs Beta](https://backstage.spotify.com/blog/product-updates/techdocs-beta-has-landed) -- [[Home] Composable homepage](https://github.com/backstage/backstage/milestone/34) -- [[Search] Out-of-the-Box Implementation (Alpha)](https://github.com/backstage/backstage/milestone/26) -- [Deploy a product demo at `demo.backstage.io`](https://demo.backstage.io) -- [Kubernetes plugin - v1](https://github.com/backstage/backstage/tree/master/plugins/kubernetes) -- [Helm charts](https://github.com/backstage/backstage/tree/master/contrib/chart/backstage) -- [Backstage Design System 💅](https://backstage.io/blog/2020/09/30/backstage-design-system) -- [Cost Insights plugin 💸](https://engineering.atspotify.com/2020/09/29/managing-clouds-from-the-ground-up-cost-engineering-at-spotify/) -- [Donate Backstage to the CNCF 🎉](https://backstage.io/blog/2020/09/23/backstage-cncf-sandbox) -- [TechDocs v1](https://backstage.io/blog/2020/09/08/announcing-tech-docs) -- [Plugin marketplace](https://backstage.io/plugins) -- [Improved and move documentation to backstage.io](https://backstage.io/docs/overview/what-is-backstage) -- [Backstage Software Catalog (alpha)](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha) -- [Backstage Software Templates (alpha)](https://backstage.io/blog/2020/08/05/announcing-backstage-software-templates) -- [Make it possible to add custom auth providers](https://backstage.io/blog/2020/07/01/how-to-enable-authentication-in-backstage-using-passport) -- [TechDocs v0](https://github.com/backstage/backstage/milestone/15) -- CI plugins: CircleCI, Jenkins, GitHub Actions and TravisCI -- [Service API documentation](https://github.com/backstage/backstage/pull/1737) -- Backstage Software Catalog can read from: GitHub, GitLab, - [Bitbucket](https://github.com/backstage/backstage/pull/1938) -- Support auth providers: Google, Okta, GitHub, GitLab, - [auth0](https://github.com/backstage/backstage/pull/1611), - [AWS](https://github.com/backstage/backstage/pull/1990) - -- [Donate Backstage to the CNCF 🎉](https://backstage.io/blog/2020/09/23/backstage-cncf-sandbox) -- [TechDocs v1](https://backstage.io/blog/2020/09/08/announcing-tech-docs) -- [Plugin marketplace](https://backstage.io/plugins) -- [Improved and move documentation to backstage.io](https://backstage.io/docs/overview/what-is-backstage) -- [Backstage Software Catalog (alpha)](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha) -- [Backstage Software Templates (beta)](https://backstage.io/blog/2021/07/26/software-templates-are-now-in-beta) -- [Make it possible to add custom auth providers](https://backstage.io/blog/2020/07/01/how-to-enable-authentication-in-backstage-using-passport) -- [TechDocs v0](https://github.com/backstage/backstage/milestone/15) -- CI plugins: CircleCI, Jenkins, GitHub Actions and TravisCI -- [Service API documentation](https://github.com/backstage/backstage/pull/1737) -- Backstage Software Catalog can read from: GitHub, GitLab, - [Bitbucket](https://github.com/backstage/backstage/pull/1938) -- Support auth providers: Google, Okta, GitHub, GitLab, - [auth0](https://github.com/backstage/backstage/pull/1611), - [AWS](https://github.com/backstage/backstage/pull/1990) +[Discord](https://discord.gg/qxsEfa8Vq8), or [book +time](http://calendly.com/spotify-backstage) with the Spotify team.