Flask Mega-Tutorial、パートXVIII：Herokuでの展開

（2018年版）

ミゲル・グリンバーグ

ここに 戻る

これは、Flask Mega-Tutorialsシリーズの18番目のパートです。このシリーズでは、Herokuクラウドプラットフォームにマイクロブログをデプロイします。

ネタバレの下には、この2018年シリーズのすべての記事のリストがあります。

注1：このコースの古いバージョンをお探しの場合は、こちらをご覧ください 。

注2：私（ミゲル）の仕事を支持して突然声をかけたい場合、または1週間記事を待つ忍耐がない場合、私（ミゲルグリーンバーグ）はこのガイドの完全版（英語）を電子書籍またはビデオの形式で提供します。 詳細については、 learn.miguelgrinberg.comをご覧ください 。

前の記事で、Pythonアプリケーションをホストする「従来の」方法を紹介し、Linuxサーバーへのデプロイの2つの実例を紹介しました。 Linuxシステムを使用していない場合、そのような展開に費やされた労力は予想よりもわずかに多かったように思われます。もちろん、もっと簡単な方法があるはずです。

この章では、ほとんどの管理タスクをサードパーティのクラウドホスティングプロバイダーに依存するまったく異なるアプローチを紹介します。これにより、アプリケーション自体の作業により多くの時間を費やすことができます。

多くのクラウドホスティングプロバイダーは、Webアプリケーションを実行する管理プラットフォームを提供します。 これらのプラットフォームにアプリケーションをデプロイするために必要なのは、実際のアプリケーションだけです。ハードウェア、オペレーティングシステム、スクリプト言語インタープリター、データベースなどです。 サービスによって管理されます。 このタイプのサービスは、 Platform as a ServiceまたはPaaSと呼ばれます 。

音が良すぎて真実ではないでしょうか？

Pythonアプリケーションにも非常に便利な人気のクラウドサービスであるHerokuにMicroblogをデプロイします。 Herokuを選んだ理由は、人気があるだけでなく、無料レベルのサービスがあり、お金をかけずに私をフォローして完全な展開を完了することができるからです。

この章のGitHubリンク： Browse 、 Zip 、 Diff 。

Herokuでのホスティング

Herokuは、2007年6月に登場した最初のクラウドプラットフォームの1つで、当初はRubyプログラミング言語のみをサポートしていましたが、現在サポートされている言語のリストには、Java、Node.js、Scala、Clojure、Go、PHP、そしてもちろんPythonも含まれています。

Webアプリケーションは、 gitバージョン管理ツールを使用してHerokuにデプロイされるため、アプリケーションはgitリポジトリに存在する必要があります。 Herokuは、アプリケーションを起動する方法について、アプリケーションのルートディレクトリでProcfileというファイルを探します。 Pythonプロジェクトの場合、Herokuには、インストールする必要のあるすべてのモジュール依存関係のリストを含むrequirements.txtファイルが必要です。 アプリケーションがgitを介してHerokuサーバーにアップロードされた後、基本的にすべてを実行しました。アプリケーションがネットワークに表示されるまで数秒待つだけです。 本当に簡単です。

Herokuでは、必要な計算能力とアプリケーションに必要な時間に基づいてサービスレベルを選択できます。ユーザーベースが拡大するにつれて、Herokuが「dyno」と呼ぶ計算ユニットを追加購入する必要があります。

Herokuを試す準備はできましたか？ さあ始めましょう！

Herokuアカウントの作成

Herokuへのデプロイを完了する前に、アカウントを取得する必要があります。 そのため、 heroku.comにアクセスして無料アカウントを作成してください。 Herokuに登録してログインすると、すべてのアプリケーションが一覧表示されるダッシュボードにアクセスできます。

Heroku CLIをインストールする

Herokuは、Windows、Mac OS X、およびLinuxで利用可能なHeroku CLIと呼ばれるサービスと対話するためのコマンドラインを提供します 。 ドキュメントには、サポートされているすべてのプラットフォームのインストール手順が含まれています。 アプリケーションをデプロイしてサービスをテストする場合は、システムにインストールしてください。

CLIをインストールした後に最初に行うべきことは、Herokuアカウントにログインすることです。

 $ heroku login 

Heroku CLIは、メールアドレスとアカウントパスワードの入力を求めます。 認証されたステータスは、後続のコマンドで保存されます。

Gitセットアップ

gitツールは、アプリケーションをHerokuにデプロイするための基礎であるため、まだインストールしていない場合はシステムにインストールする必要があります。 ご使用のオペレーティングシステムで利用可能なパッケージがない場合は、git Webサイトにアクセスしてインストーラーをダウンロードできます。

プロジェクトにgitを使用する理由はたくさんあります。 Herokuにデプロイする予定がある場合、Herokuにデプロイするにはアプリケーションがgitリポジトリにある必要があるため、別のHerokuがあります。 マイクロブログのテスト展開を実行する場合は、GitHubからアプリケーションを複製できます。

 $ git clone https://github.com/miguelgrinberg/microblog $ cd microblog $ git checkout v0.18 

git checkoutコマンドは、この章に対応する履歴で特定のアプリケーション固定ポイントを選択します。

私のコードよりも独自のコードを使用したい場合は、 git init .実行して独自のプロジェクトをgitリポジトリに変換できますgit init . 最上位ディレクトリで（現在のディレクトリにリポジトリを作成するgitの指示であるinit後の点に注意してください）。

Herokuアプリケーションの作成

新しいアプリケーションをHerokuに登録するには、ルートディレクトリからapps:createコマンドを使用し、唯一の引数としてアプリケーションの名前を渡します。

 $ heroku apps:create flask-microblog Creating flask-microblog... done http://flask-microblog.herokuapp.com/ | https://git.heroku.com/flask-microblog.git 

Herokuでは、アプリケーションに一意の名前を付ける必要があります。 上記で使用したflask-microblogという名前は、既に使用しているため使用できません。そのため、別のデプロイメントを選択する必要があります。

このコマンドの出力で、Herokuがアプリケーションに割り当てたURLとそのgitリポジトリを取得します。 ローカルgitリポジトリには、 herokuと呼ばれるリモート接続セットアップが既にあります。 git remoteコマンドを使用して、存在することを確認できます。

 $ git remote -v heroku https://git.heroku.com/flask-microblog.git (fetch) heroku https://git.heroku.com/flask-microblog.git (push) 

gitリポジトリの作成方法によっては、上記のコマンドの出力にoriginという別のリモートソースが含まれることもあります。

エフェメラルファイルシステム

Herokuプラットフォームは、仮想プラットフォーム上で実行される一時ファイルシステムを実装するという点で、他の展開プラットフォームとは異なります。 これはどういう意味ですか？ つまり、Herokuはいつでも仮想サーバーをリセットできるため、サーバーはクリーンな状態に戻ります。 ファイルシステムに保存したデータが保存されるとは想定できません。実際、Herokuはサーバーを非常に頻繁に処理します。

これらの条件下で作業すると、いくつかのファイルを使用するアプリケーションで問題が発生します。

• SQLiteデータベースエンジンは、デフォルトでディスクファイルにデータを書き込みます
• アプリケーションのログはファイルシステムに書き込まれます
• コンパイルされた言語翻訳リポジトリもローカルファイルに保存されます

次のセクションでは、これらの3つの領域について説明します。

Heroku Postgresデータベースでの作業

最初の問題を解決するために、別のデータベースエンジンに切り替えます。 第17章では、MySQLデータベースを使用してUbuntu展開の信頼性を高める方法を説明しました。 Herokuには独自のPostgresベースのデータベースサービスがあるため、ファイルに基づいてSQLiteを保存する問題を回避するために、Herokuに切り替えます。

Herokuアプリケーションのデータベースは、同じHeroku CLIを共有します。 この場合、無料レベルでデータベースを作成します。

 $ heroku addons:add heroku-postgresql:hobby-dev Creating heroku-postgresql:hobby-dev on flask-microblog... free Database has been created and is available ! This database is empty. If upgrading, you can transfer ! data from another database with pg:copy Created postgresql-parallel-56076 as DATABASE_URL Use heroku addons:docs heroku-postgresql to view documentation 

新しく作成されたデータベースのURLは、環境変数DATABASE_UR Lに格納されます。これは、アプリケーションの起動時に使用可能になります。 アプリケーションはすでにこの変数でデータベースURLを探しているため、これは非常に便利です。

stdoutへのログイン

Herokuは、アプリケーションがstdout直接I / Oを行うことを期待しています。 アプリケーションが標準出力に出力するものはすべて保存され、 heroku logsコマンドを使用するときに返されます。 したがって、前と同じように、 stdoutに書き込む必要があるか、ファイルに書き込む必要があるかを示す構成変数を追加します。 設定の変更は次のとおりです。

config.py：stdoutのログオプション。

 class Config(object): # ... LOG_TO_STDOUT = os.environ.get('LOG_TO_STDOUT') 

次に、アプリケーションファクトリ関数で、この構成を確認して、アプリケーションロガーの構成方法を理解できます。

app/__init__.pyまたはファイルにログを記録します。

 def create_app(config_class=Config): # ... if not app.debug and not app.testing: # ... if app.config['LOG_TO_STDOUT']: stream_handler = logging.StreamHandler() stream_handler.setLevel(logging.INFO) app.logger.addHandler(stream_handler) else: if not os.path.exists('logs'): os.mkdir('logs') file_handler = RotatingFileHandler('logs/microblog.log', maxBytes=10240, backupCount=10) file_handler.setFormatter(logging.Formatter( '%(asctime)s %(levelname)s: %(message)s ' '[in %(pathname)s:%(lineno)d]')) file_handler.setLevel(logging.INFO) app.logger.addHandler(file_handler) app.logger.setLevel(logging.INFO) app.logger.info('Microblog startup') return app 

そのため、アプリケーションがHerokuで実行されているが、他の構成では実行されていない場合、 LOG_TO_STDOUT環境変数を定義する必要があります。 Heroku CLIは、実行時に使用される環境変数を設定する機能を提供するため、これを簡単にします。

 $ heroku config:set LOG_TO_STDOUT=1 Setting LOG_TO_STDOUT and restarting flask-microblog... done, v4 LOG_TO_STDOUT: 1 

コンパイルされた翻訳

ローカルファイルベースのマイクロブログの3番目の側面は、コンパイルされた言語ファイルの翻訳です。 これらのファイルがエフェメラルファイルシステムから消えないようにする最も簡単なオプションは、コンパイルされた言語ファイルをGitリポジトリに追加して、Herokuにデプロイされた後にアプリケーションの初期状態の一部になるようにすることです。

私の意見では、よりエレガントなオプションは、Herokuが提供する起動コマンドにflask translate compileコマンドを含めることです。これにより、サーバーが再起動するたびにこれらのファイルが再度コンパイルされます。 まだデータベースの移行を開始する必要があるため、起動手順には複数のコマンドが必要であることを知っているため、この方法を使用します。 そのため、この問題を脇に置き、後でProcfileを作成するときに問題に戻ります。

Elasticsearchのホスティング

ElasticsearchはHerokuプロジェクトに追加できる多くのサービスの1つですが、Postgresとは異なり、Herokuが提供するサービスではなく、Herokuと連携してアドオンを提供するサードパーティです。 今日（これらの行を書くとき）、統合されたelasticsearchサービスの3つの異なるプロバイダーがあります。

Elasticsearchを設定する前に、Herokuでは、サードパーティのアドオンをインストールする前に、無料の階層内にいる場合でも、アカウントにリンクされたクレジットカードが必要であることに注意してください。 Herokuクレジットカードの詳細を提供しない場合は、このセクションをスキップしてください。 アプリケーションをデプロイできますが、検索機能は機能しません。

アドオンとして利用可能なElasticsearchオプションのうち、無料のスタータープランが付属するSearchBoxを試してみることにしました。 アカウントにSearchBoxを追加するには、Herokuへのログイン中に次のコマンドを実行する必要があります。

 $ heroku addons:create searchbox:starter 

このコマンドは、Elasticsearchサービスをデプロイし、サービスの接続URLをアプリケーションに関連付けられた環境変数SEARCHBOX_URLします。 クレジットカードをHerokuアカウントに追加しないと、このコマンドは実行されないことを再度お知らせします。

第16章を思い出すと、私のアプリケーションはELASTICSEARCH_URL変数でElasticsearch接続URLを探しているので、この変数を追加し、SearchBoxによって割り当てられた接続URLに設定する必要があります。

 $ heroku config:get SEARCHBOX_URL <your-elasticsearch-url> $ heroku config:set ELASTICSEARCH_URL=<your-elasticsearch-url> 

ここでは、最初にHerokuにSEARCHBOX_URLの値をSEARCHBOX_URLするように依頼し、次に同じ値に設定されたELASTICSEARCH_URLという名前の新しい環境変数を追加しました。

要件の更新

Herokuは、 15章で定義したように、 redependencies.txtファイルに依存関係があることを期待しています 。 しかし、Herokuでアプリケーションを実行するには、このファイルに2つの新しい依存関係を追加する必要があります。

Herokuは独自のWebサーバーを提供していません。 代わりに、アプリケーションが$PORT環境変数で指定されたポート番号で独自のWebサーバーを起動することを期待しています。 Flask開発Webサーバーは職場での使用に十分な信頼性がないため、Pythonアプリケーション用にHerokuが推奨するサーバーであるgunicornを再度使用します。

アプリケーションはPostgresデータベースにも接続します。このため、SQLAlchemyではpsycopg2パッケージのインストールが必要です。

gunicornとpsycopg2両方をrequirements.txtファイルに追加する必要があります。

プロフィール

Herokuはアプリケーションの実行方法を知る必要があり、そのために彼はアプリケーションのルートディレクトリにあるProcfileというファイルを使用します。 このファイルの形式は単純で、各行にはプロセスの名前、コロン、およびプロセスを開始するコマンドが含まれています。 Herokuで実行される最も一般的なタイプのアプリケーションはWebアプリケーションです。このタイプのアプリケーションの場合、プロセス名はwebなければなりません。 以下に、マイクロブログのProcfileを見ることができます。

Procfile：Heroku Procfile。

 web: flask db upgrade; flask translate compile; gunicorn microblog:app 

ここで、3つのコマンドのシーケンスとしてWebアプリケーションを起動するコマンドを定義しました。 まず、データベース移行の更新を開始し、次に言語翻訳をコンパイルし、最後にサーバーを開始します。

最初の2つのサブコマンドはflaskコマンドに基づいているため、 FLASK_APP環境FLASK_APPを追加する必要がありFLASK_APP 。

 $ heroku config:set FLASK_APP=microblog.py Setting FLASK_APP and restarting flask-microblog... done, v4 FLASK_APP: microblog.py 

gunicornコマンドgunicorn 、Ubuntuのデプロイに使用したものよりも簡単です。このサーバーはHeroku環境と非常に優れた統合を備えているためです。 たとえば、デフォルトで$PORT環境変数が考慮されます。プロセスの数を指定するために-wパラメーターを使用する代わりに、herokuはWEB_CONCURRENCY変数を追加することをお勧めします。 procfileを変更します。

アプリケーションの展開

すべての準備手順が完了しているので、展開を開始します。 git pushコマンドは、展開のためにアプリケーションをHerokuサーバーにダウンロードするために使用されます。 これは、GitHubまたは別のリモートgitサーバー上のローカルgitリポジトリに変更を投稿するようなものです。

そして今、Herokuホスティングアカウントにアプリケーションを送信する最も興味深い部分に到達しました。 実際には非常に単純で、アプリケーションをHeroku gitリポジトリのメインブランチにプッシュするためにgitを使用する必要があります。 gitリポジトリの作成方法に応じて、これを行う方法にはいくつかのオプションがあります。 私のv0.18コードを使用する場合、次のように、このタグに基づいてブランチを作成し、リモートマスターブランチに送信する必要があります。

 $ git checkout -b deploy $ git push heroku deploy:master 

まだ自分のリポジトリで作業している場合、コードはすでにメインブランチにある可能性が高いため、最初に変更が修正されていることを確認する必要があります。

 $ git commit -a -m "heroku deployment changes" 

その後、次のように展開を開始できます。

 $ git push heroku master 

ブランチをどのように送信しても、Herokuから次の出力が表示されます。

 $ git push heroku deploy:master Counting objects: 247, done. Delta compression using up to 8 threads. Compressing objects: 100% (238/238), done. Writing objects: 100% (247/247), 53.26 KiB | 3.80 MiB/s, done. Total 247 (delta 136), reused 3 (delta 0) remote: Compressing source files... done. remote: Building source: remote: remote: -----> Python app detected remote: -----> Installing python-3.6.2 remote: -----> Installing pip remote: -----> Installing requirements with pip ... remote: remote: -----> Discovering process types remote: Procfile declares types -> web remote: remote: -----> Compressing... remote: Done: 57M remote: -----> Launching... remote: Released v5 remote: https://flask-microblog.herokuapp.com/ deployed to Heroku remote: remote: Verifying deploy... done. To https://git.heroku.com/flask-microblog.git * [new branch] deploy -> master 

git pushコマンドで使用したherokuラベルは、アプリケーションの作成時にHEROKU CLIによって自動的に追加されたリモートリポジトリです。 deploy:master引数は、 deployブランチが参照するローカルリポジトリからHerokuリポジトリのメインmasterブランチにコードを移動することを意味します。 独自のプロジェクトで作業する場合、 git push heroku masterで変更をプッシュする可能性があります。これは、ローカルmasterブランチをプッシュ（プッシュ）します。 このプロジェクトの構成方法により、私はmasterではないブランチを送信しますが、Herokuが展開のために受け入れる唯一のブランチであるため、Heroku側の宛先ブランチは常にmasterである必要があります。

これで、アプリケーションを作成したチームの出力で指定されたURLにアプリケーションをデプロイする必要があります。 私の場合、URLはhttps://flask-microblog.herokuapp.comだったので、これはアプリケーションにアクセスするために入力する必要があるものです。

実行中のアプリケーションのログエントリを表示するには、 heroku logsコマンドを使用します。 これは、何らかの理由でアプリケーションが起動しない場合に役立ちます。 エラーがあった場合、それらはログに記録されます。

アプリケーションの更新を展開する

アプリケーションの新しいバージョンをデプロイするには、新しいコードでgit pushコマンドを実行するだけです。 これにより、展開プロセスが繰り返され、古い展開が無効になり、新しいコードに置き換えられます。 Procfileのコマンドは、新しい展開の一部として再度実行されるため、プロセス中に新しい移行またはデータベース変換が更新されます。

ここに 戻る