[OpenStack에 contribute하기 - 4] Gerrit Account 구성하기

---

 

본 포스트는 우리가 Git 가이드를 완료한 상태라고 가정합니다.

Gerrit Account

---

Gerrit이란?

Gerrit은 OpenStack 커뮤니티가 사용하는 리뷰 시스템입니다.

 

회원가입

1. OpenStack의 Gerrit 페이지를 방문하고 sign in 링크를 클릭합니다.
2. 사용자 이름을 선택하라는 메시지가 나타날 것입니다. StoryBoard나 Launchpad에서 사용했던 것과 같은 이름으로 사용합니다.

사용자 이름을 신중하게 입력하세요. 한 번 설정하면 변경할 수 없습니다.

지금부터 Gerrit에 로그인하면 StoryBoard나 Launchpad 로그인 정보를 입력하라는 메시지가 나타날 것입니다. 

 

 

개인 기여자 라이선스 계약 (Individual Contributor License Agreement)

---

이것은 개인 또는 기업의 기여로부터 인정된 지적 재산권을 명확히 하기 위한 계약입니다.

 

Gerrit의 설정에서 New Contributor Agreement 주소를 클릭하고, 계약에 서명하세요. 코드와 문서를 contribute 하기 위해선 이 과정이 필요합니다. 이 과정 없이는 Gerrit에 패치를 푸시할 수 없습니다.

 

 

SSH 키 설정하기

---

요약하자면, 우리는 SSH 키 페어를 생성하고 Gerrit 서버에 공개 키를 제공할 것입니다. 시스템이 개인 키를 소유하고 있으면 시도-응답 인증(challenge-response authentication) 도중 Gerrit에 응답하는 데 문제가 없을 것입니다.

어떤 사람들은 여러 시스템에 접근하기 위해서 하나의 SSH 키 페어를 사용하는 반면에, 다른 사람들은 별도의 키 페어를 사용하는 것을 선호합니다. 두 가지 선택사항 모두 이 섹션에서 다룰 예정입니다.

 

존재하는 SSH 키 확인하기

터미널을 열고 다음을 입력합니다.

ls -la ~/.ssh

일반적으로 공개 키 파일 이름은 다음과 같습니다.

• id_dsa.pub
• id_ecdsa.pub
• id_ed25519.pub
• id_rsa.pub

만약 .pub 파일이 없거나 OpenStack Gerrt에 대해 특정 집합을 생성하려면 키를 생성해야 합니다.

 

SSH 키 페어 생성하기

터미널에서 다음을 입력하여 주어진 이메일을 라벨로 사용하여 새 SSH 키 페어를 생성할 수 있습니다.

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

"Enter a file in which to save the key" 메시지가 나타나면 엔터를 누르세요. 이것은 기본 위치를 허용합니다.

Enter a file in which to save the key (/Users/you/.ssh/id_rsa): [Press enter]

프롬프트에서 만약 passphrase가 필요하다면 입력하고, 필요 없으면 엔터를 누르세요. (전 passphrase를 사용하지 않습니다.)

Enter passphrase (empty for no passphrase): [Type a passphrase]
Enter same passphrase again: [Type passphrase again]

 

OpenStack Gerrit 전용 개별 키 생성하기 (optional)

터미널에서 다음을 입력하여 주어진 이메일을 라벨로 사용하여 새 SSH 키 페어를 생성할 수 있습니다.

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

"Enter a file in which to save the key" 메시지가 나타나면 반드시 새로운 키 페어의 이름을 지정하고 엔터를 누르세요.

Enter a file in which to save the key (/Users/you/.ssh/id_rsa): /Users/you/.ssh/id_openstack_rsa

프롬프트에서 만약 passphrase가 필요하다면 입력하고, 필요 없으면 엔터를 누르세요. (전 passphrase를 사용하지 않습니다.)

Enter passphrase (empty for no passphrase): [Type a passphrase]
Enter same passphrase again: [Type passphrase again]

마지막으로 SSH키를 연결할 호스트가 무엇인지 구분해야 합니다. 편집기에서 "~/.ssh/config/"을 열고, 만약 파일이 없다면 파일을 생성하고 다음과 같은 내용을 추가하세요.

Host review.opendev.org review
  Hostname review.opendev.org
  Port 29418
  User <your_gerrit_username>
  IdentityFile ~/.ssh/id_openstack_rsa

 

공개키 복사하기

터미널에서 다음을 입력하세요.

cat ~/.ssh/id_rsa.pub

만약 개별 키 페어를 생성했고, 위의 예제와 같은 예제 파일 이름을 사용했다면 다음을 입력하세요.

cat ~/.ssh/id_openstack_rsa.pub

결과를 클립보드에 복사하세요.

 

Gerrit으로 공개키 Import 하기

1. Gerrit의 SSH 공개키 설정 페이지로 이동하세요.
2. Add Key 버튼을 클릭하세요.
3. Add SSH Public Key 텍스트 박스 안에 공개키를 붙여 넣기 하고 Add 버튼을 클릭하세요.

 

 

Git Review

---

Git Review란?

Git review는 OpenStack 커뮤니티에 의해 유지되는 툴입니다. 다음과 같은 하위 명령을 'git'에 추가합니다.

git review

OpenStack 프로젝트 레포지토리에 우리가 변경한 내용이 있는 경우, 이 하위 명령을 사용해서 변경 내용을 Gerrit에 게시하여 리뷰어들이 검토할 수 있게 할 수 있습니다.

 

설치

Debian, Ubuntu 또는 Mint와 같은 리눅스 배포를 사용하는 경우 터미널에 다음을 입력합니다.

sudo apt install git-review

RedHat, Fedora 21 또는 이전 버전, 또는 CentOS를 사용하는 경우 터미널에 다음을 입력합니다.

sudo yum install git-review

Fedora 22 이상 버전을 사용하는 경우 터미널에 다음을 입력합니다.

sudo dnf install git-review

 

구성

Git review는 사용자 이름과 Gerrit 사용자 이름이 동일하다고 가정합니다. 그렇지 않은 경우 다음 명령을 통해 설정할 수 있습니다.

git config --global gitreview.username <username>

만약 Gerrit username이 뭔지 모르겠다면, Gerrit settings를 확인하면 됩니다.

 

리뷰를 보낼 준비

우리의 패치에서 Git 커밋을 실행하기 전에 Git 리뷰를 초기화하는 것이 중요합니다. 다음 명령을 통해서 우리의 레포지토리 내의 초기 Git 리뷰 환경을 구성하세요.

git review -s

위 명령어는 필요한 원격 호스트를 설정하고 Gerrit에 변경 사항을 푸시할 수 있도록 Git hook을 커밋합니다.

Git review는 하나의 레포지토리 안에서 한 번만 초기화되면 됩니다.

 

본 포스트는 다음 주소를 참고하였습니다.

• https://docs.openstack.org/contributors/common/setup-gerrit.html