Anyframe Oden

배포될 파일이 존재하는 빌드리파지토리 (Build Repository) ^[11] 와 파일을 배포할 서버인 Target Server가 있을 때, Oden Server를 Build Repository에 설치할 수도 있고 Target Server에 설치할 수도 있다. Target Server에 Oden Server를 설치하게 되면 Oden Agent를 따로 설치할 필요없이 Oden Server에 내장되어 있는 Oden Agent를 이용할 수 있다. 다만, Build Repository는 물리적으로 다른 장비에 위치하고 있을 경우에는 둘 간의 통신을 위해 FTP를 사용해야 한다. Build Repository에 Oden Server를 설치하게 되면, Target Server에 Oden Agent를 별도로 설치해야 하나 FTP를 사용하여 Build Repository에 접근하지 않아도 되므로 속도가 빠르다.

Oden Server의 압축을 풀면 아래와 같은 구조로 되어 있다.

[Oden Server 설치 디렉토리]
	|
	+---- bin
	|  |
	|  +---- oden-x.x.x.jar    // 실행할 바이너리 파일 
	|
	+---- bundle    // Oden 실행시 필요한 library 파일들이 들어 있음. 
	|
	+---- conf	
	   |
	   +---- oden.ini    // Oden Server 설정파일 
	   |
	   +---- config.xml    // Oden Agent 및 기타 Oden 설정이 들어 있는 파일

Oden Agent는 아래와 같은 구조로 되어 있다.

[Oden Agent 설치 디렉토리]
	|
	+---- bin
	|  |
	|  +---- oden-x.x.x.jar    // 실행할 바이너리 파일 
	|
	+---- bundle    // Oden 실행시 필요한 library 파일들이 들어 있음.

Oden Server와 Agent의 실행 및 설정에 관한 사항은 아래를 참고하도록 한다.

위에서 언급했듯이 Oden Server를 Build Repository에 설치할 수도 있고 Target Server에 설치할 수도 있다. 여기서는 우선 Build Repository에 Oden Server를 설치하고 Target Server에 Oden Agent를 설치했다고 가정하고 Oden 설정을 하는 방법을 설명하도록 하겠다. Oden Server에서 Oden Agent를 인식시키게 하기 위해서는 conf/config.xml에 Oden Agent의 정보를 입력해 주어야 한다. conf/config.xml을 열어 Oden Agent가 제대로 등록이 되어 있는지 확인한다.

...
<agents>
    <agent name="agent0">
        <address host="177.11.22.33" port="9862"/>
        <default-location value="C:/tomcat/webapps/anyframe-app"/>
        <backup-location value="C:/oden/backup"/>
    </agent>
</agents>
...

Oden Agent가 설치된 Target Server의 주소(여기서는 177.11.22.33)를 <address .../> 란에 넣어 주었다. Agent의 기본 포트는 9862이며 실행시 -port옵션을 통해 변경할 수 있다. Oden Agent에 배포할 때 배포할 기본 위치를 default-location에 설정하며, 여기서는 Target Server에 있는 application의 root 디렉터리를 default-location으로 지정하였다. backup-location은 파일 백업이나 배포 취소를 위해 임시로 사용하는 경로이며, 필수로 설정되어 있어야 한다. (default-location과 동일하거나 default-location 하위 경로를 설정해 주어서는 안된다.) config.xml에 Agent정보를 추가하였으면, 우선 Oden을 사용할 준비는 끝났다. (config.xml은 수정 후 재부팅하지 않아도 된다.)

이번에는 Build Repository에 Oden Server를 설치하고 Target Server에 Oden Agent를 설치하는 방법을 설명하도록 하겠다. Target Server에 Oden Server를 설치하였기 때문에 별도의 Agent를 설치하지 않고 Oden Server에 내장되어 있는 Agent를 통해 파일을 배포할 것이다. 내장된 Agent라 하더라도 Oden Server에서 Agent를 인식하게 하기 위해서는 conf/config.xml에 Agent의 정보를 입력해 주어야 한다. Build Repository는 떨어져 있으므로 Oden 명령어를 실행할 때 FTP 프로토콜을 이용하여 Build Repository에 접근하여야 한다. conf/config.xml을 열어 Oden Agent가 제대로 등록이 되어 있는지 확인한다.

...
<agents>
    <agent name="agent0">
        <address host="localhost" port="9862"/>
        <default-location value="C:/tomcat/webapps/anyframe-app"/>
        <backup-location value="C:/oden/backup"/>
    </agent>
</agents>
...

여기서는 Oden Server에 내장된 Agent를 사용할 것이므로 address항목에 localhost를 넣어 주었다. Agent의 기본 포트는 9862이며 conf/oden.ini나 실행시 -port옵션에서 변경할 수 있다. 여기서는 Target Server (Oden Server가 설치되어 있는 PC)에 존재하는 application의 root 디렉터리를 default-location으로 지정하였다. config.xml은 수정후 재부팅하지 않아도 된다. config.xml에 Agent정보를 추가하였으면, 우선 Oden을 사용할 준비는 끝났다.

oden.ini 와 config.xml을 통해 Oden Server의 설정을 변경할 수 있다. Oden Agent는 oden.ini 파일이 없으므로 Oden Agent 의 포트 변경을 위해서는 구동시 -port <포트번호> 옵션을 사용하여 구동시키면 된다.

<oden>
    <agents>
        <agent name="">
            <address host="" port=""/>
            <default-location value=""/>
            <backup-location value=""/>
            <location name="" value=""/>
            <location /> ...
        </agent>
        <agent name="">
            <!-- 이 곳에 두번째 Agent의 정보를 설정한다. -->
        </agent>
    </agents>
</oden>

Oden Server 및 Agent의 설치 및 설정이 끝났으면, 아래의 명령으로 Oden Server를 실행시킬 수 있다.

cd <Oden Server가 설치된 경로>
java -jar bin/oden-x.x.x.jar

Oden Agent는 아래의 명령으로 실행시킬 수 있다.

cd <Oden Agent가 설치된 경로>
java -jar bin/oden-x.x.x.jar

Eclipse의 Help > Install New Software 를 통해서 Anyframe Update Site 인 http://dev.anyframejava.org/update 을 추가한다.

Eclipse 3.4, Eclipse 3.5의 경우에는 Anyframe Oden에 Anyframe Common이 포함되어 있으므로 따로 설치하지 않아도 된다.

설치가 완료되면, Eclipse의 Help > About Elicpse 를 통해서 확인할 수 있다.

Server, Agent의 설정은 Working with Command Line을 참조한다.

Policy를 추가하기 위한 명령어. 동일한 이름을 가진 Policy가 있을 경우 덮어 쓴다.

policy add <policy-name> 
	[-r[epo] [file://<path>] | [ftp://<host> <path> [<id> <password>]]] 
	-i[nclude] <wildcard-location> ... [-e[xclude] <wildcard-location> ...] 
	[-u[pdate] | -del] 
	-d[est] <agent-name>:<$<location-var>[/<path> | ~[/<path>] | <absolute-path>]> ... 
	[-desc <description>]

‘-r’은 Oden Server에서 접근할 Build Repository를 의미한다. Oden Server와 물리적으로 동일한 장비에 파일이 존재한다면 file 프로토콜을, 아니면 ftp프로토콜을 사용하면 된다. '-del' 옵션을 지정할 경우(삭제) '-r' 옵션의 값은 무시된다.

‘-i’는 Build Repository에서 어떤 파일들을 배포할 것인지 지정하는 옵션이다. ‘*’같은 wildcard문자를 사용할 수 있으며, 하위경로까지 포함하려면 ‘**’를 사용해야 한다. 여러개의 인자가 있을 경우 ‘스페이스’로 구분한다. ‘-e’ 옵션을 지정할 경우 지정된 파일들은 배포대상에서 제외된다. 들어가는 인자의 형태는 ‘-i’ 옵션과 동일하다.

‘-u’ 옵션을 지정할 경우 Agent에 기 배포되어 있는 파일과 비교(날짜 비교) 하여 변경된 파일만 배포한다. '-del' 옵션이 있을 경우 Agent에 배포된 파일 중 지정한 파일은 삭제된다.

‘-d’는 배포될 경로를 지정한다. 경로는 Agent명 + ':' + 하위 경로로 구성된다. Agent명은 conf/config.xml에 등록이 되어 있어야 한다. 하위 경로는 절대경로, default-location의 상대경로, 타 location의 상대경로가 올 수 있다. default-location 이하에 배포하려면 '~' 다음에 경로를 입력하면 된다. config.xml에 설정된 다른 location명에 배포하려면 '$'다음에 location명을 입력하고 그 하위 경로를 주면 된다. 배포할 Agent가 여러개일 경우 스페이스로 구분한다.

<target name="inc-build">
    <depend srcdir="src/main/java" destdir="build/classes" closure="yes" />
    <javac srcdir="src/main/java" destdir="build/classes">
        <classpath>
            <path refid="compile.classpath" />
        </classpath>
    </javac>
</target>

Policy의 정보를 조회하기 위한 명령어. policy-name을 지정하지 않았을 경우 등록된 모든 Policy의 정보를 보여준다.

policy info [<policy-name>]

Policy 삭제 명령어. policy-name에 해당하는 Policy를 삭제한다.

policy del <policy-name>

Policy가 어떤 파일들을 배포할 것인지 테스트해 보는 명령어. 배포가 될 파일들의 리스트가 나타난다. 실제로 배포하지는 않는다.

policy test [<policy-name>]

새 Task를 생성하기 위한 명령어. 동일한 이름을 가진 Task가 있을 경우 덮어 쓴다.

task add <task-name>
	-p[olicy] <policy-name> ... 
	-desc <description>

Task의 정보를 조회하기 위한 명령어. task-name을 지정하지 않았을 경우 등록된 모든 Task의 정보를 보여준다.

task info [<task-name>]

등록된 Task 삭제 명령어. task-name에 해당하는 Task를 삭제한다.

task del <task-name>

Task가 어떤 파일들을 배포할 것인지 미리 확인해 보는 명령어. 실제로 파일을 배포하지는 않는다.

task test <task-name>

Task를 실행하는 명령어. task-name에 해당하는 Task를 실행한다. -sync옵션이 있으면 task가 끝날때까지 기다린다. -sync옵션이 없으면 status명령어를 통해 task가 진행중인지 확인하고, history명령어를 통해 결과를 확인해야 한다.

task run <task-name> [-sync]

history가 기록된 내역 조회. 해당 날짜의 history 리스트를 간략히 출력한다. 날짜를 지정하지 않으면 오늘 배포된 내역 리스트를 출력한다.

history info [-d[ate] <start-date: YYYYMMDD> <end-date: YYYYMMDD>]

Oden을 통해 배포된 내역을 조회한다. 옵션이 없을 경우 최근에 배포된 Policy의 내역을 보여준다. Oden Shell이나 Telnet을 통해 수행된 Task의 유저 IP 정보는 항상 Oden Server의 IP가 된다. 누가 배포하였는지 정확한 정보를 기록하기 위해서는 Eclipse Plugin과 같이 Oden의 HTTP 서비스를 이용하는 UI를 통해 배포하여야 한다.

history show [<txid> | -d[ate] <start-date: YYYYMMDD> <end-date: YYYYMMDD>]
	[-u[ser] <user-access-ip>] 
	[-a[gent] <host-name>] 
	[-p[ath] <path>] 
	[-d[ate] <start-date: YYYYMMDD> <end-date: YYYYMMDD>]
	[-f[ailonly]]

txid가 주어지면 해당 history내역에서 상세 검색을 한다. -d가 주어지면 해당 날짜에 해당하는 history내역을 상세 검색한다. txid도 없고 -d옵션도 없으면 최근 history내역에서 상세 검색을 한다.

‘-u’ 옵션은 배포 명령어를 수행시킨 사용자의 IP를 검색하기 위한 옵션이다. 70.7로 시작하는 모든 사용자가 배포한 내역을 검색하려면 ‘-u 70.7’ 로 인자를 주면 된다. Telnet으로 수행하였더라도 Oden Shell을 통해 수행된 Task는 모두 Oden Server의 IP로 기록되어 있으니 정확한 사용자를 파악하기 위해서는 Eclipse Plug-in과 같이 Oden의 HTTP 서비스를 사용하는 UI를 이용하여야 한다.

‘-a’ 옵션은 Agent의 IP를 지칭한다. Oden Server에 내장된 Agent인 경우 IP에 localhost로 기록이 된다.

‘-p’는 배포한 파일의 경로를 지정하는 옵션이며 지정한 경로가 들어가 있는 모든 내역을 출력한다. 예를 들어 ‘-p anyframe’을 입력하면 경로에 anyframe이 들어가 있는 모든 내역을 출력한다.

‘-d’는 배포가 실행된 날짜를 지정해 주는 옵션이다. 인자가 하나만 있을 경우 ‘start-date’를 의미하며 ‘start-date’부터 오늘까지 배포된 모든 내역을 출력한다.

txid에 해당하는 배포파일들의 배포를 취소. 최근 3개의 이력까지만 취소가 가능하다. -p 옵션이 있다면 배포된 파일 중 -p옵션에 지정된 파일의 배포만 취소한다. -p의 첫번째 인자는 Agent명과 절대경로 이며 이 후 인자는 절대경로 이후의 파일들의 상대경로들이다.

history undo <txid>
	[-p[ath] <agent-name>:<absolute-path> <file-path> ...]

실패한 파일들 재배포 명령어. txid의 배포 파일 중 실패파일들만 재배포 한다. 특정파일이 agent1, agent2에 배포되다가 agent2에서만 배포가 실패하였을 경우 파일의 정합성을 맞추기 위해 agent1, agent2 모두에 다시 배포된다.

history redeploy <txid> -sync

Snapshot Plan을 추가한다. 기존에 Plan이 있을 경우 해당 정보를 덮어쓰게 된다. 해당 정보를 덮어쓰게 될 경우 Plan을 통해 생성된 Snapshot File들이 모두 사라지므로 주의해야 한다.

snapshot add <plan-name> 
	-s[ource] <agent-name>:<$<location-var>[/<path> | ~[/<path>] | <absolute-path>]> 
	[-desc <description>]

‘-s’옵션에 백업할 파일의 경로를 지정한다. 경로는 Agent명 + ':' + 하위 경로로 구성된다. Agent명은 conf/config.xml에 등록이 되어 있어야 한다. 하위 경로는 절대경로, default-location의 상대경로, 타 location의 상대경로가 올 수 있다. default-location 이하에 배포하려면 '~' 다음에 경로를 입력하면 된다. config.xml에 설정된 다른 location명에 배포하려면 '$'다음에 location명을 입력하고 그 하위 경로를 주면 된다.

Snapshot Plan 혹은 Snapshot File 정보를 조회한다. ‘-p’나 ‘-f’옵션을 붙이지 않았을 경우 모든 Snapshot Plan정보를 출력한다. ‘-p’를 붙였을 경우 해당 Plan의 정보를 출력하며 plan-name이 없을 경우 모든 Plan정보를 출력한다. ‘-f’옵션을 붙였을 경우 Backup 을 통해 생성된 Snapshot File의 정보를 출력하며 file-name을 지정하지 않았을 경우 모든 Snapshot File의 정보를 출력한다.

snapshot info 
	-p[lan] [<plan-name>] | -f[ile] [<file-name>]

Snapshot Plan 혹은 Snapshot File을 삭제한다. ‘-p’ 옵션이 있을 경우 지정한 Snapshot Plan을 삭제한다. 이 Plan을 통해 만들어진 Snapshot File도 모두 삭제되므로 주의하여야 한다. ‘-f’ 옵션이 있을 경우 지정한 Snapshot File들을 삭제한다. 각 파일은 스페이스바로 구분한다.

snapshot del 
	-p[lan] <plan-name>] | -f[ile] <file-name> ...

Snapshot Plan이 수행되었을 경우 어느 경로의 파일들이 어디에 저장될 것인지를 미리 보여준다. 실제로 Backup을 수행하지는 않는다.

snapshot test <plan-name>

Snapshot Plan의 정보를 바탕으로 Backup을 수행한다.

snapshot run <plan-name>

Backup으로 생성된 Snapshot File들을 Snapshot Plan을 참조하여 원래의 위치로 복원시킨다. 기존에 있는 파일들을 모두 무시하고 덮어쓰게 되므로 주의하여야 한다.

rollback run <snapshot-file-name>

config.xml에 등록된 agent의 정보 및 상태 확인 명령어. agent-name을 지정하지 않았을 경우 등록된 모든 Agent의 정보가 간략히 출력된다. agent-name을 지정하였을 경우 지정한 Agent의 정보가 상세히 출력된다.

agent info [<agent-name>]

Agent에 배포되어 있는 파일 비교 명령어. -t옵션에 비교하고 싶은 Agent 이름을 입력하면, 해당 Agent들의 default-location을 기준으로 모든 파일을 비교하여 일치 여부를 판단한다. 해당파일이 지정한 Agent중 한 군데라도 없으면 불일치로 판단하며, 모든 파일이 있지만 해당 파일들의 size나 timestamp가 틀릴 경우에도 불일치로 판단한다.

agent compare -t[arget] <agent-name> ...

현재 진행중이거나 대기 중인 배포작업 리스트를 출력한다.

status info

현재 진행중이거나 대기중인 배포 작업을 취소한다.

status stop <txid>

Context Menu를 통해 Oden Server의 프로파일을 관리하며 메뉴는 다음과 같다.

Server를 생성하기 위한 정보들은 아래와 같다.

Oden Agent 상태를 Agent 호스트 명 왼쪽의 아이콘을 통해 쉽게 알 수 있으며 Agent명, Address 정보를 제공한다.

Agent 간 default location 을 기준으로 하위 파일의 크기 , 생성 일짜를 비교하여 다를 경우 File Name에 빨간 색으로 표시하는 기능으로 배포의 정합성을 확인하기 위한 기능이다. 구동은 비교 하고자 하는 Agent들을 선택하고 context 메뉴에서 Compare Agents를 선택하여 수행 한다.

파일의 Directory 와 File Name을 기준으로 Agent가 증가함에 따라 컬럼이 늘어나며 특정 파일이 해당 Agent에 없을 경우 빈 공백으로 표시된다. 체크박스를 통해 정합성이 맞지 않는 파일들만 골라서 확인할 수도 있다. 또한 배포 정합성을 만족하는 경우는 배포 정합성을 만족한다는 의미의 알림창을 오픈한다.

Context Menu를 통해 Build Repository의 프로파일을 관리하며 메뉴는 다음과 같다.

Build Repository를 생성하기 위한 정보들은 아래와 같다.

Deploy Now는 Build Repository 트리 구조에서 사용자가 원하는 폴더 및 파일을 선택하고 마우스 우 클릭을 통한 context menu를 이용해 쉽게 배포를 수행 하는 기능이다.

Deploy Now...를 선택하면 배포 될 파일 목록을 미리보기를 통해 다음과 같은 정보를 확인할 수 있다.

Deploy Now Action을 위한 배포 Agent 별로 배포 되는 경로를 설정하는 대화창 이며 미설정 시에는 default location을 기준으로 배포를 수행하고 config.xml에 설정된 location variable을 사용하여 배포 경로를 추가할 수 있다. 해당 Build Repository를 선택하고 마우스 우클릭하여 context menu를 통해 창을 오픈한다.

Add 버튼을 클릭하여 해당 정보를 입력하며 입력 정보는 다음과 같다.

New Policy를 클릭하여 신규 Policy를 등록한다. 신규 Policy 입력 시에 임시 Policy Name과 Description이 자동 입력되며 원하는 값으로 변경하여 입력하면 된다.

All Policies 테이블에서 원하는 Policy를 클릭 후, Policy Details, Build Repository, Agents의 값들이 조회가 되며 원하는 값으로 편집을 하고 Save this Policy를 클릭한다.

All Policies 테이블에서 원하는 Policy를 선택 후, Remove를 클릭한다. 확인창을 통해 다시 한 번 고려할 수 있으며, 삭제된 Policy는 복구가 불가능하다.

New Task를 클릭하여 신규 Task를 등록한다. 신규 Task 입력 시에 임시 Task Name 과 Description이 자동 입력되며 원하는 값으로 변경하여 입력하면 된다.

All Tasks에서 원하는 Task를 클릭 후, Task Details, Policies 등의 값들을 편집하고 Save this Task를 클릭한다.

All Tasks에서 원하는 Task를 선택 후 Remove를 클릭한다. 확인창을 통해 다시 한 번 고려할 수 있으며, 삭제된 Task는 복구가 불가능하다.

All Tasks에서 배포를 수행하고자 하는 Task를 선택 후 Run this Task를 클릭하면 배포 될 파일 목록을 미리보기를 통해 확인 할 수 있고 OK 버튼을 클릭하면 Agent로 배포를 수행한다.

Snapshot Plan은 두가지 방법으로 생성이 가능하다.

만약, Oden Server가 연결되어 있지 않은 상태에서 Snapshot Plan을 Add 하려고 하면, Error Log에 Oden Server에 연결할 수 없다는 메시지가 나타나게 된다.

위 다이얼로그를 통해 새로운 Plan을 생성할 수도 있고, 기존에 있던 Plan을 update할 수도 있다.

정상적으로 Snapshot Plan이 저장되면, View에는 다음과 같이 나타나게 된다. Plan을 선택했을 경우, 상세 정보가 나타나게 되는데, 여기에 Snapshot Plan에 관한 정보가 추가되어 보여진다.

상세 정보에서 Snapshot Source, Agent to Use, Description은은 추후에 수정이 가능하다. 수정 후, Save 버튼을 클릭하게 되면, 정보가 새로 저장된다. 이때, 만약 Plan 하위의 Snapshot이 존재하면 수정이 불가능하며, 수정을 하기 위해서는 하위의 Snapshot이 없는 빈 Plan이어야 한다.

기존에 생성된 Snapshot Plan과 동일한 환경을 가지는 Plan을 생성하기 위해서는 Add 버튼을 통해 새로 생성하는 방법과, duplicate 메뉴를 사용하는 방법이 있다. 마우스 우클릭을 통해 Duplicate Snapshot Plan 메뉴를 클릭하게 되면, Snapshot Duplicate Dialog가 나타난다.

Snapshot Name 은 기존의 Plan명에 -duplicate 만 추가되었으며, 나머지 정보들은 동일하다. 그대로 사용해도 되고, 수정해서 사용해도 된다.

생성한 Snapshot Plan을 삭제하기 위해서 Delete 버튼을 클릭하게 되면, 선택한 Snapshot Plan에 대해서 삭제 확인 메시지가 나타나게 된다.

Snapshot Plan을 토대로 Snapshot을 생성하기 위해서는 Take Snapshot 버튼을 클릭한다.

Snapshot을 생성하기 위해 선택한 Snapshot Plan이 맞는지 확인 후, Snapshot을 생성하게 된다. Snapshot은 Source 디렉토리 하위의 모든 폴더, 파일등을 .zip으로 묶은 후, 확장자 없이 Oden Server의 conf/config.xml에서 정의한 backup-location 위치에 저장된다. Snapshot을 생성하고 난 뒤에는 Tree 위치에서 Snapshot을 확인할 수 있다.

Snapshot의 상세 정보는 다음과 같다.

생성한 Snapshot을 삭제하기 위해서 Delete 버튼을 클릭하게 되면, 선택한 Snapshot에 대해서 삭제 확인 메시지가 나타나게 된다.