Cloudant로 API 서버와 CouchDB를 배포하여 기후 등급 시스템 만들기

가정에서 친환경 에너지로 전환하면 기후에 실질적이고 상당한 영향을 미칠 수 있으나, 일반적으로 일반 가정보다는 산업 부문에서 더 많은 에너지를 사용합니다. 이와 같이 산업 부문에서 소비되는 에너지는 주로 우리가 구입하는 제품을 제조하는 데 사용됩니다. 일부 제품은 에너지 효율 등급이 표시되지만 제품 제조에 사용된 에너지의 양과 유형(예: 화석 에너지 또는 재생 에너지)에 대한 정보를 제공하는 장치는 없습니다. 여러 제조사의 제품에 대해 각 제품이 기후에 미치는 영향을 비교할 수 있다면 좋지 않을까요? 그리고, 에너지 외에도 물 소비량과 같이 기후에 영향을 주는 다른 요인에 관한 정보도 포함하면 좋을 것입니다. 그러려면 일종의 라벨링 시스템을 통해 제품에 포괄적인 기후 영향 등급을 표시하여 소비자에게 제시할 수 있어야 합니다. 매장이나 온라인 거래 시 판매 현장(POS, point-of-sale)에서 소비자가 볼 수 있는 포괄적 기후 영향 등급(CIR, Climate Impact Rating )을 포함하도록 기존 제품 라벨링 시스템을 확대하면 이러한 목적을 달성할 수 있을 것입니다.

이러한 기후 영향 등급에는 다음과 같은 정보가 포함될 수 있습니다:

  • 제품 사용 시 에너지 효율(이 정보는 현재 많은 제품에서 이미 제공되는 정보임)
  • 제품 생산에 사용된 에너지(및 에너지믹스), CO2 배출량 기준으로 표시할 수 있음
  • 제품의 예상 사용 수명(생산에 사용되는 에너지와 제품 사용 시 소비되는 에너지를 더 효과적으로 비교할 수 있음)
  • 제품 생산 시 CO2 외 기타 온실 가스 배출량(예: 비료로 인한 가스 배출)
  • 사용된 기타 자원(예: 제품 생산에 사용된 물)
  • 재활용 가능성
  • 복구 가능성(복구에 대한 권리(Right to Repair) 이니셔티브의 일환)

이러한 라벨링 시스템을 만들 때 해결해야 할 주요 과제는 무엇보다도 대상 소비자가 이해할 수 있도록 제작하고 포괄적인 정보를 포함해야 한다는 것입니다. 이러한 라벨은 현재의 에너지 효율 또는 식품 라벨과 같이, 결국에는 제품에 부착할 수 있을 것이라고 생각합니다. 그러나 우리는 이보다 먼저 스마트폰을 사용하여 판매 현장(POS)에서 바코드를 스캔하면 등급이 표시되는 시스템을 구현하고자 합니다.

또 다른 유용한 항목은 제품을 판매 현장(POS)까지 운송하는 과정에서 발생한 기후 영향에 대한 추정치입니다. 물론, 각 POS마다 발생한 영향이 다를 것이므로 이 정보는 제품에 표시할 수 없을 것입니다. 그러나 장소 정보를 바탕으로 온라인이나 스마트폰에서 조회하고 표시할 수는 있습니다.

이러한 라벨링 시스템을 만드는 일은 전 세계적으로 진행해야 할 대규모 작업이 될 것이며 이를 위해 기본적인 구성요소와 기술을 효과적으로 함께 활용하고 여러 가지 합의를 이끌어낼 수 있어야 할 것입니다. 2020 Call for Code 챌린지 에너지 부문에서 이러한 구성요소를 새로운 시도를 통해 확장하고 결합하여 이 종합 라벨링 시스템을 만들어 보시기를 바랍니다. 이 시스템의 구성요소는 여러 카테고리로 분류할 수 있습니다:

코어-아키텍쳐 제공된 스타터 킷을 사용하여 Consumer API를 지원하는 기본적인 시스템을 실행해 보세요.
등급 표시 CIR을 표시하는 새롭고 흥미로운 방법을 개발해 보세요. 예를 들면, 모바일 디바이스를 통한 증강 현실, 검색 엔진, 제품 목록 등을 활용할 수 있습니다.
데이터 사이언스 원시 데이터를 선택한 라벨에 반영할 수 있는 가장 좋은 방법은 무엇일까요? 소비자에게 숫자 목록만 보여주면 숫자가 전달하는 정보를 이해할 수 없을 것입니다. 원시 데이터를 가능한 한 적은 항목으로 어떻게 요약할 수 있을까요? 예컨대 배출된 CO2를 기준으로 에너지 사용량을 나타내는 것, 즉 에너지 사용량과 재생 에너지 사용량을 결합하는 것과 이 정보를 별도로 제시하는 것 중 어느 방법이 더 나을까요? 제품의 사용 수명은 길지만 제품 생산에 많은 에너지가 사용된다면, 에너지가 적게 들고 사용 수명이 짧은 제품을 만드는 것보다 더 나을까요? 정보를 서버 측에 배치(즉, 출력을 API가 반환한 제품 정보에 포함)하거나 클라이언트 측에서 실행하면서, 알고리즘으로 여러 가지 시도를 해볼 수 있습니다. 이와 별도로, 많은 수의 제품에 대한 세부 정보를 제시하기 전에 요약 데이터(예: 국가/지역별 CO2 배출량)를 어떻게 포함할 수 있을까요?
라벨 디자인 여러 가지 디자인을 시도해 보고(사용자 테스트도 수행할 수 있음) 포괄적인 정보를 제공하는 동시에 소비자가 이해할 수 있는 라벨 디자인을 제안해 보세요. 식품 라벨과 기존의 에너지 등급 라벨을 참고하세요.
추가 스토리보드 제조업자, 관리자, 감사자 등의 사용자를 위한 추가 스토리보드(그리고 인터페이스)를 개발해 보세요.

에너지 부문에 대한 2020 Call for Code 챌린지를 위해, 본 튜토리얼이 제공하는 스타터 킷을 살펴보고 Consumer API를 지원하는 기본적인 시스템을 실행해 보시기 바랍니다. 여러분이 더 나은 아키텍처를 개발할 수도 있을 것입니다. 아니면, 위에 제시한 구성요소 중에서 몇 가지를 추가해 보는 것은 어떨까요?

참고: 이 솔루션 스타터는 2020년 2월 27일부터 28일까지 스위스 제네바 국제연합 인권 사무소(United Nations Human Rights Office)에서 처음 작성되었으며, 이후 4주 동안 보완 작업을 거쳤습니다. JPMorgan Chase, Persistent Systems, IBM 및 Red Hat의 기술 전문가가 이 스타터 제작에 기여했습니다.

학습 목표

이 튜토리얼은 소비자 API를 지원하는 프로토타입 기후 영향 등급 시스템을 프로비저닝하는 방법을 보여주는 솔루션 스타터를 제공합니다. 이 튜토리얼은 추가적인 기후 등급 구성요소를 확장하면서 여러 가지 새로운 시도를 할 수 있도록 기본적인 아키텍처를 제공하며 다음 요소를 포함합니다:

  • 개별 제품 등급을 포함하는 NoSQL 데이터베이스 레이어인 CouchDB.
  • 데이터를 데이터베이스에 삽입하고 데이터베이스에서 추출하도록 지원하는 기본 API 서버. 이 API는 OpenAPI(Swagger) 문서로 표현되어 있으므로 사용자가 원하는 클라이언트를 구축할 수 있음.
  • 무료 티어 플랜 안에서 위의 요소들을 IBM Cloud에서 작동시키는 배포 도구.

이 데이터베이스에는 처음 시작할 때 사용할 수 있는 예시 데이터가 포함되어 있습니다.

Architecture diagram

  1. 사용자가 앱으로 제품 바코드를 스캔하고 앱은 바코드 ID를 사용하여 기후 영향 등급 API를 호출합니다.
  2. 기후 영향 등급 API가 바코드 ID에 해당되는 등급 데이터를 검색합니다.
  3. 기후 영향 등급 API가 등급 데이터를 반환하면 앱이 적절한 형식으로 표시합니다.
  4. 제조업체는 기후 영향 등급 API를 통해 제품 및 등급 데이터를 업로드합니다(예약된 포털 사용 가능).
  5. 향후, Climate Impact Analyzer가 백그라운드에서 실행되면서 더 폭넓게 등급에 대한 쿼리를 API가 수행할 수 있도록 요약 데이터를 생성합니다.

수강 전 준비사항

HTTP를 통해 API를 호출하는 방법을 기본적으로 이해하고 있어야 합니다. 또한, OpenAPI(Swagger) 사용 방법에 대해 알아 두면 좋습니다. 그리고, IBM Cloud 계정이 필요하며 로컬 머신에 최신 IBM Cloud 툴이 설치되어 있어야 합니다.

예상 소요 시간

이 튜토리얼을 완료하는 데 약 30분이 소요됩니다.

단계

1

단계: 저장소 복제하기

로컬 컴퓨터에 API 서버 복제본을 저장할 수 있도록 저장소를 복제(cloning)합니다:

git clone https://github.com/Call-for-Code/Solution-Starter-Kit-Energy-2020.git

Solution-Starter-Kit-Energy-2020 이라는 디렉토리가 생성되고 이 디렉토리 안에 API 서버의 소스를 포함하는 example 디렉토리가 생성됩니다.

2

단계: Cloudant를 사용하여 CouchDB 인스턴스 프로비저닝하기

IBM Cloud에 로그인한 다음 Coudant를 사용하여 CouchDB 인스턴스를 프로비저닝합니다. 카탈로그에서 데이터베이스와 Cloudant 패널을 선택합니다.:

Cloudant Instance

그런 다음, Cloudant 플랜을 선택할 수 있습니다. 간단한 테스트를 위한 무료 티어가 있는데 이 CIR 예시를 실행하기에 충분합니다. 적절한 지역을 선택하고 서비스의 이름을 지정해야 합니다. 그리고 Available authentication methods 아래 Use only IAM 을 선택하는 것이 좋습니다. 다른 항목은 기본 설정을 유지해도 됩니다. 준비가 되면 파란색 Create 버튼을 클릭합니다.

Cloudant Instance 2

Cloudant 인스턴스를 생성한 다음 CIR API 서버가 통신을 위해 사용할 수 있도록 서비스 자격 증명을 만들어야 합니다. 실행 중인 Cloudant 인스턴스를 선택하면 왼쪽 메뉴에서 Service credentials를 선택할 수 있습니다.:

Cloudant Credentials

새로운 서비스 자격 증명을 생성하고 이름을 지정합니다(이름은 원하는 대로 지정 가능):

Cloudant Credentials 2

서비스 자격 증명이 생성되면 view service credentials를 선택하여 자격 증명을 확인할 수 있습니다. 이 자격 증명을 복사하여 다음 단계에서 API 서버 코드에 붙여넣기 할 수 있도록 준비해야 합니다:

Cloudant Credentials 2

3

단계: API 서버 준비하기

API 서버를 준비하려면 위의 단계에서 생성한 서비스 자격 증명을 붙여넣기 해야 합니다. 복제된 디렉토리에서 example/server.py 파일을 열면 파일 상단에 기존 자격 증명이 정의되어 있는 것을 볼 수 있습니다.:

API cred before

다음 예시와 같이 방금 생성한 자격 증명으로 기존 자격 증명을 변경해야 합니다:

API cred after

파일을 저장하면 API 서버를 실행할 준비가 완료됩니다!

4

단계: API 서버 실행하기

API 서버는 머신에서 로컬로 실행하거나 Docker 컨테이너에서 실행할 수 있습니다. 서버에는 python, flask, flaskrestx가 필요하므로 컨테이너에서 더 쉽게 실행할 수 있을 것입니다(Docker 파일이 제공됨).

Docker 컨테이너에서 API 서버 실행하기

머신에 docker가 설정된 경우 API 서버의 docker 이미지를 빌드하여 실행할 수 있습니다. 복제된 저장소의 example 디렉토리에서 아래 명령을 실행하세요:

docker build . -t cir-api-server
docker run -p 8080:8080 cir-api-server

docker 컨테이너의 flask 서버는 아래와 유사한 결과를 반환할 것입니다:

 * Serving Flask app "./server.py"
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)

그 다음, API를 http://0.0.0.0:8080에서 이용할 수 있습니다.

로컬에서 API 서버 실행하기

API 서버를 로컬에서 실행하려면 로컬 컴퓨터에 모든 의존성 패키지가 설치되어 있어야 합니다. 특정 의존성 패키지 설치를 위해 pipenv를 활성화 하는 Pipefile 이 제공됩니다. 그러려면 먼저 python(3.6.x 권장) 및 pipenv가 설치되어 있는지 확인해야 합니다. MacOS에서 이 작업을 수행하는 방법에 관한 예시가 아래에 있습니다:

brew install python
pip install --user pipenv
pipenv install

의존성 패키지가 설치 되었으므로 이제 (복제된 리포지토리의 example 디렉토리 안에서) API 서버를 실행할 수 있습니다

pipenv run python ./server.py

flask 서버는 아래와 유사한 결과를 반환할 것입니다:

 * Serving Flask app "server" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
5

단계: API 엔드포인트 테스트하기

API를 처음 실행하면 API 서버는 제품 CIR 데이터베이스를 생성하고 여러 가지 작업을 시도하는 데 사용할 수 있는 소량의 더미 데이터와 함께 업로드할 것입니다.

앞서 언급했듯이 로컬에서 실행하면 API는 127.0.0.1:5000에 게시되고 docker로 실행하면 API는 http://0.0.0.0:8080에 게시됩니다. API 서버는 또한 아래 루트 url에서 API에 대한 Swagger/OpenAPI 사양을 제공합니다:

Swagger Example

화면 상단의 swagger.json url을 클릭하면 swagger 사양을 추출할 수 있으며 Swagger/OpenAPI 툴링이 이 사양을 사용하여 선택한 언어로 클라이언트를 생성할 수 있습니다.

또한 curl을 사용하여 간단한 작업을 실행할 수 있습니다(로컬에서 실행할 경우 아래 예시에서와 같이 127.0.0.1:5000 을 url 엔드포인트로 변경하는 것을 잊지 마세요).

해당 바코드에 대한 제품 CIR을 검색하려면 쿼리 매개 변수와 함께 GET을 실행할 수 있습니다((로컬에서 실행할 경우 127.0.0.1:5000을 url 엔드포인트로 변경하는 것을 잊지 마세요):

curl "http://0.0.0.0:8080/v1/product?barcode_id=0125551234508"

그러면 아래와 유사한 결과가 반환됩니다:

[{"id": "0125551234508", "barcode_id": "0125551234508", "type": "AIR CONDITIONER", "category": "SPLIT AIR-CONDITIONER", "model": "A-890AM", "brand": "Brand - A", "rating_data": {"efficiency": 4, "energy": 44.66160323, "CO2": 46.61812622, "otherGG": 61.61812622, "water": 241.0, "plastic": 1327.42056, "lifetime": 20.0, "recyclability": 9, "repairability": null}}]

모든 제품을 검색하려면 간단히 GET을 실행하면 됩니다:

curl "http://0.0.0.0:8080/v1/product"

그러면 제품 목록이 반환될 것입니다.

새로운 제품 항목을 생성할 수도 있습니다

curl -d '{"barcode_id": "1125761234500", "type": "REFRIDGERATOR", "category": "FRIDGE_FREEZER", "model": "F-13876", "brand": "Brand - F", "rating_data": {"efficiency": 4, "energy": 44.66160323, "CO2": 46.61812622, "otherGG": 61.61812622, "water": 241.0, "plastic": 1327.42056, "lifetime": 20.0, "recyclability": 9}}' -X POST "http://0.0.0.0:8080/v1/product" -H "Content-Type: application/json"

요약

이 튜토리얼에서는 소비자 API를 지원하는 기본적인 시스템을 실행하는 방법을 보여주는 솔루션 스타터를 제공했습니다. 또한, 기후 등급 시스템을 구축하면서 여러 가지 새로운 시도를 할 수 있도록 기본적인 아키텍처도 제공했습니다.