3.3. アーキテクチャー

OpenShift Dev Spaces Operator は、OpenShift Dev Spaces サーバーコンポーネントのライフサイクルを完全に管理するようにします。これには、以下が含まれます。

Dev Workspace Operator (DWO) は OpenShift Dev Spaces の依存関係であり、OpenShift Dev Spaces の機能に不可欠です。DWO は主に、Dev Workspace カスタムリソース (CR) を調整します。

Dev Workspace CR は、OpenShift Dev Spaces ワークスペースの OpenShift リソース表現です。ユーザーがバックグラウンドで OpenShift Dev Spaces を使用してワークスペースを作成するたびに、Dashboard OpenShift Dev Spaces はクラスター内に Dev Workspace CR を作成します。すべての OpenShift Dev Spaces ワークスペースには、クラスター上に基盤となる Dev Workspace CR が存在します。

図 1 は、クラスター内の Dev Workspace CR の例を示しています。

図3.3 クラスター内の Dev Workspace CR の例

View larger image

devfile を使用して OpenShift Dev Spaces でワークスペースを作成すると、Dev Workspace CR に devfile の詳細が含まれます。さらに、OpenShift Dev Spaces は、ワークスペースに選択されたエディターに応じて、エディター定義を Dev Workspace CR に追加します。OpenShift Dev Spaces は、CheCluster CR の設定方法に応じてワークスペースをさらに設定する Dev Workspace に属性も追加します。

DevWorkspaceTemplate は、Dev Workspaces の再利用可能な spec.template を定義するカスタムリソースです。

ワークスペースが起動すると、DWO は対応する Dev Workspace CR を読み取り、デプロイメント、シークレット、configmap、ルートなどの必要なリソースを作成して最後に devfile で定義された開発環境を表すワークスペース Pod が作成されます。

グローバル設定は、devworkspace-operator-config という名前の DWOC カスタムリソースであり、通常は DWO インストール namespace に配置されます。デフォルトでは、グローバル設定はインストール時には作成されません。グローバル設定で指定された設定フィールドは、DWO およびすべての Dev Workspaces に適用されます。ただし、DWOC 設定はグローバル以外の設定で上書きできます。

devworkspace-operator-config 以外の DWOC カスタムリソースは、非グローバル設定と見なされます。非グローバル設定は、Dev Workspace に DWOC への参照が含まれていない限り、どの Dev Workspace にも適用されません。グローバル設定と非グローバル設定に同じフィールドがある場合は、非グローバル設定フィールドが優先されます。

たとえば、デフォルトでは、OpenShift Dev Spaces は、devworkspace-config という名前の OpenShift Dev Spaces namespace でグローバルではない DWOC を作成して管理します。この DWOC には OpenShift Dev Spaces ワークスペースに固有の設定が含まれており、CheCluster CR の設定方法に応じて OpenShift Dev Spaces によって維持されます。OpenShift Dev Spaces がワークスペースを作成すると、OpenShift Dev Spaces は controller.devfile.io/devworkspace-config 属性を使用して OpenShift Dev Spaces が所有する DWOC への参照を追加します。

図3.4 Dev Workspace 設定属性の例

View larger image

apiVersion: controller.devfile.io/v1alpha1
kind: DevWorkspaceRouting
metadata:
  annotations:
    controller.devfile.io/devworkspace-started: 'false'
  name: routing-workspaceb14aa33254674065
  labels:
    controller.devfile.io/devworkspace_id: workspaceb14aa33254674065
spec:
  devworkspaceId: workspaceb14aa33254674065
  endpoints:
    universal-developer-image:
      - attributes:
          cookiesAuthEnabled: true
          discoverable: false
          type: main
          urlRewriteSupported: true
        exposure: public
        name: che-code
        protocol: https
        secure: true
        targetPort: 3100
  podSelector:
    controller.devfile.io/devworkspace_id: workspaceb14aa33254674065
  routingClass: che
status:
  exposedEndpoints:
    ...

apiVersion: controller.devfile.io/v1alpha1
kind: DevWorkspaceRouting
metadata:
  annotations:
    controller.devfile.io/devworkspace-started: 'false'
  name: routing-workspaceb14aa33254674065
  labels:
    controller.devfile.io/devworkspace_id: workspaceb14aa33254674065
spec:
  devworkspaceId: workspaceb14aa33254674065
  endpoints:
    universal-developer-image:
      - attributes:
          cookiesAuthEnabled: true
          discoverable: false
          type: main
          urlRewriteSupported: true
        exposure: public
        name: che-code
        protocol: https
        secure: true
        targetPort: 3100
  podSelector:
    controller.devfile.io/devworkspace_id: workspaceb14aa33254674065
  routingClass: che
status:
  exposedEndpoints:
    ...

oc get pods -l 'app.kubernetes.io/part-of=devworkspace-operator' -o custom-columns=NAME:.metadata.name -n openshift-operators

$ oc get pods -l 'app.kubernetes.io/part-of=devworkspace-operator' -o custom-columns=NAME:.metadata.name -n openshift-operators
NAME
devworkspace-controller-manager-66c6f674f5-l7rhj 

devworkspace-webhook-server-d4958d9cd-gh7vr 

devworkspace-webhook-server-d4958d9cd-rfvj6 

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: devworkspace-operator
  namespace: openshift-operators
spec:
  config:
    affinity:
      nodeAffinity: ...
      podAffinity: ...
    resources:
      limits:
        memory: ...
        cpu: ...
      requests:
        memory: ...
        cpu: ...

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: devworkspace-operator
  namespace: openshift-operators
spec:
  config:
    affinity:
      nodeAffinity: ...
      podAffinity: ...
    resources:
      limits:
        memory: ...
        cpu: ...
      requests:
        memory: ...
        cpu: ...

apiVersion: controller.devfile.io/v1alpha1
kind: DevWorkspaceOperatorConfig
metadata:
  name: devworkspace-operator-config
  namespace: <DWO install namespace>
config:
  webhooks:
    nodeSelector: <map[string]string>
    replicas: <int>
    tolerations: <[]corev1.Toleration>

apiVersion: controller.devfile.io/v1alpha1
kind: DevWorkspaceOperatorConfig
metadata:
  name: devworkspace-operator-config
  namespace: <DWO install namespace>
config:
  webhooks:
    nodeSelector: <map[string]string>
    replicas: <int>
    tolerations: <[]corev1.Toleration>

OpenShift Dev Spaces Operator はこれを che-gateway Deployment として管理します。

以下へのアクセスを制御します。

図3.5 OpenShift Dev Spaces ゲートウェイと他のコンポーネントとの対話

View larger image

ユーザーダッシュボードは、Red Hat OpenShift Dev Spaces のランディングページです。OpenShift Dev Spaces ユーザーは、ユーザーダッシュボードを参照してワークスペースにアクセスし、管理します。これは React のアプリケーションです。OpenShift Dev Spaces デプロイメントは、devspaces-dashboard Deployment で起動します。

以下へのアクセス権が必要です。

図3.6 User ダッシュボードと他のコンポーネントとの対話

View larger image

ユーザーがユーザーダッシュボードにワークスペースの起動を要求すると、ユーザーダッシュボードはこの一連のアクションを実行します。

OpenShift Dev Spaces サーバーは、HTTP REST API を公開する Java Web サービスで、以下へのアクセスが必要です。

図3.7 OpenShift Dev Spaces サーバーと他のコンポーネントとの対話

View larger image

各 OpenShift Dev Spaces ワークスペースは、特定のエディターと関連する拡張機能のセットを使用して起動します。OpenShift Dev Spaces のプラグインレジストリーは、使用可能なエディターとエディター拡張機能のリストを提供するものです。各エディターや拡張機能は、Devfile v2 に記載されています。

「ユーザーダッシュボード」 は、レジストリーの内容を読み取っています。

図3.8 他のコンポーネントとのプラグインレジストリーの相互作用

View larger image