管理ガイド

手順

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 形式の詳細な説明は、「 Devfile を使用したワークスペースポータブルの使用」を 参照してください。

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

   Expand

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

   attribute	description
   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

1. プラグインレジストリーソースをチェックアウトします。

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

   Copy to Clipboard Toggle word wrap

2. 一部のローカルフォルダーに meta.yaml を作成します。これは、ゼロまたは既存のプラグインの meta.yaml ファイルからコピーして実行できます。

   $ PLUGIN="v3/plugins/new-org/new-plugin/0.0.1"; \
     mkdir -p ${PLUGIN}; cp v3/plugins/che-incubator/cpptools/0.1/* ${PLUGIN}/
     echo "${PLUGIN##*/}" > ${PLUGIN}/../latest.txt

   Copy to Clipboard Toggle word wrap
3. 既存のプラグインからコピーした場合には、必要に応じて meta.yaml ファイルに変更を加えます。新しいプラグインに固有の タイトル、表示名、および 説明 があることを確認します。firstPublicationDate を 現在 の日付に更新します。

4. meta.yaml のこれらのフィールドは、上記の PLUGIN で定義されたパスと一致する必要があります。

   publisher: new-org
   name: new-plugin
   version: 0.0.1

   Copy to Clipboard Toggle word wrap

5. プラグインレジストリーコンテナーをホストする Pod の名前を取得します。これを実行するには、component=plugin-registry ラベルをフィルターします。

   $ PLUGIN_REG_POD=$(oc get -o custom-columns=NAME:.metadata.name \
     --no-headers pod -l component=plugin-registry)

   Copy to Clipboard Toggle word wrap

6. レジストリーの index.json ファイルを再生成し、新しいプラグインを追加します。

   $ cd codeready-workspaces/dependencies/che-plugin-registry; \
       "$(pwd)/build/scripts/generate_latest_metas.sh" v3 && \
       "$(pwd)/build/scripts/check_plugins_location.sh" v3 && \
       "$(pwd)/build/scripts/set_plugin_dates.sh" v3 && \
       "$(pwd)/build/scripts/check_plugins_viewer_mandatory_fields.sh" v3 && \
       "$(pwd)/build/scripts/index.sh" v3 > v3/plugins/index.json

   Copy to Clipboard Toggle word wrap

7. 新しい index.json および meta.yaml ファイルを新しいローカルプラグインフォルダーからコンテナーにコピーします。

   $ cd codeready-workspaces/dependencies/che-plugin-registry; \
     LOCAL_FILES="$(pwd)/${PLUGIN}/meta.yaml $(pwd)/v3/plugins/index.json"; \
     oc exec ${PLUGIN_REG_POD} -i -t -- mkdir -p /var/www/html/${PLUGIN}; \
     for f in $LOCAL_FILES; do e=${f/$(pwd)\//}; echo "Upload ${f} -> /var/www/html/${e}"; \
       oc cp "${f}" ${PLUGIN_REG_POD}:/var/www/html/${e}; done

   Copy to Clipboard Toggle word wrap
8. プラグインレジストリーの既存の CodeReady Workspaces インスタンスから新しいプラグインを使用できるようになりました。これを検出するには、CodeReady Workspaces ダッシュボードに移動し、Workspaces リンクをクリックします。ここから、歯車アイコンをクリックしてワークスペースの 1 つを設定します。Plugins タブを選択し、利用可能なプラグインの更新一覧を表示します。

1. devfile レジストリーソースをチェックアウトします。

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

   Copy to Clipboard Toggle word wrap

2. 一部のローカルフォルダーに devfile.yaml および meta.yaml を作成します。これは、ゼロまたは既存の devfile からコピーして実行できます。

   $ STACK="new-stack"; \
     mkdir -p devfiles/${STACK}; cp devfiles/03_web-nodejs-simple/* devfiles/${STACK}/

   Copy to Clipboard Toggle word wrap
3. 既存の devfile からコピーする場合は、必要に応じて devfile に変更を加えます。新しい devfile に固有の displayName と description があることを確認します。

4. devfile レジストリーコンテナーをホストする Pod の名前を取得します。これを実行するには、component=devfile-registry ラベルをフィルターします。

   $ DEVFILE_REG_POD=$(oc get -o custom-columns=NAME:.metadata.name \
     --no-headers pod -l component=devfile-registry)

   Copy to Clipboard Toggle word wrap

5. レジストリーの index.json ファイルを再生成し、新しい devfile を追加します。

   $ cd codeready-workspaces/dependencies/che-devfile-registry; \
     "$(pwd)/build/scripts/check_mandatory_fields.sh" devfiles; \
     "$(pwd)/build/scripts/index.sh" > index.json

   Copy to Clipboard Toggle word wrap

6. 新しい index.json、devfile. yaml、および meta.yaml ファイルを新しいローカル devfile フォルダーからコンテナーにコピーします。

   $ cd codeready-workspaces/dependencies/che-devfile-registry; \
     LOCAL_FILES="$(pwd)/${STACK}/meta.yaml $(pwd)/${STACK}/devfile.yaml $(pwd)/index.json"; \
     oc exec ${DEVFILE_REG_POD} -i -t -- mkdir -p /var/www/html/devfiles/${STACK}; \
     for f in $LOCAL_FILES; do e=${f/$(pwd)\//}; echo "Upload ${f} -> /var/www/html/devfiles/${e}"
       oc cp "${f}" ${DEVFILE_REG_POD}:/var/www/html/devfiles/${e}; done

   Copy to Clipboard Toggle word wrap
7. devfile レジストリーの既存の CodeReady Workspaces インスタンスから、新しい devfile を使用できるようになりました。これを検出するには、CodeReady Workspaces ダッシュボードに移動し、Workspaces リンクをクリックします。そこから Add Workspace をクリックし、利用可能な devfile の更新一覧を表示します。

1. vscode-theia -comparator リポジトリーのクローンを 作成し、yarn コマンド を使用してビルドします。
2. GITHUB _TOKEN 環境変数をトークンに設定します。
3. yarn run generate コマンドを実行してレポートを生成します。
4. out/status.html ファイルを開いてレポートを表示します。

手順

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

   $ oc get pods

   Copy to Clipboard Toggle word wrap

   例

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

   Copy to Clipboard Toggle word wrap

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

   $ oc logs <name-of-pod>

   Copy to Clipboard Toggle word wrap

   例

   $ oc logs codeready-11-j4w2b

   Copy to Clipboard Toggle word wrap

手順

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

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

   • app=che を押して Enter

   • component=postgres および Enter

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

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

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

   OpenShift Web コンソールは、データベースログを表示します。

手順

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.

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

手順

1. OpenShift Container Platform コンソールを開きます。
2. メインの OpenShift Container Platform 画面の左側のメニューから、Operators → OperatorHub に移動します。
3. Search by keyword search bar に Jaeger Operator を入力します。
4. Jaeger Operator タイルをクリックします。
5. Jaeger Operator ポップアップウィンドウで Install ボタンを クリックします。
6. インストール方法： CodeReady Workspaces がデプロイされている クラスター上の特定のプロジェクト で、残りのプロジェクトはデフォルト値のままにします。
7. Subscribe ボタンをクリックします。
8. OpenShift Container Platform メイン画面の左側のメニューから、Operators → Installed Operators セクションに移動します。
9. Red Hat CodeReady Workspaces は Installed Operator として表示され、InstallSucceeded ステータスで示されます。
10. インストールされた Operator の一覧で Jaeger Operator 名をクリックします。
11. Overview タブに移動します。
12. ページ下部の Conditions セクションで、この message: install strategy completed with error を待ちます。
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. 「 CodeReady Workspaces メトリクスコレクションの有効化」の手順にしたがって、手順を完了します。

1. scope を repo,user,write:public_key に設定します。

2. トークンおよび ON で読み取り可能な保存されたトークンを設定します。

   

3. デフォルトの read-token ロールを追加します。

   

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

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

手順

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

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   3

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

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

   CREATE USER <identity-database-user> WITH PASSWORD '<identity-database-password>' 

   1

   2

   
   CREATE DATABASE <identity-database>                                               

   3

   
   GRANT ALL PRIVILEGES ON DATABASE <identity-database> TO <identity-database-user>

   Copy to Clipboard Toggle word wrap

   1

   RH-SSO データベースのユーザー名

   2

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

   3

   RH-SSO データベース名

手順

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

   $ oc create project workspaces

   Copy to Clipboard Toggle word wrap

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

   $ oc create secret generic <server-database-credentials> \ 

   1

   
   --from-literal=user=<database-user> \                            

   2

   
   --from-literal=password=<database-password> \                    

   3

   
   -n workspaces

   Copy to Clipboard Toggle word wrap

   1

   CodeReady Workspaces サーバーデータベースのクレデンシャルを保存するシークレット名

   2

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

   3

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

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

   $ oc create secret generic <identity-database-credentials> \ 

   1

   
   --from-literal=user=<identity-database-user> \                     

   2

   
   --from-literal=password=<identity-database-password> \             

   3

   
   -n workspaces

   Copy to Clipboard Toggle word wrap

   1

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

   2

   RH-SSO データベースのユーザー名

   3

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

4. Operator にデータベースのデプロイを省略し、既存のデータベースの接続詳細を CodeReady Workspaces サーバーに渡させるには、カスタムリソースに以下の値を設定します。

   spec:
     database:
       externalDb: true
       chePostgresHostName: <hostname>                     

   1

   
       chePostgresPort: <port>                             

   2

   
       chePostgresSecret: <server-database-credentials>    

   3

   
       chePostgresDb: <database>                           

   4

   
   spec:
     auth:
       identityProviderPostgresSecret: <identity-database-credentials> 

   5

   Copy to Clipboard Toggle word wrap

   1

   外部データベースのホスト名

   2

   外部データベースポート

   3

   CodeReady Workspaces サーバーデータベースのクレデンシャルのあるシークレット名

   4

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

   5

   RH-SSO データベースのクレデンシャルのあるシークレット名

手順

1. OpenShift クラスターコンソールに移動し、Operators → OperatorHub に移動します。
2. Filter by keyword ボックスを使用して OpenShift Image Puller Operator を検索します。OpenShift Image Puller Operator をクリックします。
3. Operator の説明を確認します。Continue → Install を クリックし ます。
4. Installation Mode について A specific project on the cluster を選択します。ドロップダウンで、イメージプルーナーをインストールするために作成したプロジェクトを見つけます。Subscribe をクリックします。
5. Image Puller Operator のインストールを待ちます。OpenShiftImagePuller → Create instance をクリックします。
6. YAML エディターでリダイレクトされたウィンドウで、OpenShiftImagePuller カスタム リソースに変更し、Create をクリックします。
7. プロジェクトの Workloads および Pods メニューに移動し、イメージプルーダーがインストールされていることを確認します。