4.2. プロジェクトの設定

手順

1. CheCluster レベルでの自動 namespace プロビジョニングを無効にします。

   devEnvironments:
     defaultNamespace:
       autoProvision: false

2. 次のラベルとアノテーションを使用して、<username> ユーザーの <project_name> プロジェクトを作成します。

   kind: Namespace
   apiVersion: v1
   metadata:
     name: <project_name> 

   1

   
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-namespace
     annotations:
       che.eclipse.org/username: <username>

   1

   選択したプロジェクト名を使用します。

手順

1. 以下の ConfigMap を作成して、すべてのユーザープロジェクトに複製します。設定可能性を高めるために、追加のラベルとアノテーションを追加して ConfigMap をカスタマイズできます。デフォルトでは、ConfigMap はユーザーワークスペースに自動的にマウントされます。ConfigMap をマウントしない場合は、次のラベルを明示的に追加して動作をオーバーライドします。

   controller.devfile.io/watch-configmap: "false"
   controller.devfile.io/mount-to-devworkspace: "false"

   その他の可能なラベルとアノテーションは、ボリューム、configmap、シークレットの自動マウント を参照してください。

   例4.4 ConfigMap をすべてのユーザープロジェクトに複製する

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: devspaces-user-configmap
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/watch-configmap: "false"
       controller.devfile.io/mount-to-devworkspace: "false"
   data:
     ...

   例4.5 ConfigMap をすべてのユーザープロジェクトに複製し、パス /home/user/.m2 によってすべてのユーザーコンテナーに settings.xml ファイルを自動的にマウントする

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: devspaces-user-configmap
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.m2
   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>/home/user/.m2/repository</localRepository>
         <interactiveMode>true</interactiveMode>
         <offline>false</offline>
       </settings>

2. 以下の Secret を作成し、すべてのユーザープロジェクトに複製します。設定可能性を高めるために、追加のラベルとアノテーションを追加して Secret をカスタマイズできます。デフォルトでは、Secret はユーザーのワークスペースに自動的にマウントされます。Secret をマウントしない場合は、次のラベルを明示的に追加して動作をオーバーライドします。

   controller.devfile.io/watch-secret: "false"
   controller.devfile.io/mount-to-devworkspace: "false"

   その他の可能なラベルとアノテーションは、ボリューム、configmap、シークレットの自動マウント を参照してください。

   例4.6 すべてのユーザープロジェクトに Secret を複製する

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/watch-secret: "false"
       controller.devfile.io/mount-to-devworkspace: "false"
     annotations:
       controller.devfile.io/mount-as: env
   stringData:
     ...

   例4.7 Secret をすべてのユーザープロジェクトに複製し、パス /etc/pki/ca-trust/source/anchors によってすべてのユーザーコンテナーに trusted-certificates.crt ファイルを自動的にマウントする

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /etc/pki/ca-trust/source/anchors
   stringData:
     trusted-certificates.crt: |
       ...

   注記

   ワークスペースの起動時に update-ca-trust コマンドを実行して証明書をインポートします。これは手動で実行することも、devfile の postStart イベントにこのコマンドを追加することで実行することもできます。devfile でのイベントバインディングの追加 を参照してください。

   例4.8 Secret をすべてのユーザープロジェクトに複製し、すべてのユーザーコンテナーに環境変数として自動的にマウントする

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: env
   stringData:
     ENV_VAR_1: value_1
     ENV_VAR_2: value_2

3. 以下の PersistentVolumeClaim を作成して、それをすべてのユーザープロジェクトに複製します。

   設定可能性を高めるために、追加のラベルとアノテーションを追加して PersistentVolumeClaim をカスタマイズできます。その他の可能なラベルとアノテーションは、ボリューム、configmap、シークレットの自動マウント を参照してください。

   PersistentVolumeClaim を変更するには、一度削除し、openshift-devspaces namespace に新しいものを作成します。

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: devspaces-user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
   spec:
     ...

   例4.9 PersistentVolumeClaim をユーザーワークスペースにマウントする

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: devspaces-user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/mount-to-devworkspace: 'true'
     annotations:
       controller.devfile.io/mount-path: /home/user/data
       controller.devfile.io/read-only: 'true'
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 5Gi
     volumeMode: Filesystem

4. OpenShift Kubernetes Engine を活用するために、Template オブジェクトを作成して、テンプレート内で定義したすべてのリソースを各ユーザープロジェクトに複製できます。

   Template オブジェクトには、前述の ConfigMap、Secret、PersistentVolumeClaim の他に、次のものを含めることができます。

   • LimitRange
   • NetworkPolicy
   • ResourceQuota
   • Role

   • RoleBinding

     apiVersion: template.openshift.io/v1
     kind: Template
     metadata:
       name: devspaces-user-namespace-configurator
       namespace: openshift-devspaces
       labels:
         app.kubernetes.io/part-of: che.eclipse.org
         app.kubernetes.io/component: workspaces-config
     objects:
       ...
     parameters:
     - name: PROJECT_NAME
     - name: PROJECT_ADMIN_USER

     parameters はオプションであり、使用可能なパラメーターを定義します。現時点では、PROJECT_NAME および PROJECT_ADMIN_USER のみがサポートされています。PROJECT_NAME は OpenShift Dev Spaces namespace の名前で、PROJECT_ADMIN_USER は namespace の OpenShift Dev Spaces ユーザーです。

     オブジェクトの namespace 名は、同期中にユーザーの namespace 名に置き換えられます。

     例4.10 Kubernetes リソースをユーザープロジェクトに複製する

     apiVersion: template.openshift.io/v1
     kind: Template
     metadata:
       name: devspaces-user-namespace-configurator
       namespace: openshift-devspaces
       labels:
         app.kubernetes.io/part-of: che.eclipse.org
         app.kubernetes.io/component: workspaces-config
     objects:
     - apiVersion: v1
       kind: ResourceQuota
       metadata:
         name: devspaces-user-resource-quota
       spec:
         ...
     - apiVersion: v1
       kind: LimitRange
       metadata:
         name: devspaces-user-resource-constraint
       spec:
         ...
     - apiVersion: rbac.authorization.k8s.io/v1
       kind: Role
       metadata:
         name: devspaces-user-roles
       rules:
         ...
     - apiVersion: rbac.authorization.k8s.io/v1
       kind: RoleBinding
       metadata:
         name: devspaces-user-rolebinding
       roleRef:
         apiGroup: rbac.authorization.k8s.io
         kind: Role
         name: devspaces-user-roles
       subjects:
       - kind: User
         apiGroup: rbac.authorization.k8s.io
         name: ${PROJECT_ADMIN_USER}
     parameters:
     - name: PROJECT_ADMIN_USER

     注記

     Template Kubernetes リソースの作成は、OpenShift でのみサポートされます。