ZEN Backstage implementation

A young woman with braided hair smiles while wearing a white shirt with a floral design.

Zoia Baletska

25 January 2024

Dashboard showing metrics for features and non-features over a three-month period.

What is Backstage, and why should I use it?

Backstage is an open platform for building developer portals – locations where companies can engage in technical outreach and education. These portals enable the provision of software documentation, example code, tools, and knowledge bases to enhance communication and functional collaboration. From a developer's perspective, a developer portal simplifies API management.

Backstage offers a centralized catalogue of microservices and infrastructure, empowering product teams to ship quickly without compromising autonomy. It unifies all infrastructure tooling, services, and technical documentation to create a streamlined development environment from end to end.

How we use Backstage at ZEN Software

ZEN Software's Developer Portal is set up to centralize crucial project data, incorporating services like API documentation, Lighthouse, and Tech Radar. Additionally, the portal features an integrated Agile Analytics plugin, providing a concise summary report for enhanced project management efficiency. This platform caters to the diverse needs of developers and companies, offering a holistic solution for optimized project tracking.

Dashboard showing the ZVA Software Service Catalog with a list of components and their details.

Here are some of the implemented features:

Identity-Aware Proxy

Identity-Aware Proxy (IAP) is a global service by Google Cloud. IAP establishes a central authorization layer for applications accessed by HTTPS, allowing an application-level access control model instead of relying on network-level firewalls.

When IAP protects an application or resource, it can only be accessed through the proxy by principals, also known as users, with the correct Identity and Access Management (IAM) role. Granting a user access to an application or resource by IAP subjects them to fine-grained access controls implemented by the product in use without requiring a VPN. When attempting to access an IAP-secured resource, IAP performs authentication and authorization checks.

API Docs

Incorporating the API Docs Backstage plugin allows the discovery and display of API entities defined in machine-readable formats, providing human-readable documentation. Using the OpenAPI format, ZEN Software accumulated its documentation in the Backstage Developer Portal.

Dashboard showing the Agile Analytics API documentation with global considerations highlighted.

Lighthouse Audits

Google's Lighthouse auditing tool for websites is an excellent open-source resource for benchmarking and improving website accessibility, performance, SEO, and best practices.

What makes the Backstage plugin implementation unique is its ability to track a website's audit performance over time using Lighthouse's primary metrics rather than simply running reports. Sparklines provides a quick overview of how all your websites perform over recent builds.

Dashboard showing audit records with details such as status, date, and time.

Agile Analytics Plugin

Agile Analytics is a Software Development Management application assisted by A.I. It collects all relevant data from your software systems and translates it into clear dashboards with concrete information about your teams' performance, allowing better control over software projects.

Agile Analytics provides a Backstage plugin that integrates a summary of the reports generated by Agile Analytics into your Backstage Developer portal.

Dashboard showing metrics for features and non-features over a three-month period.

Results

As a result of ZEN's Backstage Developer portal implementation, ZEN Software achieved the following goals:

  • Provided a single point of entry for development teams

  • Established a centralized Service Catalog

  • Improved discoverability of people, services, and documentation

  • Centralized technical documentation and provided a Technology Radar

  • Displayed DevOps Metrics for all services and teams

Through this initiative, ZEN Software has met its goals and paved the way for a more cohesive and efficient development environment, showcasing the potential of Backstage as a comprehensive solution for modern software development practices.

What Agile Analytics looks like

A few screens from the product, as you see them in use.

Engineering Health Report

One number for the health of your engineering, built from five scores: delivery, reliability, flow, predictability and hours. One glance shows you where it hurts and which way it is moving.

DORA metrics per repository

Deployment frequency, cycle time, time to restore and change failure rate, filterable per repository. The badges show whether you are performing at high or elite level.

Sprint insights

Every status transition of every ticket, with timestamp, type, assignee and a confidence score. It shows where tickets get stuck instead of leaving you to guess.

no image placeholder

Make Agile Work for You

We're here to help you seamlessly implement DevOps, SRE, Scrum, LeSS, or Kanban!