環境変数

このガイドでは、CWSandbox インスタンスで環境変数を設定および管理する方法について説明します。環境変数を使用すると、ログレベルや project 識別子など、機密性のない設定値をサンドボックスに渡すことができます。環境変数は、個々のサンドボックスに設定するほか、Session内の複数のサンドボックスで共有したり、適用範囲をリモート関数に限定したりすることもできます。

APIキー、パスワード、その他の認証情報を environment_variables にハードコードしたり、ログに出力したりしないでください。認証情報をそのまま渡すのではなく、シークレット参照を使用することを推奨します。Forge のシークレット注入を利用できない場合でも、機密性の高い値はシークレットマネージャーで管理してください。このガイダンスは、サーバーレスサンドボックスと CKS サンドボックスの両方に適用されます。

Forge で認証されたサーバーレスサンドボックスでは、Forge シークレットを使用してください。サーバーがこれらの参照を解決し、値を環境変数として注入します。Forge のシークレット注入は、CKS に配置されたサンドボックスや、CoreWeave API アクセストークンで認証されたサンドボックスでは利用できません。CKS の場合は、組織で承認されている方法でワークロードにシークレットを渡してください。

認証を選択する

以下の例は、CKS を指定しているセクションを除き、サーバーレスキャパシティ上で実行されます。サンドボックスを所有するアカウントの認証情報を選択してください。キーまたはトークンの取得方法については、認証情報の選択と取得を参照してください。インストールコマンドは、有効化した Python 仮想環境内で実行してください。使用する認証情報のタブにある Python コードを、このページで実行する Python スクリプトと同じディレクトリに sandbox_auth.py として保存します。このファイルに保存されるのは認証方式の選択であり、認証情報そのものではありません。各例ではこのファイルから AUTH をインポートし、新しいサンドボックスまたは Session ごとに明示的に渡します。

Forge API キー
CoreWeave API アクセストークン

SDK の W&B 認証方式で Forge APIキーを使用します。

uv pip install 'cwsandbox[wandb]>=1.14.2'
export WANDB_API_KEY="[WANDB-API-KEY]"

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.WANDB

CoreWeave 組織のトークンを使用します。

uv pip install 'cwsandbox>=1.14.2'
export CWSANDBOX_API_KEY="[API-ACCESS-TOKEN]"

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.COREWEAVE_API_KEY

CKS に配置する場合は、CoreWeave トークンを選択し、ランナーを有効化したうえで、サンドボックスの作成時または SandboxDefaults で placement_mode="cks" を設定します。auth=AUTH を指定して Session を作成すると、その Session が所有するサンドボックスも認証されます。サンドボックスへの再接続、一覧表示、クリーンアップの際も、同じ認証情報を使用してください。

基本的な使い方

サンドボックス内で実行されるプロセスで値を使用できるようにするには、Sandbox.run に environment_variables 辞書を渡します。

from sandbox_auth import AUTH
from cwsandbox import Sandbox

with Sandbox.run(
    environment_variables={"LOG_LEVEL": "info"},
    resources={"cpu": "1", "memory": "1Gi"},
    auth=AUTH,
) as sandbox:
    result = sandbox.exec([
        "python",
        "-c",
        "import os; print(os.environ.get('LOG_LEVEL'));",
    ]).result()
    print(result.stdout.strip())  # "info"

Sessionレベルのデフォルト

複数のサンドボックスで同じ変数を使う場合は、サンドボックスごとに繰り返し定義する代わりに、Sessionで一度だけ定義できます。個々のサンドボックスでは、Sessionのデフォルトを上書きしたり、独自の変数を追加したりできます。

from sandbox_auth import AUTH
from cwsandbox import SandboxDefaults, Session

defaults = SandboxDefaults(
    environment_variables={
        "PROJECT_ID": "my-project",
        "LOG_LEVEL": "info",
    },
    resources={"cpu": "1", "memory": "1Gi"},
)

with Session(defaults, auth=AUTH) as session:
    with session.sandbox() as sb1:
        result = sb1.exec([
            "python",
            "-c",
            "import os; print(os.environ.get('LOG_LEVEL'));",
        ]).result()
        print(result.stdout.strip())  # "info"

    # LOG_LEVEL を上書きし、新しい変数を追加
    with session.sandbox(
        environment_variables={
            "LOG_LEVEL": "debug",  # セッションのデフォルトを上書き
            "MODEL_NAME": "gpt-4",  # 新しい変数を追加
        }
    ) as sb2:
        result = sb2.exec([
            "python",
            "-c",
            "import os; "
            "print(os.environ.get('PROJECT_ID')); "
            "print(os.environ.get('LOG_LEVEL')); "
            "print(os.environ.get('MODEL_NAME'));",
        ]).result()
        lines = result.stdout.strip().split("\n")
        print(lines)  # ["my-project", "debug", "gpt-4"]

リモート関数

リモート関数はSessionの環境変数を継承するほか、@session.function デコレーターで独自の環境変数を宣言することもできます。SDK は呼び出し時に、関数レベルの変数をSessionのデフォルトとマージします。

from sandbox_auth import AUTH
with Session(defaults, auth=AUTH) as session:
    @session.function(environment_variables={"MODEL_VERSION": "v2.0"})
    def process(task_id: int) -> dict:
        import os
        return {
            "task": task_id,
            "project": os.environ.get("PROJECT_ID"),  # セッションのデフォルトから取得
            "version": os.environ.get("MODEL_VERSION"),  # 関数デコレーターから取得
        }

    result = process.remote(42).result()
    print(result)  # {"task": 42, "project": "my-project", "version": "v2.0"}

環境変数は参照渡しされます。次の例に示すように、デコレート後に辞書へ加えた変更は、以降の関数の Call に反映されます。

env_vars = {"MODEL_VERSION": "v2.0"}

@session.function(environment_variables=env_vars)
def process(task_id: int) -> dict:
    import os
    return {"version": os.environ.get("MODEL_VERSION")}

result = process.remote(42).result()  # バージョン: "v2.0"

env_vars["MODEL_VERSION"] = "v3.0"  # 辞書を変更する

result = process.remote(42).result()  # バージョン: "v3.0"（変更が反映される）

サンドボックス

サンドボックスを使用する

サンドボックスの管理

リファレンス

認証を選択する

基本的な使い方

Sessionレベルのデフォルト

リモート関数

​認証を選択する

​基本的な使い方

​Sessionレベルのデフォルト

​リモート関数

認証を選択する

基本的な使い方

Sessionレベルのデフォルト

リモート関数