Backstageプラグインの使い方
Placeholder
本ドキュメントは構成のたたき台(placeholder)です。各セクションには「網羅すべき項目」のみを記載しています。内容は今後追記します。
このドキュメントで扱うこと
Backstage のプラグイン機構を理解し、必要な機能をプラグインで追加・設定・自作できるようにする。
1. プラグインアーキテクチャ
- フロントエンドプラグイン / バックエンドプラグインの違い
- 新バックエンドシステム(new backend system)の概要
- プラグインのインストール経路(npm パッケージ)
2. プラグインの導入手順(共通)
- パッケージ追加(yarn add)
- フロントエンド/バックエンドへの登録
- app-config.yaml への設定
- 認証情報・シークレットの扱い
3. 代表的なコア / 公式プラグイン
- Kubernetes
- CI/CD(GitHub Actions、Azure DevOps 等)
- TechDocs
- Search
- Cost Insights
4. 代表的なサードパーティプラグイン
- セキュリティ系(Dependency Track 連携は専用ドキュメント参照)
- 監視・可観測性系
- その他コミュニティプラグイン(plugin marketplace)
5. 自作プラグイン開発
- スキャフォールド(@backstage/cli)
- フロントエンドコンポーネントの追加
- バックエンドモジュール / API の追加
- テストと配布(社内 npm レジストリ)
6. プラグインの選定・管理
- メンテナンス状況・コミュニティ活性度の評価
- バージョン互換性(Backstage 本体との整合)
- アップグレード時の影響範囲
ベストプラクティス
- 必要最小限のプラグインに絞る
- バージョン固定とアップグレード方針
- カスタマイズはプラグイン境界で行う
- アンチパターン(フォーク乱立、未メンテプラグイン依存)