手軽にPythonにUIを追加してアプリケーションを作成できるStremlitを使い始めています。ローカルで実行できるので開発やテストは問題ないのですが、できあがったアプリを他の人に見てもらうにはどこかにデプロイする必要があります。
StremlitではStremlitSharingというStremlitの専用の公開サイトがあるのでそこへ手軽にデプロイできるのですが、他のデプロイ先も試してみようと思います。
Herokuとかへのデプロイする情報が多いのですが、今回はあまり情報のないIBM Cloud Code Engineへのデプロイを試してみました。
事前チェック
下記のものを準備しておいてください。
- IBM Cloud アカウント (ライトアカウント以上）
- GitHub アカウント
- Git CLI
IBM Cloud
IBMのクラウドサイトです。企業向けに力を入れてる感じです。開発したアプリケーションをデプロイする方法としてはいろいろあるのですが、昨年2021年に、Code Engineというサーバーレスランタイム環境が正式公開されたのでこちらを試してみます。
Code Engine
IBM Cloud Code Engine
サーバーレスのコンテナ、アプリケーションコード、バッチを実行できる環境として提供されています。開発者がサーバーとかインフラとか意識せずにアプリケーションを公開できる環境として便利ですね。
ここにアプリケーションをデプロイする方法としてはあらかじめDockerイメージを作成する方法とGithubに配置したソース・ファイルを元にしてDockerイメージを作成してデプロイする方法があります。（HerokuとかStremlitSharingと同じような使い方というとGithubソースの方なのでこちらをやってみます。）
Github準備
サンプルソースの準備
作成したソース・ファイルをGithubで公開します。参照してください。
https://github.com/saboten10/simple_streamlit
必要なものは下記の３つのファイルになります。
- python program file
- Dockerfile
- requirement.txt
Dockerfileの説明
IBM Cloude Code Engineへデプロイするのに必要となるDockerfileになります。Dockerイメージファイルのサイズが気になる人はSlimも利用できます。
# For more information, please refer to https://aka.ms/vscode-docker-python
# you can reduce the docker image size by using python:3.x-slim-buster
#FROM python:3.8
FROM python:3.8-slim-buster
# Keeps Python from generating .pyc files in the container
ENV PYTHONDONTWRITEBYTECODE=1
# Turns off buffering for easier container logging
ENV PYTHONUNBUFFERED=1
# for python:fullpackage
RUN apt-get update && apt-get upgrade -y
WORKDIR /app
# Exposing default port for streamlit
EXPOSE 8501
# Install requirements
COPY requirements.txt .
RUN pip install -r requirements.txt
#RUN python -m pip install -r requirements.txt
# Copy necessary files
COPY . /app
# Creates a non-root user with an explicit UID and adds permission to access the /app folder
# For more info, please refer to https://aka.ms/vscode-docker-python-configure-containers
RUN adduser -u 5678 --disabled-password --gecos "" appuser && chown -R appuser /app
USER appuser
# Launch app when container is run
CMD streamlit run sample1.py
Code Engine準備
IBM Cloud上の操作方法を順を追って説明します。
Code Engineのアクティベート
IBM Cloudのカタログの中のCotainerの中にCode Engineがあります。
デプロイ操作
Githubにアップロードされているソースコードを元にIBM Cloud Code Engineへデプロイする方法を最初から手順を順番にやっていきます。
ソース・コードから始める
Code EngineのスタートページにDockerイメージから始めるか、ソースコードから始めるか選ぶところがあるのでソースコードを選択してください。
ソースコードリポジトリには自分のGithubのソースコードリポジトリを指定します。自分のはパブリックにしていますが非公開でも対応できます。
ソースコードリポジトリに自分のGithubを指定して、「作成の開始」ボタンを押します。
作成の開始
なんか翻訳が変なのかな、日本語的におかしな感じがしますが作成するアプリケーションの情報を入れていきます。
上から順番に指定していきます。
アプリケーション名:simple-streamlit-application-20220130
としておきます。アンダーバーが使えないので注意してください。
プロジェクトの作成ボタンを押すと画面の右側に次のような画面が出てきます。
アプリケーションの作成
なんかプロジェクトがロードできないとかエラーが出たのでCode Engineのメニューから作成したプロジェクトを選択してアプリケーションの作成を選択
※本当はこのまま進めるはずです。
赤枠部分を入力して、「ビルド詳細の指定」ボタンを押す。
ビルド詳細の指定画面が出てくるのでブランチ名を「master」として「次」へ
その後はディフォルトのまま進むと作成するDockerイメージを格納するリポジトリが作成されて元の画面に戻ります。
ビルドとデプロイの実行
いよいよ「作成」ボタンを押します。
イメージビルドから始まって、成功すると自動的に環境へデプロイまで進みます。
「準備完了」が表示されるとデプロイが完了してアプリケーションの準備ができました。
アプリケーションの実行
アプリケーションのテストを押して、「アプリケーションのURL」を押すと対象のURLへアクセスされます。
はい、作成したStreamlitアプリケーションが表示されました！！
おつかれさまでした。
これでアプリケーションをデプロイする環境ができたので、もとのGithub側を変更してビルド、デプロイすればアプリケーションを変更することもできます。
今回のサンプルはStreamlitのタイトルとマークダウンしか出力していないシンプルなプログラムですがベースはできましたので自分のコードで試してみてください。
お金の話
IBM Cloud Code Engineはクレジットカードを登録したライトアカウント以上で利用できます。
費用のページに詳細が書かれていますが、
- 作成したDockerイメージを格納するレジストリが512MBまでは無料ですが、それ以上だと無料プランからアップグレードする必要があります。この場合は超過した容量が有料（今回のサンプルは273MBなので無料枠です）
- 同じくレジストリからPULLする容量にも制限があります。月間5GB以内が無料枠、それ以上は同じくアップグレードが必要（従量課金）
- 作成したアプリケーションについてもヒット数によって課金です。月間で10万アクセスなのでテストプログラムとかならまぁ大丈夫かな。
実際、今回のDockerファイルではslimイメージを指定しているけど、普通にStreamlitでイメージ作ったら512MBを超えちゃってる。
はみ出した費用はわずかだけど完全に無料でやりたいよね。
終わりに
今回はPythonで手軽にUIを作成できるStremlitをIBM Cloudへデプロイする方法について書きました。
- Streamlit Sharing (Streamlit Cloud)
- Heroku
- IBM Cloud
とデプロイを試してきましたがStremlit SharingはStremlitを使ったアプリのみが対象でGithub側のソースはパブリック公開しておかないといけないです。それに対してHeroku、IBM CloudはStremlit以外でも大丈夫ですし、ソースコードもパブリック公開する必要はないのでソースを公開したくない人には選択肢としていいと思います。
特にIBM Cloudには他にもたくさんのサービスがあるのでそれを利用したPythonアプリケーションを作成するのであれば今回のIBM Cloud Code Engineにデプロイするメリットはあると思います。
（もちろんIBM Cloud Code EngineからAzureとかGoogleとか他のAPIも呼び出すことはできます。）