1. ユーザーは、以下によって定義された CodeReady Workspaces ワークスペースを起動します。

   • エディター (デフォルトは Che-Theia)
   • プラグインの一覧（Java や OpenShift ツールなど)
   • ランタイムアプリケーションの一覧
2. CodeReady Workspaces サーバーは、プラグインレジストリーからエディターおよびプラグインメタデータを取得します。
3. すべてのプラグインタイプに対して、CodeReady Workspaces サーバーは特定のプラグインブローカーを起動します。

4. CodeReady Workspaces プラグインブローカーは、プラグインのメタデータを Che Plugin 定義に変換します。これは以下の手順を実行します。

   1. プラグインをダウンロードし、そのコンテンツを展開します。
   2. プラグインの meta.yaml ファイルを処理し、これを Che Plugin の形式で CodeReady Workspaces サーバーに戻します。
5. CodeReady Workspaces サーバーはエディターとプラグインサイドカーを起動します。
6. エディターは、プラグインの永続ボリュームからプラグインを読み込みます。

手順

1. devfile レジストリーリポジトリーのクローンを作成し、デプロイするバージョンをチェックアウトします。

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces
   $ git checkout crw-2.8-rhel-8

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

   例3.1 devfile のファイル編成

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

3. devfile.yaml ファイルに有効なコンテンツを追加します。devfile 形式の詳細は、「devfile を 使用したワークスペースの設定」を参照して ください。

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

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

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

   例3.2 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

5. カスタム devfile レジストリーイメージをビルドします。

   $ cd dependencies/che-devfile-registry
   $ ./build.sh --organization <my-org> \
              --registry <my-registry> \
              --tag <my-tag>

   注記

   build.sh スクリプトの詳細なオプションを表示するには --help パラメーターを使用します。

手順

1. プラグインレジストリーリポジトリーのクローンを作成し、デプロイするバージョンをチェックアウトします。

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces
   $ git checkout crw-2.8-rhel-8

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

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

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

3. 有効な内容を meta.yaml ファイルに追加します。「 VS Code 拡張機能のメタデータの公開 」を参照してください。

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

   例3.4 プラグインファイルツリーの例

   $ 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

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

   $ cd dependencies/che-plugin-registry
   $ ./build.sh --organization <my-org> \
              --registry <my-registry> \
              --tag <my-tag>

   注記

   build.sh スクリプトの詳細なオプションを表示するには --help パラメーターを使用します。レジストリーイメージにプラグインバイナリーを含めるには、--offline パラメーターを追加します。

1. OpenShift テンプレートを使用してプラグインレジストリーをデプロイするには、以下のコマンドを実行します。

   NAMESPACE=<namespace-name>  1
   IMAGE_NAME="my-plug-in-registry"
   IMAGE_TAG="latest"
   oc new-app -f openshift/che-plugin-registry.yml \
    -n "$\{NAMESPACE}" \
    -p IMAGE="$\{IMAGE_NAME}" \
    -p IMAGE_TAG="$\{IMAGE_TAG}" \
    -p PULL_POLICY="Always"

   1

   crwctl を使用してインストールされている場合、デフォルトの CodeReady Workspaces プロジェクトは openshift-workspaces になります。この OperatorHub のインストール方法では、CodeReady Workspaces を現在のプロジェクトユーザーにデプロイします。

2. devfile レジストリーには、GitHub リポジトリーの deploy/openshift/ ディレクトリーに OpenShift テンプレートがあります。これをデプロイするには、以下のコマンドを実行します。

   NAMESPACE=<namespace-name>  1
   IMAGE_NAME="my-devfile-registry"
   IMAGE_TAG="latest"
   oc new-app -f openshift/che-devfile-registry.yml \
    -n "$\{NAMESPACE}" \
    -p IMAGE="$\{IMAGE_NAME}" \
    -p IMAGE_TAG="$\{IMAGE_TAG}" \
    -p PULL_POLICY="Always"

   1

   crwctl を使用してインストールされている場合、デフォルトの CodeReady Workspaces プロジェクトは openshift-workspaces になります。この OperatorHub のインストール方法では、CodeReady Workspaces を現在のプロジェクトユーザーにデプロイします。

検証手順

1. <plug-in> プラグインはプラグインレジストリーで利用できます。

   例3.5 プラグインレジストリー API を要求する <plug-in> を検索します。

   $ URL=$(oc  get route -l app=che,component=plugin-registry \
     -o 'custom-columns=URL:.spec.host' --no-headers)
   $ INDEX_JSON=$(curl -sSL http://${URL}/v3/plugins/index.json)
   $ echo ${INDEX_JSON} | jq '.[] | select(.name == "<plug-in>")'

2. <devfile> devfile は devfile レジストリーで利用できます。

   例3.6 devfile レジストリー API を要求する <devfile> を検索します。

   $ URL=$(oc  get route -l app=che,component=devfile-registry \
     -o 'custom-columns=URL:.spec.host' --no-headers)
   $ INDEX_JSON=$(curl -sSL http://${URL}/v3/plugins/index.json)
   $ echo ${INDEX_JSON} | jq '.[] | select(.name == "<devfile>")'

3. CodeReady Workspaces サーバーはプラグインレジストリーの URL を参照します。

   例3.7 che ConfigMap の CHE_WORKSPACE_PLUGIN__REGISTRY__URL パラメーターの値をプラグインレジストリールートの URL と比較します。

   che ConfigMap の CHE_WORKSPACE_PLUGIN__REGISTRY__URL パラメーターの値を取得します。

   $ oc  get cm/che \
     -o "custom-columns=URL:.data['CHE_WORKSPACE_PLUGIN__REGISTRY__URL']" \
     --no-headers

   プラグインレジストリールートの URL を取得します。

   $ oc  get route -l app=che,component=plugin-registry \
     -o 'custom-columns=URL: .spec.host' --no-headers

4. CodeReady Workspaces サーバーは devfile レジストリーの URL を参照します。

   例3.8 che ConfigMap の CHE_WORKSPACE_DEVFILE__REGISTRY__URL パラメーターの値を devfile レジストリールートの URL と比較します。

   che ConfigMap の CHE_WORKSPACE_DEVFILE__REGISTRY__URL パラメーターの値を取得します。

   $ oc  get cm/che \
     -o "custom-columns=URL:.data['CHE_WORKSPACE_DEVFILE__REGISTRY__URL']" \
     --no-headers

   devfile レジストリールートの URL を取得します。

   $ oc  get route -l app=che,component=devfile-registry \
     -o 'custom-columns=URL: .spec.host' --no-headers

5. 値が一致しない場合は、ConfigMap を更新し、CodeReady Workspaces サーバーを再起動します。

   $ oc  edit cm/codeready
   (...)
   $ oc  scale --replicas=0 deployment/codeready
   $ oc  scale --replicas=1 deployment/codeready

手順

1. ターミナルで以下のコマンドを実行し、Pod を取得します。

   $ oc get pods

   例

   $ oc get pods
   NAME            READY  STATUS   RESTARTS  AGE
   codeready-11-j4w2b    1/1    Running  0         3m

2. デプロイメントのログを取得するには、以下のコマンドを実行します。

   $ oc logs <name-of-pod>

   例

   $ oc logs codeready-11-j4w2b

手順

1. OpenShift Web コンソールで Deployments をクリックします。

2. Find by label 検索フィールドに以下を入力します。

   • app=che および Enter を押してください。

   • component=postgres および Enter を押してください。

     OpenShift Web コンソールは、これら 2 つのキーでベースを検索し、PostgreSQL ログを表示するようになりました。

3. postgres デプロイメントをクリックして開きます。

4. アクティブな PostgreSQL デプロイメントの View log リンクをクリックします。

   OpenShift Web コンソールには、データベースログが表示されます。

手順

1. OpenShift Container Platform コンソールを開きます。
2. メインの OpenShift Container Platform 画面の左側のメニューから、Operators → OperatorHub に移動します。
3. Search by keyword 検索バーに、Jaeger Operator と入力します。
4. Jaeger Operator タイルをクリックします。
5. Jaeger Operator ポップアップウィンドウで Install ボタンをクリックします。
6. インストール方法を選択します。A specific project on the cluster の場合、CodeReady Workspaces はデプロイされ、残りをデフォルト値のままにします。
7. Subscribe ボタンをクリックします。
8. メインの OpenShift Container Platform 画面の左側のメニューから、Operators → Installed Operators ページ に移動します。
9. Red Hat CodeReady Workspaces は、InstallSucceeded ステータスで示唆されるようにインストールされた Operator として表示されます。
10. インストールされた Operator の一覧で、 Jaeger Operator 名をクリックします。
11. Overview タブに移動します。
12. ページ下部の Conditions セクションで、メッセージ install strategy completed with no errors が表示されるのを待機します。
13. Jaeger Operator および追加の Elasticsearch Operator がインストールされています。
14. Operators → Installed Operators セクションに移動します。
15. インストールされた Operator の一覧で Jaeger Operator をクリックします。
16. Jaeger Cluster ページが表示されます。
17. ウィンドウの左下にある Create Instance をクリックします。
18. 保存 をクリックします。
19. OpenShift は Jaeger クラスター jaeger-all-in-one-inmemory を作成します。
20. メトリクスコレクションの有効化についての手順に従い、以下の手順を完了します。

手順

1. OpenShift Container Platform クラスターの CodeReady Workspaces インストールプロジェクトで、oc クライアントを使用して Jaeger デプロイメントの新規アプリケーションを作成します。

   $ oc new-app -f / ${CHE_LOCAL_GIT_REPO}/deploy/openshift/templates/jaeger-all-in-one-template.yml:
   
   --> Deploying template "<project_name>/jaeger-template-all-in-one" for "/home/user/crw-projects/crw/deploy/openshift/templates/jaeger-all-in-one-template.yml" to project <project_name>
   
        Jaeger (all-in-one)
        ---------
        Jaeger Distributed Tracing Server (all-in-one)
   
        * With parameters:
           * Jaeger Service Name=jaeger
           * Image version=latest
           * Jaeger Zipkin Service Name=zipkin
   
   --> Creating resources ...
       deployment.apps "jaeger" created
       service "jaeger-query" created
       service "jaeger-collector" created
       service "jaeger-agent" created
       service "zipkin" created
       route.route.openshift.io "jaeger-query" created
   --> Success
       Access your application using the route: 'jaeger-query-<project_name>.apps.ci-ln-whx0352-d5d6b.origin-ci-int-aws.dev.rhcloud.com'
       Run 'oc status' to view your app.

2. メインの OpenShift Container Platform 画面の左側のメニューから Workloads → Deployments を使用して、Jaeger デプロイメントが正常に終了するまで監視します。
3. メインの OpenShift Container Platform 画面の左側のメニューから Networking → Routes を選択し、URL リンクをクリックして Jaeger ダッシュボードにアクセスします。
4. メトリクスコレクションの有効化についての手順に従い、以下の手順を完了します。

手順

1. 以下の SQL スクリプトを使用して、CodeReady Workspaces サーバーのユーザーおよびデータベースを作成し、ワークスペースのメタデータなどを永続化させます。

   CREATE USER <database-user> WITH PASSWORD '<database-password>' 1 2
   CREATE DATABASE <database>                                      3
   GRANT ALL PRIVILEGES ON DATABASE <database> TO <database-user>
   ALTER USER <database-user> WITH SUPERUSER

   1

   CodeReady Workspaces サーバーデータベースのユーザー名

   2

   CodeReady Workspaces サーバーデータベースのパスワード

   3

   CodeReady Workspaces サーバーデータベースの名前

2. 以下の SQL スクリプトを使用して、RH-SSO バックエンドのデータベースを作成して、ユーザー情報を永続化させます。

   CREATE USER keycloak WITH PASSWORD '<identity-database-password>' 1
   CREATE DATABASE keycloak
   GRANT ALL PRIVILEGES ON DATABASE keycloak TO keycloak

   1

   RH-SSO データベースのパスワード

手順

1. CodeReady Workspaces のプロジェクトを事前に作成します。

   $ oc create namespace openshift-workspaces

2. CodeReady Workspaces サーバーデータベースの認証情報を保存するためにシークレットを作成します。

   $ oc create secret generic <server-database-credentials> \ 1
   --from-literal=user=<database-user> \                            2
   --from-literal=password=<database-password> \                    3
   -n openshift-workspaces

   1

   CodeReady Workspaces サーバーデータベースの認証情報を保存するためのシークレットの名前

   2

   CodeReady Workspaces サーバーデータベースのユーザー名

   3

   CodeReady Workspaces サーバーデータベースのパスワード

3. RH-SSO データベース認証情報を保存するためのシークレットを作成します。

   $ oc create secret generic <identity-database-credentials> \ 1
   --from-literal=password=<identity-database-password> \             2
   -n openshift-workspaces

   1

   RH-SSO データベースの認証情報を保存するためのシークレット名

   2

   RH-SSO データベースのパスワード

4. パッチを適用して crwctl コマンドを実行し、Red Hat CodeReady Workspaces をデプロイします。以下に例を示します。

   $ crwctl server:deploy --che-operator-cr-patch-yaml=patch.yaml ...

1. ユーザーダッシュボードでワークスペースを選択します。
2. Share タブに移動して、ユーザーのメール ID を入力します。複数のメールの区切り文字としてコンマまたはスペースを使用します。

手順

1. CheCluster カスタムリソース (CR) に以下のプロパティーを設定します。

   spec:
     auth:
       externalIdentityProvider: true
       identityProviderURL: <auth-base-url>
       identityProviderRealm: <provider-realm-name>
       identityProviderClientId: <oidc-client-name>

2. OpenShift OAuth サポートを有効にして CodeReady Workspaces をインストールする場合は、CheCluster カスタムリソース (CR) に以下のプロパティーを設定します。

   spec:
     auth:
       openShiftoAuth: true
   # Note: only if the OpenShift identity provider alias is different from 'openshift-v3' or 'openshift-v4'
   server:
     customCheProperties:
       CHE_INFRA_OPENSHIFT_OAUTH__IDENTITY__PROVIDER: <OpenShift identity provider alias>

1. che realm settings > Email の順に移動します。
2. ホスト、ポート、ユーザー名、およびパスワードを指定します。

1. 左側の Realm Settings メニューに移動し、Login タブを開きます。
2. User registration オプションを On に設定します。

手順

1. OperatorHub を使用して CodeReady Workspaces をデプロイしている場合は、以下の値を codeready-workspaces カスタムリソース(CR)に設定します。

   spec:
     auth:
       openShiftoAuth: true
       initialOpenShiftOAuthUser: ''

2. crwctl ツールを使用して CodeReady Workspaces をデプロイした後に、--che-operator-cr-patch-yaml フラグを使用します。

   $ crwctl server:deploy --che-operator-cr-patch-yaml=patch.yaml ...

   patch.yaml には以下を含める必要があります。

   spec:
     auth:
       openShiftoAuth: true
       initialOpenShiftOAuthUser: ''

手順

1. codeready-workspaces カスタムリソースを更新します。

   $ oc patch checluster codeready-workspaces -n openshift-workspaces --type=json -p \
   '[{"op": "replace", "path": "/spec/auth/initialOpenShiftOAuthUser", "value": false}]'

手順

1. codeready-workspaces CheCluster Custom リソース (CR) 定義を更新して、RH-SSO データベースからユーザーのデータの削除を許可します。

   $ oc patch checluster/codeready-workspaces \
     --patch "{\"spec\":{\"server\":{\"customCheProperties\": {\"CHE_KEYCLOAK_CASCADE__USER__REMOVAL__ENABLED\": \"true\"}}}}" \
     --type=merge -n openshift-workspaces

2. API を使用してデータを削除します。

   $ curl -i -X DELETE \
     --header 'Authorization: Bearer <user-token>' \
     https://<codeready-<openshift_deployment_name>.<domain_name>>/api/user/<user-id>