Configuration

Ce guide présente les variables d'environnement et les options de configuration des applications AppKit.

Configuration du déploiement de l'application

Fichier `app.yaml`

Le fichier app.yaml configure l'environnement d'exécution de votre app dans Databricks Apps.

Exemple de base :

command:
  - node
  - build/index.mjs
env:
  - name: DATABRICKS_WAREHOUSE_ID
    valueFrom: sql-warehouse

Spécification de la commande

Indiquez comment démarrer votre application dans le champ command :

command:
  - node
  - build/index.mjs

Cette commande exécute le build de production de votre serveur AppKit (généré par npm run build).

Lier un SQL warehouse

Pour utiliser le plugin Analytics, liez un SQL warehouse dans votre app.yaml :

env:
  - name: DATABRICKS_WAREHOUSE_ID
    valueFrom: sql-warehouse

L'ID du warehouse devient ainsi accessible à votre application au runtime. La directive valueFrom: sql-warehouse indique à Databricks Apps d'injecter l'ID du warehouse configuré.

Association de volumes Unity Catalog (plugin files)

Le plugin files utilise des volumes nommés. Chaque clé de volume correspond à une variable d'environnement DATABRICKS_VOLUME_{KEY_UPPERCASE} :

env:
  - name: DATABRICKS_VOLUME_UPLOADS
    valueFrom: volume
  - name: DATABRICKS_VOLUME_EXPORTS
    valueFrom: volume

Consultez la documentation du plugin Files pour plus de détails.

Pour les options de configuration avancées (autorisation, réseau, limites de ressources), consultez la documentation Databricks Apps Configuration.

Variables d'environnement

Requises pour le déploiement Databricks Apps

Ces variables sont généralement fournies par le runtime Databricks Apps (l'ensemble exact peut varier selon la plateforme et la version) :

Variable	Description
`DATABRICKS_HOST`	URL du workspace (ex. `https://xxx.cloud.databricks.com`)
`DATABRICKS_APP_PORT`	Port d'écoute (par défaut : `8000`)
`DATABRICKS_APP_NAME`	Nom de l'app dans Databricks

Requis pour les requêtes SQL (plugin Analytics)

Variable	Description	Comment la définir
`DATABRICKS_WAREHOUSE_ID`	ID du SQL warehouse	Dans `app.yaml` : `valueFrom: sql-warehouse`

Consultez la section Configuration du déploiement de l'app ci-dessus pour savoir comment lier cette variable.

Variables facultatives

Variable	Description	Valeur par défaut
`DATABRICKS_WORKSPACE_ID`	ID du workspace	Récupéré automatiquement via l'API
`NODE_ENV`	`"development"` ou `"production"`	—
`FLASK_RUN_HOST`	Hôte d'écoute	`0.0.0.0`

Télémétrie (facultatif)

Variable	Description
`OTEL_EXPORTER_OTLP_ENDPOINT`	Endpoint du collecteur OpenTelemetry
`OTEL_SERVICE_NAME`	Nom du service utilisé pour les traces

Authentification en développement local

En développement local, vous devez vous authentifier auprès de Databricks. Choisissez l'une des options suivantes :

Option 1 : authentification via la CLI Databricks (recommandée)

Configurez l'authentification une seule fois à l'aide de la CLI Databricks :

databricks auth login --host [host] --profile [profile-name]

Si vous utilisez DEFAULT comme nom de profil, vous pouvez lancer directement votre serveur de développement :

npm run dev

Pour exécuter l'application avec un profil spécifique, définissez la variable d'environnement DATABRICKS_CONFIG_PROFILE :

DATABRICKS_CONFIG_PROFILE=my-profile npm run dev

Remarque : certaines versions du SDK Databricks utilisent DATABRICKS_PROFILE au lieu de DATABRICKS_CONFIG_PROFILE.

Option 2 : variables d'environnement

export DATABRICKS_HOST="https://xxx.cloud.databricks.com"
export DATABRICKS_TOKEN="dapi..."
export DATABRICKS_WAREHOUSE_ID="abc123..."
npm run dev

Option 3 : fichier `.env` (chargé automatiquement par AppKit)

Créez un fichier .env à la racine de votre projet (à ajouter au .gitignore !) :

DATABRICKS_HOST=https://xxx.cloud.databricks.com
DATABRICKS_TOKEN=dapi...
DATABRICKS_WAREHOUSE_ID=abc123...

Puis exécutez :

npm run dev

Configuration avancée

Pour la configuration avancée de Databricks Apps (autorisation, réseau, limites de ressources), consultez la documentation Databricks Apps Configuration.

Voir aussi

Gestion des applications - Déployer et gérer les applications
Plugins - Options de configuration des plugins