Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

インタラクティブな作業環境を作成する

インタラクティブな作業環境をクラスタ上に作成するにはワークスペース機能を使用します。 ワークスペースは、ブラウザからアクセスできるインタラクティブな作業環境です。 JupyterLab などのインターフェイスを通して PFCP の計算リソースを利用できます。

ワークスペースの隔離

ワークスペースの各インスタンスを隔離する単位は、個人ユーザ と ネームスペース の 2 通りがあります。 ワークスペースを作成する際に、どちらかの隔離タイプを選んで作成できます。

個人ユーザ

個人ユーザ単位で隔離するワークスペースは、ワークスペースを作成したユーザのみが利用できます。 そのため、SSH 秘密鍵など個人の認証情報を安全に保存できます。

組織管理者を含め、他のユーザは利用できません。 ただし、組織管理者はワークスペースを休止・削除できます。

利用可能な操作を以下に一覧します。

操作ワークスペースを作成したユーザ組織管理者その他のユーザ
ブラウザからワークスペースへのアクセスo
ワークスペースの更新o
稼働中のワークスペースの休止oo
休止中のワークスペースの再開o
ワークスペースの削除oo

ネームスペース

ネームスペース単位で隔離するワークスペースは、ワークスペースが作成されたネームスペースに対し org-edit Role をもつユーザが利用できます。 そのため、ネームスペースに対する権限をもつユーザ間でワークスペースを共有できます。

ネームスペースに対し org-edit Role をもたないユーザは利用できません。

Warning

同一ネームスペース内の Pod や別のワークスペースからであっても、ワークスペース Pod へは通信できません。そのため、Pod 間通信を利用したい場合は、ワークスペース以外のPodを作成してください。

ワークスペースを作成する

Note

ワークスペースは、お使いの組織の計算リソースを利用します。 計算リソースが不足している場合、ワークスペースの作成に失敗することがあります。

Note

個人ユーザ単位で隔離するワークスペースは、ルートネームスペースにのみ作成可能です。 そのため、作成にはルートネームスペースに対する org-edit または org-workspace-edit ClusterRole の付与が必要です。 ClusterRole を付与する方法は、RoleBinding の作成 をご参照ください。

  1. ポータルの ワークスペースページ にアクセスし、新規作成 ボタンをクリックします。
  2. フォームを入力し、作成 ボタンをクリックします。

ワークスペースにアクセスする

  1. ポータルの ワークスペースページ にアクセスします。
  2. アクセスしたいワークスペースの URL 列にあるリンクをクリックします。

ワークスペースを休止・再開する

Warning

ワークスペースを休止すると、ワークスペース内のデータが削除されます。 PersistentVolume に保存されているデータは、休止中も保持されます。

利用していないワークスペースを休止することで、計算リソースを節約できます。

  1. ポータルの ワークスペースページ にアクセスします。
  2. 休止したいワークスペースを選択し、休止 ボタンをクリックします。

休止したワークスペースは、同様の手順で再開できます。

  1. ポータルの ワークスペースページ にアクセスします。
  2. 再開したいワークスペースを選択し、再開 ボタンをクリックします。

ワークスペースを削除する

Warning

ワークスペースを削除すると、ワークスペース内のデータ、およびワークスペースから作成した PersistentVolume がすべて削除されます。

  1. ポータルの ワークスペースページ にアクセスします。
  2. 削除したいワークスペースを選択し、削除 ボタンをクリックします。

Kubernetes マニフェストでワークスペースを管理する

ワークスペースはポータルでの操作のほかに、Kubernetes マニフェストを使った管理も可能です。 マニフェストを使うことで、ワークスペースの管理を自動化でき、ワークスペース設定の再現性を高めることができます。

Workspace カスタムリソース

ワークスペースの各インスタンスは、Workspace カスタムリソースで表現されます。

Workspace リソースから、ワークスペースの実体となる Pod が作成されます。 Workspace リソースを作成・更新・削除することで、ワークスペースを管理できます。

以下は、ネームスペース単位で隔離し、MN-Core 2 デバイスを 1 つ割り当て、10GiB の PersistentVolume を /root/data にマウントするワークスペースの例です。 <組織名> はお使いの組織名に置き換えてください。

apiVersion: preferred.jp/v1alpha1
kind: Workspace
metadata:
  name: my-workspace
  namespace: org-<組織名>
spec:
  owner:
    type: Namespace
  podTemplate:
    spec:
      containers:
      - name: workspace
        resources:
          requests:
            cpu: "4"
          limits:
            memory: 16Gi
            preferred.jp/mncore2: 1
        volumeMounts:
        - name: data
          mountPath: /root/data
      volumes:
      - name: data
        persistentVolumeClaim:
          claimName: data
  volumeClaimTemplates:
  - metadata:
      name: data
    spec:
      accessModes:
      - ReadWriteOnce
      storageClassName: standard-rwo-<組織名>
      resources:
        requests:
          storage: 10Gi

この例では spec.presetRef フィールドを省略しているため、default ClusterWorkspacePreset が適用され、MN-Core SDK のコンテナイメージで JupyterLab が起動します。 JupyterLab のルートディレクトリは /root のため、/root/data に保存したファイルは JupyterLab から参照でき、ワークスペースを休止しても保持されます。

マニフェストを適用してワークスペースを作成します。

kubectl apply -f workspace.yaml

ワークスペースの URL は kubectl get workspace コマンドの URLS 列で確認できます。

kubectl -n org-<組織名> get workspace my-workspace

Tip

kubectl explain workspace コマンドでも各フィールドの説明を確認できます。

spec.owner フィールド

  • ワークスペースの隔離タイプを spec.owner.type で指定します。
    • 個人ユーザで隔離する場合は Individual、ネームスペースで隔離する場合は Namespace を指定します。
    • Individual のワークスペースはルートネームスペース(org-<組織名>)にのみ作成できます。
  • Individual の場合、spec.owner.individual.username には作成したユーザが自動で設定されます。
  • 作成後は変更できません。

spec.presetRef フィールド

  • ワークスペースに適用する プリセット を指定します。
  • 省略した場合は default ClusterWorkspacePreset が適用されます。

spec.podTemplate フィールド

spec.podTemplate フィールドには、ワークスペースの実体となる Pod の構成を PodTemplateSpec の形式で指定します。 PodTemplateSpec は Deployment の spec.template と同じ形式で、Pod マニフェストの metadata と spec に相当します。 そのため、Pod マニフェストの spec に書く内容(コンテナのリソース要求、ボリューム、環境変数、priorityClassName など)は、spec.podTemplate.spec にそのまま記述できます。

spec.podTemplate フィールドの値は、プリセット の値を上書きする形で適用されます。 記述しなかったフィールドにはプリセットの値が使われます。 コンテナは name で照合されるため、プリセットのコンテナ(default プリセットでは workspace)の設定を変更する場合は、同じ名前のコンテナとして記述してください。 異なる名前のコンテナを記述すると、コンテナが追加されます。

Note

spec.podTemplate.metadata.name と spec.podTemplate.metadata.namespace は指定できません。

最初の例では、workspace コンテナに resources と volumeMounts を記述し、default プリセットのコンテナにリソース要求と PersistentVolume のマウントを追加しています。

spec.volumeClaimTemplates フィールド

  • ワークスペースから作成する PersistentVolumeClaim のリストを指定します。metadata.name は必須です。
  • 作成される PersistentVolumeClaim の名前は <metadata.name>-ws-<Workspace 名> になります。 spec.podTemplate.spec.volumes[].persistentVolumeClaim.claimName に metadata.name の値を指定すると、この名前に自動で置き換えられます。
  • 作成された PersistentVolumeClaim は、ワークスペースの削除時に削除されます。
  • 既存の PersistentVolumeClaim を使う場合は、Workspace と同じネームスペースにある PersistentVolumeClaim の名前を claimName に指定してください。 ただし、Individual タイプのワークスペースでは既存の PersistentVolumeClaim を利用できないため、spec.volumeClaimTemplates を使用してください。
  • StorageClass には ブロックストレージ の standard-rwo-<組織名>、または ファイルストレージ の standard-rwx-<組織名>(ReadWriteMany)を指定できます。

spec.suspend フィールド

  • true を指定するとワークスペースを休止し、false に戻すと再開します。

プリセット

ワークスペースの実体となる Pod の構成を プリセット として事前に定義できます。 プリセットを定義することで、似た構成をもつワークスペースの管理を簡素化できます。

プリセットは、ワークスペースに適用する spec.podTemplate フィールドのデフォルト値を定義します。 Workspace リソースからワークスペースの実体となる Pod が作成される際、Workspace リソースの spec.podTemplate フィールドに記述しなかったフィールドはプリセットから引き継がれます。 spec.podTemplate フィールドに記述したフィールドは、その値で上書きされ Pod が作成されます。

プリセットには、ClusterWorkspacePreset カスタムリソースと WorkspacePreset カスタムリソースの 2 種類があります。

ClusterWorkspacePreset カスタムリソース

ClusterWorkspacePreset カスタムリソースは、PFCP マネージドなクラスタ全体で共有されるプリセットです。 すべての組織のワークスペースで利用できます。

利用可能な ClusterWorkspacePreset リソースは、kubectl get clusterworkspacepreset コマンド(または kubectl get cwspreset)で確認できます。 Workspace リソースの spec.presetRef フィールドを以下のように設定することで、適用したい ClusterWorkspacePreset を選択できます。

apiVersion: preferred.jp/v1alpha1
kind: Workspace
spec:
  presetRef:
    apiVersion: preferred.jp/v1alpha1
    kind: ClusterWorkspacePreset
    name: NAME

spec.presetRef フィールドを省略した場合、default ClusterWorkspacePreset が適用されます。 default ClusterWorkspacePreset の一部の値を抜粋すると、以下のようになっています。

apiVersion: preferred.jp/v1alpha1
kind: ClusterWorkspacePreset
metadata:
  name: default
spec:
  podTemplate:
    spec:
      containers:
      - name: workspace
        image: registry.pfcomputing.internal/mncore-sdk/mncore-sdk-full
        command:
        - /app/jupyter/bin/jupyter
        - lab

Workspace リソースの spec.podTemplate フィールドを記述しなかった場合、この値に従い、MN-Core SDK のコンテナイメージで JupyterLab を起動する workspace コンテナをもつ Pod が作成されます。 spec.podTemplate フィールドでコンテナイメージやコマンドなどを指定することで、このデフォルト設定を上書きできます。 また、workspace コンテナのリソース要求の設定や、workspace 以外のコンテナの追加も可能です。

WorkspacePreset カスタムリソース

WorkspacePreset カスタムリソースは、ネームスペース単位で共有されるプリセットです。 ネームスペースに対する org-edit Role をもつユーザが作成・更新・削除できます。

ネームスペースに存在する WorkspacePreset リソースは、kubectl get workspacepreset コマンド(または kubectl get wspreset)で確認できます。 Workspace リソースの spec.presetRef フィールドを以下のように設定することで、適用したい WorkspacePreset を選択できます。

apiVersion: preferred.jp/v1alpha1
kind: Workspace
spec:
  presetRef:
    apiVersion: preferred.jp/v1alpha1
    kind: WorkspacePreset
    name: NAME

Note

Workspace が WorkspacePreset を参照するには、Workspace と WorkspacePreset が同じネームスペースに存在する必要があります。