SonarQube 서버 설치하기

데이터베이스 설치하기

SonarQube는 다양한 종류의 데이터베이스 엔진을 지원합니다. 사용하고자 하는 데이터베이스에 따라 다음 요구사항(필수)을 확인합니다.

빈 데이터베이스 스키마 하나와 sonarqube 사용자 하나를 생성합니다. sonarqube 사용자는 이 스키마의 오브젝트 (create), 업데이트(update) 및 삭제(delete) 권한을 가져야 합니다. 데이터베이스의 문자셋은 "UTF-8", 언어(데이터베이스 및 사용자)는 "English"로 설정해야 합니다.

Microsoft SQL Server

 Collation은 반드시 대소문자 구분(CS) 및 액센트 구분(AS)로 설정되어야 합니다.

 SonarQube 데이터 베이스에는 반드시 READ_COMMITED_SNAPSHOT 속성이 설정되어야 합니다.

MS SQL이 제공하는 공유 잠금 정책(shared lock strategy)을 활성화하는 경우, SonarQube 실행시간에 영향을 미칠 수 있습니다. is_read_committed_snapshot_on이 true로 설정되어있는지 확인하시기 바랍니다.

다은 쿼리를 사용해 is_read_committed_snapshot_on 속성값을 확인할 수 있습니다:

SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name='YourSonarQubeDatabase';

다음 쿼리를 사용해 is_read_committed_snapshot_on 속성값을 업데이트 할 수 있습니다:

ALTER DATABASE YourSonarQubeDatabase SET READ_COMMITTED_SNAPSHOT ON WITH ROLLBACK IMMEDIATE;

통합된 보안 정책을 사용하고자 하는 경우, http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774에서 Microsoft SQL JDBC Driver 6.2 패키지를 다운로드 한뒤, `sqljdbc_auth.dll`을 원하는 경로에 복사합니다. 사용하는 서버 머신에 따라 x86 혹은 x64 버전의 dll을 복사해야 합니다.

SoanrQube를 윈도우 서비스로 운영하면서 통합된 보안 정책을 사용하고자 하는 경우, 서비스를 실행하는 윈도우 계정이 SQL Server에 대한 접근 권한을 가지고 있는지 확인합니다. 해당 계정은 db_owner 데이터베이스 권한을 가지고 있어야 합니다.

커맨드 라인 명령어로 SonarQube를 실행하면서 통합된 보안 정책을 사용하고자 하는 경우, 해당 계정 역시 db_owner 데이터베이스 권한을 가지고 있어야 합니다. 이와 함께 "sonar.jdbc.username" 혹은 "sonar.jdbc.password" 속성이 주석 처리가 되어 있는지 확인합니다(sonar.properties). 주석 처리를 하지 않은 경우, SonarQube는 SQL authentication을 사용합니다.

sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar;integratedSecurity=true

SQL authentication을 사용하고자 하는 경우, 아래의 컨넥션 스트링을 사용합니다. "sonar.jdbc.username", "sonar.jdbc.password"가 올바르게 설정되어 있는지 확인합니다.

sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar
sonar.jdbc.username=sonarqube
sonar.jdbc.password=mypassword

Oracle

Oracle 인스턴스 하나에 두 개의 SonarQube 스키마를 생성한 경우--특히, 두 스키마가 서로 다른 버전인 경우--SonarQube는 가장 먼저 탐색된 스키마를 선택합니다. 아래의 방법으로 이 문제를 해결할 수 있습니다:

• SonarQube Oracle 사용자에게 할당된 priviledges를 제거하거나

• Oracle이 자동으로 새로운 컨텍션을 만들 경우 SonarQube Oracle 사용자를 변경하도록 합니다.
  

  ALTER SESSION SET current_schema="MY_SONARQUBE_SCHEMA"

PostgreSQL

"public" 스키마가 아닌 커스텀 스키마를 사용하고자 하는 경우, PostgreSQL의 "search_path" 속성을 다음과 같이 설정해야 합니다:

ALTER USER mySonarUser SET search_path to mySonarQubeSchema

MySQL (not recommended)

MySQL은 MyISAM, InnoDB의 두 가지 엔진을 사용하도록 설정할 수 있습니다. MyISAM은 InnoDB에 비해 오래된 엔진으로, 점차 InnoDB로 변경되는 추세입니다. SonarQube에서 분석하는 프로젝트의 수가 증가하는 경우에도 InnoDB는 MyISAM에 빠른 속도과 더 나은 스케일링을 제공합니다. 만약 SonarQube를 초기부터 사용한 경우 MyISAM 엔진을 사용하는 테이블들이 존재할 수 있습니다. InnoDB 엔진으로 해당 테이블들을 변경해서 SonarQube의 성능을 한층 개선할 수 있습니다.

SonarQube가 사용하는 모든 테이블들을 InnoDB 엔진에 맞게 변경한 후, 가장 먼저 "innodb_buffer_pool_size" 파라미터를 변경합니다. MySQL이 최대한의 RAM을 할당하도록  "query_cache_size" 파라미터 값으로 15MB를 설정합니다. 보다 자세한 내용은 InnoDB 성능 최적화하기(영문)를 참조합니다.

웹 서버 설치하기

먼저, 요구사항을 확인합니다.

다음으로, 배포 패키지를 다운로드 받은 후 압축을 풉니다(숫자로 시작하는 디렉토리명을 사용하지 마십시오). 리눅스 용의 네이티브 패키지도 배포됩니다.

<install_directory>는 SonarQube 배포 패키지의 압축이 풀린 디렉토리를 의미합니다.

데이터베이스 접근 권한 설정하기

<install_directory>/conf.sonar.properties 파일에서 데이터베이스를 설정합니다. 해당 파일에는 SonarQube가 지원하는 모든 데이터베이스에 대한 설정 템플릿이 포함되어 있습니다. 사용하고자 하는 데이터베이스와 관련된 설정 템플릿의 주석을 해제하고 H2 데이터베이스와 관련된 설정 내용을 주석 처리합니다:

sonar.jdbc.username=sonarqube
sonar.jdbc.password=mypassword
sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube

JDBC 드라이버 추가하기

지원하는 데이터베이스(Oracle 제외)와 관련된 드라이버는 SonarQube 패키지에 포함되어 있습니다. 함께 제공하는 드라이버만 정상 동작하므로 해당 드라이버를 변경하지 않습니다.

Oracle을 사용하는 경우 을 사용할 경우 <install_directory>/extensions/jdbc-driver/oracle 에 oracle jdbc 드라이버를 복사합니다.

웹 서버 시작하기

기본 포트는 "9000"이고, 기본 context 경로는 "/"입니다. <install_directory>/conf/sonar.properties 파일에서 이 값을 변경할 수 있습니다:

sonar.web.host=192.0.0.1
sonar.web.port=80
sonar.web.context=/sonar

다음 스크립트를 실행새 서버를 시작합니다:

• Linux/Mac OS: bin/\<YOUR OS>\/sonar.sh start
• Windows: bin/windows-x86-XX/StartSonar.bat

웹 브라우저에서 http://localhost:9000으로 SonarQube에 접속할 수 있습니다(기본 System administrator 계정/비밀번호 = admin/admin).

웹 서버 튜닝하기

SonarQube는 기본적으로 하나의 Java JRE가 설치된 컴퓨터에서 실행되도록 설정되어 있습니다.

성능을 개선하고자 하는 경우, 가장 먼저 Java JDK를 사용하고 <install_directory>/conf/sonar.properties 파일을 수정해 서버 모드를 활성화합니다:

sonar.web.javaOpts=-server

SonarQube가 사용하는 Java JVM을 변경할 경우, <install_directory>/conf/wrapper.conf 파일에서 다음 라인을 변경합니다:

wrapper.java.command=/path/to/my/jdk/bin/java

설치 관련 고급 기능

• Windows 혹은 Linux에서 SonarQube를 Servie로 작동하기
• Proxy 뒤에서 Sonarqube를 운용하기

다음 단계

서버 설치를 정상적으로 완료했다면, 원하는 플러그인을 설치할 수 있습니다. 플러그인을 설치한 후에는 언제든지 소스 코드를 분석할 수 있습니다.

트러블 슈팅 / 자주하는 질문

웹 서버 / 연산 엔진 / 엘라스틱 서치에 더욱 많은 메모리 할당 (Grant more memory to the web server / compute engine / elastic search)

서버 사이드 프로세스에 더 많은 메모리를 할당하고자 하는 경우, $SONARQUBE_HOME/conf/sonar.properties 파일에서 관련된 `javaOpts` 속성을 편집합니다:

• sonar.web.javaOpts (최소값: -server -Xmx768m)
• sonar.ce.javaOpts
• sonar.search.javaOpts

MySQL 데이터베이스에 접속 불가 (Cannot connect to MySQL database)

MySQL 데이터베이스 서버에 대한 원격접속은 보안상의 이유로 기본적으로 비활성화되어 있습니다. 데이터베이스 서버에 원격으로 접속하고자 하는 경우, MySQL 가이드(영문)를 참조합니다.

Windows Vista에서 구동 실패 (Failed to start on Windows Vista)

SonarQube가 Windows Vista의 Program Files 디렉토리 아래 설치된 경우, 정상 시작되지 않을 수 있습니다. 해당 디렉토리를 사용하지 않도록 합니다.

잘못된 USERS 테이블 구조로 인해 SonarQube가 Oracle 데이터베이스 사용시 구동 실패 (Failed to start SonarQube with Oracle due to bad USERS table structure)

다른 USERS 테이블이 Oracle 데이터베이스에 존재하고, sonarqube 사용자가 다른 USERS 테이블에 읽기 권한을 가지고 있는 경우 SonarQube 웹서버는 다음과 같인 예외를 발생하며 구동하지 않습니다:

ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier
: INSERT INTO users (login, name, email, crypted_password, salt, 
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59', '2519754f77ea67e5d7211cd1414698f465aacebb',
TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)
ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier
 
: INSERT INTO users (login, name, email, crypted_password, salt, 
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59', 
'2519754f77ea67e5d7211cd1414698f465aacebb', TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)

sonarqube Oracle 사용자가 다른 USERS 테이블을 읽을 수 있는 권한을 제거해서, 이 문제를 해결할 수 있습니다.

프록시를 통해 마켓플레이스 접근 실패 (Failed to connect to the Marketplace via proxy)

SONARQUBE_HOME/conf/sonar.properties 파일의 프록시 설정을 확인합니다.

프록시의 username에 "\"(백슬래시) 문자가 포함된 경우, 특수문자 처리가 필요합니다.  예를 들어 username이 "domain\user"인 경우, 아래와 같이 설정합니다:

http.proxyUser=domain\\user

일부 프록시의 경우, 잘못된 username 혹은 password 설정의 원인으로 "java.met.ProtocolException: Server redirected too many times" exception이 발생할 수 있습니다.