Watson Studio -Erweiterung für Visual Studio Code

Wenn Sie die Erweiterung „ Watson Studio “ zu Visual Studio Code hinzufügen, können Sie eine Verbindung zu Ihrer watsonx -Instanz herstellen, Ihre Laufzeiten starten und stoppen, Dateien in Ihren Watson Studio - und Git -basierten Projekten bearbeiten sowie den Code in Ihren Laufzeiten direkt über den Visual Studio Code -Editor ausführen und debuggen.

Die Verbindung leitet die Kommunikation über sichere WebSocket-Tunnel, die durch die Standard-Authentifizierung Ihrer Instanz geschützt sind. Die Web-Socket-Tunnel unterstützen die Untergruppe des SSH-Protokolls, die erforderlich ist, um Code über Fernzugriff zu bearbeiten oder Code in Ihren fernen Laufzeiten auszuführen und zu debuggen.

Erforderliche Services
Watson Studio plus geeignete Laufzeitservices

Dienst Diese Dienste sind standardmäßig nicht verfügbar. Ein Administrator muss die Dienste installieren. Um festzustellen, ob „ Watson Studio “ installiert ist, öffnen Sie den Dienst katalog. Ready to useWenn der Dienst installiert und einsatzbereit ist, wird die Kachel im Katalog angezeigt. Um bei „ Watson Studio Runtimes “ festzustellen, ob der Dienst installiert ist, klicken Sie auf Ihren Avatar und dann auf „Über“ > „Versionsdetails “. Wenn der Dienst installiert und einsatzbereit ist, wird er als Deployed. gekennzeichnet.

Voraussetzungen

Stellen Sie vor dem Herunterladen und Installieren der Watson Studio -Erweiterung sicher, dass Ihr Administrator die Visual Studio Code -Unterstützung aktiviert hat. Details finden Sie unter Tasks nach der Installation für den Service Watson Studio.

Die Erweiterung Watson Studio wurde mit Visual Studio Code 1.72.2 getestet und erfordert mindestens Visual Studio Code 1.69.0 oder höher. Obwohl Versionen vor 1.72.2 funktionieren sollten, sollten Sie versuchen, Visual Studio Code auf dem neuesten Stand der verfügbaren Version zu halten.

Projekttypen

Nur Git-basierte Projekte können mit der Erweiterung Visual Studio Code integriert werden. Veraltete Git -Projekte werden nicht unterstützt.

Assettypen

Alle Assets, die Sie einem Watson Studio -Projekt hinzufügen können. Details finden Sie unter Daten zu einem Projekt hinzufügen.

Datenformat

Alle Assets in einem Git-basierten Projekt.

Einschränkungen

  • Nur Git-basierte Projekte können mit der Erweiterung Visual Studio Code integriert werden. Veraltete Git -Projekte werden nicht unterstützt. Konfigurieren Sie die „ Git “-Integration über die Benutzeroberfläche von „ watsonx “, bevor Sie das Projekt in „ Visual Studio Code “ verwenden. Weitere Informationen finden Sie unter „Zugriff auf ein Repository von Git “.
  • Alle JupyterLab -Standardumgebungen werden unterstützt, mit Ausnahme von Spark-basierten Umgebungen und angepassten Umgebungen, die auf Spark basieren.
  • Die Integration von Visual Studio Code funktioniert nicht, wenn FIPS auf Ihrem Cluster aktiviert ist.
  • x86 ist die einzige unterstützte Plattform aufgrund von Einschränkungen im Zusammenhang mit der fernen SSH-Verbindung.

Konfigurationsschritte

Gehen Sie wie folgt vor, um die Watson Studio -Erweiterung für Visual Studio Codeeinzurichten:

  1. Erweiterung herunterladen
  2. Erweiterung installieren
  3. Erweiterung konfigurieren
  4. Richten Sie SSH auf Ihrem Rechner ein
  5. Optional: Zusätzliche Erweiterungen erneut installieren

Wenn die Watson Studio -Erweiterung ordnungsgemäß eingerichtet ist, können Sie sie für folgende Zwecke verwenden:

Watson Studio -Erweiterung für Visual Studio Code herunterladen

Um die Watson Studio -Erweiterung für Visual Studio Codeherunterzuladen, verwenden Sie den Link Watson Studio -Erweiterung.

Watson Studio -Erweiterung für Visual Studio Code installieren

So installieren Sie die Watson Studio -Erweiterung für Visual Studio Code:

  1. Öffnen Sie in Visual Studio Codedas Menü "Erweiterungen", klicken Sie auf "Weitere Optionen" (...) und wählen Sie dann Install from VSIXaus.

  2. Wählen Sie die heruntergeladene Datei watson-studio.vsix aus und klicken Sie auf Installieren.

  3. Optional: Wenn Sie direkt über Visual Studio Codeauf Ihre Laufzeit zugreifen können wollen, installieren Sie die Remote SSH-Erweiterung in Visual Studio Code. Die Erweiterung finden Sie in Microsoft Marketplace.

    Hinweis: Wenn Sie die Remote-SSH-Erweiterung nicht installieren möchten, müssen Sie einen anderen SSH-Client auf Ihrem Rechner installieren. Eine Verbindung zu Ihrer Laufzeit aus Visual Studio Code ohne einen SSH-Client ist nicht möglich.

Erweiterung aus einer vsix-Datei installieren

Watson Studio -Erweiterung für Visual Studio Code konfigurieren

So konfigurieren Sie die Watson Studio -Erweiterung für Visual Studio Code:

  1. Öffnen Sie in Visual Studio Codedas Menü Einstellungen . Verwenden Sie alternativ die Tastenkombination Cmd/Strg + Umschalttaste + P , um die Befehlspalette zu öffnen, und suchen Sie nach Settings UI.
  2. Wählen Sie Settings UIaus.
  3. Legen Sie die erforderlichen Parameter fest. Sehen Sie sich diese Tabelle an:
Konfigurationsparameter für die Erweiterung Visual Studio Code
Parameter Beschreibung
watsonstudio.host Hostname der „ watsonx “-Instanz. Sie finden sie in der Adressleiste Ihres Browsers, wenn Sie sich unter watsonx anmelden. Beispiel: cpd.xxx.xxx.xxx.com.
watsonstudio.userName Der Benutzername, mit dem Sie sich bei watsonx anmelden
watsonstudio.localPort Der Port, an dem lokal empfangsbereit ist (Standardwert: 5681)
watsonstudio.localHost Der SSH-Host, zu dem Remote SSH eine Verbindung herstellt. Es kann sich um einen beliebigen Host handeln, der in der SSH-Clientkonfigurationsdatei angegeben ist. Siehe Separaten SSH-Schlüssel für Watson Studio.
Die in Ihrer SSH-Clientkonfiguration konfigurierte HostName muss immer auf 'localhost' und den in localPortangegebenen Port verweisen. Dadurch können Sie Ihre eigenen SSH-Einstellungen verwenden, bei denen es sich um einen bestimmten privaten Schlüssel handelt. Ändern Sie diese Einstellung nicht, wenn Sie Ihren SSH-Standardschlüssel (id_rsa) verwenden. Standardwert: 127.0.0.1.
watsonstudio.publicKeyPath Vollständiger Pfad zur Datei mit dem öffentlichen Schlüssel für die SSH-Verbindung (z. B. /home/user/.ssh/id_rsa.pub).
watsonstudio.verifySSL Optional: Gibt an, ob das Zertifikat der Verbindung SSL überprüft werden soll oder nicht. Standardeinstellung: true
watsonstudio.autoOpenRuntime Die Laufzeit wird nach dem Laden automatisch geöffnet, ohne dass eine zusätzliche Bestätigung erforderlich ist.
watsonstudio.logLevel Die Protokollebene der Erweiterung
watsonstudio.storeApiKeyInKeychain Ob der verschlüsselte API-Schlüssel für „ watsonx “ im Schlüsselbund Ihres Betriebssystems gespeichert werden soll. Standardwert: true. Wenn Sie diese Option inaktivieren, wird der API-Schlüssel nur für die Dauer der aktuellen Sitzung im Speicher gespeichert. Wenn Sie Ihre Visual Studio Code -Instanz neu starten, müssen Sie Ihren API-Schlüssel erneut eingeben.
watsonstudio.autoUpdateHostkey Den Hostschlüssel in der known_hosts Datei automatisch aktualisieren, indem er über eine sichere TLS -Verbindung abgerufen wird. Diese Einstellung muss immer aktiviert sein, insbesondere beim Betrieb mit mehreren Instanzen. Vor jeder Änderung wird eine Sicherung der Datei known_hosts unter ~/.ssh/.known_hosts.cpd-backuperstellt.

Erweiterung konfigurieren

Einrichten von SSH auf Ihrem Rechner

Sie können Ihr vorhandenes SSH-Schlüsselpaar für die Arbeit mit der Erweiterung Watson Studio Visual Studio Code verwenden. Gehen Sie wie folgt vor, um zu überprüfen, ob bereits ein SSH-Schlüsselpaar konfiguriert ist:

Auf Windows-basierten Arbeitsstationen:
Überprüfen Sie, ob Ihr Home-Verzeichnis das .ssh Verzeichnis enthält, oder führen Sie dir "%USERPROFILE%/.ssh"das Programm aus.

Auf Workstations unter „ MacOS “ und „ Linux “:
Überprüfen Sie das ~/.ssh Verzeichnis.

Wenn der einzige Schlüssel, den Sie gefunden haben, Ihr Standardschlüssel ist, können Sie ihn weiterhin mit der Erweiterung Watson Studio Visual Studio Code verwenden. Wenn Sie Ihren SSH-Standardschlüssel nicht verwenden wollen, können Sie optional einen separaten SSH-Schlüssel für Watson Studioerstellen.

Wenn Sie noch keine SSH-Schlüsselpaare haben, generieren Sie sie, bevor Sie die Erweiterung verwenden.

Hinweis: Derzeit werden nur RSA-Schlüssel unterstützt und der SSH-Schlüssel muss im OpenSSH -Format vorliegen.

Details zum Generieren von SSH-Schlüsselpaaren finden Sie unter Generieren eines SSH-Schlüsselpaars unter MacOS und Linux und unter Generieren eines SSH-Schlüsselpaars unter Windows.

SSH-Schlüsselpaar unter MacOS und Linux generieren

So generieren Sie ein SSH-Schlüsselpaar unter MacOS und Linux:

  1. Terminal öffnen

  2. Geben Sie den folgenden Befehl ein:

    ssh-keygen -t rsa -N ""

Wenn Sie ein Schlüsselpaar generieren, geben Sie die Position des öffentlichen Schlüssels in den watsonstudio.publicKeyPath -Einstellungen der Erweiterung an. Siehe Erweiterung konfigurieren.

SSH-Schlüsselpaar unter Windows generieren

So generieren Sie ein SSH-Schlüsselpaar unter Windows:

Unter Windows 10 oder höher mit aktiviertem Feature OpenSSH Client:

  1. Öffnen Sie eine neue Eingabeaufforderung und verwenden Sie das Dienstprogramm 'ssh-keygen'.
  2. Geben Sie den folgenden Befehl ein:
    ssh-keygen -t rsa -N ""

Wenn Sie eine ältere Windows-Version verwenden:

  1. Installieren Sie ein Tool eines Drittanbieters, wie z. B. PuTTY, um einen SSH-Schlüssel zu erzeugen.

  2. Wenn Sie PuTTY, verwenden, benutzen Sie das puttygen Dienstprogramm, um ein SSH-Schlüsselpaar zu erzeugen.

    Hinweis: PuttyGen generiert standardmäßig keine OpenSSH Schlüssel. Um einen OpenSSH -Schlüssel zu exportieren, konvertieren Sie den Schlüssel: Wählen Sie Conversions` -> `Export OpenSSH keyaus.

Wenn Sie ein Schlüsselpaar generieren, geben Sie die Position des öffentlichen Schlüssels in den watsonstudio.publicKeyPath -Einstellungen der Erweiterung an. Siehe Erweiterung konfigurieren.

Optional: Separaten SSH-Schlüssel für Watson Studio verwenden

Für die Authentifizierung sucht SSH nach einem Standardschlüssel namens id_rsa in Ihrem Verzeichnis .ssh . Wenn dieser Standardschlüssel nicht verwendet werden soll, können Sie einen separaten Schlüssel für Watson Studiodefinieren. Gehen Sie wie folgt vor, um einen bestimmten SSH-Schlüssel für Watson Studiozu verwenden:

  1. Fügen Sie einen neuen Eintrag zu Ihrer SSH-Konfiguration unter ~/.ssh/confighinzu:

    Host cpdenv
    HostName localhost
    Port 5681 # Same port as watsonstudio.localPort
    IdentityFile ~/.ssh/id_cpd_rsa # Path to your private key

  2. Geben Sie in den Watson Studio -Erweiterungseinstellungen unter watsonstudio.localHostden Host ein. Beispiel: cpdenv.

Optional: Zusätzliche Erweiterungen erneut installieren

Ihre lokale Benutzerschnittstelle von Visual Studio Code stellt eine Verbindung zu einem Visual Studio Code -Server her, der in der Laufzeit ausgeführt wird, sodass die meisten Erweiterungen erneut installiert werden müssen. Öffnen Sie dazu die Registerkarte Erweiterung und wählen Sie Install in SSH für die Erweiterungen aus, die in Ihrer Laufzeit verfügbar sein sollen.

In SSH installieren, Option

Verbindung zu einer Laufzeit herstellen

Voraussetzung:
Es wird empfohlen, dass die von der Laufzeit, zu der Sie eine Verbindung herstellen, verwendete Umgebung über mindestens 2 CPUs und 4 GB Speicher verfügt.

Die erste Verbindung zur Laufzeit dauert länger, da die Visual Studio Code -Serverkomponente installiert werden muss. Nachfolgende Verbindungen, die von demselben Benutzer hergestellt werden, sind schneller.

Wenn Sie eine Verbindung zu einer „ watsonx “-Instanz herstellen, die eine selbstsignierte Zertifizierungsstelle verwendet, fügen Sie Ihr Zertifikat dem Zertifikatsspeicher Ihres Betriebssystems hinzu (aufrufbar über „ Visual Studio Code “). Andernfalls wird die Verbindung zurückgewiesen. Use SSLAlternativ können Sie die Option `/Verify SSL ` deaktivieren, um die Überprüfung von Zertifikaten unter SSL zu deaktivieren. Diese Methode wird nicht empfohlen.

So stellen Sie eine Verbindung zu Ihrer Laufzeit her:

  1. Verwenden Sie die Tastenkombination Cmd/Strg + Umschalttaste + P , um die Befehlspalette zu öffnen, und suchen Sie dann nach Watson Studio: Connect to Runtime.
  2. Wählen Sie Watson Studio: Connect to Runtimeaus.
  3. Geben Sie bei der ersten Verbindung jeder Sitzung den API-Schlüssel von watsonx an.
  4. Wählen Sie das Projekt aus, das verwendet werden soll.
  5. Wählen Sie die von der Laufzeit zu verwendende Umgebung aus.
  6. Wenn Ihre Laufzeit gestartet wird und ein sicherer Tunnel eingerichtet ist, können Sie wie folgt eine Verbindung zur Laufzeit herstellen:
    • Verwendung des SSH-Befehls, der im Popup-Fenster angezeigt wird.
      Wichtig: Sie müssen dieses Visual Studio Code -Fenster geöffnet lassen, andernfalls wird die Verbindung zur Laufzeit geschlossen.
    • Wenn Sie die Erweiterung "Remote SSH" installiert haben, können Sie über die Schaltfläche Laufzeit öffnen eine Verbindung herstellen. Wenn Sie die Remote SSH-Erweiterung verwenden, wird empfohlen, die Python -Erweiterung für Visual Studio Codezu installieren.

Optional: Zertifikat zum Zertifikatsspeicher Ihres Betriebssystems unter Windows hinzufügen

Gehen Sie wie folgt vor, um Ihr Zertifikat zum Windows-Zertifikatsspeicher hinzuzufügen:

  1. Öffnen Sie die Eingabeaufforderung.
  2. Führen Sie certmgraus.
  3. Fügen Sie das Zertifikat in Trusted Root Certification Authorities > Certificateshinzu.

Verbindung zu einer Laufzeit trennen

Um die Verbindung zu einer Laufzeitumgebung zu trennen, schließen Sie den sicheren Tunnel zwischen der Laufzeitumgebung und Ihrem Computer:

  1. Verwenden Sie die Tastenkombination Cmd/Strg + Umschalttaste + P , um die Befehlspalette zu öffnen, und suchen Sie dann nach Watson Studio: Disconnect from Runtime.
  2. Wählen Sie Watson Studio: Disconnect from Runtimeaus. Die Nachricht Successfully disconnected from runtime wird angezeigt.

Laufzeit stoppen

Eine Laufzeitumgebung läuft so lange weiter, bis Sie sie über die Webkonsole oder die Erweiterung „ Visual Studio Code “ anhalten. Bevor Sie eine Laufzeit stoppen, stellen Sie sicher, dass Sie die Verbindung zuerst trennen. Siehe Verbindung zu einer Laufzeit trennen. Wenn Sie eine Laufzeit stoppen, ohne zuvor die Verbindung zu trennen, führt dies zu einem Fehler des Typs 502 .

So beenden Sie eine laufende Laufzeitumgebung in Ihrer „ watsonx “-Instanz:

  1. Verwenden Sie die Tastenkombination Cmd/Strg + Umschalttaste + P , um die Befehlspalette zu öffnen, und suchen Sie dann nach Watson Studio: Stop Runtime.
  2. Wählen Sie Watson Studio: Stop Runtimeaus.
  3. Wählen Sie die Laufzeit aus, die Sie stoppen wollen.

Häufig gestellte Fragen und häufige Fragen

Ich kann keine Verbindung zu meiner „ watsonx “-Instanz herstellen, da die Serverkomponente nicht heruntergeladen werden kann.

In Air-Gapped-Konfigurationen kann die Verbindung zur „ watsonx “-Instanz fehlschlagen, da die Serverkomponente nicht geladen werden kann. Um dieses Problem zu umgehen, müssen Sie den „ watsonx “-Laufzeitkomponenten den Zugriff auf bestimmte Microsoft-Domänen gewähren, damit die Server-Binärdatei heruntergeladen werden kann. Weitere Informationen finden Sie unter „Welche Verbindungsanforderungen gelten für den VS Code Server, wenn er auf einem Remote-Rechner ausgeführt wird?“ ( VM ) sowie unter „Remote-Entwicklung über SSH“ ( Visual Studio Code ).

Ich habe die Verbindung zur Laufzeit verloren, während ich die Remote SSH-Erweiterung verwendet habe. Wie kann ich die Verbindung wiederherstellen?

Wenn Sie die Verbindung zur Laufzeit verlieren, stellen Sie mit dem Befehl Watson Studio: Connect to Runtime erneut eine Verbindung zur Laufzeit her. Details hierzu finden Sie unter Verbindung zu einer Laufzeit herstellen. Nachdem Sie die Verbindung zwischen der Laufzeitumgebung und Ihrem lokalen Rechner wiederhergestellt haben, klicken Sie im Fenster „Remote SSH“ auf die Schaltfläche „Neu laden“, um die Verbindung über Remote SSH wiederherzustellen.

Fenster für nicht mehr vorhandene Verbindung

Wenn ich versuche, eine Verbindung zur Instanz „ watsonx “ herzustellen, erhalte ich die Fehlermeldung „ SSL “

Um dieses Problem zu beheben, fügen Sie Ihr „ TLS “-Zertifikat auf dem Mac zum Zertifikatsspeicher Ihres Betriebssystems hinzu:

Hinweis: Das Zertifikat erhalten Sie von Ihrem Instanzadministrator. Alternativ kannst du dich bei {% if site.prodkey ==
  1. Rufen Sie Finder > Applications > Utilities > Keychain Accessauf.
  2. Wählen Sie Systemaus.
  3. Überprüfen Sie, ob das selbst signierte CA-Zertifikat in der Liste aufgeführt ist. Wenn Ihr Zertifikat nicht in der Liste aufgeführt ist, gehen Sie wie folgt vor, um es hinzuzufügen:
    1. Importieren Sie das Zertifikat mit File -> Import items.
    2. Wenn Ihr Zertifikat importiert wurde, doppelklicken Sie auf das Zertifikat, um es zu öffnen, und wählen Sie dann Trust -> When using this certificate -> Always trustaus.

Weitere Fragen zu Netz-und Proxy-Einstellungen finden Sie in der offiziellen Dokumentation zu Visual Studio Code.

Weitere Informationen