Résoudre les problèmes liés à l’interface CLI Databricks

Remarque

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Utilisez les informations suivantes pour résoudre les problèmes liés à l’interface CLI Databricks.

Activation de la journalisation

Si une commande échoue ou ne produit pas la sortie attendue, vous pouvez utiliser la journalisation pour identifier les problèmes éventuels. Vous pouvez journaliser les messages générés par l’interface CLI Databricks concernant différents événements de commande, avertissements et erreurs. Pour journaliser ces messages, spécifiez les options de commande Databricks CLI suivantes :

Indicateur	Description
--log-file	Chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n’est pas spécifié, la valeur par défaut consiste à écrire les logs de sortie dans stderr.
--log-format	text pour écrire les journaux de sortie au format texte ou json pour écrire les journaux de sortie au format JSON. Si cet indicateur n’est pas spécifié, les journaux de sortie sont écrits au format texte.
--log-level	Chaîne représentant le niveau de format du journal. Les niveaux de journal valides sont error, warn, info, debug, trace et disabled. Le niveau par défaut est disabled, ce qui signifie que rien n’est journalisé. --debug est équivalent à --log-level debug.

L’exemple de commande suivant enregistre les messages de trace de la commande spécifiée dans un fichier nommé databricks-cli.log au format JSON.

databricks clusters list --log-file databricks-cli.log --log-format json --log-level trace

Erreur lors du téléchargement de Terraform

Une clé expirée dans certaines versions de l’interface CLI Databricks provoque l’erreur suivante lors de l’exécution databricks bundle deploy:

error downloading Terraform: unable to verify checksums signature: openpgp: key expired

Pour résoudre cette erreur, mettez à niveau l’interface CLI Databricks vers une dernière version corrigée, qui met à jour le mécanisme de vérification pour qu’il fonctionne avec une clé plus récente. Effectuez une mise à niveau vers la version corrigée qui correspond à votre version mineure cli actuelle :

• installation binaire : téléchargez la version patchée depuis la page des publications Databricks CLI sur GitHub.

• setup-cli (en tant que script d’installation ou action GitHub) : Mettez à jour la version dans votre configuration vers une version corrigée à partir de la page Databricks CLI releases sur GitHub.

  Par exemple, pour utiliser 0.296.1 avec l’action de GitHub :

  - uses: databricks/setup-cli@main
    with:
      version: 0.296.1
  

Erreur d’informations d’identification stockées

À partir de la version 1.0.0 de Databricks CLI, Databricks CLI stocke les jetons d’authentification de type utilisateur-vers-machine (U2M) dans le stockage sécurisé natif du système (trousseau sur macOS, Credential Manager sur Windows, D-Bus Secret Service sur Linux) au lieu d’un fichier JSON. Voir Stockage de jetons. Si votre workflow s’appuie sur le fichier JSON, il ne fonctionnera pas sur la nouvelle méthode de stockage et que vous pouvez rencontrer des problèmes dans les scénarios suivants :

• Mis à niveau vers la disponibilité générale, sans s’être encore reconnecté à nouveau. L’interface CLI Databricks ne lit plus les informations d’identification stockées par des versions antérieures et retourne une erreur :

  Stored credentials from older CLI versions are no longer used.
  Run "databricks auth login" to sign in again.
  
  If secure storage is not available in this environment, set
  DATABRICKS_AUTH_STORAGE=plaintext and re-run login.
  

  Exécutez cette opération databricks auth login pour résoudre ce problème.

• Échec de la vérification du stockage sécurisé lors de la connexion Pendant databricks auth login, l’interface CLI Databricks vérifie le stockage sécurisé avant de démarrer le flux OAuth. Si la vérification échoue (le plus courant dans les conteneurs Linux, les sessions SSH, WSL1 et les serveurs sans tête où D-Bus n’est pas en cours d’exécution), le comportement dépend de la configuration explicite du stockage sécurisé :

  • Mode par défaut, aucun paramètre de stockage explicite : l’interface CLI Databricks revient silencieusement en texte brut et écrit auth_storage = plaintext dans la [__settings__] section de ~/.databrickscfg. Les commandes suivantes utilisent le texte en clair sans revérifier.
  • Mode sécurisé explicite (DATABRICKS_AUTH_STORAGE=secure ou auth_storage = secure dans le profil de configuration) : l’interface de ligne de commande Databricks renvoie une erreur indiquant la solution de secours DATABRICKS_AUTH_STORAGE=plaintext.

  Si la vérification expire au lieu d’échouer immédiatement (par exemple, le trousseau est verrouillé mais accessible), Databricks CLI conserve le backend du trousseau et l’invite de déverrouillage du système d’exploitation s’exécute en parallèle avec le flux OAuth dans le navigateur.

  Pour confirmer le mode de stockage utilisé par l’interface CLI Databricks après la connexion, exécutez databricks auth describe.

• Trousseau inaccessible lors de la lecture d’un jeton stocké. Contrairement à la connexion, l’interface CLI Databricks ne revient pas silencieusement lorsqu’elle ne peut pas atteindre le trousseau au moment de la lecture du jeton. Par exemple, si vous vous êtes connecté sur un ordinateur de bureau, puis que vous vous êtes connecté en SSH dans une session sans interface graphique, les commandes qui nécessitent le jeton stocké échouent en renvoyant une erreur. Utilisez la solution de secours en texte brut pour résoudre ce problème. Consultez Utiliser la solution de secours en texte brut.

Commandes non terminées

Si vous exécutez une commande telle que databricks cluster list et qu’elle semble se bloquer, mettez à jour votre version de l’interface CLI Databricks vers la version la plus récente. Les versions antérieures de l’interface CLI tentent de charger des listes complètes même si le nombre d’éléments de la liste était volumineux et que la commande semble ne pas se terminer.