Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Important
Dieses Feature befindet sich in der Betaversion. Um diese Funktionsvorschau im Arbeitsbereich zu aktivieren, wähle die Databricks-Sandbox-Einstellung auf der Seite Vorschauen des Arbeitsbereichs an. Siehe Manage Azure Databricks Previews.
Das Databricks SDK für Python enthält einen Sandbox-Client zum Erstellen von Sandboxes, zum Ausführen von Befehlen darin, zum Weiterleiten von Ports an Apps, die darin ausgeführt werden, und zum Verwalten ihres Lebenszyklus. Für einen Überblick über Databricks Sandbox siehe Databricks Sandbox.
Das SDK installieren
Installieren oder aktualisieren Sie das Databricks SDK für Python, das den Sandbox-Client enthält:
pip install --upgrade databricks-sdk
Erstellen Sie einen WorkspaceClient
Alle Vorgänge in der Sandbox werden über ein WorkspaceClient ausgeführt. Erstelle eine WorkspaceClient mit Anmeldeinformationen, die aus deiner Umgebung, einem Konfigurationsprofil oder einem explizit angegebenen Host und Token ermittelt werden:
from databricks.sdk import WorkspaceClient
# Resolve credentials from the environment or the default config profile:
w = WorkspaceClient()
# Or select a specific ~/.databrickscfg profile:
w = WorkspaceClient(profile="my-workspace")
# Or pass the host and token explicitly:
w = WorkspaceClient(host="https://<workspace>.cloud.databricks.com", token="dapi...")
Weitere Informationen zur Konfiguration und Authentifizierung des SDK finden Sie unter Databricks SDK für Python.
Erstelle eine Sandbox
Erstellen Sie eine Sandbox anhand der ID. Du kannst optional die Compute-Spezifikation konfigurieren, zum Beispiel die Inaktivitätszeit, die steuert, wie lange die Sandbox ohne Aktivität läuft:
from google.protobuf.duration_pb2 import Duration
from databricks.sdk.service.sandbox import ComputeSpec, Sandbox, SandboxSpec
created = w.sandbox.create_sandbox(
sandbox=Sandbox(
spec=SandboxSpec(compute=ComputeSpec(inactivity_timeout=Duration(seconds=900))),
),
sandbox_id="my-sandbox",
)
print(created.name) # "sandboxes/my-sandbox"
Tip
Um aus deinem eigenen Container-Image eine Sandbox zu erstellen, setze spec.environment.image_uri. Siehe Erstellen einer Sandbox aus einem benutzerdefinierten Image.
Sandboxes abrufen und auflisten
Holen Sie einen einzelnen Sandkasten nach Namen ab oder listen Sie alle Sandboxen auf:
sandbox = w.sandbox.get_sandbox("sandboxes/my-sandbox")
print(sandbox.status.state) # SandboxState.SANDBOX_STATE_RUNNING
for sandbox in w.sandbox.list_sandboxes():
print(sandbox.name, sandbox.status.state if sandbox.status else None)
Führe einen Befehl in einer Sandbox aus
Führe einen Befehl in einer Sandbox aus und lies dessen Ausgabe. Das erste Argument ist der Name der Sandbox, gefolgt vom zu ausführenden Programm und seinen Argumenten. Dies ist eine direkte Ausführung ohne Shell. Um einen Shell-Befehl auszuführen, verwenden Sie /bin/bash -c. Führen Sie beliebige Umweltvariablen durch envs:
from google.protobuf.duration_pb2 import Duration
resp = w.sandbox.execute_command_sync(
"sandboxes/my-sandbox",
"/bin/bash",
args=["-c", "echo hello world && whoami"],
envs={"MY_VAR": "value"},
execution_timeout=Duration(seconds=30),
)
print(resp.status) # ExecuteCommandStatus.EXECUTE_COMMAND_STATUS_COMPLETED
print(resp.exit_code) # 0
print(resp.stdout) # "hello world\nsandbox-agent\n"
print(resp.stderr)
print(resp.truncated) # True if the output was truncated
Einen Port aus einer Sandbox weiterleiten
Nutzen Sie Portweiterleitung, um einen Webserver, ein Notebook oder eine API zu erreichen, die in einem Sandbox von Ihrem lokalen Rechner aus läuft.
forward() öffnet einen Listener und 127.0.0.1 leitet HTTP- und WebSocket-Datenverkehr an einen Port im Sandbox weiter. Es authentifiziert sich mit denselben Workspace-Anmeldedaten wie das WorkspaceClient, sodass du keine SSH-Schlüssel brauchst. Portweiterleitung erfordert databricks-sdk 0.166.0 oder höher. Siehe die SDK-Referenz forward() für die Methodensignatur und den unterstützten Portbereich.
Starte eine App in der Sandbox, die auf 0.0.0.0 lauscht, und leite dann deren Port weiter. Führen Sie die App im Hintergrund aus, sodass der Befehl zurückkehrt, während die App weiterläuft:
w.sandbox.execute_command_sync(
"sandboxes/my-sandbox",
"/bin/bash",
args=["-c", "nohup python3 -m http.server 10080 --bind 0.0.0.0 > /tmp/server.log 2>&1 &"],
)
with w.sandbox.forward("sandboxes/my-sandbox", 10080) as fwd:
print(fwd.url) # http://127.0.0.1:<local-port>
input("Press Enter to stop forwarding...")
forward() Kehrt zurück, sobald der lokale Listener bereit ist, und die Weiterleitung läuft im Hintergrund weiter, bis Sie anrufen close() oder der with Block beendet wird. Standardmäßig wählt das SDK einen freien lokalen Port. Lesen Sie ihn aus fwd.local_port, oder setzen Sie einen bestimmten Port mit local_port:
fwd = w.sandbox.forward("sandboxes/my-sandbox", 10080, local_port=8080)
# Open http://127.0.0.1:8080 in a browser or send requests with curl.
fwd.close()
Portweiterleitung hat folgende Anforderungen und Einschränkungen:
- Die App in der Sandbox muss auf allen Schnittstellen zuhören (
0.0.0.0). Apps, die nur auf127.0.0.1lauschen, sind unerreichbar. Viele Entwicklungsserver binden standardmäßig an127.0.0.1, daher geben Sie eine Host-Option wieuvicorn --host 0.0.0.0,jupyter lab --ip=0.0.0.0odervite --hostan. - Man kann die Ports 10000 an 65535 weiterleiten, außer 10101, 18767 und 19090, die die Plattform reserviert.
- Portweiterleitung überträgt HTTP/1.1- und WebSocket-Datenverkehr. Roh-TCP, wie etwa ein Datenbank-Wire-Protokoll, wird nicht unterstützt.
- Du kannst Ports nur in Sandboxes weiterleiten, die du besitzt.
- Die erste Anfrage an eine gestoppte Sandbox startet sie. Die App muss auf dem angeforderten Port laufen, damit die Anfrage erfolgreich ist.
- WebSocket-Verbindungen schließen sich nach höchstens 1 Stunde. Erneut verbinden, um fortzufahren.
Note
In den Versionen 0.164.0 und 0.165.0 des Databricks SDK hieß diese Methode port_forward(). Verwenden Sie in Version 0.166.0 und höher forward().
Um einen Port aus einer Sandbox weiterzuleiten, die Sie mit der Databricks-CLI erstellt haben, geben Sie nach -- SSH-Optionen weiter. Die Sandbox-CLI-Referenz dokumentiert diese Weiterleitung. Verwenden Sie -N, um die Verbindung offen zu halten, ohne eine entfernte Shell zu starten:
databricks sandbox ssh -- -N -L 8080:localhost:8080
Aktualisieren Sie Sandbox-Metadaten
Du kannst den Anzeigenamen und das Inaktivitäts-Timeout einer Sandbox aktualisieren. Es werden nur die folgenden Feldpfade akzeptiert. Jeder andere Pfad liefert INVALID_PARAMETER_VALUE:
display_namespec.compute.inactivity_timeout
from databricks.sdk.common.types.fieldmask import FieldMask
from databricks.sdk.service.sandbox import ComputeSpec, Sandbox, SandboxSpec
from google.protobuf.duration_pb2 import Duration
# Rename the sandbox
w.sandbox.update_sandbox(
name="sandboxes/my-sandbox",
sandbox=Sandbox(display_name="renamed sandbox"),
update_mask=FieldMask(["display_name"]),
)
# Extend the inactivity timeout
w.sandbox.update_sandbox(
name="sandboxes/my-sandbox",
sandbox=Sandbox(spec=SandboxSpec(compute=ComputeSpec(inactivity_timeout=Duration(seconds=1800)))),
update_mask=FieldMask(["spec.compute.inactivity_timeout"]),
)
Stoppe und starte einen Sandkasten neu
Stoppen Sie eine Sandbox, um ihre Rechenkapazität freizugeben, wobei Ihr Home-Verzeichnis erhalten bleibt:
w.sandbox.stop_sandbox("sandboxes/my-sandbox") # Moves to SANDBOX_STATE_STOPPED
Starte den Sandkasten erneut, um die Arbeit fortzusetzen:
w.sandbox.start_sandbox("sandboxes/my-sandbox") # Moves to SANDBOX_STATE_RUNNING
Eine Sandbox stoppt automatisch 24 Stunden nach jedem Start, sodass beim erneuten Start eine neue 24-Stunden-Phase beginnt. Siehe Databricks Sandbox-Einschränkungen.
Eine Sandbox löschen
Lösche eine Sandbox, wenn du fertig bist. Beim Löschen einer Sandbox wird ihr Home-Verzeichnis entfernt und die Abrechnung für die Sandbox beendet:
w.sandbox.delete_sandbox("sandboxes/my-sandbox")