🆓

Backstage | 開発者向けポータルの強化

2023/07/18に公開

PostgreSQL

この抜粋の内容は次のとおりです。

Backstage 開発環境の構築 | devcontainer
Backstage App の作成
永続化 | PostgreSQL
認証 | GitHub

さらに詳しく知りたい方は読み続けてください。

2023年7月3回目です。

Backstage についてです。
ご存じのとおり、Backstage は、Spotify 社が開発し、CNCF に寄贈された開発者ポータルです。

https://github.com/backstage/backstage

Schema 駆動開発は、API の仕様をあらかじめ決めることで、Frontend と Backend の開発をスムーズにします。

弊社では、
GraphQL でいえば、Apollo Client
gRPC でいえば、Buf Schema Registry
REST でいえば、Swagger
です。

用途に合わせて API を開発することで、Schema が各所に散らばります。
これでは、本来の Schema 駆動開発の意義が薄れていきます。
また、Frontend Engineer からすると「どこを見れば良いのか統一してくれ！」と。

その悩みを解決してくれるのが、Backstage です。

Backstage では、直接 API を呼ぶことができます。Frontend は、API ができるまで Backstage を見るようにできる。
Schema 管理以外にも Docs や Data Lineage Graph など便利な機能があります。

開発環境の構築 | devcontainer

ローカルでの検証に devcontainer を使用します。

Node.js は、Backstage に合わせるため、1.18 を使います。

Backstage App の作成

次に Backstage を起動します。
これで、基本構成は、完了です。

node ➜ /workspaces/backstage-example (main) $ npx @backstage/create-app@latest
Need to install the following packages:
  @backstage/create-app@0.5.2
Ok to proceed? (y) y
? Enter a name for the app [required] backstage

App を起動します。

node ➜ /workspaces/backstage-example/backstage (main) $ yarn dev

永続化 | PostgreSQL

次は、データの永続化のために、SQLite から PostgreSQL に変更します。
devcontainer は、Node.js + PostgreSQL を使っているため、それをそのまま使います。

Ctl+c で一度停止し、PostgreSQL 用の環境変数を定義します。

再度、App を起動します。

node ➜ /workspaces/backstage-example/backstage (main) $ yarn dev

認証 | GitHub

次は、ログイン認証を設定します。
いくつか選択肢がありますが、今回は GitHub を使います。

Ctl+c で一度停止し、Auth 用の環境変数を定義します。

OAuth Apps　で作成した client/secret を環境変数に設定します。

node ➜ /workspaces/backstage-example/backstage (main) $ export AUTH_GITHUB_CLIENT_ID=01234567890123456789
node ➜ /workspaces/backstage-example/backstage (main) $ export AUTH_GITHUB_CLIENT_SECRET=0123456789012345678901234567890123456789
node ➜ /workspaces/backstage-example/backstage (main) $ echo $AUTH_GITHUB_CLIENT_ID
node ➜ /workspaces/backstage-example/backstage (main) $ echo $AUTH_GITHUB_CLIENT_SECRET