Compose ファイルからサンドボックスを作成する

​

始める前に

export FORGE_API_KEY="[FORGE-API-KEY]"

export CWSANDBOX_API_KEY="[API-ACCESS-TOKEN]"

​

リクエストフィールド

​

サンドボックスを作成する

cat > compose.yaml <<'EOF'
services:
  helper:
    image: docker.io/library/busybox:1.36
    command: ["sleep", "3600"]
    expose: ["8080"]
    healthcheck:
      test: ["CMD", "true"]
      interval: 1s
      timeout: 1s
      retries: 3
  main:
    image: docker.io/library/busybox:1.36
    command: ["sleep", "3600"]
    environment:
      HELPER_HOST: helper
    depends_on:
      helper:
        condition: service_healthy
EOF

jq -n --rawfile yaml compose.yaml '{
  type: "SANDBOX_FILE_TYPE_COMPOSE",
  contents: ($yaml | @base64),
  primaryService: "main",
  defaultResources: { requests: { cpu: "100m", memory: "128Mi" } },
  maxLifetimeSeconds: 3600,
  tags: ["from-file"]
}' | curl -sS -X POST https://api.cwsandbox.com/v1/sandboxes:createFromFile \
  -H "x-wandb-api-key: $FORGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d @-

export SANDBOX_ID="[SANDBOX-ID]"

curl -sS "https://api.cwsandbox.com/v1/sandboxes/$SANDBOX_ID" \
  -H "x-wandb-api-key: $FORGE_API_KEY"

​

Compose のサポート

• 起動は逐次実行されます。 プライマリ以外の各サービスは、プライマリより先に、順番に起動します。これを考慮して maxLifetimeSeconds を設定してください。サービスが準備完了にならない場合、サンドボックスは STATE_CREATING のままになります。
• RUNNING はプライマリのみをトラッキングします。 起動後にヘルパーがクラッシュしても、サンドボックスは失敗しません。
• healthcheck は exec のみの起動プローブになります。 test は string、CMD、CMD-SHELL、または NONE である必要があり、期間は整数秒で指定する必要があります。プローブの再試行回数を使い切ると、コンテナーは異常とマークされるのではなく、停止されます。
• ポートは Pod 内にとどまります。 expose と ports は待ち受けポートを宣言しますが、外部には公開されません。
• イメージはプル可能である必要があります。 すべてのサービスで、ファイル内の image: または imageOverrides 内のエントリが必要です。依然として build: が必要なサービスは、UNIMPLEMENTED を返します。
• command と entrypoint は Docker のシェル形式と exec 形式に従います。 イメージのデフォルトを使用するには、これらを省略してください。明示的な null と [] は拒否されます。
• GPU はプライマリ専用です。deploy.resources.reservations.devices で gpu 機能と正の整数の個数を指定します。
• 名前は DNS-1123 ラベルである必要があります (My_App ではなく my-app) 。また、予約済みの接頭辞 cw-object-store-agent、cw-object-store-agent-restore、dns-egress は使用できません。

​

サポートされないキー

​

よくあるエラー

​

関連情報

• はじめに: spec から最初のサンドボックスを作成します。
• API の概要: 認証、バージョン管理、エラー処理について説明します。
• サンドボックスの環境変数: プラットフォームが各コンテナーに注入する環境変数について説明します。