VSCodeからインスタンスにSSH接続する方法

 突然ですが皆さんVSCode(Visual Studio Code)はお使いでしょうか。
Microsoft社の提供するVSCodeはシンプルで使いやすく、拡張性にも富むため統合開発環境のデファクトスタンダードと言っても過言ではありません。

 このVSCodeを使って、インスタンス内のコードなどのファイルを編集したいと思いませんか?本記事ではVSCodeの「Remote-SSH」というプラグインを用いて、インスタンス内のファイルをVSCode越しに編集できる環境を構築する手法を解説します。

  • アクセスサーバに接続
    ターミナルからアクセスサーバへの接続を行ってください(図 1)。
ssh -L 20122:[インスタンスIP]:22 user@[アクセスサーバIP] -p 30022 -i   .\.ssh\ackey.txt   

図 1 アクセスサーバへ接続


  • VSCodeの立ち上げとプラグインのインストール

 VSCodeからインスタンス内のファイルを編集できるようにするためには、VSCodeの「Remote – SSH」というプラグインを導入して、接続先を設定しSSH接続する必要があります。

 図2のようにVSCodeを開いて、プラグインメニューの検索欄に「Remote – SSH」と打ち込んで検索すると同名のプラグインが表示されます。プラグインの紹介ページにある「インストール」のボタンをクリックすることでプラグインのダウンロードとインストールが行われます。


図 2 Remote – SSHの導入


  • 接続先ホストの追加

 図3のようなロゴをクリックし、出てくるメニュー上をマウスオーバーすると「+」の記号が出てきます。これをクリックすればホストを追加追加することができます。ホストの設定はまだ行っていないため次節にて設定します。


図 3  ホストの追加
  • 接続先の設定
     ホスト情報の設定は、configファイルにホスト名やユーザ名などの接続情報を記載することで行うことができます。インスタンス立上時にSSHキーなどを格納したフォルダに「config」という新規ファイル(拡張子不要)を作ります。

例えばWindows10で標準的な場所にSSHキーを置いた場合、C:Users\[ユーザ名]\.ssh\configというファイル構成になるようにconfigファイルを作成してください。

 ファイルができたら、これをVSCode等で開いて編集します。ここには接続先のホスト名やSSHキーのパスを記載していきますが、下記の「IdentityFile」のパス部分の「ユーザ名」のみ変えれば標準的な接続は可能です。

Host HGA_instance
 # ホスト名   
 HostName localhost  
 # ユーザ名   
 User user  
 # 接続先ポート   
 Port 20122  
 # SSHキーのパス   
 IdentityFile C:\Users\[ユーザ名]\.ssh\mykey.txt
  • 接続
     configファイルを編集し保存したら、設定したホスト名の上で右クリックし、「Connect Host in New Window」をクリックすることでインスタンスへの接続を行います。

図 4 インスタンスへの接続

  新規VSCodeが開くので、「Ctrl + Shift + @」同時押しでターミナルを開き、インスタンス内にログインしていることが確認できたら接続完了です。


図 5  インスタンスへのログイン

 以上で接続完了となります。

code hogehoge.py

のようにcodeコマンドを用いればターミナル上からVSCodeの編集画面を開くこともできます。

 自分にとって使いやすいインスタンス環境を構築するのも一つの楽しみですね。良いHGAライフを!

弊社クラウドGPUサーバのご利用をご検討中の方はhttps://gpu-advance.highreso.jp/?adid=blog_1009からお気軽にお申込みやお問い合わせください。最初の3日間はお試し利用でご利用料無料です!