ユーザーガイド

検証

1. URL にアクセスして、新しいワークスペース を開始 します。
2. 選択したブラウザー内 IDE が、起動したワークスペースのブラウザータブでロードされていることを確認します。

手順

1. すでにある場合は、ホームディレクトリーで .git-credentials ファイルを見つけて開きます。または、このファイルがない場合は、Git クレデンシャルストレージ形式 を使用して、新しい .git-credentials ファイルを保存します。各クレデンシャルは、ファイル内の独自の行に保存されます。

   https://<username>:<token>@<git_server_hostname>

   例6.1 .git-credentials ファイルの行

   https://trailblazer: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@github.com

2. シークレットの .git-credentials ファイルからクレデンシャルを選択します。次の手順のために、選択したクレデンシャルを Base64 にエンコードします。

   ヒント

   • ファイル内のすべての行をエンコードするには:

     $ cat .git-credentials | base64 | tr -d '\n'

   • 選択した行をエンコードするには:

     $ echo -n '<copied_and_pasted_line_from_.git-credentials>' | base64

3. ユーザープロジェクトに新しい OpenShift シークレットを作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: git-credentials-secret
     labels:
       controller.devfile.io/git-credential: 'true' 

   1

   
       controller.devfile.io/watch-secret: 'true'
     annotations:
       controller.devfile.io/mount-path: /etc/secret 

   2

   
   data:
     credentials: <Base64_content_of_.git-credentials> 

   3

   1

   controller.devfile.io/git-credential ラベルは、シークレットに Git クレデンシャルが含まれていることを示します。

   2

   DevWorkspace コンテナーのカスタム絶対パス。シークレットは、このパスに credentials ファイルとしてマウントされます。デフォルトのパスは / です。

   3

   前の手順で Base64 にエンコードした .git-credentials から選択したコンテンツ。

   ヒント

   ユーザープロジェクトで複数の Git クレデンシャルシークレットを作成して適用できます。それらはすべて、DevWorkspace コンテナーにマウントされる 1 つのシークレットにコピーされます。たとえば、マウントパスを /etc/secret に設定すると、すべての Git クレデンシャルを持つ 1 つのシークレットが /etc/secret/credentials にマウントされます。ユーザープロジェクトのすべての Git クレデンシャルシークレットを同じマウントパスに設定する必要があります。マウントパスは /etc/gitconfig で設定された Git 設定ファイルで自動的に設定されるため、マウントパスを任意のパスに設定できます。

4. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

手順

1. アクセストークンをコピーし、Base64 にエンコードします。

   $ echo -n '<your_access_token>' | base64

2. ユーザープロジェクトで新しい OpenShift シークレットを準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: personal-access-token-<your_chosen_name_for_this_token>
     labels:
       app.kubernetes.io/component: scm-personal-access-token
       app.kubernetes.io/part-of: che.eclipse.org
     annotations:
       che.eclipse.org/che-userid: <devspaces_user_ID> 

   1

   
       che.eclipse.org/scm-personal-access-token-name: <git_provider_name> 

   2

   
       che.eclipse.org/scm-url: <Git_provider_endpoint> 

   3

   
       che.eclipse.org/scm-userid: <Git_provider_user_ID> 

   4

   
       che.eclipse.org/scm-username: <Git_provider_username>
   data:
     token: <Base64_encoded_access_token>
   type: Opaque

   1

   あなたの Che ユーザー ID。<che-endpoint>/api/user を取得して、Che ユーザーデータを取得できます。

   2

   Git プロバイダー名: github または gitlab または bitbucket-server。

   3

   Git プロバイダーの URL。

   4

   Git プロバイダーのユーザー ID。API ドキュメントに従ってユーザーオブジェクトを取得します。

   • GitHub: ユーザーを取得します。レスポンスの id 値を参照してください。
   • GitLab: ユーザーの一覧表示: 通常のユーザー の場合は、username フィルターを使用します: /users?username=:username。レスポンスの id 値を参照してください。
   • Bitbucket Server: ユーザーを取得します。レスポンスの id 値を参照してください。

3. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

手順

1. <username> -devspaces 名前空間で、TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. <username> -devspaces 名前空間で、ConfigMap を適用して settings.xml ファイルを作成します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: settings-xml
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.m2
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     settings.xml: |
       <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
         <localRepository/>
         <interactiveMode/>
         <offline/>
         <pluginGroups/>
         <servers/>
         <mirrors>
           <mirror>
             <id>redhat-ga-mirror</id>
             <name>Red Hat GA</name>
             <url>https://<maven_artifact_repository_route>/repository/redhat-ga/</url>
             <mirrorOf>redhat-ga</mirrorOf>
           </mirror>
           <mirror>
             <id>maven-central-mirror</id>
             <name>Maven Central</name>
             <url>https://<maven_artifact_repository_route>/repository/maven-central/</url>
             <mirrorOf>maven-central</mirrorOf>
           </mirror>
           <mirror>
             <id>jboss-public-repository-mirror</id>
             <name>JBoss Public Maven Repository</name>
             <url>https://<maven_artifact_repository_route>/repository/jboss-public/</url>
             <mirrorOf>jboss-public-repository</mirrorOf>
           </mirror>
         </mirrors>
         <proxies/>
         <profiles/>
         <activeProfiles/>
       </settings>

3. オプション: EAP ベースの devfile を使用する場合は、2 つ目 の settings-xml ConfigMap を <username> -devspaces 名前空間に、同じ内容、別の名前、および /home/jboss/.m2 マウントパスで適用します。

4. <username> -devspaces 名前空間で、TrustStore 初期化スクリプトの ConfigMap を適用します。

   Java 8

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-java8-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -trustcacerts -keystore ~/.java/current/jre/lib/security/cacerts -storepass changeit

   Java 11

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-java11-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -cacerts -storepass changeit

5. Maven ワークスペースを開始します。
6. tools コンテナーで新しいターミナルを開きます。
7. ~/init-truststore.sh を実行します。

手順

1. TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. TrustStore 初期化スクリプトに ConfigMap を適用します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -cacerts -storepass changeit

3. Gradleinit スクリプトに ConfigMap を適用します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-gradle
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.gradle
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init.gradle: |
       allprojects {
         repositories {
           mavenLocal ()
           maven {
             url "https://<gradle_artifact_repository_route>/repository/maven-public/"
             credentials {
               username "admin"
               password "passwd"
             }
           }
         }
       }

4. Gradle ワークスペースを開始します。
5. tools コンテナーで新しいターミナルを開きます。
6. ~/init-truststore.sh を実行します。

手順

1. TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. ConfigMap を適用して、tools コンテナーに次の環境変数を設定します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     NODE_EXTRA_CA_CERTS: /home/user/certs/tls.cer
     NPM_CONFIG_REGISTRY: >-
       https://<npm_artifact_repository_route>/repository/npm-all/

手順

1. TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. ConfigMap を適用して、tools コンテナーに次の環境変数を設定します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     PIP_INDEX_URL: >-
       https://<python_artifact_repository_route>/repository/pypi-all/
     PIP_CERT: /home/user/certs/tls.cer

手順

1. TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. ConfigMap を適用して、tools コンテナーに次の環境変数を設定します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     GOPROXY: >-
       http://<athens_proxy_route>
     SSL_CERT_FILE: /home/user/certs/tls.cer

手順

1. TLS 証明書のシークレットを適用します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. ConfigMap を適用して、tools コンテナー内の TLS 証明書ファイルのパスの環境変数を設定します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     SSL_CERT_FILE: /home/user/certs/tls.cer

3. ConfigMap を適用して、nuget.config ファイルを作成します。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-nuget
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /projects
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     nuget.config: |
       <?xml version="1.0" encoding="UTF-8"?>
       <configuration>
         <packageSources>
           <add key="nexus2" value="https://<nuget_artifact_repository_route>/repository/nuget-group/"/>
         </packageSources>
         <packageSourceCredentials>
           <nexus2>
               <add key="Username" value="admin" />
               <add key="Password" value="passwd" />
           </nexus2>
         </packageSourceCredentials>
       </configuration>

手順

1. ユーザープロジェクトで、プライベートコンテナーレジストリーの詳細とクレデンシャルを使用してイメージプルシークレットを作成します。

   $ oc create secret docker-registry <Secret_name> \
       --docker-server=<registry_server> \
       --docker-username=<username> \
       --docker-password=<password> \
       --docker-email=<email_address>

2. 次のラベルをイメージプルシークレットに追加します。

   $ oc label secret <Secret_name> controller.devfile.io/devworkspace_pullsecret=true controller.devfile.io/watch-secret=true

手順

1. .dockercfg ファイルを Base64 にエンコードします。

   $ cat .dockercfg | base64 | tr -d '\n'

2. ユーザープロジェクトに新しい OpenShift シークレットを作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: <Secret_name>
     labels:
       controller.devfile.io/devworkspace_pullsecret: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     .dockercfg: <Base64_content_of_.dockercfg>
   type: kubernetes.io/dockercfg

3. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

手順

1. $HOME/.docker/config.json ファイルを Base64 にエンコードします。

   $ cat config.json | base64 | tr -d '\n'

2. ユーザープロジェクトに新しい OpenShift シークレットを作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: <Secret_name>
     labels:
       controller.devfile.io/devworkspace_pullsecret: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     .dockerconfigjson: <Base64_content_of_config.json>
   type: kubernetes.io/dockerconfigjson

3. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

手順

1. Topology ビューを開き、すべてのプロジェクトを一覧表示します。
2. Select an Application 検索フィールドに workspace と入力してすべてのワークスペースを一覧表示します。

3. ワークスペースをクリックして編集します。

   デプロイメントは、円形のボタンで囲まれたグラフィカルな円で表示されます。これらのボタンの 1 つは Edit Source Code です。

   
4. OpenShift Dev Spaces を使用してアプリケーションのコードを編集するには、Edit Source Code ボタンをクリックします。これにより、アプリケーションコンポーネントのクローン作成されたソースコードのあるワークスペースにリダイレクトされます。

手順

1. メイン画面の右上にある 3 x 3 マトリックスアイコンを使用して、Red Hat Applications メニューを開きます。

   ドロップダウンメニューには、利用可能なアプリケーションが表示されます。

   
2. OpenShift Dev Spaces リンクをクリックして、Dev Spaces ダッシュボードを開きます。

手順

1. Dashboard を使用してワークスペースを起動しようとします。
2. 起動に失敗する場合は、表示される Open in Verbose mode リンクをクリックします。
3. Logs タブを確認して、ワークスペースの失敗の理由を見つけます。

手順

1. Workspace タブを開きます。
2. ワークスペース専用の行の左側で、3 つの水平点として表示されるドロップダウンメニューにアクセスし、Open in Verbose mode オプションを選択します。または、このオプションは Actions ドロップダウンメニューでワークスペースの詳細でも利用できます。
3. Logs タブを確認して、ワークスペースの失敗の理由を見つけます。

前提条件

1. GitHub リポジトリーのルートに .che/che-theia-plugins.yaml ファイルがある。

手順

1. プラグインの ID を .che/che-theia-plugins.yaml ファイルに追加します。/ 記号を使用して、発行元とプラグインの名前を区切ります。次の例では、Red Hat Visual Studio Code Java 拡張機能の ID を使用しています。

   - id: redhat/java/latest

前提条件

1. GitHub リポジトリーのルートに .che/che-theia-plugins.yaml ファイルがある。

手順

1. プラグインの id の下にある .che/che-theia-plugins.yaml ファイルに override セクションを追加します。

2. 拡張機能のメモリー制限を指定します。次の例では、OpenShift Dev Spaces は Red Hat Visual Studio Code Java 拡張機能を OpenShift Dev Spaces ワークスペースに自動的にインストールし、ワークスペースのメモリーを 2 ギガバイト増やします。

     - id: redhat/java/latest
       override:
         sidecar:
           memoryLimit: 2Gi

前提条件

1. GitHub リポジトリーのルートに .che/che-theia-plugins.yaml ファイルがある。

手順

1. 拡張子の id の下にある .che/che-theia-plugins.yaml ファイルに override セクションを追加します。

2. Preferences セクションで設定を指定します。次の例では、OpenShift Dev Spaces は Red Hat Visual Studio Code Java 拡張機能を Red Hat ワークスペースに自動的にインストールし、java.server.launchMode プリファレンスを LightWeight に設定します。

     - id: redhat/java/latest
       override:
         preferences:
           java.server.launchMode: LightWeight

手順

1. devfile.yaml ファイルに attributes セクションを追加します。
2. .vscode/extensions.json を atributes セクションに追加します。コロン区切り文字の後に | 記号を追加します。

3. | 記号の後に .vscode/extensions.json ファイルの内容を貼り付けます。次の例では、Red Hat Visual Studio Code Java 拡張属性を使用しています。

   schemaVersion: 2.2.0
   metadata:
     name: my-example
   attributes:
     .vscode/extensions.json: |
       {
         "recommendations": [
           "redhat.java"
         ]
       }

手順

1. devfile.yaml ファイルに attributes セクションを追加します。
2. .vscode/extensions.json を atributes セクションに追加します。コロン区切り文字の後に | 記号を追加します。

3. | 記号の後に .che/che-theia-plugins.yaml ファイルの内容を貼り付けます。次の例では、Red Hat Visual Studio Code Java 拡張属性を使用しています。

   schemaVersion: 2.2.0
   metadata:
     name: my-example
   attributes:
     .che/che-theia-plugins.yaml: |
       - id: redhat/java/latest