翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アドオンをカスタマイズする

テンプレート

テンプレートは再利用可能なワークスペース設定であり、ワークスペース作成の管理者が管理する設計図として機能します。ワークスペース設定値のデフォルトと、データサイエンティストが実行できる操作を制御するガードレールを提供します。テンプレートはクラスターレベルに存在し、名前空間間で再利用できます。

SageMaker Spaces は、データサイエンティストの開始点として 2 つのシステムテンプレートを作成します。1 つはコードエディタ用、もう 1 つは JupyterLab 用です。これらのシステムテンプレートはアドオンによって管理され、直接編集することはできません。代わりに、管理者は新しいテンプレートを作成し、デフォルトとして設定できます。

タスクガバナンス

apiVersion: workspace.jupyter.org/v1alpha1
kind: WorkspaceTemplate
metadata:
  name: my-jupyter-template
  namespace: my-namespace
  labels:
    kueue.x-k8s.io/priority-class: <user-input>-priority
spec:
  displayName: "My Custom Jupyter Lab"
  description: "Custom Jupyter Lab with specific configurations"
  defaultImage: "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
  allowedImages:
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-gpu"
  defaultResources:
    requests:
      cpu: "1"
      memory: "4Gi"
    limits:
      cpu: "4"
      memory: "16Gi"
  primaryStorage:
    defaultSize: "10Gi"
    minSize: "5Gi"
    maxSize: "50Gi"
    defaultStorageClassName: "sagemaker-spaces-default-storage-class"
    defaultMountPath: "/home/sagemaker-user"
  defaultContainerConfig:
    command: ["/opt/amazon/sagemaker/workspace/bin/entrypoint-workspace-jupyterlab"]
  defaultPodSecurityContext:
    fsGroup: 1000
  defaultOwnershipType: "Public"
  defaultAccessStrategy:
    name: "hyperpod-access-strategy"
  allowSecondaryStorages: true
  appType: "jupyterlab"

SMD / カスタムイメージ

お客様は、デフォルトのイメージと許可されたイメージのリストを提供することで、 テンプレートを使用してイメージポリシーを設定できます。さらに、管理者はデータサイエンティストに独自のカスタムイメージの持ち込みを許可するかどうかを選択できます。システムはデフォルトで最新の SageMaker ディストリビューションを使用しますが、特定のバージョンに固定する場合は、テンプレートで使用する正確な SMD バージョンを指定できます。

カスタムイメージの要件:

リモート IDE 要件

VS Code バージョン要件

VS Code バージョン v1.90 以降が必要です。VS Code の最新の安定したバージョンを使用することをお勧めします。

オペレーティングシステムの要件

Studio スペースにリモート接続するには、次のいずれかのオペレーティングシステムが必要です。

ローカルマシンの前提条件

ローカル Visual Studio コードを Studio スペースに接続する前に、ローカルマシンに必要な依存関係とネットワークアクセスがあることを確認してください。

必要なローカル依存関係

ローカルマシンには、次のコンポーネントがインストールされている必要があります。

プラットフォーム固有の要件

ネットワーク接続要件

ローカルマシンには、Session Manager エンドポイントへのネットワークアクセスが必要です。たとえば、米国東部 (バージニア北部) (us-east-1) では、次のようになります。

イメージの要件

SageMaker ディストリビューションイメージ

リモートアクセスで SageMaker Distribution を使用する場合は、SageMaker Distribution バージョン 2.7 以降を使用します。

カスタムイメージ

リモートアクセスで独自のイメージ (BYOI) を使用するときは、カスタムイメージの仕様に従い、次の依存関係がインストールされていることを確認してください。

インスタンスの要件

コンテナイメージの事前ウォーミングによる Kubernetes 起動時間の最適化

コンテナイメージのプルパフォーマンスは、特に AI/ML ワークロードがますます大きなコンテナイメージに依存するため、多くの EKS 顧客にとって大きなボトルネックとなっています。これらの大きなイメージをプルおよび解凍するには、通常、各 EKS ノードで初めて使用する場合に数分かかります。この遅延により、SageMaker Spaces を起動する際のレイテンシーが大幅に増加し、ユーザーエクスペリエンスに直接影響します。特に、ノートブックやインタラクティブな開発ジョブなど、高速起動が不可欠な環境では顕著です。

イメージの事前ウォーミングは、特定のコンテナイメージを EKS/HyperPod クラスター内のすべてのノードに必要な前にプリロードするために使用される手法です。ポッドが大きなイメージの最初のプルをトリガーするのを待つ代わりに、クラスターはすべてのノードでイメージをプロアクティブにダウンロードしてキャッシュします。これにより、ワークロードの起動時に必要なイメージが既にローカルで利用可能になり、コールドスタートの遅延が長くなります。イメージの事前ウォーミングにより、SageMaker Spaces の起動速度が向上し、エンドユーザーにより予測可能で応答性の高いエクスペリエンスが提供されます。

DaemonSet による事前ウォーミング

DaemonSet を使用してイメージをプリロードすることをお勧めします。DaemonSet は、クラスター内のすべてのノードで 1 つのポッドが実行されるようにします。DaemonSet ポッド内の各コンテナは、キャッシュするイメージを参照します。Kubernetes がポッドを起動すると、イメージが自動的にプルされ、各ノードのキャッシュがウォームアップされます。

次の例は、2 つの GPU イメージをプリロードする DaemonSet を作成する方法を示しています。各コンテナは軽量sleep infinityコマンドを実行して、最小限のオーバーヘッドでポッドをアクティブに保ちます。

cat <<EOF | kubectl apply -n "namespace_1" -f -
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: image-preload-ds
spec:
  selector:
    matchLabels:
      app: image-preloader
  template:
    metadata:
      labels:
        app: image-preloader
    spec:
      containers:
      - name: preloader-3-4-2
        image: public.ecr.aws/sagemaker/sagemaker-distribution:3.4.2-gpu
        command: ["sleep"]
        args: ["infinity"]
        resources:
          requests:
            cpu: 1m
            memory: 16Mi
          limits:
            cpu: 5m
            memory: 32Mi
      - name: preloader-3-3-2
        image: public.ecr.aws/sagemaker/sagemaker-distribution:3.3.2-gpu
        command: ["sleep"]
        args: ["infinity"]
        resources:
          requests:
            cpu: 1m
            memory: 16Mi
          limits:
            cpu: 5m
            memory: 32Mi
EOF

仕組み

スペースデフォルトストレージ (EBS)

システムはデフォルトで EBS CSI ドライバーを使用して、各ワークスペースに EBS ストレージボリュームをプロビジョニングします。SageMaker はワークスペースで使用する EBS ストレージクラスを作成し、管理者はテンプレート設定を使用してこれらのボリュームのデフォルトサイズと最大サイズをカスタマイズできます。CLI ツールを使用する上級ユーザーの場合、ワークスペースのストレージクラスをカスタマイズすることもできます。これにより、ユーザーは EBS ボリュームのカスタマーマネージド KMS キーの設定など、他のストレージクラスを活用できます。

EBS ボリュームは特定の AZ にバインドされることに注意してください。つまり、ワークスペースはストレージボリュームと同じ AZ 内のノードでのみスケジュールできます。これにより、クラスター容量は存在するが、正しい AZ にない場合、スケジューリングが失敗する可能性があります。

Lifecycle

ライフサイクル設定は、ワークスペースの作成時または起動時に実行される起動スクリプトを提供します。これらのスクリプトにより、管理者は起動時にワークスペース環境をカスタマイズできます。これらは、最大サイズが 1 KB の bash スクリプトです。より大きなセットアップ設定が必要な場合は、コンテナイメージにスクリプトを追加し、ライフサイクル設定からスクリプトをトリガーすることをお勧めします。

Kubernetes コンテナライフサイクルフックを活用して、この機能 https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/ を提供します。Kubernetes は、コンテナのエントリポイントに関連して起動スクリプトがいつ実行されるかを保証するものではないことに注意してください。

アイドルシャットダウン

アイドル状態のワークスペースの自動シャットダウンを設定して、リソースの使用を最適化します。

アイドルシャットダウン

idleShutdown:
  enabled: true
  idleShutdownTimeoutMinutes: 30
  detection:
    httpGet:
      path: /api/idle
      port: 8888
      scheme: HTTP

パラメータ

有効 (ブール値、必須) - ワークスペースのアイドルシャットダウンを有効または無効にします。

idleShutdownTimeoutMinutes (整数、必須) - ワークスペースがシャットダウンするまでの非アクティブ状態の分数。最小値は 1 です。

detection (オブジェクト、必須) - ワークスペースのアイドル状態を検出する方法を定義します。

detection.httpGet (オブジェクト、オプション) - アイドル検出用の HTTP エンドポイント設定。Kubernetes HTTPGetAction 仕様を使用します。

設定場所

WorkSpace の設定

ワークスペース仕様でアイドルシャットダウンを直接定義します。

apiVersion: workspace.jupyter.org/v1alpha1
kind: Workspace
metadata:

      name: my-workspace
spec:
  displayName: "Development Workspace"
  image:
      jupyter/scipy-notebook:latest
  idleShutdown:
    enabled: true

      idleShutdownTimeoutMinutes: 30
    detection:
      httpGet:
        path:
      /api/idle
        port: 8888

テンプレート設定

WorkspaceTemplate でデフォルトのアイドルシャットダウン動作を定義します。

apiVersion: workspace.jupyter.org/v1alpha1
kind: WorkspaceTemplate
metadata:
  name: jupyter-template
spec:
  displayName: "Jupyter Template"
  defaultImage: jupyter/scipy-notebook:latest
  defaultIdleShutdown:
    enabled: true
    idleShutdownTimeoutMinutes: 30
    detection:
      httpGet:
        path: /api/idle
        port: 8888
  idleShutdownOverrides:
    allow: true
    minTimeoutMinutes: 60
    maxTimeoutMinutes: 240

テンプレートの継承と上書き

テンプレートを使用する Workspace は、テンプレートdefaultIdleShutdownの設定を自動的に継承します。テンプレートで許可されている場合、WorkSpaces はこの設定を上書きできます。

ポリシーを上書きする

テンプレートは、 を通じてオーバーライド動作を制御しますidleShutdownOverrides。

allow (ブール値、デフォルト: true) - ワークスペースがデフォルトのアイドルシャットダウン設定を上書きできるかどうか。

minTimeoutMinutes (整数、オプション) - ワークスペースオーバーライドで許可される最小タイムアウト値。

maxTimeoutMinutes (整数、オプション) - ワークスペースオーバーライドの最大許容タイムアウト値。

継承の例

WorkSpace はテンプレートのデフォルトを継承します。

apiVersion: workspace.jupyter.org/v1alpha1
kind: Workspace
metadata:
  name: my-workspace
spec:
  displayName: "My Workspace"
  templateRef:
    name: jupyter-template
  # Inherits defaultIdleShutdown from template

オーバーライドの例

WorkSpace はテンプレートのデフォルトを上書きします。

apiVersion: workspace.jupyter.org/v1alpha1
kind: Workspace
metadata:
  name: my-workspace
spec:
  displayName: "My Workspace"
  templateRef:
    name: jupyter-template
  idleShutdown:
    enabled: true
    idleShutdownTimeoutMinutes: 60  # Must be within template bounds
    detection:
      httpGet:
        path: /api/idle
        port: 8888

ロックされた設定

ワークスペースの上書きを防止します。

apiVersion: workspace.jupyter.org/v1alpha1
kind: WorkspaceTemplate
metadata:
  name: locked-template
spec:
  displayName: "Locked Template"
  defaultImage: jupyter/scipy-notebook:latest
  defaultIdleShutdown:
    enabled: true
    idleShutdownTimeoutMinutes: 30
    detection:
      httpGet:
        path: /api/idle
        port: 8888
  idleShutdownOverrides:
    allow: false  # Workspaces cannot override

行動

アイドルシャットダウンが有効になっている場合、システムは設定された HTTP エンドポイントを使用してワークスペースのアクティビティを定期的にチェックします。エンドポイントが、指定したタイムアウト時間ワークスペースがアイドル状態であることを示している場合、ワークスペースは自動的に停止します。必要に応じて、ワークスペースを手動で再起動できます。

テンプレートの更新

Kubectl や Hyperpod CLI や SDK などのクライアントツールは、EKS クラスター内のスペースの管理に使用できます。管理者はデフォルトのスペース設定用にスペーステンプレートをプロビジョニングできますが、データサイエンティストは基盤となる Kubernetes の複雑さを理解することなく、統合された開発環境をカスタマイズできます。詳細な使用手順については、https://sagemaker-hyperpod-cli.readthedocs.io/en/latest/index.html の CLI と SDK のドキュメントを参照してください。

管理者は、スペーステンプレートで CRUD オペレーションを実行できます。これは、スペースを作成する際の基本設定として機能します。データサイエンティストは、スペースで CRUD オペレーションを実行し、特定のコンピューティングノードのマルチインスタンス GPU プロファイルなど、さまざまなパラメータを上書きできます。リモート VSCode アクセスとウェブ UI を使用して、Spaces を起動、停止、接続できます。スペーステンプレートが更新されると、後で作成されるスペースは、更新されたテンプレートの設定で設定されます。コンプライアンスチェックは、既存のスペースが更新または開始されたときに実行されます。いずれかの設定が範囲外であるか、一致しない場合、スペースは更新または起動に失敗します。

hyp CLI と kubectl の使用

ユーザーは Hyperpod CLI を使用してテンプレートで CRUD を実行できます

### 1. Create a Space Template
hyp create hyp-space-template --file template.yaml

### 2. List Space Templates
hyp list hyp-space-template
hyp list hyp-space-template --output json

### 3. Describe a Space Template
hyp describe hyp-space-template --name my-template
hyp describe hyp-space-template --name my-template --output json

### 4. Update a Space Template
hyp update hyp-space-template --name my-template --file updated-template.yaml

### 5. Delete a Space Template
hyp delete hyp-space-template --name my-template

カスタムテンプレートを作成するには、システムテンプレートを開始点として使用できます。このテンプレートは SMD のようなイメージで機能しますが、管理者が使用するイメージに基づいてカスタマイズできます。

カスタム JupyterLab テンプレートの例:

apiVersion: workspace.jupyter.org/v1alpha1
kind: WorkspaceTemplate
metadata:
  name: my-jupyter-template
  namespace: my-namespace
spec:
  displayName: "My Custom Jupyter Lab"
  description: "Custom Jupyter Lab with specific configurations"
  defaultImage: "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
  allowedImages:
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-gpu"
  defaultResources:
    requests:
      cpu: "1"
      memory: "4Gi"
    limits:
      cpu: "4"
      memory: "16Gi"
  primaryStorage:
    defaultSize: "10Gi"
    minSize: "5Gi"
    maxSize: "50Gi"
    defaultStorageClassName: "sagemaker-spaces-default-storage-class"
    defaultMountPath: "/home/sagemaker-user"
  defaultContainerConfig:
    command: ["/opt/amazon/sagemaker/workspace/bin/entrypoint-workspace-jupyterlab"]
  defaultPodSecurityContext:
    fsGroup: 1000
  defaultOwnershipType: "Public"
  defaultAccessStrategy:
    name: "hyperpod-access-strategy"
  allowSecondaryStorages: true
  appType: "jupyterlab"

カスタムコードエディタテンプレートの例:

apiVersion: workspace.jupyter.org/v1alpha1
kind: WorkspaceTemplate
metadata:
  name: my-code-editor-template
  namespace: my-namespace
spec:
  displayName: "My Custom Code Editor"
  description: "Custom Code Editor with specific configurations"
  defaultImage: "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
  allowedImages:
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-cpu"
    - "public.ecr.aws/sagemaker/sagemaker-distribution:latest-gpu"
  defaultResources:
    requests:
      cpu: "1"
      memory: "4Gi"
    limits:
      cpu: "4"
      memory: "16Gi"
  primaryStorage:
    defaultSize: "10Gi"
    minSize: "5Gi"
    maxSize: "50Gi"
    defaultStorageClassName: "sagemaker-spaces-default-storage-class"
    defaultMountPath: "/home/sagemaker-user"
  defaultContainerConfig:
    command: ["/opt/amazon/sagemaker/workspace/bin/entrypoint-workspace-code-editor"]
  defaultPodSecurityContext:
    fsGroup: 1000
  defaultOwnershipType: "Public"
  defaultAccessStrategy:
    name: "hyperpod-access-strategy"
  allowSecondaryStorages: true
  appType: "code-editor"