Variables d’environnement

Cette page décrit les variables d’environnement que CoreWeave définit dans chaque sandbox et explique comment les lire depuis le code exécuté dans la sandbox. La plateforme les définit à la création, en plus des variables que vous fournissez vous-même, afin que votre code puisse identifier son propre environnement d’exécution. Pour définir vos propres variables, consultez Définir vos propres variables d’environnement.

Choisir l’authentification

Ces exemples s’exécutent sur la capacité sans serveur, sauf si une section précise CoreWeave Kubernetes Service (CKS). Choisissez l’identifiant d’authentification du compte propriétaire de vos sandboxes. Pour obtenir une clé ou un jeton, consultez Choisir et obtenir des identifiants. Enregistrez la configuration correspondant à votre langage dans le même répertoire que les scripts que vous exécutez depuis cette page. Les exemples Python importent AUTH depuis sandbox_auth.py. Les exemples TypeScript importent client depuis sandbox-client.mts. Ces fichiers sélectionnent la méthode d’authentification sans stocker votre identifiant d’authentification. Pour Python, utilisez un environnement virtuel actif. Pour TypeScript, installez d’abord le client avec npm install @coreweave/cwsandbox@1.0.0.

Clé API Forge
Jeton d’accès à l’API CoreWeave

Utilisez votre clé API Forge avec l’intégration wandb du SDK. Remplacez [WANDB-API-KEY] par votre clé API :

export WANDB_API_KEY="[WANDB-API-KEY]"

Python
TypeScript

uv pip install 'cwsandbox[wandb]>=1.14.2'

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.WANDB

sandbox-client.mts

import { createSandboxClientFromEnv } from "@coreweave/cwsandbox/wandb";

export const client = createSandboxClientFromEnv();

Utilisez le jeton de votre organisation CoreWeave. Remplacez [API-ACCESS-TOKEN] par votre jeton :

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

Python
TypeScript

uv pip install 'cwsandbox>=1.14.2'

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.COREWEAVE_API_KEY

sandbox-client.mts

import { createSandboxClientFromEnv } from "@coreweave/cwsandbox/node";

export const client = createSandboxClientFromEnv();

Pour un placement sur CKS, choisissez le jeton CoreWeave, activez un exécuteur et définissez placement_mode="cks" lors de la création de la sandbox ou dans SandboxDefaults. En TypeScript, choisissez le jeton CoreWeave et définissez un tableau runnerIds non vide pour sélectionner CKS. Lorsque vous créez une session Python avec auth=AUTH, les sandboxes qui lui appartiennent sont également authentifiées. Conservez le même identifiant d’authentification pour vous reconnecter à vos sandboxes, les lister ou les nettoyer.

Variables

La plateforme définit la variable suivante dans chaque sandbox :

Variable	Valeur	Description
`CW_SANDBOX_ID`	UUID	L’ID propre à la sandbox. Il est identique à l’ID renvoyé lors de la création de la sandbox et correspond à l’ID que vous utilisez dans les appels d’API et de SDK qui agissent sur la sandbox.

La plateforme définit ces variables quelle que soit la version du SDK ou de l’API que vous utilisez.

N’analysez pas le nom d’hôte pour obtenir l’ID de la sandbox. Le nom d’hôte d’une sandbox commence par l’ID de la sandbox, mais il comporte un suffixe généré qui change si le pod sous-jacent redémarre. Utilisez plutôt CW_SANDBOX_ID.

Lire une variable

Les variables de plateforme sont accessibles au processus principal de chaque conteneur, à tout processus qu’il lance, ainsi qu’aux processus lancés avec exec ou par exécution en diffusion en continu. Seule exception : un programme qui efface son environnement avant de lancer un processus enfant.

Python
TypeScript
Shell

import os

sandbox_id = os.environ["CW_SANDBOX_ID"]
print(f"running in sandbox {sandbox_id}")

const sandboxId = process.env.CW_SANDBOX_ID;

console.log(`running in sandbox ${sandboxId}`);

echo "$CW_SANDBOX_ID"

Un usage courant consiste à étiqueter les journaux ou les métriques émis depuis la sandbox, afin de pouvoir ensuite corréler les enregistrements avec la sandbox dont ils proviennent.

Remplacer une variable

Les variables de plateforme sont des valeurs par défaut, et non des noms réservés. Si vous définissez une variable portant le même nom sur votre sandbox, celle-ci utilise votre valeur et la plateforme n’applique pas sa valeur par défaut. Remplacez [YOUR-VALUE] par la valeur que la sandbox doit renvoyer :

Python
TypeScript

from sandbox_auth import AUTH
from cwsandbox import Sandbox

sandbox = Sandbox.run(
    container_image="ubuntu:22.04",
    environment_variables={"CW_SANDBOX_ID": "[YOUR-VALUE]"},
    resources={"cpu": "1", "memory": "1Gi"},
    auth=AUTH,
)

import { client } from "./sandbox-client.mts";

const sandbox = await client.create({
  containerImage: "ubuntu:22.04",
  environmentVariables: { CW_SANDBOX_ID: "[YOUR-VALUE]" },
});

Les règles suivantes s’appliquent aux remplacements :

Toute valeur est prise en compte, y compris une chaîne vide. Définir CW_SANDBOX_ID sur "" crée une variable présente mais vide. La plateforme ne considère pas une valeur vide comme non définie et ne la remplace pas.
Une politique ne peut pas remplacer les variables de plateforme. Le nom est protégé contre la configuration de l’opérateur : la politique d’un cluster ne peut donc pas remplacer à votre insu une valeur que vous avez définie.
Les secrets valent remplacement. Un secret associé au même nom de variable neutralise la valeur par défaut de la plateforme, exactement comme une valeur définie directement.

Simple métadonnée, pas une identité

CW_SANDBOX_ID est une métadonnée purement indicative. Comme sa valeur peut être remplacée, le code exécuté dans une sandbox peut déclarer n’importe quelle valeur.

N’utilisez pas CW_SANDBOX_ID pour l’authentification, l’autorisation ou l’attribution dans le cadre d’un audit. Vos propres systèmes ont enregistré un ID de sandbox au moment de créer la sandbox. C’est cet ID qui fait foi, et non une valeur déclarée depuis l’intérieur de la sandbox.

Sandbox comportant plusieurs conteneurs

Chaque conteneur reçoit la valeur définie sur le premier conteneur de la sandbox, sauf s’il définit lui-même CW_SANDBOX_ID. Une valeur explicite prévaut pour le conteneur qui la définit. Il en découle deux conséquences :

Si vous remplacez la variable sur le premier conteneur, tous les autres conteneurs qui ne la définissent pas reçoivent votre valeur de remplacement.
Si vous la remplacez par une chaîne vide sur le premier conteneur, les autres conteneurs ne reçoivent pas du tout la variable.

Comportement au cours du cycle de vie de la sandbox

CW_SANDBOX_ID se comporte comme suit pendant la durée de vie d’une sandbox :

La valeur reste fixe pendant toute la durée de vie de la sandbox. La plateforme l’attribue lors de la création, et elle ne change pas si le pod sous-jacent redémarre.
Une sandbox restaurée est une nouvelle sandbox. La restauration à partir d’un instantané du système de fichiers crée une sandbox dotée d’un nouvel ID, et CW_SANDBOX_ID prend cette nouvelle valeur. Tout ID antérieur que votre application a écrit dans un volume d’instantané est enregistré en tant que données propres et n’est pas mis à jour.

Sandbox

Utiliser les Sandbox

Gérer les bacs à sable

Référence

Variables d’environnement

Choisir l’authentification

Variables

Lire une variable

Remplacer une variable

Simple métadonnée, pas une identité

Sandbox comportant plusieurs conteneurs

Comportement au cours du cycle de vie de la sandbox

​Choisir l’authentification

​Variables

​Lire une variable

​Remplacer une variable

​Simple métadonnée, pas une identité

​Sandbox comportant plusieurs conteneurs

​Comportement au cours du cycle de vie de la sandbox

Choisir l’authentification

Variables

Lire une variable

Remplacer une variable

Simple métadonnée, pas une identité

Sandbox comportant plusieurs conteneurs

Comportement au cours du cycle de vie de la sandbox