第3章 devfile およびプラグインレジストリーのカスタマイズ

手順

1. devfile レジストリーリポジトリーのクローンを作成します。

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces/dependencies/che-devfile-registry

   Copy to Clipboard Toggle word wrap

2. ./che-devfile-registry/devfiles/ ディレクトリーに、<devfile-name>/ サブディレクトリーを作成し、devfile.yaml および meta.yaml ファイルを追加します。

   devfile のファイル編成

   ./che-devfile-registry/devfiles/
   └── <devfile-name>
       ├── devfile.yaml
       └── meta.yaml

   Copy to Clipboard Toggle word wrap

3. devfile.yaml ファイルに有効なコンテンツを追加します。devfile 形式の詳細については、https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/2.4/html-single/end-user_guide/index#making-a-workspace-portable-using-a-devfile_crw を参照して ください。

4. meta.yaml ファイルが以下の構造に準拠することを確認します。

   Expand

   表3.1 devfile meta.yaml のパラメーター

   属性	説明
   description	ユーザーダッシュボードに表示される説明。
   displayName	ユーザーダッシュボードに表示される名前。
   globalMemoryLimit	devfile が起動するすべてのコンポーネントによって消費されることが予想されるメモリーの合計。この数字はユーザーダッシュボードに表示されます。これは情報を示唆するように提供されますが、CodeReady Workspaces サーバーでは考慮されません。
   icon	ユーザーダッシュボードに表示される .svg ファイルへのリンク
   tags	タグの一覧。タグには通常、スタックに含まれるツールが含まれます。

   Show more

   devfile の例 meta.yaml

   displayName: Rust
   description: Rust Stack with Rust 1.39
   tags: ["Rust"]
   icon: https://www.eclipse.org/che/images/logo-eclipseche.svg
   globalMemoryLimit: 1686Mi

   Copy to Clipboard Toggle word wrap

5. カスタム devfile レジストリーのコンテナーをビルドします。

   $ docker build -t my-devfile-registry .

   Copy to Clipboard Toggle word wrap

手順

1. プラグインレジストリーリポジトリーのクローンを作成します。

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces/dependencies/che-plugin-registry

   Copy to Clipboard Toggle word wrap

2. ./che-plugin-registry/v3/plugins/ ディレクトリーで、最後のディレクトリーに新しいディレクトリー <publisher>/<plugin-name>/<plugin-version>/ および meta.yaml ファイルを作成します。

   プラグインのファイル編成

   ./che-plugin-registry/v3/plugins/
   ├── <publisher>
   │   └── <plugin-name>
   │       ├── <plugin-version>
   │       │   └── meta.yaml
   │       └── latest.txt

   Copy to Clipboard Toggle word wrap

3. 有効な内容を meta.yaml ファイルに追加します。meta.yaml ファイル形式の詳細については、「Using a Visual Studio Code extension in CodeReady Workspaces」セクションまたは eclipse/che-plugin-registry リポジトリーの README.md ファイルを参照してください。

4. 最新の <plugin-version> ディレクトリーの名前が含まれる latest.txt という名前のファイルを作成します。

   例

   $ tree che-plugin-registry/v3/plugins/redhat/java/
   che-plugin-registry/v3/plugins/redhat/java/
   ├── 0.38.0
   │   └── meta.yaml
   ├── 0.43.0
   │   └── meta.yaml
   ├── 0.45.0
   │   └── meta.yaml
   ├── 0.46.0
   │   └── meta.yaml
   ├── 0.50.0
   │   └── meta.yaml
   └── latest.txt
   $ cat che-plugin-registry/v3/plugins/redhat/java/latest.txt
   0.50.0

   Copy to Clipboard Toggle word wrap

5. カスタムプラグインレジストリーのコンテナーをビルドします。

   ./build.sh

   Copy to Clipboard Toggle word wrap