Flask + Gunicorn with Docker

가끔 유지보수 하고 있던 node.js 기반의 텔레그램 봇에서 파이썬을 도입하게 되었다. 그 이유는, 봇의 특정 기능 중 요약문을 제공하는 기능을 필요로 했었고, Komoran + TextRank 알고리즘 기반으로 구성하는 것이 그나마 빠르게 진행할 수 있었기 때문이었다.

다만, 다른 곳에서 해당 기능을 사용하므로 api로 배포할 필요가 있었고, 전체적인 구조는 다음과 같다.

  • 텔레그램 봇 —> Textrank API —> TextRank Analyzer

이 중, API를 사용하기 위해 Flask-RESTFul 를 사용하고, 배포는 Python WSGI 웹 서버인 Gunicorn 를 사용했다.

이 글에서는 TextRank Analyzer 를 API로 expose 하고, Docker로 배포하는 과정을 정리한다.

API 연결

먼저, TextRank 알고리즘 수행을 위해 외부에서 받아 와야 할 정보들에 대해 정리가 필요하다.

  • 요약할 문장 (필수값)
  • 최대 요약할 문장 갯수 (기본값 3)
  • 최대 요약할 키워드 갯수 (기본값 3)
  • PageRankDamping Factor 값 → 사용자가 클릭을 중단할 확률. 기본값 0.85
  • 최상위에 랭크된 문장과 그 다음 문장 간의 최소 코사인 거리. 기본값 0.3
  • 허용 단어 빈도 (최소 n번 사용된 문장을 선택하나 m번 이상 사용된 문장은 사용하지 않음). 기본값 3, 20
  • 최소 문장 단어 수 (최소 n개 단어를 사용한 문장을 사용하나 m개 이상 단어가 사용되면 사용하지 않음). 기본값 10, 80

이제, 이 값들을 body로 받아 보관해야 하는데, Flask-RESTFul 는 reqparse 라는 기능을 제공한다.

이는 argument parsing 에 많이 쓰이는 argparse 와 비슷한 사용법을 가지면서도 사용자의 post body 를 해석하는 기능을 제공한다.

사용법은 `parser.add_argument(name, type) 이고, required 여부나 default 도 지정할 수 있다.

이를 반영한 API 클래스는 다음과 같을 것이다.

class TextRank(Resource):
    def post(self):
        try:
            parser = reqparse.RequestParser()
            parser.add_argument('body', type=str, required=True) 
            parser.add_argument('sentenceCount', type=int, default=3, required=False) 
            parser.add_argument('keywordCount', type=int, default=5, required=False)  
            parser.add_argument('beta', type=float, default=0.85, required=False) 
            parser.add_argument('diversity', type=float, default=0.3, required=False)  
            parser.add_argument('minWordCount', type=int, default=3, required=False)  
            parser.add_argument('maxWordCount', type=int, default=20, required=False)  
            parser.add_argument('minSentencePenalty', type=int, default=10, required=False) 
            parser.add_argument('maxSentencePenalty', type=int, default=80, required=False) 
            args = parser.parse_args()

            ...

            return {
                'code': '1',
                'message': 'Success',
                'sentence': sentence,
                'keyword': keywords
            }

        except Exception as e:
            return {'code': -1, "message": 'Failed ' + str(e)}

만들어진 TextRank 클래스를 Flask에 연결하게 되면, 지정한 routing 에 따라 API가 호출된다.

app = Flask(__name__)
api = Api(app)
api.add_resource(TextRank, '/summarize')

if __name__ == '__main__':
    app.run(port=8000)

이와 같이 작성하고 Run을 하여 127.0.0.1:8000/summarize 로 API 요청을 보내면 결과가 나오게 된다.

Gunicorn 배포

python3 server.py 로 서버를 실행시킬 수 있지만, 이는 development 기준으로 배포용도에는 맞지 않다.

실제로, 위 명령어로 배포하게 되면 아래와 같은 메세지가 나오게 된다.

* 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:8000/> (Press CTRL+C to quit)

요점은 production WSGI server 를 사용하라는 것이다. 여기서 WSGI 는 PEP-3333 에 정의된 파이썬 웹 서버 게이트웨이로, 파이썬 스크립트가 웹 서버와 통신하기 위해 작성된 인터페이스라고 설명할 수 있다.

여기서는 상기하였듯이 Gunicorn 를 사용했고, 사용법은 다음과 같다.

gunicorn server:app

여기서 server:app 는 각각 Flask를 담고 있는 파이썬 스크립트와 Flask 로컬 변수를 의미한다.

명령어를 입력하면 아래와 같은 로그가 나오게 된다.

% gunicorn server:app
[2020-02-15 13:15:14 +0900] [38332] [INFO] Starting gunicorn 20.0.4
[2020-02-15 13:15:14 +0900] [38332] [INFO] Listening at: <http://127.0.0.1:8000> (38332)
[2020-02-15 13:15:14 +0900] [38332] [INFO] Using worker: sync
[2020-02-15 13:15:14 +0900] [38336] [INFO] Booting worker with pid: 38336

기본적으로 127.0.0.1 (loopback) 주소에만 대응하고 있는데, 이를 도커 등으로 활용하려면 0.0.0.0:8000 등으로 port만 지정할 필요가 있다.

이는 -b 0.0.0.0:8000 으로 지정할 수 있고, 최종 명령어는 다음과 같다.

gunicorn -b 0.0.0.0:8000 server:app

이를 실행하면 다음과 같이 나온다.

% gunicorn -b 0.0.0.0:8000 server:app
[2020-02-15 13:16:04 +0900] [38387] [INFO] Starting gunicorn 20.0.4
[2020-02-15 13:16:04 +0900] [38387] [INFO] Listening at: <http://0.0.0.0:8000> (38387)
[2020-02-15 13:16:04 +0900] [38387] [INFO] Using worker: sync
[2020-02-15 13:16:04 +0900] [38391] [INFO] Booting worker with pid: 38391

Docker 배포

위 gunicorn 을 사용해 Dockerfile로 만들면 다음과 같을 것이다.

FROM ubuntu
WORKDIR /usr/src/app
RUN rm -rf /var/lib/apt/list/* && apt-get update && apt-get install python3 python3-pip -y
ADD . .
RUN pip3 install -r requirements.txt
EXPOSE 8000
CMD ["gunicorn", "-b", "0.0.0.0:8000", "server:app"]

간단히, python 과 python3-pip 를 설치하고 모든 파일을 복사하여 requirements.txt 에 적힌 항목을 전부 설치한다. 마지막으로, 포트 8000를 expose 하여 gunicorn를 실행한다.

Deploy React App by Docker 삽질기

처음 React로 토이 프로젝트를 진행하면서, Docker로 배포하면서 삽질한 기록을 정리해둔다.

1. 개발 환경에서는 npm start로 작동하지만…

RUN npm install
RUN npm run build
ENTRYPOINT ["npm", "start"]

처음에는 위의 단순한 코드로 Docker 컨테이너를 생성하고 올렸지만, Firefox에서 이상한 메세지가 나왔다.

이를 보니 Firefox에서는 https:// 에서 ws:// 로 이동하는 것이 Firefox에서는 불가능하다고 되어있다고 한다. (https://stackoverflow.com/questions/11768221/firefox-websocket-security-issue/12042843#12042843)

라이브러리 상 문제긴 하였지만, DevTools 를 실제 서버에 올리는 것도 문제가 되었기에 아래처럼 개발용일 때에만 DevTools와 Logger를 사용하도록 수정했다.

import rootReducer from "./reducers/RootReducer";

const middlewares = [];
let enhancer: any;

if (process.env.NODE_ENV === "development") {
 const createLogger = require("redux-logger").createLogger;
 const logger = createLogger();
 middlewares.push(logger);
 const compose = composeWithDevTools({
   trace: true,
   traceLimit: 100
});
 enhancer = compose(applyMiddleware(...middlewares));
}

const store = createStore(rootReducer, enhancer);
const rootElement = document.getElementById("root");

2. Production build로 올리기

1번에서 사용하던 Dockerfile로는 개발 빌드로 계속 올라가서, react-scripts build 로 빌드를 시도했을 때, 아래의 메세지가 나온다.

...
You can control this with the homepage field in your package.json.  
For example, add this to build it for GitHub Pages:

"homepage" : "...",

The build folder is ready to be deployed.
You may serve it with a static server:

npm install -g serve
serve -s build

Find out more about deployment here:

bit.ly/CRA-deploy

물론, 정석은 nginx를 올리는 것이지만 이미 서버의 앞단에 nginx가 reverse-proxy로 자리잡고 있어 단순히 static page를 올리는 것에서는 본문에 있는 serve 가 좀 더 적합해 보였다. https://github.com/zeit/serve

이를 Dockerfile로 반영하면 다음과 같았다.

RUN npm install
RUN npm i -S serve
RUN npm run-script build
ENTRYPOINT [ "serve" "-s" "build" ]

단, 이렇게 했을 때 [“serve” 를 path 에서 찾을 수 없다는 에러가 나오게 되는데, 이는 기본적으로 ENTRYPOINT 및 CMD가 /bin/sh 로 작업을 실행하기 때문에 찾을 수 없다는 로그다.

따라서 이를 해결하기 위해 직접 node_modules 에 있는 바이너리를 참조할 필요가 있다.

EXPOSE 5000

RUN npm install
RUN npm i -S serve
RUN npm run-script build
ENTRYPOINT [ "./node_modules/.bin/serve", "-s", "build" ]

이렇게 하고 빌드하니 정상적으로 실행이 되었고, nginx로 reverse proxy 연결해주니 도메인으로 접속할 수 있었다.

2019 회고

2019년의 몇 일이 남지 않은 지금, 2019년에 있었던 일을 아주 간단히 되돌아보고자 합니다.

간단 Life 요약

  • 병역특례를 끝내고, 카카오뱅크에 이직을 성공했습니다.
  • 처음으로 현지 라이브를 가보았습니다. > Rausch und/and Craziness

올 해 관심있던 기술은?

  • 전체적으로 안드로이드 보다는 다른 분야에 좀 더 관심이 있던 해 라고 평가할 수 있습니다. (그렇다고 안드로이드를 소홀히 한 건 전혀 아닙니다 (._. ;;
  • 이번 년도에는 잉여로운(?) 작품을 많이 만든 것 같습니다. 이 중에는 오픈소스가 차마 불가능한(._. 아이들도 많습니다.

기타 기억나는 것들

  • 블로그를 호스팅하고 있는 UzukiLive 서버가 Vultr (작년 12월) > Lightsail > EC2 > Vultr High compute 로 두 번 가량 이전을 했습니다. 이유는 가격 때문이었는데, 결국에는 이전부터 믿고 사용했던 Vultr로 다시 회귀했습니다.
    • 그래도 이전부터 서버에서 호스팅 하고 있는 모든 서비스를 Docker 기반으로 구성했으니, 이전 할 때 마다 시간이 오래 걸린 것은 아니란 것에 위안을 두고 있습니다.
    • 이에 맞춰, DNS도 DNSEver 에서 Cloudflare로 전환했습니다.

반성점

  • 예전보다 삽질한 것에 대해 정리하는 빈도가 매우 줄은 것 같습니다. 그로 인해 블로그 투고 분기도 줄어드는 것 같고요.
  • 코딩하는 시간이 예전보단 적었던 것 같습니다. 작년엔 8시간이 기본이었는데, 올 해에는 보통 3~4시간만 하고 쉬었던 것 같습니다.
    • 다만, 물리적인 시간이 줄었을 뿐이지 더 유익했다고 표현해도 괜찮을 것 같습니다.

내년의 목표

  • 스칼라로 배우는 함수형 프로그래밍 책을 정독하려고 합니다. 한 100페이지 읽고 그만둔 유일한 책인데, 이제는 좀 더 잘 이해할 수 있을 것 같습니다.
  • 회사 일도 하면서, 이번 년도와 같이 잉여로운 작품을 계속해서 만들어갈 생각입니다. 오픈소스가 가능하면 하면 좋고요.
  • 블로그 글은 한 달 1 ~ 2개 페이스로 유지하면서 점점 투고 빈도를 늘려갈 생각입니다.