👨‍💻
Mike's Notes
  • Introduction
  • MacOs Setup
    • System Preferences
    • Homebrew
      • Usage
    • iTerm
      • VIM
      • Tree
      • ZSH
    • Visual Studio Code
    • Git
    • SSH Keys
  • Developer Productivity
    • How To Measure
  • DevOps Knowledge
    • SRE
      • Scaling Reliably
        • Splitting a Monolith into Microservices
      • Troubleshooting Common Issues
      • Service Level Terminology
      • Toil
      • Monitoring
      • Release Engineering
      • Best Practices
      • On-Call
      • Alerting
    • Containers
      • Docker
        • Best Practices
          • Image Building
          • Docker Development
        • CLI Cheat Sheet
      • Container Orchestration
        • Kubernetes
          • Benefits
          • Cheat Sheet
          • Components
          • Pods
          • Workload Resources
          • Best Practices
    • Developer Portal 👨‍💻
      • Solution Overview 🎯
      • System Architecture 🏗️
      • Implementation Journey 🛠️
      • Cross-team Collaboration 🤝
      • Lessons & Future 🎓
    • Provisioning
      • Terraform
        • Installation
        • Usage
    • Configuration Management
      • Ansible
        • Benefits
        • Installation
    • Build Systems
      • Bazel
        • Features
  • Security
    • Secure Software Engineering
    • Core Concepts
    • Security Design Principles
    • Software Security Requirements
    • Compliance Standards and Policies
      • Sarbanes-Oxley (SOX)
      • HIPAA and HITECH
      • Payment Card Industry Data Security Standard (PCI-DSS)
      • General Data Protection Regulation (GDPR)
      • California Consumer Privacy Act (CCPA)
      • Federal Risk and Authorization Management Program (FedRAMP)
    • Privacy & Data
  • Linux Fundamentals
    • Introduction to Linux
    • Architecture
    • Server Administration
      • User / Groups
      • File Permissions
      • SSH
      • Process Management
    • Networking
      • Diagrams
      • Browser URL Example
      • Network Topologies
      • Signal Routing
      • DNS (Domain Name System)
      • SSL (Secure Sockets Layer)
      • TLS (Transport Layer Security)
  • System Design
    • Process
    • Kafka
      • Advanced Topics
    • URL Shortener
Powered by GitBook
On this page
  • Vision
  • Core Requirements
  • Functional Requirements
  • Non-functional Requirements
  • Why Backstage?

Was this helpful?

  1. DevOps Knowledge
  2. Developer Portal 👨‍💻

Solution Overview 🎯

Vision

Build a self-service developer portal that automates project creation and standardizes infrastructure setup across the organization.

Core Requirements

Functional Requirements

  • Project Creation

    • Create new projects from templates

    • Configure project CI/CD and infrastructure

    • Automate repository setup and permissions

    • Set up required platform integrations (Sentry, Datadog, etc.)

  • Platform Features

    • Centralized API documentation

    • Service discovery

Non-functional Requirements

  • Performance

    • Reduce project setup time from 1 week to under 2 hours

    • Handle concurrent project creation requests

  • Scalability

    • Support 200+ engineers

    • Handle multiple project templates

    • Scale across different engineering teams

  • Security

    • Enterprise SSO Integration

    • Role based access control

  • Maintainability

    • Maintainable template system

    • Standardized infrastructure patterns

    • Clear documentation

  • Reliability

    • Consistent project creation

    • Error handling and recovery

Why Backstage?

  • Wrote a tech brief that included a decision matrix with the popular Developer Portal platforms

  • Backstage emerged as the optimal choice based on:

    • Open source and free

    • Great documentation

    • Intuitive UI/UX

    • 100+ existing plugins

    • Strong developer experience focus

PreviousDeveloper Portal 👨‍💻NextSystem Architecture 🏗️

Last updated 3 months ago

Was this helpful?