Backstage: каталог сервисов и «золотые пути»

Platform Engineering · IDP

Не изучено

Добавлено 2026-10-29.

Проблема

Непонятно, чей сервис, где его репозиторий, документация и дашборды. Новый сервис каждый раз собирают с нуля, по-своему.

Решение

Внутренний портал разработчика: каталог сервисов из файлов catalog-info.yaml в репозиториях, шаблоны создания новых сервисов (Software Templates) и документация TechDocs на базе MkDocs. Backstage — это фреймворк, а не готовый продукт: его собирают и сопровождают как отдельное приложение.

Пример

catalog-info.yaml в корне репозитория:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: devops-kb
  description: Личная база знаний DevOps
  annotations:
    backstage.io/techdocs-ref: dir:.
spec:
  type: website
  lifecycle: production
  owner: andrew

Аннотация techdocs-ref указывает на каталог с mkdocs.yml — текущий сайт подходит для TechDocs почти без изменений.

Когда применять

Когда сервисов и команд несколько и вопрос «чьё это и как этим пользоваться» звучит регулярно. Для одного инженера и одного VPS избыточно.

Источник

• backstage/backstage
• Формат catalog-info.yaml
• Software Templates

Как применить у себя

1. Поднять демо локально.
2. Описать 2–3 своих сервиса в catalog-info.yaml.
3. Сделать один шаблон нового сервиса.
4. Записать трудозатраты на сопровождение; отметить «Изучено», когда есть обоснованное решение «внедрять / не внедрять».