Redis 설치 가이드(Bosh-Lite)

1. 문서 개요

1.1. 목적

본 문서(Redis서비스팩설치 가이드)는 전자정부표준프레임워크 기반의 Open PaaS에서 제공되는 서비스팩인Redis서비스팩을 Bosh를 이용하여 설치 하는 방법과 Open PaaS의 SaaS 형태로 제공하는 Application 에서Redis 서비스를 사용하는 방법을 기술하였다.

1.2. 범위

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

1.3. 시스템 구성도

본 문서의 설치된 시스템 구성도입니다. Redisdedicated-node(5대), Redis 서비스 브로커로 최소사항을 구성하였다.

1.4. 참고자료

2. Redis 서비스팩 설치

2.1. 설치전 준비사항

본 설치 가이드는 Linux 환경에서 설치하는 것을 기준으로 하였다. 서비스팩 설치를 위해서는 먼저 BOSH-lite 가 설치 되어 있어야 하고 BOSH 에 로그인 및 타켓 설정이 되어 있어야 한다. BOSH-lite 가 설치 되어 있지 않을 경우 먼저 BOSH-lite 설치 가이드 문서를 참고 하여 BOSH-lite를 설치 해야 한다.

2.2. Redis 서비스 릴리즈 업로드

  • OpenPaaS-Services 폴더 안에 있는 redis 서비스 릴리즈 파일 openpaas-redis-release-1.0.tgz 을 다운로드 한다.

업로드할 openpaas-redis-release-beta-1.0.tgz 파일을 확인한다.

$ls –all

업로드 되어 있는 릴리즈 목록을 확인한다.

$ bosh releases
Redis 서비스 릴리즈가 업로드 되어 있지 않은 것을 확인

Redis 서비스 릴리즈 파일을업로드한다.

$ bosh upload release {서비스릴리즈 파일 PATH}
$ bosh upload release openpaas-redis-release-beta-1.0.tgz

업로드 된 Redis릴리즈를 확인한다.

$ bosh releases
Redis 서비스 릴리즈가 업로드 되어 있는 것을 확인

2.3. Redis 서비스 Deployment 파일 수정 및 배포

BOSH Deployment manifest 는 components 요소 및 배포의 속성을 정의한 YAML 파일이다. Deployment manifest 에는 sotfware를 설치 하기 위해서 어떤 Stemcell (OS, BOSH agent) 을 사용할것이며 Release (Software packages, Config templates, Scripts) 이름과 버전, VMs 용량, Jobs params등을 정의가 되어 있다.
  • OpenPaaS-Deployment 폴더안에 있는 BOSH-lite용 Redis Deployment 화일인 openpaas-redis-lite-1.0.yml를 다운로드한다.
$ ls –all

Director UUID를 확인한다.

BOSH CLI가 배포에 대한 모든 작업을 허용하기위한 현재 대상 BOSH Director의 UUID와 일치해야한다. ‘bosh status’ CLI 을 통해서 현재 BOSH Director 에 target 되어 있는 UUID를 확인할수 있다.
$ bosh status

Deploy시 사용할 Stemcell을 확인한다. (Stemcell 389 버전 사용)

$ bosh stemcells
Stemcell목록이 존재 하지 않을 경우 BOSH-lite 설치 가이드 문서를 참고 하셔서 Stemcell 389 버전을 업로드를 해야 한다.

openpaas-redis-lite.yml Deployment 파일을 서버 환경에 맞게 수정한다.

$vi openpaas-redis-lite.yml
1
# openpaas-redis-lite 설정 파일 내용
2
---
3
name: openpaas-redis-service # 서비스 배포이름(필수)
4
director_uuid: 46965538-fe7f-4260-b5df-ef9411558b99 # bosh status 에서 확인한 Director UUID을 입력(필수)
5
releases:
6
- name: cf-redis # 서비스 릴리즈 이름(필수)
7
version: beta-1.0 # 서비스 릴리즈 버전(필수): latest 시 업로드된 서비스 릴리즈 최신버전
8
compilation: # 컴파일시 필요한 가상머신의 속성(필수)
9
cloud_properties: # 컴파일 VM을 만드는 데 필요한 IaaS의 특정 속성 (instance_type, availability_zone), 직접 cpu,disk,ram 사이즈를 넣어도 됨
10
name: random
11
network: services # Networks block에서 선언한 network 이름(필수)
12
reuse_compilation_vms: true # 컴파일지 VM 재사용 여부(옵션)
13
workers: 2 # 컴파일 하는 가상머신의 최대수(필수)
14
update:
15
canaries: 1 # canary 인스턴스 수(필수)
16
canary_watch_time: 30000-180000 # canary 인스턴스가 수행하기 위한 대기 시간(필수)
17
update_watch_time: 30000-180000 # non-canary 인스턴스가 수행하기 위한 대기 시간(필수)
18
max_in_flight: 4 # non-canary 인스턴스가 병렬로 update 하는 최대 개수(필수)
19
networks: # 네트워크 블록에 나열된 각 서브 블록이 참조 할 수있는 작업이 네트워크 구성을 지정, bosh lite 에서는 제공하는 네트워크를 수정 없이 사용
20
- name: services
21
subnets:
22
- cloud_properties:
23
name: random
24
range: 10.244.3.32/30
25
reserved:
26
- 10.244.3.33
27
- cloud_properties:
28
name: random
29
range: 10.244.3.36/30
30
reserved:
31
- 10.244.3.37
32
- cloud_properties:
33
name: random
34
range: 10.244.3.40/30
35
reserved:
36
- 10.244.3.41
37
- cloud_properties:
38
name: random
39
range: 10.244.3.44/30
40
reserved:
41
- 10.244.3.45
42
static:
43
- 10.244.3.46
44
- cloud_properties:
45
name: random
46
range: 10.244.3.48/30
47
reserved:
48
- 10.244.3.49
49
- cloud_properties:
50
name: random
51
range: 10.244.3.52/30
52
reserved:
53
- 10.244.3.53
54
static:
55
- 10.244.3.54
56
- cloud_properties:
57
name: random
58
range: 10.244.3.56/30
59
reserved:
60
- 10.244.3.57
61
static:
62
- 10.244.3.58
63
- cloud_properties:
64
name: random
65
range: 10.244.3.60/30
66
reserved:
67
- 10.244.3.61
68
static:
69
- 10.244.3.62
70
- cloud_properties:
71
name: random
72
range: 10.244.3.64/30
73
reserved:
74
- 10.244.3.65
75
static:
76
- 10.244.3.66
77
- cloud_properties:
78
name: random
79
range: 10.244.3.68/30
80
reserved:
81
- 10.244.3.69
82
static:
83
- 10.244.3.70
84
resource_pools: # 배포시 사용하는 resource pools를 명시하며 여러 개의 resource pools 을 사용할 경우 name 은 unique 해야함(필수)
85
- cloud_properties: # 컴파일 VM을 만드는 데 필요한 IaaS의 특정 속성을 설명 (instance_type, availability_zone), 직접 cpu, disk, 메모리 설정가능
86
ram: 1024
87
name: random
88
name: services-small
89
network: services
90
stemcell:
91
name: bosh-warden-boshlite-ubuntu-trusty-go_agent # stemcell 이름(필수)
92
version: 389 # stemcell 버전(필수)
93
jobs:
94
- name: dedicated-node # 작업 이름(필수)
95
templates:
96
- name: dedicated-node # job template 이름(필수)
97
release: cf-redis # 서비스 릴리즈 이름(필수)
98
- name: syslog-configurator
99
release: cf-redis
100
instances: 5 # 생성하는 인스턴스 수(필수)
101
resource_pool: services-small
102
persistent_disk: 4096 # 영구적 디스크 사이즈 정의(옵션): 4G
103
networks:
104
- name: services
105
static_ips: # 전용 노드 IP 목록(필수)
106
- 10.244.3.54
107
- 10.244.3.58
108
- 10.244.3.62
109
- 10.244.3.66
110
- 10.244.3.70
111
- name: openpaas-redis-broker
112
templates:
113
- name: cf-redis-broker # job template 이름(필수)
114
release: cf-redis # 서비스 릴리즈 이름(필수)
115
- name: syslog-configurator
116
release: cf-redis
117
instances: 1
118
resource_pool: services-small
119
persistent_disk: 4096 # 영구적 디스크 사이즈 정의(옵션): 4G
120
networks:
121
- name: services
122
static_ips:
123
- 10.244.3.46
124
- name: broker-registrar # 작업 이름: 서비스 브로커 등록
125
instances: 1
126
lifecycle: errand # bosh deploy시 vm에 생성되어 설치 되지 않고 bosh errand 로 실행할때 설정, 주로 테스트 용도에 쓰임
127
networks:
128
- name: services
129
resource_pool: services-small
130
templates:
131
- name: broker-registrar
132
release: cf-redis
133
properties:
134
broker: # 서비스 브로커 설정 정보
135
name: openpaas-redis-service
136
host: 10.244.0.34
137
username: admin
138
password: admin
139
- name: broker-deregistrar
140
instances: 1
141
lifecycle: errand
142
networks:
143
- name: services
144
resource_pool: services-small
145
templates:
146
- name: broker-deregistrar
147
release: cf-redis
148
properties:
149
broker:
150
name: openpaas-redis-service
151
host: 10.244.0.34
152
username: admin
153
password: admin
154
- name: smoke-tests
155
instances: 1
156
lifecycle: errand
157
networks:
158
- name: services
159
resource_pool: services-small
160
templates:
161
- name: smoke-tests
162
release: cf-redis
163
properties:
164
syslog_aggregator:
165
address: 127.0.0.1
166
port: 1234
167
cf:
168
api_url: https://api.bosh-lite.com # CF API url(필수)
169
apps_domain: api.bosh-lite.com # CF 도메인(필수)
170
admin_username: admin # CF 어드민 아이디 (필수)
171
admin_password: admin # CF 어드민 아이디 비밀번호(필수)
172
nats: # CF 설치시 설치한 nats 정보 (필수)
173
host: 10.244.0.6
174
port: 4222
175
username: nats
176
password: admin
177
redis:
178
host: 10.244.3.46
179
maxmemory: 262144000 # 최대 메모리
180
config_command: config # config 설정 명령어가 있을 경우(옵션)
181
save_command: save # 저장 명령어가 있을 경우(옵션)
182
bg_save_command: bgsave
183
agent:
184
backend_port: 54321 # Redis backend 포트번호(필수)
185
broker:
186
network: services
187
backend_host: 10.244.3.46
188
backend_port: 12345
189
dedicated_nodes:
190
- 10.244.3.54
191
- 10.244.3.58
192
- 10.244.3.62
193
- 10.244.3.66
194
- 10.244.3.70
195
service_instance_limit: 3 # 서비스 인스턴스 생성 가능 수(필수)
196
service_name: redis-sb
197
auth:
198
username: admin
199
password: admin
200
backups:
201
path: "/backups"
202
access_key_id: ZZZZZZZZZZZZZZZ
203
secret_access_key: ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
204
endpoint_url: https://s3.amazonaws.com
205
bucket_name: my-backup-bucket
Copied!

Deploy 할 deployment manifest 파일을 BOSH 에 지정한다.

$ bosh deployment {Deployment manifest 파일 PATH}
$ bosh deployment openpaas-redis-lite.yml

Redis서비스팩을 배포한다.

$ bosh deploy

배포된 Redis서비스팩을 확인한다.

$ bosh vms

2.4. Redis 서비스 브로커 등록

Redis서비스팩 배포가 완료 되었으면 Application에서 서비스 팩을 사용하기 위해서 먼저 Redis 서비스 브로커를 등록해 주어야 한다. 서비스 브로커 등록시개방형 클라우드 플랫폼에서서비스브로커를등록할수있는사용자로로그인이되어있어야한다.

서비스 브로커 목록을 확인한다.

$ cf service-brokers

Redis 서비스 브로커를 등록한다.

$ cf create-service-broker {서비스 브로커 이름} {서비스 브로커 사용자ID} {서비스 브로커 사용자 비밀번호} http://{서비스 브로커 URL}
1
서비스 브로커 이름: 서비스 관리를 위해 개방형 클라우드 플랫폼에서 보여지는 명칭이다. 서비스 Marketplace에서는 각각의 API 서비스 명이 보여지니 여기서 명칭은 서비스 브로커의의 명칭이다.
2
서비스 브로커 사용자ID / 비밀번호: 서비스 브로커에 접근할 수 있는 사용자 ID이다. 서비스 브로커도 하나의 API 서버이기 때문에 아무나 접근을 허용할 수 없어 접근이 가능한 ID/비밀번호를 입력한다.
3
서비스 브로커 URL: 서비스 브로커가 제공하는 API를 사용할 수 있는 URL을 입력한다.
Copied!
$ cf create-service-broker redis-service-broker admin adminhttp://10.244.3.46:80

등록된 Redis 서비스 브로커를 확인한다.

$ cf service-brokers

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

$ cf service-access
서비스 브로커 생성시 디폴트로 접근을 허용하지 않는다.

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

$cf enable-service-access redis-sb
$ cf service-access

3. Redis 연동 Sample App 설명

본 Sample App은 개방형 클라우드 플랫폼에 배포되며 redis의 서비스를 Provision과 Bind를 한 상태에서 사용이 가능하다.

3.1. Sample App 구조

Sample App은 개방형 클라우드 플랫폼에 App으로 배포가 된다. 배포 완료 후 정상적으로 App 이 구동되면 curl 명령어로 App url 를 입력하면 redis 환경정보(서비스 연결 정보)를 보여주는 url 페이지를 제공한다.
Sample App 구조는 다음과 같다.
이름
설명
lib
Sample 소스디렉토리
manifest.yml
개방형클라우드 플랫폼에 app 배포시 필요한 설정을 저장하는 파일
Gemfile
Sample App 구동시 필요한 ruby gem 설정 파일
config.ru
Sample App 구동 파일

OpenPaaS-Sample-Apps.zip 파일 압축을 풀고 Service폴더안에 있는 RedisSample Web App인 redis-example-app을복사한다

$ ls -all

3.2. 개방형 클라우드 플랫폼에서 서비스 신청

Sample App에서 Redis 서비스를 사용하기 위해서는 서비스 신청(Provision)을 해야 한다. *참고: 서비스 신청시개방형 클라우드 플랫폼에서 서비스를 신청 할 수 있는 사용자로 로그인이 되어 있어야 한다.

먼저 개방형 클라우드 플랫폼 Marketplace에서 서비스가 있는지 확인을 한다.

$ cf marketplace

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

$ cf create-service {서비스명} {서비스플랜} {내서비스명}
1
서비스명 :redis-sb로 Marketplace에서 보여지는 서비스 명칭이다.
2
서비스플랜 : 서비스에 대한 정책으로 plans에 있는 정보 중 하나를 선택한다. Redis 서비스는 shared-vm 과 dedicated-vmplan을지원한다.
3
내서비스명 : 내 서비스에서 보여지는 명칭이다. 이 명칭을 기준으로 환경설정정보를 가져온다.
Copied!
$ cf create-service redis-sbshared-vmredis-service-instance

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

$cf services

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

서비스 신청이 완료되었으면 Sample App 에서는 생성된 서비스 인스턴스를 Bind 하여 App에서 Redis 서비스를 이용한다.
  • 참고: 서비스 Bind 신청시개방형 클라우드 플랫폼에서 서비스 Bind신청 할 수 있는 사용자로 로그인이 되어 있어야 한다.

Sample App 디렉토리로 이동하여 manifest 파일을 확인한다

$ cd redis-example-app
$ vi manifest.yml
1
---
2
applications:
3
- name: redis-example-app #배포할 App 이름
4
memory: 256M #배포시 메모리 크기
5
instances: 1 #배포시인스턴스 수
6
path: . #배포시 구동되는 Path
Copied!

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

--no-start: App 배포시 구동은 하지 않는다.
$ cf push --no-start

배포된 Sample App을 확인하고 로그를 수행한다.

$ cf apps
$ cf logs {배포된 App명}
$ cf logs redis-example-app

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

$ cf bind-service redis-example-appredis-service-instance

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

$ cf restart redis-example-app

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

curl로 확인
  • Redis Application 을 이용하여 Key 값으로 데이터 저장
$ export APP=redis-example-app.bosh-lite.com
$ curl -X PUT $APP/foo -d 'data=bar'
>
  • Key 값을 이용하여 Redis 에 저장되어 있는 Value 값 Get
$ curl -X GET $APP/foo
>
  • Key 값을 이용하여 Redis 에 저장되어 있는 Value 삭제
$ curl -X DELETE $APP/foo

4. Redis Client 툴 접속

Application에 바인딩된Redis 서비스 연결정보는 Private IP로 구성되어 있기 때문에 Redis Client 툴에서 직접 연결할수 없다. 따라서 Redis Client 툴에서 SSH 터널, Proxy 터널 등을 제공하는 툴을 사용해서 연결하여야 한다. 본 가이드는 SSH 터널을 이용하여 연결 하는 방법을 제공하며 Redis Client 툴로써는 오픈 소스인 Redis Desktop Manager로 가이드한다. 또한 Bosh lite를 AWS 환경에서 구성 한 경우를 전제로 하였다. AWS에서 Bosh lite를 구성하면 Vagrant VM이 생성되는데 Vagrant VM 에서는 서비스팩의 Private IP 와 해당 포트로 접근이 가능하도록 구성되어 있다.

4.1. Redis Desktop Manager 설치 및 연결

Redis Desktop Manager 프로그램은 무료로 사용할 수 있는 오픈소스 소프트웨어이다.

Redis Desktop Manager를 다운로드 하기 위해 아래 URL로 이동하여 설치파일을 다운로드 한다.

다운로드한 설치파일을 실행한다.

Redis Desktop Manager 설치를 위한 안내사항이다. Next 버튼을 클릭한다.

프로그램 라이선스에 관련된 내용이다. I Agree 버튼을 클릭한다.

Redis Desktop Manager를 설치할 경로를 설정 후 Install 버튼을 클릭한다.

별도의 경로 설정이 필요 없을 경우 default로 C드라이브 Program Files 폴더에 설치가 된다.

설치 완료 후 Next 버튼을 클릭하여 다음 과정을 진행한다.

Finish 버튼 클릭으로 설치를 완료한다.

Redis Desktop Manager를 실행했을 때 처음 뜨는 화면이다. 이 화면에서 Server에 접속하기 위한 profile을 설정/저장하여 접속할 수 있다. Connect to Redis Server 버튼을 클릭한다.

Connection 탭에서 아래 붉은색 영역에 접속하려는 서버 정보를 모두 입력한다.

서버 정보는 Application에 바인드되어 있는 서버 정보를 입력한다. cf env 명령어로 이용하여 확인한다.

예) $ cf env redis-example-app

SSH Tunnel탭을 클릭하고 OpenPaaS 운영 관리자에게 제공받은 SSH 터널링 가능한 서버 정보를 입력하고 공개키(.pem) 파일을 불러온다. Test Connection 버튼을 클릭하면 Redis 서버에 접속이 되는지 테스트 하고 OK 버튼을 눌러 Redis 서버에 접속한다.

(참고) 만일 공개키 없이 ID/Password로 접속이 가능한 경우에는 공개키 대신 사용자 이름과 암호를 입력한다.

접속이 완료되고 좌측 서버 정보를 더블 클릭하면 좌측에 스키마 정보가 나타난다.

신규 키 등록후 확인

Last modified 1yr ago