[환경설정] VSCode Remote SSH 사용법

안녕하세요. 바른호랑이입니다.

이번 게시글에서는 VS Code를 기반으로 SSH를 사용하여 Linux 서버에 접근하는 방법에 대해서 알아볼 예정입니다.

Linux가 설치된 가상머신(VM)이나 외부 컴퓨터를 접속하려고 하는 경우, 보통 SSH(Secure SHell, 네트워크 상의 다른 컴퓨터에 로그인하여 명령을 실행하고 정보를 보고 받을 수 있게 해주는 프로토콜)를 이용합니다. 일반적으로 22번 포트를 통해 통신을 하기에 서버의 22번 포트가 오픈되어 있다면 Windows의 CMD만으로도 접속이 가능하고, 보다 원활한 관리를 위해서 SSH 통신을 지원하는 Xshell, PuTTY, MobaXterm등과 같은 다양한 프로그램들을 이용할 수도 있습니다.

위의 프로그램들도 많은 기능들을 지원하기는 하지만 VS Code에서 지원하는 여러 가지 Extension을 활용하여 작업을 진행하면 보다 나은 편의성과 효율성을 얻을 수 있기에 VS Code로 SSH를 이용하여 VM에 접속하는 방법에 대해 알아보려고 합니다. 기본적으로 VS Code를 이용하여 작업 시 아키텍처는 아래와 같습니다.

 

※ VS Code의 Remote Development 구조도

구조도에서 확인할 수 있듯이 VS Code에서 작업을 해도 Remote Machine / VM의 Local에서 작업하듯이 코드 개발, 실행, 테스트 등을 수행할 수 있기에 VS Code의 다른 Extension들과 연계하여 사용할 수 있습니다. 

 

※ VS Code의 Remote SSH 익스텐션 사용방법

1. Remote - SSH Extension 설치 

VS Code에서 SSH 접속을 지원하는 Extension을 설치합니다.

2. Ctrl+Shift+P를 눌러 명령 팔레트를 열고 Remote-SSH: Open SSH Configuration File...를 선택 후 config 파일을 선택합니다.

3. config 파일에 접속을 하려는 VM 관련 정보를 입력 및 저장하고 Ctrl+Shift+P를 눌러 명령 팔레트를 연 후  Remote-SSH: Connect to Host... 를 선택한 후 저장한 Host이름을 선택하여 접속을 진행합니다.

Host: 저장된 접속정보를 가진 호스트의 이름으로 다수의 Host가 존재할 때 구별하기 위해 작성

HostName: 접속하려는 VM의 IP 주소

User: 접속하려는 VM의 유저이름

Port: 접속 시 사용할 포트로 일반적으로 22번 포트를 이용

IdentityFile: 접속시 사용할 Key값이 저장된 위치경로

4. 접속이 정상적으로 완료되었다면 로컬 서버에서 작업하듯이 코드 수정 및 테스트 환경 실행등의 작업들이 정상적으로 되는지 확인합니다.

+ config 파일에 직접 입력정보를 입력하지 않고 명령어로 config 파일에 접속정보를 추가하는 방법

Ctrl+Shift+P를 눌러 명령 팔레트를 연 후  Remote-SSH: Connect to Host... 를 선택한 후 Add New SSH Host...을 선택합니다. 이후 명령어 입력창이 나오면 아래의 구문에 맞게 정보를 입력하고 값을 저장할 config 파일을 선택합니다. 이후 해당 접속정보로 접속이 정상적으로 되는지 확인합니다.

ssh [계정]@[ip주소] -p [port] -i [key주소]