Application Gateway 설치 가이드
1. 문서 개요
3. 애플리케이션 Gateway 서비스 관리 및 신청
본 문서는 애플리케이션 Gateway 서비스 Release를 Bosh2.0을 이용하여 설치 하는 방법을 기술하였다.
설치 범위는 애플리케이션 Gateway 서비스 Release를 검증하기 위한 기본 설치를 기준으로 작성하였다.
본 장에서는 애플리케이션 Gateway 서비스의 시스템 구성에 대해 기술하였다. 애플리케이션 Gateway 서비스 시스템은 service-broker, mariadb, api-gateway(WSO2)서비스의 최소사항을 구성하였다.
VM명 | 인스턴스 수 | vCPU수 | 메모리(GB) | 디스크(GB) |
service-broker | 1 | 1 | 1 | |
mariadb | 1 | 1 | 2 | Root 8G + Persistent disk 10G |
api-gateway | N | 2 | 4 | Root 10G + Persistent disk 20G |
본 설치 가이드는 Linux 환경에서 설치하는 것을 기준으로 하였다. 애플리케이션 Gateway 서비스 설치를 위해서는 BOSH 2.0과 PaaS-TA 5.0, PaaS-TA 포털이 설치되어 있어야 한다.
애플리케이션 Gateway 서비스 설치에 필요한 Deployment 및 릴리즈 파일을 다운로드 받아 서비스 설치 작업 경로로 위치시킨다.
설치 파일 다운로드 위치 : https://paas-ta.kr/download/package = Deployment : paasta-api-gateway-service = 릴리즈 파일 : paasta-api-gateway-service-release.tgz
설치 작업 경로 생성 및 파일 다운로드
# Deployment 다운로드 파일 위치 경로 생성$ mkdir -p ~/workspace/paasta-5.0/deployment/service-deployment# Deployment 다운로드(paasta-api-gateway-service) 및 파일 경로 확인$ ls ~/workspace/paasta-5.0/deployment/service-deployment/paasta-api-gateway-serviceREADME.md deploy-paasta-api-gateway-service.sh manifests# 릴리즈 다운로드 파일 위치 경로 생성$ mkdir -p ~/workspace/paasta-5.0/release/service# 릴리즈 파일 다운로드(paasta-api-gateway-service-release.tgz) 및 파일 경로 확인$ ls ~/workspace/paasta-5.0/release/servicepaasta-api-gateway-service-release.tgz
애플리케이션 Gateway 서비스 설치에 필요한 Stemcell을 확인하여 존재하지 않을 경우 BOSH 설치 가이드 문서를 참고 하여 Stemcell을 업로드 한다. (애플리케이션 Gateway 서비스는 Stemcell ubuntu-xenial 315.64 버전을 사용, PaaSTA-Stemcell.zip)
설치 파일 다운로드 위치 : https://paas-ta.kr/download/package
# Stemcell 목록 확인$ bosh -e micro-bosh stemcellsUsing environment '10.0.1.6' as client 'admin'Name Version OS CPI CIDbosh-aws-xen-hvm-ubuntu-xenial-go_agent 315.64* ubuntu-xenial - ami-0297ff649e8eea21b(*) Currently deployed1 stemcellsSucceeded
릴리즈 목록을 확인하여 애플리케이션 Gateway 서비스 릴리즈(paasta-api-gateway-service)가 업로드 되어 있지 않은 것을 확인한다.
# 릴리즈 목록 확인 (검색)$ bosh -e micro-bosh releases | grep "api-gateway-service"# 릴리즈 목록 확인 (전체)$ bosh -e micro-bosh releasesUsing environment '10.0.1.6' as client 'admin'Name Version Commit Hashbinary-buildpack 1.0.32* 2399a07bosh-dns 1.12.0* 5d607edbosh-dns-aliases 0.0.3* eca9c5abpm 1.1.0* 27e1c8fcapi 1.83.0* 6b3cd37... ((생략)) ...(*) Currently deployed(+) Uncommitted changes34 releasesSucceeded
애플리케이션 Gateway 서비스 릴리즈 파일을 업로드한다.
# 릴리즈 파일 업로드$ bosh -e micro-bosh upload-release ~/workspace/paasta-5.0/release/service/paasta-api-gateway-service-release.tgzUsing environment '10.0.1.6' as client 'admin'####################################################### 100.00% 121.38 MiB/s 10sTask 48Task 48 | 10:29:49 | Extracting release: Extracting release (00:00:08)Task 48 | 10:29:57 | Verifying manifest: Verifying manifest (00:00:00)Task 48 | 10:29:57 | Resolving package dependencies: Resolving package dependencies (00:00:00)Task 48 | 10:29:57 | Creating new packages: api-gateway/5e6d9b56be340309b31b5604cd1811c751223686b3c5cf582b90026ee4d0a737 (00:00:05)Task 48 | 10:30:02 | Creating new packages: common/1213e44f16684a87f85f2a1784f1a8bb2b6d4dc8bb8caf8fed62a94c80352a20 (00:00:00)Task 48 | 10:30:02 | Creating new packages: java/9ee03ac5327ece3bc9f8e67dd78abded89b56b1cff6079620b820e88ef336889 (00:00:01)Task 48 | 10:30:03 | Creating new packages: mariadb/5383f62b0bfdc8c0ba3de3df0ac4a6aa0e5fb407489a715947a63e61946b7709 (00:00:10)Task 48 | 10:30:13 | Creating new packages: service-broker/89fe44473aca3736744f333e303c99d4ffcc8f644118b076f4e1307a99a7d456 (00:00:01)Task 48 | 10:30:14 | Creating new jobs: api-gateway/755592481274935d83035bdfd3ee5a097f15402245ecd31011225b730a4a1fbc (00:00:00)Task 48 | 10:30:14 | Creating new jobs: mariadb/7100c6696eeac52a485e6521ca9ac1f0e175a3c5ef623556c57bc1e81010c4fa (00:00:00)Task 48 | 10:30:14 | Creating new jobs: service-broker/af4db1033fef0541a53b705202dd4380abc4cf7d7c34d8750c5ce258519eee6c (00:00:01)Task 48 | 10:30:15 | Release has been created: paasta-api-gateway-service/1.0 (00:00:00)Task 48 Started Wed Nov 6 10:29:49 UTC 2019Task 48 Finished Wed Nov 6 10:30:15 UTC 2019Task 48 Duration 00:00:26Task 48 doneSucceeded
릴리즈 목록을 확인하여 애플리케이션 Gateway 서비스 릴리즈(paasta-api-gateway-service)가 업로드 되어 있는 것을 확인한다.
# 릴리즈 목록 확인 (검색)$ bosh -e micro-bosh releases | grep "api-gateway-service"paasta-api-gateway-service 1.0 2cbdac9+# 릴리즈 목록 확인 (전체)$ bosh -e micro-bosh releasesUsing environment '10.0.1.6' as client 'admin'Name Version Commit Hashbinary-buildpack 1.0.32* 2399a07bosh-dns 1.12.0* 5d607edbosh-dns-aliases 0.0.3* eca9c5abpm 1.1.0* 27e1c8fcapi 1.83.0* 6b3cd37paasta-api-gateway-service 1.0 2cbdac9+... ((생략)) ...(*) Currently deployed(+) Uncommitted changes35 releasesSucceeded
BOSH Deployment manifest는 Components 요소 및 배포의 속성을 정의한 YAML 파일이다. Deployment 파일에서 사용하는 network, vm_type, disk_type 등은 Cloud config를 활용하고, 활용 방법은 BOSH 2.0 가이드를 참고한다.
Cloud config 설정 내용을 확인한다.
# Cloud config 조회$ bosh -e micro-bosh cloud-configUsing environment '10.0.1.6' as client 'admin'azs:- cloud_properties:availability_zone: ap-northeast-2aname: z1- cloud_properties:availability_zone: ap-northeast-2aname: z2... ((생략)) ...- cloud_properties:availability_zone: ap-northeast-2aname: z7compilation:az: z4network: defaultreuse_compilation_vms: truevm_type: xlargeworkers: 5disk_types:- disk_size: 1024name: default... ((생략)) ...- cloud_properties:type: gp2disk_size: 500000name: 50GB_GP2networks:- name: defaultsubnets:- az: z1cloud_properties:security_groups: paasta-security-groupsubnet: subnet-00000000000000000dns:- 8.8.8.8gateway: 10.0.1.1range: 10.0.1.0/24reserved:- 10.0.1.2 - 10.0.1.9static:- 10.0.1.10 - 10.0.1.120... ((생략)) ...- cloud_properties:ephemeral_dist:size: 4096type: gp2instance_type: t2.smallname: caas_small- cloud_properties:ephemeral_dist:size: 30000type: gp2instance_type: m4.xlargename: caas_small_highmemSucceeded
Deployment YAML에서 사용하는 변수들을 서버 환경에 맞게 수정한다.
# 변수 설정$ vi ~/workspace/paasta-5.0/deployment/service-deployment/paasta-api-gateway-service/manifests/vars.yml# RELEASEservice_release_name: "paasta-api-gateway-service" # release nameservice_release_version: "1.0" # release version# STEMCELLstemcell_os: "ubuntu-xenial" # stemcell osstemcell_version: "315.64" # stemcell version# VM_TYPEvm_type_default: "medium" # vm type defaultvm_type_highmem: "small-highmem-16GB" # vm type highmemory# NETWORKprivate_networks_name: "service_private" # private network namepublic_networks_name: "service_public" # public network name :: The public network name can only use "vip" or "service_public".#private_nat_networks_name: "service_private" # AWS의 경우, NATS Network Name# MARIA_DBmariadb_azs: [z3] # mariadb : azsmariadb_instances: 1 # mariadb : instances (1)mariadb_persistent_disk_type: "10GB" # mariadb : persistent_disk_typemariadb_port: "<MARIADB_PORT>" # mariadb : database port (e.g. 3306)mariadb_admin_password: "<MARIADB_ADMIN_PASSWORD>" # mariadb : database admin password (e.g. "paas-ta!admin")mariadb_broker_username: "<MARIADB_BROKER_USERNAME>" # mariadb : service-broker-user id (e.g. "apigateway")mariadb_broker_password: "<MARIADB_BROKER_PASSWORD>" # mariadb : service-broker-user password (e.g. "broker!admin")# SERVICE-BROKERbroker_azs: [z3] # service-broker : azsbroker_instances: 1 # service-broker : instances (1)broker_port: "<SERVICE_BROKER_PORT>" # service-broker : broker port (e.g. "8080")broker_logging_level_broker: "INFO" # service-broker : broker logging levelbroker_logging_level_hibernate: "INFO" # service-broker : hibernate logging levelbroker_services_id: "<SERVICE_BROKER_SERVICES_GUID>" # service-broker : service guid (e.g. "8b78dfb6-1fb6-4586-b767-45b5f77e0d42")broker_services_plans_id: "<SERVICE_BROKER_SERVICES_PLANS_GUID>" # service-broker : service plan id (e.g. "b5e33932-8f87-4712-9776-887bfb73c584")bosh_client_id: "<BOSH_CLIENT_ID>" # service-broker : bosh client idbosh_client_secret: "<BOSH_CLIENT_SECRET>" # service-broker : bosh client secretbosh_url: "<BOSH_URL>" # service-broker : bosh url (e.g. "https://00.000.0.0:25555")bosh_oauth_url: "<BOSH_OAUTH_URL>" # service-broker : bosh oauth url (e.g. "https://00.000.0.0:8443")# API-GATEWAYapi_gateway_azs: [z3] # api-gateway : azsapi_gateway_instances: 2 # api-gateway : instances (N)api_gateway_persistent_disk_type: "20GB" # api-gateway : persistent_disk_typeapi_gateway_public_ips: "<API_GATEWAY_PUBLIC_IPS>" # api-gateway : public ips (e.g. ["00.00.00.00" , "11.11.11.11"])api_gateway_admin_password: "<API_GATEWAY_ADMIN_PASSWORD>" # api-gateway : api-gateway super admin password (e.g. "admin!Service")
Deploy 스크립트 파일을 서버 환경에 맞게 수정한다.
= vSphere : -o manifests/ops-files/vsphere-network.yml
= AWS : -o manifests/ops-files/aws-network.yml
= OpenStack : -o manifests/ops-files/openstack-network.yml
= Azure : -o manifests/ops-files/azure-network.yml
= GCP : -o manifests/ops-files/gcp-network.yml
# Deploy 스크립트 수정$ vi ~/workspace/paasta-5.0/deployment/service-deployment/paasta-api-gateway-service/deploy-paasta-api-gateway-service.sh#!/bin/bash# VARIABLESDEPLOYMENT_NAME="paasta-api-gateway-service"BOSH2_NAME="micro-bosh"# DEPLOYbosh -e ${BOSH2_NAME} -n -d ${DEPLOYMENT_NAME} deploy --no-redact manifests/${DEPLOYMENT_NAME}.yml \-o manifests/ops-files/vsphere-network.yml \-l manifests/vars.yml \-v deployment_name=${DEPLOYMENT_NAME}
애플리케이션 Gateway 서비스를 배포한다.
# 애플리케이션 Gateway 서비스 Deploy (e.g AWS)$ cd ~/workspace/paasta-5.0/deployment/service-deployment/paasta-api-gateway-service$ sh ./deploy-paasta-api-gateway-service.shUsing environment '10.0.1.6' as client 'admin'Using deployment 'paasta-api-gateway-service'+ azs:+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z1+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z2+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z3+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z4+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z5+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z6+ - cloud_properties:+ availability_zone: ap-northeast-2a+ name: z7... ((생략)) ...+ disk_size: 500000+ name: 50GB_GP2+ stemcells:+ - alias: default+ os: ubuntu-xenial+ version: '315.64'+ releases:+ - name: paasta-api-gateway-service+ version: '1.0'+ update:+ canaries: 1+ canary_watch_time: 30000-600000+ max_in_flight: 1+ serial: true+ update_watch_time: 10000-600000... ((생략)) ...+ instance_groups:+ - azs:+ - z3+ instances: 1+ jobs:+ - name: mariadb+ properties:+ database:+ admin_password: "<redacted>"+ broker:+ password: "<redacted>"+ username: "<redacted>"+ port: "<redacted>"+ release: paasta-api-gateway-service+ name: mariadb+ networks:+ - name: default+ persistent_disk_type: 10GB+ stemcell: default+ update:+ max_in_flight: 1+ vm_type: medium+ - azs:+ - z3+ instances: 1+ jobs:+ - name: service-broker+ properties:+ bosh:+ client:+ id: "<redacted>"+ secret: "<redacted>"+ deployment_name: "<redacted>"+ oauth_url: "<redacted>"+ url: "<redacted>"+ logging:+ level_broker: "<redacted>"+ level_hibernate: "<redacted>"+ port: "<redacted>"+ service:+ admin_password: "<redacted>"+ services:+ id: "<redacted>"+ plans:+ id: "<redacted>"+ release: paasta-api-gateway-service+ name: service-broker+ networks:+ - name: default+ stemcell: default+ update:+ max_in_flight: 1+ vm_type: medium+ - azs:+ - z7+ instances: 2+ jobs:+ - name: api-gateway+ properties:+ service:+ admin_password: "<redacted>"+ release: paasta-api-gateway-service+ name: api-gateway+ networks:+ - default:+ - dns+ - gateway+ name: default+ - name: vip+ static_ips:+ - 13.124.4.62+ - 52.78.10.153+ persistent_disk_type: 20GB+ stemcell: default+ update:+ max_in_flight: 1+ vm_type: medium+ name: paasta-api-gateway-serviceTask 52Task 52 | 11:35:34 | Preparing deployment: Preparing deployment (00:00:02)Task 52 | 11:35:36 | Preparing deployment: Rendering templates (00:00:00)Task 52 | 11:35:36 | Preparing package compilation: Finding packages to compile (00:00:00)Task 52 | 11:35:36 | Creating missing vms: mariadb/5b19e4ba-ea0b-4e76-b37b-8e6c991907ef (0)Task 52 | 11:35:36 | Creating missing vms: service-broker/6bcc651a-f94e-4b38-aee7-3640407315b6 (0)Task 52 | 11:35:36 | Creating missing vms: api-gateway/de1608fc-e254-40fd-a190-4d9366b50658 (0)Task 52 | 11:35:36 | Creating missing vms: api-gateway/248133ba-73e4-4fd5-bf29-834cd4345f33 (1)Task 52 | 11:36:44 | Creating missing vms: service-broker/6bcc651a-f94e-4b38-aee7-3640407315b6 (0) (00:01:08)Task 52 | 11:36:45 | Creating missing vms: api-gateway/248133ba-73e4-4fd5-bf29-834cd4345f33 (1) (00:01:09)Task 52 | 11:36:51 | Creating missing vms: mariadb/5b19e4ba-ea0b-4e76-b37b-8e6c991907ef (0) (00:01:15)Task 52 | 11:36:52 | Creating missing vms: api-gateway/de1608fc-e254-40fd-a190-4d9366b50658 (0) (00:01:16)Task 52 | 11:36:52 | Updating instance mariadb: mariadb/5b19e4ba-ea0b-4e76-b37b-8e6c991907ef (0) (canary) (00:02:21)Task 52 | 11:39:13 | Updating instance service-broker: service-broker/6bcc651a-f94e-4b38-aee7-3640407315b6 (0) (canary) (00:00:41)Task 52 | 11:39:54 | Updating instance api-gateway: api-gateway/de1608fc-e254-40fd-a190-4d9366b50658 (0) (canary) (00:02:13)Task 52 | 11:42:07 | Updating instance api-gateway: api-gateway/248133ba-73e4-4fd5-bf29-834cd4345f33 (1) (00:01:59)Task 52 Started Wed Nov 6 11:35:34 UTC 2019Task 52 Finished Wed Nov 6 11:44:06 UTC 2019Task 52 Duration 00:08:32Task 52 doneSucceeded
배포된 애플리케이션 Gateway 서비스를 확인한다.
$ bosh -e micro-bosh -d paasta-api-gateway-service vmsUsing environment '10.0.1.6' as client 'admin'Task 53. DoneDeployment 'paasta-api-gateway-service'Instance Process State AZ IPs VM CID VM Type Activeapi-gateway/248133ba-73e4-4fd5-bf29-834cd4345f33 running z7 10.0.0.123 i-0e7eee082646e7097 medium true52.78.10.153api-gateway/de1608fc-e254-40fd-a190-4d9366b50658 running z7 10.0.0.122 i-0e457a121da8afaa8 medium true13.124.4.62mariadb/5b19e4ba-ea0b-4e76-b37b-8e6c991907ef running z3 10.0.81.122 i-0d7296803b6a2d36e medium trueservice-broker/6bcc651a-f94e-4b38-aee7-3640407315b6 running z3 10.0.81.123 i-043331991d8beeda7 medium true4 vmsSucceeded
애플리케이션 Gateway 서비스의 배포가 완료 되면, PaaS-TA 포탈에서 서비스를 사용하기 위해 애플리케이션 Gateway 서비스 브로커를 등록해 주어야 한다. 서비스 브로커 등록 시에는 개방형 클라우드 플랫폼에서 서비스 브로커를 등록 할 수 있는 권한을 가진 사용자로 로그인 되어 있어야 한다.
서비스 브로커 목록을 확인한다
$ cf service-brokers
Getting service brokers as admin...name urlNo service brokers found애플리케이션 Gateway 서비스 브로커를 등록한다.
$ cf create-service-broker [SERVICE_BROKER] [USERNAME] [PASSWORD] [SERVICE_BROKER_URL]
[SERVICE_BROKER] : 서비스 브로커 명
[USERNAME] / [PASSWORD] : 서비스 브로커에 접근할 수 있는 사용자 ID / PASSWORD
[SERVICE_BROKER_URL] : 서비스 브로커 접근 URL
### e.g. 애플리케이션 Gateway 서비스 브로커 등록$ cf create-service-broker api-gateway-service-broker admin cloudfoundry http://10.0.81.123:8080Creating service broker api-gateway-service-broker as admin...OK등록된 애플리케이션 Gateway 서비스 브로커를 확인한다.
$ cf service-brokers
Getting service brokers as admin...name urlapi-gateway-service-broker http://10.0.81.123:8080애플리케이션 Gateway 서비스의 서비스 접근 정보를 확인한다.
$ cf service-access -b api-gateway-service-broker
Getting service access for broker api-gateway-service-broker as admin...broker: api-gateway-service-brokerservice plan access orgsapi-gateway dedicated-vm none애플리케이션 Gateway 서비스의 서비스 접근 허용을 설정(전체)하고 서비스 접근 정보를 재확인 한다.
$ cf enable-service-access api-gateway $ cf service-access -b api-gateway-service-broker
$ cf enable-service-access api-gatewayEnabling access to all plans of service api-gateway for all orgs as admin...OK$ cf service-access -b api-gateway-service-brokerGetting service access for broker api-gateway-service-broker as admin...broker: api-gateway-service-brokerservice plan access orgsapi-gateway dedicated-vm all
PaaS-TA 운영자 포탈을 통해 애플리케이션 Gateway 서비스를 등록 및 공개하면, PaaS-TA 사용자 포탈을 통해 서비스를 신청 하여 사용할 수 있다.
PaaS-TA 운영자 포탈에 접속하여 애플리케이션 Gateway 서비스를 등록한다.
※ 운영관리 > 카탈로그 > 앱서비스 등록
이름 : 애플리케이션 Gateway 서비스
분류 : 개발 지원 도구
서비스 : api-gateway
썸네일 : [애플리케이션 Gateway 서비스 썸네일]
서비스 생성 파라미터 : password / 패스워드
앱 바인드 사용 : N
공개 : Y
대시보드 사용 : Y
온디멘드 : N
태그 : paasta / tag1, free / tag2
요약 : 애플리케이션 Gateway 서비스
설명 : API 등록 및 API 라이프 사이클 관리등의 기능을 제공하는 애플리케이션 Gateway 서비스인 WSO2 서비스를 dedicated 방식으로 제공합니다. 서비스 관리자 계정은 serviceadmin/<서비스 신청 시 입력한 Password> 입니다.
PaaS-TA 사용자 포탈에 접속하여, 카탈로그를 통해 애플리케이션 Gateway 서비스를 신청한다.
대시보드 URL을 통해 서비스에 접근한다. (서비스의 관리자 계정은 serviceadmin/[서비스 신청시 입력받은 패스워드])
애플리케이션 Gateway 서비스 대시보드
애플리케이션 Gateway 서비스(WSO2) 참고 자료
Last updated 11 months ago