Spotify Portal
Onboarding Checklist
What to expect when you’re expecting Portal.
Are you ready for Spotify Portal? Below is a list of to-dos for your first month with the beta.
Want to get started today? Get access to the beta.
Week 1
1. Initial Setup
|
Log into Portal Once you’re approved for the beta, you’ll receive a Welcome email with links for logging into Portal, retrieving your one-time password, and referencing product documentation. (As a Portal Cloud user, you should skip the steps for setting up a self-hosted Portal.)
https://backstage.spotify.com/docs/portal/ |
|
|
Create a Spotify for Backstage account You’ll receive a separate email with an invitation to create a customer account. Creating an account gives you access to additional product information and technical support.
https://backstage.spotify.com/account/ |
2. Set Up Your Software Catalog
|
Complete the Setup Wizard You’ll be asked to create a personal access token with the following GitHub scopes:
• repo
• read:user • read:org • user:email • write:package https://backstage.spotify.com/docs/portal/getting-started#setup-wizard |
|
|
Complete the Catalog Wizard You can either use the Onboarding Wizard or the URL Wizard. The Onboarding Wizard requires a CODEOWNERS file in each repository in order to identify a team’s repo.
|
|
|
Merge the Catalog PRs The Catalog Wizard automatically generates pull requests for adding entities (aka, your teams’ services, websites, libraries, etc.) to the Software Catalog. Note: It may take a few minutes before entities are viewable in the Catalog. Portal automatically ingests new entities every few minutes. (We’ll walk through how you can change that setting later!)
|
Week 2
3. Understand Admin Permissions
|
Understand who should have Config Manager permissions Prior to inviting people to use Portal, familiarize yourself with the permission settings to prevent unauthorized access from users.
In Portal, go to: …/config-manager/lifecycle#root_portal_authorizedUsers__title
|
4. Welcome Your Teams to Portal 🚀
Week 3
5. Understand Catalog Entity Lifecycles
|
Get a high level understanding of the “Life of an Entity” Worth bookmarking for future reading and referencing over time for any Catalog processing questions.
https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/life-of-an-entity |
|
|
Configure the Catalog’s processing interval The interval determines how quickly Backstage reads updates from external sources. Consider configuring an interval setting that makes sense for local development. We recommend a value between 60–120 minutes in production and a shorter value for testing changes locally.
In Portal, go to: …/config-manager/catalog#root_catalog_processingInterval__title |
6. Explore the Plugins
|
Use the Setup Wizard to enable plugins Portal’s setup guides will help you step by step.
In Portal, go to: …/setup-guide |
|
|
Explore Portal’s plugins Learn which features make the most sense for your organization.
• Catalog: Increases software ownership visibility within your organization • Scaffolder: Standardizes software development practices & automate common tasks • TechDocs: Facilitates a culture of documentation as code to increase collaboration
• Soundcheck: Standardizes software development practices & improves compliance through automated measurement of service maturity, security, and other organizational standards.
|
7. Tap into Community Resources
|
Explore the Backstage community repository Learn from other organizations who’ve already adopted Backstage. Find stories that resonate with your organization’s platform goals and talk to us about them!
https://github.com/backstage/community |
|
|
Attend the monthly Backstage Community Sessions Add the community calendar to keep up with all the meetups. We recommend attending the monthly community sessions, as well as whatever special interest groups (SIGs) interest you.
https://calendar.google.com/calendar/u/0/embed?src=c_qup9gbhn9sqpuao6trttd8mk5s@group.calendar.google.com |
|
|
Join the Backstage Discord server In addition to our documentation and the community repo, the Backstage Discord is a great place to get your questions answered by the community and Spotify’s Backstage maintainers.
https://discord.com/servers/backstage-687207715902193673 |
Week 4
8. See What's New in Portal
|
Keep sending us your feedback Portal Cloud stays up to date through monthly releases. Let us know what improvements you’re looking forward to next.
|
Ready to get started with Spotify Portal?