Backstage developer portal

Eén developer portal voor je teams, services en operations

Services verspreid over tien projecten, eigenaarschap dat in iemands hoofd zit, documentatie die niemand terugvindt. ZEN richt Backstage in als developer portal en beheert het, zodat teams, componenten, API-docs en wat er nu in productie speelt op één plek staan.

Screenshots met voorbeelddata.

Herkenbaar?

Wie beheert dit eigenlijk?

Niemand weet zeker wie een service beheert. Het staat in een spreadsheet van vorig jaar, of in het hoofd van iemand die net met verlof is.

Componenten, API-specificaties en documentatie staan verspreid over repositories, wiki’s en losse links in chatkanalen.

Bij een storing of een cloudrekening die oploopt, kost het uitzoeken wie erbij hoort meer tijd dan het oplossen.

Begrippen

Wat is een developer portal?

Een developer portal is één website voor je hele engineering: een catalogus van alle services, API’s en documentatie, met bij elk onderdeel het team dat het beheert. Het is de voorkant van een intern developer platform, de plek waar een engineer begint in plaats van in een wiki, een spreadsheet of een chatkanaal. Backstage is het open-source framework om zo’n portal mee te bouwen, in 2020 door Spotify vrijgegeven en sinds 2022 een incubating project van de Cloud Native Computing Foundation. Platform engineering is het werk om dat portal en de tooling eromheen in te richten en bij te houden, zodat teams zelf kunnen vinden, uitrollen en beheren wat ze nodig hebben.

Backstage: één centrale catalogus

Alles wat je teams draaien, op één lijst

Componenten, systemen, resources en API’s staan in één doorzoekbare catalogus, met een eigen pagina per onderdeel.

  • Per onderdeel: eigenaar, systeem, type, levenscyclus en tags
  • Op de pagina van een service zie je waar hij van afhangt en welke API’s hij gebruikt
  • De catalogus vult zich vanuit je repositories (catalog-info.yaml), dus hij loopt mee met de code

Screenshots met voorbeelddata.

Backstage: eigenaarschap en teamstructuur

Elk onderdeel heeft een team erachter

Backstage vraagt bij elk onderdeel om een eigenaar. Op de pagina van een team zie je wat het beheert, en op die van de organisatie hoe de teams in elkaar zitten.

  • Per team: hoeveel services, libraries, resources en systemen het in beheer heeft
  • De organisatie met haar teams, en per team de repositories en services met hun levenscyclus
  • Teams en eigenaarschap staan als code in Git, met review en historie, en hangen dus niet af van één persoon
  • Een onderdeel zonder eigenaar valt op, omdat het veld leeg blijft
Een team en wat het beheert
De organisatie en haar teams

Screenshots met voorbeelddata.

Backstage: API-documentatie en TechDocs

De API en de uitleg staan naast de service

Een API staat in de catalogus met zijn specificatie, bij de service die hem aanbiedt. Technische documentatie leeft in de repository en is te lezen vanaf dezelfde servicepagina.

  • OpenAPI-specificatie met endpoints, gewoon leesbaar in het portal
  • Documentatie in Markdown naast de code, met inhoudsopgave en zoekveld
API-specificatie
TechDocs bij de component

Screenshots met voorbeelddata.

Wat ZEN toevoegt: operations

Errors, services en kosten naast je catalogus

Drie plugins van ZEN in hetzelfde portal laten zien wat er op dit moment in productie gebeurt. Bij elk signaal staat het project en het team, zodat je niet hoeft te zoeken bij wie het hoort.

Error Reporting

De errors uit Google Cloud Error Reporting, per project en over alle projecten heen.

  • Open en nieuwe errors per project, met het aantal keer en wanneer het laatst
  • Per error het bestand, de service en de status: open, acknowledged, resolved of muted
  • Bij elk project het team dat het beheert

Screenshots met voorbeelddata.

Cloud Run

Verkeer, serverfouten, latency en resources van elke Cloud Run-service, plus de geplande jobs per Google Cloud-project.

  • Een lijst met wat aandacht vraagt, en waarom: CPU hoog, traag, 5xx of een revisie die niet klaarkwam
  • Per service een eigen tabblad met status, revisie en grafieken van requests, latency, instances en CPU
  • De eigenaar staat bovenaan de servicepagina

Screenshots met voorbeelddata.

FinOps

Wat je Google Cloud deze maand kost, tegen dezelfde periode vorige maand, uit de Cloud Billing-export.

  • Uitgaven tot nu toe, de prognose voor deze maand en een vooruitblik op de maanden erna
  • Per project de kosten, de verandering en het team dat erbij hoort
  • Aanbevelingen uit Google Cloud Recommender en sprongen in de uitgaven, met wat ze per maand schelen

Screenshots met voorbeelddata.

Van signaal naar eigenaar

Je hoeft niet meer uit te zoeken wie je moet bellen

Elk signaal hangt aan een onderdeel in de catalogus, en dat onderdeel aan een team.

  1. Signaal

    een error, een warning op Cloud Run of een kostensprong

  2. Service

    de pagina in de catalogus

  3. Team

    eigenaar en contact

  4. Docs

    runbook en TechDocs

Dezelfde stappen in het portal zelf: van de error naar de service, en van de service naar het team. Opname met voorbeelddata.
Plugin

Agile Analytics in hetzelfde portal

Wil je ook zien hoe je teams leveren, dan zet de Agile Analytics-plugin die cijfers in Backstage. Uitleg en prijzen staan op de site van Agile Analytics.

  • Engineering health per organisatie en team
  • DORA-metrics
  • Error budgets en DORA-cijfers per service, op de pagina van die service
  • AI-adoptie

Screenshots met voorbeelddata.

Waarom ZEN

Vier redenen om het door ons te laten doen

  • We draaien het zelf

    Ons eigen portal staat op Backstage, met dezelfde plugins. De schermen op deze pagina komen uit onze demo-omgeving.

  • Operations erbij, niet alleen een catalogus

    Error Reporting, Cloud Run en FinOps zetten wat er nu in productie gebeurt naast de service en het team dat erbij hoort.

  • Vaste prijs per sprint, beheer per maand

    Inrichten vanaf €4.000 per sprint van twee weken, beheer vanaf €950 per maand. Geen kick-off-fee, geen jaarplan.

  • Senior engineers, geen tussenlaag

    Je werkt met de mensen die het inrichten en beheren. Google Cloud Partner, en net zo thuis op AWS.

Hoe ZEN helpt

Wij richten het in en houden het bij

Een portal dat na de livegang niemand bijhoudt, is over een half jaar weer een verouderde wiki. Daarom doen we het beheer erbij.

  1. Inrichten

    Backstage in jouw cloud, op Cloud Run of op je Kubernetes-cluster, met inloggen via je eigen identity provider en je teams en organisatie erin.

  2. Migreren

    Bestaande services, API’s en documentatie de catalogus in: per repository een catalog-info.yaml, eigenaren als code, TechDocs uit de Markdown die er al staat.

  3. Koppelen

    Error Reporting, Cloud Run en FinOps aansluiten op je Google Cloud-projecten, en desgewenst de Agile Analytics-plugin.

  4. Beheren en doorontwikkelen

    Updates van Backstage, nieuwe plugins en vragen van je teams. Beheer vanaf €950 per maand.

Inrichten, migreren en koppelen doen we in sprints van twee weken met een vaste prijs: €4.000, €8.000 of €12.000, afhankelijk van het sprintdoel. Na elke sprint draait er iets en beslis je over de volgende.

Licht en donker

In het thema dat je team prettig vindt

Het portal werkt in het lichte en het donkere thema van Backstage.

Licht
Donker

Screenshots met voorbeelddata.

Vragen

Wat klanten vragen over Backstage

Wat is Backstage?

Backstage is een open-source framework voor developer portals. Spotify bouwde het voor zichzelf en gaf het in 2020 vrij; sinds 2022 is het een incubating project van de Cloud Native Computing Foundation, en de Thoughtworks Technology Radar zette het op Adopt. De kern is een softwarecatalogus met eigenaarschap per team, TechDocs voor documentatie en een pluginmodel om er tooling aan te hangen. Het is gratis: je betaalt de hosting en het werk om het in te richten.

Hebben we Kubernetes nodig?

Nee. Backstage is een Node.js-applicatie met een PostgreSQL-database en draait overal waar een container draait. Wij zetten het op Cloud Run of op een Kubernetes-cluster dat je al hebt; welke van de twee hangt af van wat er bij jou draait.

Kan het op AWS of op Google Cloud?

Allebei. Backstage zelf, met de catalogus, het eigenaarschap en TechDocs, werkt op elke cloud. De drie operations-plugins die wij toevoegen lezen uit Google Cloud: Error Reporting, Cloud Run en de Cloud Billing-export. Draai je op AWS, dan bespreken we in het eerste gesprek wat daar het equivalent is; dat hangt af van welke diensten je gebruikt.

Werkt het met onze GitHub, GitLab of Azure DevOps?

Ja. De catalogus vult zich uit een catalog-info.yaml per repository, en Backstage heeft integraties voor GitHub, GitLab, Bitbucket en Azure DevOps. TechDocs leest de documentatie uit de Markdown die naast de code staat, dus die hoef je niet over te zetten.

Hoe lang duurt het inrichten?

We werken in sprints van twee weken. Het eerste sprintdoel is een portal in jouw cloud met je teams erin en de eerste services in de catalogus. Hoeveel sprints daarna nodig zijn, hangt af van het aantal repositories, of die al een catalog-info.yaml hebben en welke koppelingen je wilt. Dat schatten we in het eerste gesprek, niet op deze pagina.

Wat kost een Backstage developer portal?

Backstage zelf is open source en kost niets; je betaalt de hosting bij je cloudprovider en ons werk. Inrichten, migreren en koppelen gaan in sprints van twee weken met een vaste prijs: €4.000, €8.000 of €12.000, exclusief btw. Beheer en doorontwikkeling kosten vanaf €950 per maand. De Agile Analytics-plugin heeft eigen prijzen; die staan op de site van Agile Analytics.

Even kijken of het past?

In een half uur laten we de demo zien en hoor je wat er nodig is om het met jouw teams en projecten te vullen.

Plan een gesprek Of bel direct: +31 72 202 93 44