3장. 서비스 프레임워크를 단독 설치하는 경우

이 장에서는 서비스 프레임워크를 다른 서버에 단독 설치하는 경우, 필요한 SW와 서버 설치 조건에 대해 설명한다. 그리고 설치 방법에 대해 설명한다.

1. 설치 모듈

제품 CD 또는 코난테크놀로지의 담당자를 통해 설치 패키지를 준비한다.

JDK는 필수로 미리 설치해야 하고 외부 WAS를 사용하는 경우, Apache Tomcat 사용을 권장한다.

또한, 단독 설치 시, 서비스 프레임워크의 포트 기본값은 7612이다. (Konan Search 패키지를 통해 서비스 프레임워크를 사용할 경우, 기본값 7614를 사용한다.)

설치 항목	필수/옵션	다운로드 경로 및 파일 명
서비스 프레임워크	필수	[IRIS] > [[00] Product Information] > [02. KONAN Product Release] > [P107. KONAN Sevice Framework] KONAN_SERVICE_FRAMEWORK-{버전}-{릴리즈날짜}-{revision번호}.tar ksf.war ksf-standalone-version-bin.tar
무료 배포 사전 (옵션, 샘플)	옵션	[IRIS] > [[00] Product Information] > [02. KONAN Product Release] > [사전 Download]
JDK (1.7 이상)	필수	설치하고자 하는 OS에 적합한 JDK를 설치한다. http://www.oracle.com/technetwork/java/javase/downloads/index.html 참고 설치 후, JAVA_HOME classpath를 설정한다.
Tomcat (7.0 이상)	옴션	JDK 버전 및 OS에 적합한 Tomcat을 설치한다. http://tomcat.apache.org/ 참고 Windows에서 설치 시, 설치 경로 문자열에는 공백이 없어야 한다. 예: c:\Tomcat 7.0(X) , c:\Tomcat7(O) 파일 실행 시, Tomcat7.exe를 사용한다. 설치 후에는 반드시 메모리와 캐릭터셋 관련 옵션을 설정한다. 실행 파일 : {설치경로}/bin/catalina.sh (또는 catalina.bat) JAVA_OPTS="$JAVA_OPTS -Xms1024m -Xmx2048m -Dfile.encoding=UTF-8 -Dfile.client.encoding= UTF-8 -Dclient.encoding.override=UTF-8"

2. 설치 조건

2.1. 서버 설치 조건

서비스 프레임워크는 내장 WAS(Web Application Server)를 기본으로 동작하며, 선택적으로 외부 WAS(Apache Tomcat 권장)를 지원한다.

현재 지원 가능한 서버의 운영체제는 다음과 같다.

기능 설명	서비스 프레임워크
탑재 모듈	ksf.war 또는 ksf-standalone-version-bin.tar
지원 OS	N/A

참고

내장 WAS 또는 Apache Tomcat v7.x 이상 (옵션)
JDK 1.7 이상

작은 정보

설치 주의 사항

jetty.xml에서 connector port가 중복되지 않아야 한다. (standalone 방식으로 설치한 경우)
db.properties에서 port가 중복되지 않아야 한다.
동일한 context가 존재하지 않아야 한다.

2.2. 클라이언트 사용 조건

OS	브라우저	버전
Windows XP, Windows 7	Internet Explorer	10, 11
Windows XP, Windows 7	Chrome	52 이상

3. 라이선스 키

서비스 프레임워크 설치 후 구동을 위해서는 라이선스 키가 필요하다. 라이선스 키를 얻기위해서는 (주)코난테크놀로지의 담당영업자 또는 기술지원을 통해 얻을 수 있다.

라이선스를 얻기 위해서는 아래의 정보가 필요하다.

서비스 프레임워크가 설치된 서버의 MAC Address
서비스 프레임워크 설치 버전

4. 설치 (standalone, 단독 서버)

서비스 프레임워크 버전 1.1 이상에서는 미리 빌드되어 실행할 수 있는 단독 서버를 배포한다. 단독 서버는 tomcat과 같은 외부 WAS 설치 없이 서비스 프레임워크 기능들을 서비스할 수 있는 가장 쉬운 방법이다.

4.1. 구성

서비스 프레임워크 단독 서버는 ksf-standalone-version-bin.tar 라는 압축 파일 형식으로 배포된다. 이 압축 파일을 풀면 아래와 같이 디렉터리 및 파일들이 생성된다.

/ksf-standalone-bin/
    |--bin
    |   |--ksf-standalone-version.jar
    |   |--run.bat
    |   `--run.sh
    |--conf
    |    `--jetty.xml
    `--ksf.war

4.2. 단독 서버 실행

실행

서비스 프레임워크 단독 서버를 실행하기 위해서는 자바 버전 v1.7 이상이 필요하다. 서버를 실행하기 위해서는 배포판의 bin/run.bat 파일을 실행한다. 유닉스나 리눅스에서는 run.sh 명령을 실행한다.

C:\KSF\BIN> run.bat
2014-06-19 22:03:20.367:INFO:ckks.Runner:Starting the server...
…
2014-06-19 22:03:26.298:INFO:ckks.Runner:KONAN Service Framework is now running at http://localhost:7612/
^C
2014-06-19 22:05:52.855:INFO:ckks.Runner:Shutting down the server...
2014-06-19 22:05:52.995:INFO:ckks.Runner:---------------------------
2014-06-19 22:05:52.995:INFO:ckks.Runner:Goodbye from KONAN Service Framework!

웹 브라우저 연결 : http://localhost:7612/ksf
디폴트 포트, 컨텍스트 패스 변경 : conf/jetty.xml
서버 접근 로그 및 서비스 로그 : logs 디렉터리
jetty 설정 참고 : http://wiki.eclipse.org/Jetty/Howto/Configure_Jetty

종료

서버를 종료하기 위해서는 [Ctrl]-[C] 버튼을 눌러 표준 종료 시그널을 보낸다. 유닉스나 리눅스에서는 run.sh stop 명령을 실행한다.

서비스 프레임워크 실행

웹 브라우저를 통해http://localhost:7612/ksf의 초기 설정 페이지에 연결할 수 있다.

검색 서비스는 아직 설정되지 않았다. WEB-INF/default.properties 파일을 통해 설정할 수 있다. 설정에 관한 내용은 "환경 설정 및 실행"을 참고한다.

또한, 브라우저를 통해 발급받은 라이선스를 입력해야 서비스 프레임워크를 사용할 수 있다.

4.3. 명령어 라인 옵션

명령어 라인 옵션은 다음과 같다.

$ java –jar ksf-standalone-version.jar –h
usage: KONAN Service Framework Help
 -c,--conf <configfile>  jetty xml config file
 -h,--help                  print help message

특별히 동시 접속 클라이언트가 많거나 모듈별 사전 크기가 클 경우 자바 VM의 최대 힙 메모리 요량을 증가시킬 필요가 있다. 이 경우 run.bat 혹은 run.sh파일에서 JAVA_OPTS 변수를 수정한다.

set JAVA_OPTS=-Xms1024m -Xmx1536m

4.4. 약점

서비스 프레임워크 단독 서버는 기본적으로 간단한 설치를 위해 설계되었다. 좀 더 복잡한 배치 시나리오가 필요할 경우에는 Tomcat과 같은 외장 WAS에 배치해야 한다.

5. 설치 (WAS)

5.1. 배치 모델

서비스 프레임워크 및 검색엔진, Admin, 검색 서비스 애플리케이션은 아래와 같이 다양한 방식으로 배치할 수 있다.

그림 3.1. 구성 예제들

요구하는 시스템의 가용성, 성능, 가용한 호스트 등을 고려하여 각 서브 시스템을 배치해야 한다. 서비스 가용성이 중요한 품질 속성일 경우에는 Model 1과 같이 검색 엔진과 검색 서비스 웹 애플리케이션을 별도의 호스트에 배치하는 것이 바람직하다. 가용한 호스트가 많지 않을 경우 Model 2나 3과 같이 Admin 및 서비스 프레임워크 웹 애플리케이션을 동일한 WAS에 배치하는 것도 가능하다. 이 경우에도 서비스의 가용성을 위해 검색 서비스 웹 애플리케이션은 별도의 WAS에 배치하는 것이 바람직하다. 이렇게 함으로써 Admin 혹은 서비스 프레임워크 서비스가 중단되더라도 검색 엔진 서비스는 계속 동작할 수 있다.

5.2. 설치

Apache Tomcat을 사용하는 경우를 예를 들어 설명한다.

서블릿 컨테이너(WAS)를 중지한다.

$TOMCAT-HOME\bin> shutdown.bat

[konan@locolhost bin] ./shutdown.sh

배포되는 WAS 파일을 서블릿 컨테이너의 webapps 디렉터리에 복사한다. 배포된 파일 이름에는 버전명이 포함되어 있다. 버전명을 지우고 ksf.war로 이름을 변경한다.
```
$TOMCAT-HOME\webapps/
 |--- dos
 |--- exemples
 |--- host-manager
 |--- ROOT
 `--- ksf.war
```

서블릿 컨테이너를 재시작한다.

$TOMCAT-HOME\bin> start.bat

[konan@locolhost bin] ./start.sh

웹 브라우저를 통해 http://localhost:7612/ksf의 초기 설정 페이지에 연결할 수 있다.
검색 서비스는 아직 설정되지 않았다. WEB-INF/default.properties 파일을 통해 설정할 수 있다. 설정에 관한 내용은 "환경 설정 및 실행"을 참고한다.
또한, 브라우저를 통해 발급받은 라이선스를 입력해야 서비스 프레임워크를 사용할 수 있다.

6. 디렉터리 구성 및 파일

ksf.war 디렉터리의 구성은 일반적인 WAR 형식을 따른다. 다음은 서비스 프레임워크 웹 애플리케이션의 루트로부터의 각 디렉터리에 대한 설명이다.

디렉터리	설명
/	서비스 프레임워크로부터 클라이언트 브라우저로 전송되는 JSP 파일들이 위치한다.
/bootstrap	초기 설치 시 환경 설정과 관련된 JSP 파일들이 위치한다.
/css	각 페이지에 적용되는 스타일 시트 파일들이 위치한다.
/doc	JAVADOC 파일들이 위치한다.
/fonts	각 페이지에서 사용하는 폰트 파일들이 위치한다.
/img	각 페이지에서 참조하는 이미지 파일들이 위치한다.
/js	자바 스크립트 파일들이 위치한다.
/META-INF	WAR에 대한 메타 정보 파일(MANIFEST.MF) 및 서비스 프레임워크의 라이선스 파일(ksf.lic), 오픈 소스 라이선스 파일들이 위치한다.
/WEB-INF	웹 애플리케이션 배치 설명자(web.xml) 파일 및 서비스 프레임워크의 환경 설정 파일이 위치한다.
/WEB-INF/classes	서비스 프레임워크를 구성하는 자바 클래스 파일들이 위치한다.
/WEB-INF/data	예제로 제공되는 사전 파일들이 위치한다.
/WEB-INF/lib	서비스 프레임워크가 사용하는 자바 클래스 파일들을 포함하는 JAR 파일들이 위치한다.
/WEB-INF/spring	스프링 프레임워크의 빈 설정 파일들이 위치한다.
/WEB-INF/templates	최초 설치 시 환경 설정 파일(default.properties)에 대한 템플릿 파일이 위치한다.