第4章 ソフトウェアテンプレートについて

1. RHDH の my-rhdh-app-config ファイルまたは Backstage カスタムリソース (CR) で、必要なプラグインが有効になっていることを確認してください。

   global:
     dynamic:
       plugins:
         - package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-scaffolder-relation-processor-dynamic
           disabled: false
         - package: ./dynamic-plugins/dist/backstage-plugin-notifications
           disabled: false
         - package: ./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic
           disabled: false

2. 更新する必要があるソフトウェアテンプレートを変更します。

3. 次のタスクのうち、どちらか一方または両方を完了します。

   • テンプレートにアノテーションを含める: テンプレートのメタデータに backstage.io/template-version アノテーションを追加します。このアノテーションが存在する場合、カタログエンティティーに自動的にアノテーションが付けられ、デフォルトのバージョン値が表示されます。
   • アノテーションをアクションへの入力として渡す: この方法はテンプレート自体のアノテーションよりも優先され、テンプレートを実行するユーザーがバージョンを指定できます。

   # ...
   - id: version-templateRef
     name: Append the version of this template to the entityRef
     action: catalog:template:version
     input:
       annotations:
         backstage.io/template-version: ${{ parameters.version }}
   # ...

検証

1. 更新されたソフトウェアテンプレートを使用してカタログコンポーネントを作成します。このステップでは、Backstage に新しいコンポーネントを作成し、必要に応じてファイルを外部リポジトリー (GitHub、GitLab など) にプッシュします。

2. Catalog UI でコンポーネントを確認します。

   1. Catalog ページで、新しく作成したカタログコンポーネントを見つけます。
   2. エンティティーに backstage.io/template-version アノテーションが存在することを確認します。INSPECT ENTITY を使用して、YAML Raw または JSON Raw ビューを選択すると、コンポーネント定義内のアノテーションを確認できます。

3. カタログコンポーネントを公開している場合のみ: リポジトリー内のコンポーネントファイルを確認します。

   1. UI に VIEW SOURCE が表示される場合: VIEW SOURCE をクリックして、リポジトリーに保存されているコンポーネントファイルを開きます。
   2. ファイルを手動で見つけて、backstage.io/template-version アノテーションが存在することを確認します。