第5章 ソフトウェアカタログについて
Red Hat Developer Hub ソフトウェアカタログは、サービス、Web サイト、ライブラリー、データパイプラインなど、エコシステム全体のすべてのソフトウェアを可視化する集中型システムです。これを使用すると、各コンポーネントの所有権の詳細とメタデータを 1 カ所で表示できます。
ソフトウェアカタログ内のコンポーネントのメタデータは、バージョン管理システム内のコードと一緒に存在する YAML ファイルとして保存されます。バージョン管理リポジトリーには、1 つまたは複数のメタデータファイルを含めることができます。ソフトウェアカタログは項目をエンティティーとして整理します。エンティティーには、Components、Resources、APIs、およびその他の関連タイプが含まれます。各エンティティーには、関連付けられたメタデータが含まれます。たとえば、所有者、タイプ、その他の関連情報などです。
コードと一緒に YAML ファイルにメタデータを保存することで、Red Hat Developer Hub は、明確で視覚的なインターフェイスを通じてこの情報を処理および表示できるようになります。ソフトウェアカタログを使用すると、ソフトウェアを管理および保守し、エコシステムで利用可能なすべてのソフトウェアを把握し、サービスとツールの所有権を取得できます。
コンポーネントの Overview ページには、ソースコード、ドキュメント、依存関係、所有権の詳細へのリンクなどの重要な情報が提供されます。特定のニーズに合わせて、プラグインを使用してこのページをカスタマイズできます。
5.1. Red Hat Developer Hub インスタンスに新しいコンポーネントを追加する リンクのコピーリンクがクリップボードにコピーされました!
前提条件
- Red Hat Developer Hub インスタンスをインストールして設定した。
- 必要な権限がある。Red Hat Developer Hub での認可 を参照してください。
手順
次の方法を使用して、RHDH インスタンスにコンポーネントを追加できます。
-
必要な権限を持った状態で、GUI または
app-config.yamlを使用してコンポーネントを手動で登録します。 - Software Template を使用して新しいコンポーネントを作成します。
- 必要な権限を持った状態で一括インポートプラグインを使用します。詳細は、GitHub リポジトリーの一括インポート を参照してください。
5.1.1. Red Hat Developer Hub インスタンスに新しいコンポーネントを作成する リンクのコピーリンクがクリップボードにコピーされました!
RHDH インスタンスのソフトウェアカタログに新しいコンポーネントを作成できます。Red Hat Developer Hub は、開発者またはプラットフォームエンジニアがテンプレートを使用して作成したすべてのコンポーネントをソフトウェアカタログに自動的に登録します。
前提条件
- Red Hat Developer Hub インスタンスをインストールして設定した。
- 必要な権限がある。Red Hat Developer Hub での認可 を参照してください。
手順
- Red Hat Developer Hub のナビゲーションメニューで、Catalog をクリックします。
- Catalog ページで、Self-service をクリックします。
5.1.2. RHDH インスタンスにコンポーネントを手動で登録する リンクのコピーリンクがクリップボードにコピーされました!
RHDH インスタンスにコンポーネントを手動で登録するには、catalog-info.yaml ファイルを作成し、Red Hat Developer Hub インスタンスに登録します。catalog-info.yaml ファイルには、ソフトウェアコンポーネントに登録するメタデータが含まれています。
前提条件
- Red Hat Developer Hub インスタンスをインストールして設定した。
- 必要な権限がある。Red Hat Developer Hub での認可 を参照してください。
手順
ソフトウェアプロジェクトの root ディレクトリーに、
catalog-info.yamlという名前のファイルを作成します。apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: _<your_software_component>_ description: _<software_component_brief_description>_ tags: - example - service annotations: github.com/project-slug: _<repo_link_of_your_component_to_register>_ spec: type: _<your_service>_ owner: _<your_team_name>_ lifecycle: _<your_lifecycle>_-
catalog-info.yamlファイルをプロジェクトソースコードリポジトリーの root にコミットします。 - Red Hat Developer Hub のナビゲーションメニューで、Catalog > Self-service に移動します。
- Self-service ページで、Register Existing Component をクリックします。
-
Register an existing component ページで、リポジトリー内の
catalog-info.yamlファイルの完全な URL を入力します。例: Artist lookup component. - ウィザードの指示を完了します。
検証
- ソフトウェアコンポーネントは、ソフトウェアカタログにリストされます。詳細を表示して、すべてのメタデータが正確であることを確認できます。