Backstage developer portal

Eén portal voor je teams, services en operations

ZEN richt Backstage in en beheert het. Eigenaarschap, componenten, API-docs en wat er nu in productie speelt staan dan op één plek.

Backstage-catalogus met 34 componenten, per regel het systeem, de eigenaar, het type, de levenscyclus en tags

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.

Eé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
Pagina van de Compression API in Backstage: eigenaar Compression, systeem Middle-Out Compression, levenscyclus production en een relatiediagram met API’s en resources

Screenshots met voorbeelddata.

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
Teampagina van Compression in Backstage: blokken met wat het team beheert (4 libraries, 3 Cloud Run-resources, 2 services) en een tabel met repositories en services
Een team en wat het beheert
Organisatiepagina van Pied Piper in Backstage met de teams Apps, Compression, Data, Growth, Leadership, PiperNet en Platform
De organisatie en haar teams

Screenshots met voorbeelddata.

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
OpenAPI-definitie van de Pied Piper Compression API in Backstage met de endpoints compress, decompress, jobs en usage
API-specificatie
Tabblad Docs op de pagina van Middle-Out Core: technische documentatie met inhoudsopgave en zoekveld
TechDocs bij de component

Screenshots met voorbeelddata.

Operations: wat er nu speelt

Errors, services en kosten naast je catalogus

Drie pagina’s 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
Error Reporting in Backstage: per project het aantal open en nieuwe errors, en daaronder errors zoals TokenExpiredError met service, status en aantal keer

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
Cloud-overzicht in Backstage: per project services, jobs, requests en 5xx, en een lijst Needs attention met warnings zoals CPU at 93%

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 de maand en het verschil met vorige maand
  • 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
FinOps in Backstage: uitgaven deze maand, prognose en vorige maand, een grafiek van de uitgaven en een tabel met kosten per project en team

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

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 per service, op de pagina van die service
  • AI-adoptie
Agile Analytics-overzicht in Backstage met engineering health voor de hele organisatie
DORA-metrics in de Agile Analytics-plugin voor Backstage
Error budget-kaart op de pagina van de PiperChat API in Backstage
AI-adoptie per team in de Agile Analytics-plugin voor Backstage

Screenshots met voorbeelddata.

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, met je teams erin en de catalogus gevuld vanuit je repositories.

  2. Koppelen

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

  3. Beheren en doorontwikkelen

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

Inrichten en koppelen doen we in sprints van twee weken met een vaste prijs, vanaf €4.000. 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.

Servicepagina in Backstage in het lichte thema
Licht
Dezelfde servicepagina in Backstage in het donkere thema
Donker

Screenshots met voorbeelddata.

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