PaaS-TA-5.5.0
Search…
RabbitMQ 설치 가이드

Table of Contents

1. 문서 개요

1.1. 목적

본 문서는 전자정부표준프레임워크 기반의 PaaS-TA에서 제공되는 서비스팩인 RabbitMQ 서비스팩을 Bosh를 이용하여 설치 하는 방법과 PaaS-TA의 SaaS 형태로 제공하는 Application에서 RabbitMQ 서비스를 사용하는 방법을 기술하였다. PaaS-TA 3.5 버전부터는 Bosh2.0 기반으로 deploy를 진행하며 기존 Bosh1.0 기반으로 설치를 원할경우에는 PaaS-TA 3.1 이하 버전의 문서를 참고한다.

1.2. 범위

설치 범위는 RabbitMQ 서비스팩을 검증하기 위한 기본 설치를 기준으로 작성하였다.

1.3. 시스템 구성도

본 문서의 설치된 시스템 구성도이다. RabbitMQ(1대), RabbitMQ 서비스 브로커, haproxy로 최소사항을 구성하였다.
시스템 구성도
구분
스펙
paasta-rmq-broker
1vCPU / 1GB RAM / 8GB Disk
haproxy
1vCPU / 1GB RAM / 8GB Disk
rmq
1vCPU / 1GB RAM / 8GB Disk

1.4. 참고자료

2. RabbitMQ 서비스 설치

2.1. Prerequisite

본 설치 가이드는 Linux 환경에서 설치하는 것을 기준으로 하였다. 서비스 설치를 위해서는 BOSH 2.0과 PaaS-TA 5.0 이상, PaaS-TA 포털이 설치되어 있어야 한다.

2.2. Stemcell 확인

Stemcell 목록을 확인하여 서비스 설치에 필요한 Stemcell이 업로드 되어 있는 것을 확인한다. (PaaS-TA 5.5.1 과 동일 stemcell 사용)
$ bosh -e micro-bosh stemcells
1
Using environment '10.0.1.6' as client 'admin'
2
3
Name Version OS CPI CID
4
bosh-aws-xen-hvm-ubuntu-xenial-go_agent 621.94* ubuntu-xenial - ami-0297ff649e8eea21b
5
6
(*) Currently deployed
7
8
1 stemcells
9
10
Succeeded
Copied!

2.3. Deployment 다운로드

서비스 설치에 필요한 Deployment를 Git Repository에서 받아 서비스 설치 작업 경로로 위치시킨다.
1
# Deployment 다운로드 파일 위치 경로 생성 및 설치 경로 이동
2
$ mkdir -p ~/workspace/paasta-5.5.1/deployment
3
$ cd ~/workspace/paasta-5.5.1/deployment
4
5
# Deployment 파일 다운로드
6
$ git clone https://github.com/PaaS-TA/service-deployment.git -b v5.0.6
7
8
9
# common_vars.yml 파일 다운로드(common_vars.yml가 존재하지 않는다면 다운로드)
10
$ git clone https://github.com/PaaS-TA/common.git
Copied!

2.4. Deployment 파일 수정

BOSH Deployment manifest는 Components 요소 및 배포의 속성을 정의한 YAML 파일이다. Deployment 파일에서 사용하는 network, vm_type, disk_type 등은 Cloud config를 활용하고, 활용 방법은 BOSH 2.0 가이드를 참고한다.
  • Cloud config 설정 내용을 확인한다.
$ bosh -e micro-bosh cloud-config
1
Using environment '10.0.1.6' as client 'admin'
2
3
azs:
4
- cloud_properties:
5
availability_zone: ap-northeast-2a
6
name: z1
7
- cloud_properties:
8
availability_zone: ap-northeast-2a
9
name: z2
10
11
... ((생략)) ...
12
13
disk_types:
14
- disk_size: 1024
15
name: default
16
- disk_size: 1024
17
name: 1GB
18
19
... ((생략)) ...
20
21
networks:
22
- name: default
23
subnets:
24
- az: z1
25
cloud_properties:
26
security_groups: paasta-security-group
27
subnet: subnet-00000000000000000
28
dns:
29
- 8.8.8.8
30
gateway: 10.0.1.1
31
range: 10.0.1.0/24
32
reserved:
33
- 10.0.1.2 - 10.0.1.9
34
static:
35
- 10.0.1.10 - 10.0.1.120
36
37
... ((생략)) ...
38
39
vm_types:
40
- cloud_properties:
41
ephemeral_disk:
42
size: 3000
43
type: gp2
44
instance_type: t2.small
45
name: minimal
46
- cloud_properties:
47
ephemeral_disk:
48
size: 10000
49
type: gp2
50
instance_type: t2.small
51
name: small
52
53
... ((생략)) ...
54
55
Succeeded
Copied!
  • common_vars.yml을 서버 환경에 맞게 수정한다.
  • RabbitMQ에서 사용하는 변수는 system_domain, paasta_admin_username, paasta_admin_password 이다.
$ vi ~/workspace/paasta-5.5.1/deployment/common/common_vars.yml
1
# BOSH INFO
2
bosh_ip: "10.0.1.6" # BOSH IP
3
bosh_url: "https://10.0.1.6" # BOSH URL (e.g. "https://00.000.0.0")
4
bosh_client_admin_id: "admin" # BOSH Client Admin ID
5
bosh_client_admin_secret: "ert7na4jpew48" # BOSH Client Admin Secret('echo $(bosh int ~/workspace/paasta-5.5.1/deployment/paasta-deployment/bosh/{iaas}/creds.yml --path /admin_password)' 명령어를 통해 확인 가능)
6
bosh_director_port: 25555 # BOSH director port
7
bosh_oauth_port: 8443 # BOSH oauth port
8
bosh_version: 271.2 # BOSH version('bosh env' 명령어를 통해 확인 가능, on-demand service용, e.g. "271.2")
9
10
# PAAS-TA INFO
11
system_domain: "61.252.53.246.xip.io" # Domain (xip.io를 사용하는 경우 HAProxy Public IP와 동일)
12
paasta_admin_username: "admin" # PaaS-TA Admin Username
13
paasta_admin_password: "admin" # PaaS-TA Admin Password
14
paasta_nats_ip: "10.0.1.121"
15
paasta_nats_port: 4222
16
paasta_nats_user: "nats"
17
paasta_nats_password: "7EZB5ZkMLMqT73h2Jh3UsqO" # PaaS-TA Nats Password (CredHub 로그인후 'credhub get -n /micro-bosh/paasta/nats_password' 명령어를 통해 확인 가능)
18
paasta_nats_private_networks_name: "default" # PaaS-TA Nats 의 Network 이름
19
paasta_database_ips: "10.0.1.123" # PaaS-TA Database IP (e.g. "10.0.1.123")
20
paasta_database_port: 5524 # PaaS-TA Database Port (e.g. 5524(postgresql)/13307(mysql)) -- Do Not Use "3306"&"13306" in mysql
21
paasta_database_type: "postgresql" # PaaS-TA Database Type (e.g. "postgresql" or "mysql")
22
paasta_database_driver_class: "org.postgresql.Driver" # PaaS-TA Database driver-class (e.g. "org.postgresql.Driver" or "com.mysql.jdbc.Driver")
23
paasta_cc_db_id: "cloud_controller" # CCDB ID (e.g. "cloud_controller")
24
paasta_cc_db_password: "cc_admin" # CCDB Password (e.g. "cc_admin")
25
paasta_uaa_db_id: "uaa" # UAADB ID (e.g. "uaa")
26
paasta_uaa_db_password: "uaa_admin" # UAADB Password (e.g. "uaa_admin")
27
paasta_api_version: "v3"
28
29
# UAAC INFO
30
uaa_client_admin_id: "admin" # UAAC Admin Client Admin ID
31
uaa_client_admin_secret: "admin-secret" # UAAC Admin Client에 접근하기 위한 Secret 변수
32
uaa_client_portal_secret: "clientsecret" # UAAC Portal Client에 접근하기 위한 Secret 변수
33
34
# Monitoring INFO
35
metric_url: "10.0.161.101" # Monitoring InfluxDB IP
36
syslog_address: "10.0.121.100" # Logsearch의 ls-router IP
37
syslog_port: "2514" # Logsearch의 ls-router Port
38
syslog_transport: "relp" # Logsearch Protocol
39
saas_monitoring_url: "61.252.53.248" # Pinpoint HAProxy WEBUI의 Public IP
40
monitoring_api_url: "61.252.53.241" # Monitoring-WEB의 Public IP
41
42
### Portal INFO
43
portal_web_user_ip: "52.78.88.252"
44
portal_web_user_url: "http://portal-web-user.52.78.88.252.xip.io"
45
46
### ETC INFO
47
abacus_url: "http://abacus.61.252.53.248.xip.io" # abacus url (e.g. "http://abacus.xxx.xxx.xxx.xxx.xip.io")
Copied!
  • Deployment YAML에서 사용하는 변수 파일을 서버 환경에 맞게 수정한다.
$ vi ~/workspace/paasta-5.0/deployment/service-deployment/rabbitmq/vars.yml
1
# STEMCELL
2
stemcell_os: "ubuntu-xenial" # stemcell os
3
stemcell_version: "621.94" # stemcell version
4
5
# VM_TYPE
6
vm_type_small: "minimal" # vm type small
7
8
# NETWORK
9
private_networks_name: "default" # private network name
10
11
# RABBITMQ
12
rabbitmq_azs: [z3] # rabbitmq : azs
13
rabbitmq_instances: 1 # rabbitmq : instances (1)
14
rabbitmq_private_ips: "<RABBITMQ_PRIVATE_IPS>" # rabbitmq : private ips (e.g. "10.0.81.31")
15
16
# HAPROXY
17
haproxy_azs: [z3] # haproxy : azs
18
haproxy_instances: 1 # haproxy : instances (1)
19
haproxy_private_ips: "<HAPROXY_PRIVATE_IPS>" # haproxy : private ips (e.g. "10.0.81.32")
20
21
# SERVICE-BROKER
22
broker_azs: [z3] # service-broker : azs
23
broker_instances: 1 # service-broker : instances (1)
24
broker_private_ips: "<SERVICE_BROKER_PRIVATE_IPS>" # service-broker : private ips (e.g. "10.0.81.33")
25
broker_port: 4567 # service-broker : broker port (e.g. "4567")
26
27
# BROKER-REGISTRAR
28
broker_registrar_azs: [z3] # broker-registrar : azs
29
broker_registrar_instances: 1 # broker-registrar : instances (1)
30
31
# BROKER-DEREGISTRAR
32
broker_deregistrar_azs: [z3] # broker-deregistrar : azs
33
broker_deregistrar_instances: 1 # broker-deregistrar : instances (1)
Copied!

2.5. 서비스 설치

  • 서버 환경에 맞추어 Deploy 스크립트 파일의 VARIABLES 설정을 수정하고, Option file을 추가할지 선택한다.
    (선택) -o operations/use-compiled-releases.yml (ubuntu-xenial/621.94로 컴파일 된 릴리즈 사용)
$ vi ~/workspace/paasta-5.5.1/deployment/service-deployment/rabbitmq/deploy.sh
1
#!/bin/bash
2
3
# VARIABLES
4
COMMON_VARS_PATH="<COMMON_VARS_FILE_PATH>" # common_vars.yml File Path (e.g. ../../common/common_vars.yml)
5
BOSH_ENVIRONMENT="${BOSH_ENVIRONMENT}" # bosh director alias name (PaaS-TA에서 제공되는 create-bosh-login.sh 미 사용시 bosh envs에서 이름을 확인하여 입력)
6
7
# DEPLOY
8
bosh -e ${BOSH_ENVIRONMENT} -n -d rabbitmq deploy --no-redact rabbitmq.yml \
9
-l ${COMMON_VARS_PATH} \
10
-l vars.yml
Copied!
  • 서비스를 설치한다.
1
$ cd ~/workspace/paasta-5.5.1/deployment/service-deployment/rabbitmq
2
$ sh ./deploy.sh
Copied!

2.6. 서비스 설치 - 다운로드 된 PaaS-TA Release 파일 이용 방식

  • 서비스 설치에 필요한 릴리즈 파일을 다운로드 받아 Local machine의 서비스 설치 작업 경로로 위치시킨다.
  • 설치 릴리즈 파일 다운로드 : paasta-rabbitmq-2.0.tgz
1
# 릴리즈 다운로드 파일 위치 경로 생성
2
$ mkdir -p ~/workspace/paasta-5.5.1/release/service
3
4
# 릴리즈 파일 다운로드 및 파일 경로 확인
5
$ ls ~/workspace/paasta-5.5.1/release/service
6
paasta-rabbitmq-2.0.tgz
Copied!
  • 서버 환경에 맞추어 Deploy 스크립트 파일의 VARIABLES 설정을 수정하고 Option file 및 변수를 추가한다.
    (추가) -o operations/use-offline-releases.yml (미리 다운받은 offline 릴리즈 사용)
    (추가) -v releases_dir=""
$ vi ~/workspace/paasta-5.5.1/deployment/service-deployment/rabbitmq/deploy.sh
1
#!/bin/bash
2
3
# VARIABLES
4
COMMON_VARS_PATH="<COMMON_VARS_FILE_PATH>" # common_vars.yml File Path (e.g. ../../common/common_vars.yml)
5
BOSH_ENVIRONMENT="${BOSH_ENVIRONMENT}" # bosh director alias name (PaaS-TA에서 제공되는 create-bosh-login.sh 미 사용시 bosh envs에서 이름을 확인하여 입력)
6
7
# DEPLOY
8
bosh -e ${BOSH_ENVIRONMENT} -n -d rabbitmq deploy --no-redact rabbitmq.yml \
9
-l ${COMMON_VARS_PATH} \
10
-l vars.yml \
11
-v releases_dir="/home/ubuntu/workspace/paasta-5.5.1/release"
Copied!
  • 서비스를 설치한다.
1
$ cd ~/workspace/paasta-5.5.1/deployment/service-deployment/rabbitmq
2
$ sh ./deploy.sh
Copied!

2.7. 서비스 설치 확인

설치 완료된 서비스를 확인한다.
$ bosh -e micro-bosh -d rabbitmq vms
1
Using environment '10.30.40.111' as user 'admin' (openid, bosh.admin)
2
3
Task 8077. Done
4
5
Deployment 'rabbitmq'
6
7
Instance Process State AZ IPs VM CID VM Type Active
8
haproxy/a30fb543-000d-4f74-b62d-7418da0e6101 running z5 10.30.107.192 vm-fbd4a04a-5346-4e00-b793-17c327f90aa7 minimal true
9
paasta-rmq-broker/52629ddb-32c9-4097-b9f6-e5dc0aff55ce running z5 10.30.107.191 vm-5238f05b-ec4f-449c-ab1d-a1a5b932d76e minimal true
10
rmq/a4ef4c7e-4776-411d-8317-b2b059e416dd running z5 10.30.107.193 vm-f8d8a62d-bfc4-442e-8306-9f133ebfc518 minimal true
11
12
3 vms
13
14
Succeeded
Copied!

3. RabbitMQ 연동 Sample App 설명

본 Sample App은 PaaS-TA에 배포되며 RabbitMQ의 서비스를 Provision과 Bind를 한 상태에서 사용이 가능하다.

3.1. 서비스 브로커 등록

RabbitMQ 서비스팩 배포가 완료 되었으면 Application에서 서비스 팩을 사용하기 위해서 먼저 RabbitMQ 서비스 브로커를 등록해 주어야 한다. 서비스 브로커 등록시에는 PaaS-TA에서 서비스 브로커를 등록할 수 있는 사용자로 로그인 하여야 한다
서비스 브로커 목록을 확인한다.
1
$ cf service-brokers
2
Getting service brokers as admin...
3
4
name url
5
cubrid-service-broker http://10.30.101.1:8080
Copied!
rabbitmq 서비스 브로커를 등록한다.
$ cf create-service-broker {서비스팩 이름} {서비스팩 사용자ID} {서비스팩 사용자비밀번호} http://{서비스팩 URL(IP)}
서비스팩 이름 : 서비스 팩 관리를 위해 PaaS-TA에서 보여지는 명칭이다. 서비스 Marketplace에서는 각각의 API 서비스 명이 보여지니 여기서 명칭은 서비스팩 리스트의 명칭이다. 서비스팩 사용자ID / 비밀번호 : 서비스팩에 접근할 수 있는 사용자 ID입니다. 서비스팩도 하나의 API 서버이기 때문에 아무나 접근을 허용할 수 없어 접근이 가능한 ID/비밀번호를 입력한다. 서비스팩 URL : 서비스팩이 제공하는 API를 사용할 수 있는 URL을 입력한다.
1
$ cf create-service-broker rabbitmq-service-broker admin admin http://10.30.53.33:4567
2
Creating service broker rabbitmq-service-broker as admin...
3
OK
Copied!
등록된 RabbitMQ 서비스 브로커를 확인한다.
$ cf service-brokers
1
$ cf service-brokers
2
Getting service brokers as admin...
3
4
name url
5
cubrid-service-broker http://10.30.101.1:8080
Copied!

접근 가능한 서비스 목록을 확인한다.

$ cf service-access
1
$ cf service-access
2
Getting service access as admin...
3
broker: rabbitmq-service-broker
4
service plan access orgs
5
p-rabbitmq standard none
Copied!
  • 서비스 브로커 등록시 최초에는 접근을 허용하지 않는다. 따라서 access는 none으로 설정된다.

특정 조직에 해당 서비스 접근 허용을 할당하고 접근 서비스 목록을 다시 확인한다. (전체 조직)

$ cf enable-service-access p-rabbitmq
1
Enabling access to all plans of service p-rabbitmq for all orgs as admin...
2
OK
3
4
$ cf service-access
5
Getting service access as admin...
6
broker: rabbitmq-service-broker
7
service plan access orgs
8
p-rabbitmq standard all
Copied!

3.2. 서비스 신청

Sample App에서 RabbitMQ 서비스를 사용하기 위해서는 서비스 신청(Provision)을 해야 한다. *참고: 서비스 신청시 PaaS-TA에서 서비스를 신청 할 수 있는 사용자로 로그인이 되어 있어야 한다.

먼저 PaaS-TA Marketplace에서 서비스가 있는지 확인을 한다.

$ cf marketplace
1
$ cf marketplace
2
getting services from marketplace in org system / space dev as admin...
3
OK
4
5
service plans description broker
6
p-rabbitmq standard RabbitMQ is a robust and scalable high-performance multi-protocol messaging broker. rabbitmq-service-broker
7
8
TIP: Use 'cf marketplace -s SERVICE' to view descriptions of individual plans of a given service.
Copied!

Marketplace에서 원하는 서비스가 있으면 서비스 신청(Provision)을 한다.

$ cf create-service {서비스명} {서비스 플랜} {내 서비스명}
  • 서비스명 : p-rabbitmq로 Marketplace에서 보여지는 서비스 명칭이다.
  • 서비스플랜 : 서비스에 대한 정책으로 plans에 있는 정보 중 하나를 선택한다. RabbitMQ 서비스는 standard plan만 지원한다.
  • 내 서비스명 : 내 서비스에서 보여지는 명칭이다. 이 명칭을 기준으로 환경 설정 정보를 가져온다.
1
$ cf create-service p-rabbitmq standard my_rabbitmq_service
2
Creating service instance my_rabbitmq_service in org system / space dev as admin...
3
OK
Copied!

생성된 rabbitmq 서비스 인스턴스를 확인한다.

$ cf services
1
$ cf services
2
Getting services in org system / space dev as admin...
3
4
name service plan bound apps last operation broker upgrade available
5
my_rabbitmq_service p-rabbitmq standard create succeeded rabbitmq-service-broker
Copied!

3.3. Sample App에 서비스 바인드 신청 및 App 확인

서비스 신청이 완료되었으면 cf 에서 제공하는 rabbit-example-app을 다운로드해서 테스트를 진행한다.
  • 참고: 서비스 Bind 신청시 PaaS-TA에서 서비스 Bind 신청 할 수 있는 사용자로 로그인이 되어 있어야 한다.

git을 통해 sample-app을 다운로드 한다.

1
$ git clone https://github.com/pivotal-cf/rabbit-example-app.git
2
Cloning into 'rabbit-example-app'...
3
remote: Enumerating objects: 297, done.
4
remote: Total 297 (delta 0), reused 0 (delta 0), pack-reused 297
5
Receiving objects: 100% (297/297), 10.59 MiB | 4.48 MiB/s, done.
6
Resolving deltas: 100% (87/87), done.
7
Checking connectivity... done
Copied!

--no-start 옵션으로 App을 배포한다.

--no-start: App 배포시 구동은 하지 않는다.
$cd rabbit-example-app
$cf push rabbit-example-app --no-start
1
$ cf push rabbit-example-app --no-start
2
Pushing from manifest to org system / space dev as admin...
3
Using manifest file /home/inception/workspace/user/cheolhan/rabbit-example-app/manifest.yml
4
Getting app info...
5
Creating app with these attributes...
6
+ name: test-app
7
path: /home/inception/workspace/user/cheolhan/rabbit-example-app
8
+ command: thin -R config.ru start
9
routes:
10
11
Creating app test-app...
12
Mapping routes...
13
Comparing local files to remote cache...
14
Packaging files to upload...
15
Uploading files...
16
3.24 MiB / 3.24 MiB [============================================================================================================================================================================================================================================] 100.00% 1s
17
18
Waiting for API to complete processing files...
19
20
name: test-app
21
requested state: stopped
22
routes: test-app.115.68.47.178.xip.io
23
last uploaded:
24
stack:
25
buildpacks:
26
27
type: web
28
instances: 0/1
29
memory usage: 1024M
30
start command: thin -R config.ru start
31
state since cpu memory disk details
32
#0 down 2019-11-19T01:24:08Z 0.0% 0 of 0 0 of 0
Copied!

Sample App에서 생성한 서비스 인스턴스 바인드 신청을 한다.

cf bind-service test-app my_rabbitmq_service
(참고) 바인드 후 App구동시 Mysql 서비스 접속 에러로 App 구동이 안될 경우 보안 그룹을 추가한다.
rule.json 화일을 만들고 아래와 같이 내용을 넣는다.
$ vi rule.json
1
[
2
{
3
"protocol": "all",
4
"destination": "{haproxy_IP}"
5
}
6
]
Copied!
보안 그룹을 생성한다.
$ cf create-security-group rabbitmq rule.json
모든 App에 Mysql 서비스를 사용할수 있도록 생성한 보안 그룹을 적용한다.
$ cf bind-running-security-group rabbitmq

바인드가 적용되기 위해서 App을 재기동한다.

cf restart test-app

App이 정상적으로 RabbitMQ 서비스를 사용하는지 확인한다.

브라우저에서 확인

http://test-app.<YOUR_DOMAIN>/write
http://test-app.<YOUR_DOMAIN>/read

스토어 엔드포인트 테스트

curl -XPOST -d 'test' http://test-app.<YOUR-DOMAIN>/store
curl -XGET http://test-app.<YOUR-DOMAIN>/store

큐 엔드포인트 테스트

curl -XPOST -d 'test' http://test-app.<YOUR-DOMAIN>/queues/<YOUR-QUEUE-NAME>
curl -XGET http://test-app.<YOUR-DOMAIN>/queues/<YOUR-QUEUE-NAME>
Last modified 8mo ago