ユーザーガイド

検証

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

手順

1. Git プロバイダーの Web サイトでアクセストークンを生成します。

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

   ヒント

   オペレーティングシステムに base64 コマンドラインツールがインストールされている場合は、次のコマンドラインを使用できます。

   $ echo -n '<your_access_token_string>' | base64

3. Web ブラウザーで "https://devspaces-<openshift_deployment_name>.<domain_name>"/api/user アクセスし、レスポンスから id 値をコピーします。これは、OpenShift Dev Spaces ユーザー ID です。

4. Git プロバイダーの API ドキュメントに従って、Git プロバイダーのユーザー ID を取得します。

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

5. 新しい OpenShift シークレットを準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: personal-access-token-<your_choice_of_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

   OpenShift Dev Spaces ユーザー ID。

   2

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

   3

   Git プロバイダーの URL。

   4

   Git プロバイダーのユーザー ID。

6. "https://devspaces-<openshift_deployment_name>.<domain_name>"/api/kubernetes/namespace にアクセスして、OpenShift Dev Spaces ユーザーの namespace を name として取得します。

7. クラスター内の OpenShift Dev Spaces ユーザー namespace に切り替えます。

   ヒント

   OpenShift の場合:

   • oc コマンドラインツールは、クラスター内で現在使用している namespace を返すことができます。これを使用して、現在の namespace を確認できます。

     $ oc project

   • 必要に応じて、コマンドラインで OpenShift Dev Spaces ユーザー namespace に切り替えることができます。

     $ oc project <your_user_namespace>

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

   ヒント

   OpenShift では、oc コマンドラインツールを使用できます。

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

検証

1. Git プロバイダーがホストする リモート Git リポジトリーの URL を使用して、新しいワークスペースを開始します。
2. 変更を加えて、ワークスペースからリモート Git リポジトリーにプッシュします。

手順

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. DevWorkspace カスタムリソースを準備するには、ターゲット Git リポジトリーの devfile の内容をコピーします。

   例8.2 schemaVersion: 2.2.0 の devfile コンテンツをコピー

   components:
     - name: tooling-container
       container:
         image: quay.io/devfile/universal-developer-image:ubi8-latest

   ヒント

   詳細については、devfile v2 のドキュメントを 参照してください。

2. 前のステップの devfile の内容を spec.template フィールドの下に貼り付けて、DevWorkspace カスタムリソースを作成します。

   例8.3 DevWorkspace カスタムリソース

   kind: DevWorkspace
   apiVersion: workspace.devfile.io/v1alpha2
   metadata:
     name: my-devworkspace

   1

   
     namespace: user1-dev

   2

   
   spec:
     routingClass: che
     started: true

   3

   
     contributions:

   4

   
       - name: ide
         uri: "https://devspaces-<openshift_deployment_name>.<domain_name>"/plugin-registry/v3/plugins/che-incubator/che-code/insiders/devfile.yaml
     template:
       projects:

   5

   
         - name: my-project-name
           git:
             remotes:
               origin: https://github.com/eclipse-che/che-docs
       components:

   6

   
         - name: tooling-container
           container:
             image: quay.io/devfile/universal-developer-image:ubi8-latest

   1

   DevWorkspace カスタムリソースの名前です。これが新しいワークスペースの名前になります。

   2

   新しいワークスペースのターゲットプロジェクトであるユーザー namespace です。

   3

   DevWorkspace カスタムリソースの作成時にワークスペースを開始する必要があるかどうかを決定します。

   4

   プラグインレジストリーからの Microsoft Visual Studio Code - オープンソース IDE devfile への URL 参照 です。

   5

   起動時にワークスペースに複製する Git リポジトリーの詳細です。

   6

   ワークスペースコンテナーやボリュームコンポーネントなどのコンポーネントの一覧です。

3. DevWorkspace カスタムリソースをクラスターに適用します。

検証

1. DevWorkspace の PHASE ステータスをチェックして、ワークスペースが起動していることを確認します。

   $ oc get devworkspaces -n <user_project> --watch

   例8.4 出力

   NAMESPACE        NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev        my-devworkspace       workspacedf64e4a492cd4701   Starting   Waiting for workspace deployment

2. ワークスペースが正常に開始されると、oc get devworkspaces コマンドの出力でその PHASE ステータスが Running に変わります。

   例8.5 出力

   NAMESPACE            NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev            my-devworkspace       workspacedf64e4a492cd4701   Running    https://url-to-workspace.com

   次に、次のいずれかのオプションを使用してワークスペースを開くことができます。

   • oc get devworkspaces コマンドの出力の INFO セクションにある URL にアクセスします。
   • OpenShift Dev Spaces ダッシュボードからワークスペースを開きます。

手順

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. OpenShift Dev Spaces ダッシュボードで、Workspaces に移動します。
2. ワークスペース名をクリックして、ワークスペースの概要ページを表示します。このページには、OpenShift プロジェクト名 <project_name> が表示されます。
3. 右上の Applications メニューをクリックし、OpenShift コンソールリンクをクリックします。
4. Administrator パースペクティブで、OpenShift コンソールで次の手順を実行します。
5. Workloads > Pods をクリックして、アクティブなすべてのワークスペースのリストを表示します。
6. Project ドロップダウンメニューで、<project_name> プロジェクトを選択して検索を絞り込みます。
7. ワークスペースを実行する実行中の Pod の名前をクリックします。Details タブには、追加情報を含むすべてのコンテナーのリストが含まれています。
8. Logs タブに移動します。

手順

1. 拡張機能を設定します。File > Preferences > Settings をクリックし、Extensions セクションを展開して拡張機能を検索し、trace.server または同様の設定を verbose に設定します (そのような設定が存在する場合)。詳細な設定については、拡張機能のドキュメントを参照してください。
2. View → Output をクリックし、出力ビューのドロップダウンリストで言語サーバーを選択して、言語サーバーログを表示します。

手順

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

手順

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