groupe de commandesssh
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Bêta
Le tunnel SSH est en Bêta.
Le groupe de commandes ssh au sein du CLI Databricks vous permet de configurer et d'établir des connexions SSH à votre compute et votre workspace Databricks. Consultez Connectez-vous à Databricks à l'aide d'un tunnel SSH.
connexion SSH Databricks
Connectez-vous à votre compute Databricks et votre workspace via SSH. Cette commande établit une connexion SSH au compute Databricks, en configurant le tunnel SSH et en gérant le proxy de connexion.
databricks ssh connect [flags]
Options
--accelerator string
Le type d'accélérateur GPU lors de la connexion à l'AI Runtime. Accepte GPU_1xA10 ou GPU_8xH100.
--auto-approve
Ignorer les invites de confirmation lors de l'installation d'extensions d'EDI et de l'application des paramètres d'EDI. Default : false.
--auto-start-cluster
Automatically start the cluster s'il ne fonctionne pas. Default: true.
--base-environment string
Un environnement de base de Workspace pour préconfigurer les dépendances Python lors de la connexion au compute serverless. Pris en charge avec la version 4 et les versions antérieures de l'environnement serverless ; la version 5 de l'environnement serverless n'est pas prise en charge. Accepte l'un des formats suivants :
- Un nom d'affichage, par exemple
my-workspace-env - Un chemin de fichier YAML, par exemple
/Workspace/path/to/env.yaml - Un ID de Ressource, par exemple
workspace-base-environments/dbe_123
Cet indicateur ne peut pas être combiné avec --cluster.
--cluster string
ID Databricks pour un cluster mono-utilisateur dédié. Lorsque cette option est omise, le tunnel SSH se connecte au compute serverless.
Cet indicateur ne peut pas être combiné avec --base-environment.
--ide string
IDE à lancer pour la session. Accepte vscode ou cursor. Pour start la session dans votre terminal, omettez cet indicateur, puis utilisez cd /Workspace/Users/someone@example.com pour accéder à votre workspace.
--keep-detached-processes
Pendant que le travail est toujours en cours, gardez le tunnel SSH et tous les processus détachés de la session avec tmux, setsid ou nohup en cours d'exécution, liés par --server-timeout. Pris en charge sur le compute serverless et classic. Pendant l’exécution de processus détachés, le compute continue de s’exécuter et un cluster classique ne s’arrête pas automatiquement. Consultez Maintenir l'exécution des processus détachés. default : false.
--max-clients int
Nombre maximal de clients SSH. Default : 10.
--name string
Nom de la connexion à réutiliser dans toutes les sessions. Compute Serverless uniquement.
--server-timeout duration
Durée de vie maximale du tunnel SSH. Le tunnel s’arrête après cette durée, même si des clients sont connectés. Si vous ne définissez pas cet indicateur, la durée de vie est la plus longue entre la default et --shutdown-delay. Si vous le définissez, --shutdown-delay ne peut pas être plus long que cette valeur. Par default : 24h0m0s.
--shutdown-delay duration
Délai avant l’arrêt du tunnel après la déconnexion du dernier client. default : 10m0s.
--usage-policy-id string
ID de politique d’utilisation pour le tunnel SSH serverless. Serverless uniquement.
Exemples
L'exemple suivant se connecte au compute serverless :
databricks ssh connect
L'exemple suivant se connecte à un compute Serverless sur l'AI Runtime à l'aide d'un accélérateur GPU :
databricks ssh connect --accelerator GPU_1xA10
L'exemple suivant se connecte au compute serverless à l'aide d'un environnement de base Workspace qui a des dépendances Python préconfigurées.
databricks ssh connect --base-environment my-workspace-env
L'exemple suivant se connecte à un cluster dédié :
databricks ssh connect --cluster 0123-456789-abcdefgh
L'exemple suivant se connecte à un cluster à l'aide d'un profil spécifique :
databricks ssh connect --cluster 0123-456789-abcdefgh --profile my-profile
L’exemple suivant se connecte avec un délai d’arrêt personnalisé :
databricks ssh connect --cluster 0123-456789-abcdefgh --shutdown-delay 30m
configuration SSH Databricks
Configurez la configuration SSH pour les connexions à compute classique. Seules les connexions aux clusters dédiés (mono-utilisateur) sont prises en charge. Cette commande ajoute une configuration d'hôte SSH à votre fichier de configuration SSH. Après avoir exécuté la configuration, vous pouvez vous connecter avec ssh <name>.
Pour les connexions serverless, utilisez databricks ssh connect. Aucune étape de configuration n'est requise.
databricks ssh setup [flags]
Options
--auto-approve
Ignorer les invites de confirmation lors de la recréation des configurations d'hôte SSH existantes. Default : false.
--auto-start-cluster
start automatiquement le cluster lors de l'établissement de la connexion SSH. Default : true.
--cluster string
Databricks ID pour un cluster mono-utilisateur dédié.
--keep-detached-processes
Pendant que le travail est toujours en cours, conservez le tunnel SSH et tous les processus détachés de la session avec tmux, setsid ou nohup en cours d’exécution, délimités par --server-timeout. Classic compute uniquement. Les connexions serverless ne nécessitent pas de configuration. Pour que les processus détachés continuent de s’exécuter sur le compute serverless, transmettez plutôt ce flag à databricks ssh connect. Lorsque des processus détachés sont en cours d'exécution, le cluster ne s'arrête pas automatiquement. Voir Maintenir les processus détachés en cours d'exécution. L’entrée d’hôte SSH générée applique ce flag à chaque connexion. default : false.
--name string
Host name à utiliser dans la configuration SSH.
--server-timeout duration
Durée de vie maximale du tunnel SSH. Le tunnel s’arrête après cette durée, même si des clients sont connectés. Si vous ne définissez pas cet indicateur, la durée de vie est la plus longue entre la default et --shutdown-delay. Si vous le définissez, --shutdown-delay ne peut pas être plus long que cette valeur. Par default : 24h0m0s.
--shutdown-delay duration
Le tunnel SSH s'arrête après ce délai s'il n'y a pas de connexions actives. default : 10m0s.
--ssh-config string
Chemin d'accès au fichier de configuration SSH. Default : ~/.ssh/config.
Exemples
L'exemple suivant configure la configuration SSH pour un cluster :
databricks ssh setup --name my-cluster --cluster 0123-456789-abcdefgh
Après avoir exécuté la configuration, vous pouvez vous connecter à l'aide du client SSH standard :
ssh my-cluster
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser