Visual Studio Code 로 원격 서버(AWS EC2)에서 작업하기

그래피컬 환경을 지원하지 않는 서버 모드에서 프로그래밍을 할 때 vim 으로만 개발하기가 매우 불편할 수 있습니다.

이런 경우, Visual Studio Code 의 Remote - SSH 익스텐션을 활용하면 보다 쉽게 로컬에서 개발하는 것과 같은 환경으로 개발하는 것이 가능합니다.

아래는 로컬 MacOS 에서 EC2 인스턴스에 접속하여 Visual Studio Code 로 개발하기 위한 환경 세팅 방법이며, 리모트 서버가 EC2 가 아니라면 SSH 접속 설정 부분만 해당 리모트 서버에 접속 가능하도록 설정하면 됩니다.

 

Remote - SSH 익스텐션 설치

• 왼쪽 익스텐션 메뉴를 클릭한 후, 검색어로 remote 를 검색합니다.
• 아래와 같이 Remote - SSH 를 Install 버튼을 눌러서 설치합니다.

원격 서버 접속을 위한 SSH 설정

AWS 에서 EC2 인스턴스를 생성하였다면, 생성할 때 지정한 key-pair 파일을 SSH config 파일에 등록하여 패스워드 입력없이 원격서버에 접속할 수 있습니다.

vim ~/.ssh/config

필자의 경우에는 EC2 인스턴스를 Ubuntu 20.04 LTS 로 설치하였고, key-pair 파일명은 sandbox.pem 입니다.

아래와 같이 원하는 호스트명(sandbox)과 본인의 EC2 인스턴스 public 아이피를 EC2_PUBLIC_IP 대신 입력해 준 후 저장을 합니다.

Host sandbox
    HostName EC2_PUBLIC_IP
    User ubuntu
    IdentityFile ~/.ssh/sandbox.pem

 

config 파일 설정이 완료되었다면, 잘 접속되는지 터미널에서 테스트를 해 봅니다.

ssh sandbox

아래와 같이 잘 접속이 되는 것을 확인했다면, 설정이 잘 적용된 것 입니다.

Welcome to Ubuntu 20.04.4 LTS (GNU/Linux 5.13.0-1029-aws x86_64)

 * Documentation:  https://help.ubuntu.com
 * Management:     https://landscape.canonical.com
 * Support:        https://ubuntu.com/advantage

  System information as of Mon Sep 12 03:33:36 UTC 2022

  System load:  0.0               Processes:             140
  Usage of /:   7.1% of 28.90GB   Users logged in:       0
  Memory usage: 2%                IPv4 address for ens5: 10.10.23.4
  Swap usage:   0%

 * Ubuntu Pro delivers the most comprehensive open source security and
   compliance features.

   https://ubuntu.com/aws/pro

66 updates can be applied immediately.
42 of these updates are standard security updates.
To see these additional updates run: apt list --upgradable

New release '22.04.1 LTS' available.
Run 'do-release-upgrade' to upgrade to it.

 

Visual Studio Code 익스텐션 실행

왼쪽에 Remote Explorer 메뉴를 클릭하면, 아래와 같이 SSH config 파일에 등록된 SSH TARGETS 이 보이게 됩니다.

오른쪽에 아이콘을 클릭해서 새 윈도우를 실행합니다.

새롭게 실행된 윈도우에서 Open Folder 를 클릭하고,

/home/ubuntu/ 디렉토리가 보인다면 OK 버튼을 클릭해 줍니다.

이제 아래와 같이 원격 서버의 디렉토리와 파일들이 왼쪽 Explorer 에 잘 보이게 되고, 로컬 PC 에서 구동된 Visual Studio Code 에서 편집 작업을 수행할 수 있습니다.