More than 3 years have passed since last update.

求ム！Pythonを使ってAzureで開発する時のTips！【PR】日本マイクロソフトAdvent Calendar 2020

無料でお手軽に Azure Static Web Apps に Web サイトをデプロイする

Last updated at 2021-09-25Posted at 2020-11-30

フロントエンドよくわからんという人でも、開発を通じて Web アプリを作りたくなることがあると思います。

本記事では Python x Azure というアドベントカレンダーの趣旨に沿って、 Python 製の静的サイトジェネレーター MkDocs で作った静的サイトを Azure Static Web Apps にデプロイしてみた話を書きます。

ソースコード: mkdocs-on-azure
できるもの : Azure Static Web Apps にデプロイした静的サイト ↓

Static Web Apps にデプロイ可能なアプリケーションについての理解を深めるために、

静的サイト
SPA(Single Page Application)
についての話もしていきます。

💪 モチベーション

👩‍💻　フロントエンドの技術スタックがない
✨　簡単・いい感じにウェブページを作りたい
⛏　メンテしたくない、運用コストかけたくない

みたいなお気持ちになったことはないでしょうか？？私はあります。

そんなあなたは、これを読むと良いかもしれません。

👨‍👩‍👧 対象読者と前提

この記事は，以下の人にむけた内容になっています

Azure を使っていて静的サイト作りたいな〜という人
低コストで簡単にウェブページをデプロイ・管理したい人
Web アプリも Python で作りてえんだ！な人

また，以下の内容については既知 or 既にあるという前提で話を進めます

pip
Git 使ったことある，GitHub のアカウントがある
VSCode 使ったことある
Azure のアカウントがある（今回使う Azure Static Web Apps は無料で利用できます）

🤷 どうやってやるのか

大まかな流れは以下のようになります：

1. 静的サイトジェネレータのセットアップ
2. リポジトリのセットアップ
3. Azure Static Web Apps のリソース作成
4. CI/CD のセットアップ

次に，使用する 静的サイトジェネレーター と Azure Static Web Apps について説明します

静的サイトジェネレーター - MkDocs

静的サイトジェネレータ ¹として，本記事では Python 製の OSS である MkDocs を使います。

MkDocs を使ってみて良いなと思ったのは下記の点です。

機能面
- プラグインが充実（数式表現，コードのシンタックスハイライトなど）
- デフォルトで全文検索機能をサポート
- テーマが充実 (pip install で利用可能)
手軽さ
- 設定ファイルでカスタマイズ可能（HTML，CSS，JS が隠蔽）
- 環境構築の簡単さ
  - pip install mkdocs && mkdocs new mysite && cd mysite && mkdocs serve

世の中にはいろんな静的サイトジェネレータがあり，その中でもドキュメントサイトに特化した OSS をいくつか使ったことがあるのですが，MkDocs は必要十分な機能を簡単にプラグインとして取り込めるのが良いところです。

📚　NOTE
機能を網羅的に知りたい方は，@mebiusbox2 さんの『MkDocsによるドキュメント作成』が参考になります。

ちなみに，Python の有名なフロントエンドフレームワーク django や Flask と MkDocs はどのように違うのでしょうか？

前者は基本的にサーバー側で動的に HTML を生成するので，Python 実行環境が必要になります。しかし，MkDocs の場合は HTML を生成するのはビルド時のみなので，あとはビルド時に生成した静的コンテンツをホスティングするだけです。

図にすると以下のようになります。

動的に HTML を生成する django や Flask はサービス提供時も常に Python 実行環境が稼働している必要があるので，Web Apps や VM といったリソースを使う必要があります。

しかし，MkDocs では， CI/CD などでビルドして一度 HTML を生成したら，それをホスティングするサービスさえあれば十分です。そこで，デプロイ先として Azure Static Web Apps や Azure Storage Blob などの，ホスティングに最適化したサービスを選べばコストも抑えられますし，ホスティングサーバの面倒は Azure がみてくれるので（サーバーレス）便利です。

Azure Static Web Apps

ちょうど最近リリースされたばかりの Azure のリソースで，現在はプレビュー版となっていますが，Azure を使っているなら 今後フロントエンド開発における最良のリソースの選択肢の1つになると注目されている ² ものです (公式 docs はこちら)。

理由は，以下の通りです。

無料 ³
高速 ⁴
便利機能の数々！（認証，ブランチごとの自動デプロイ...）
サーバーレス

無料で使えるホスティングサービスには例えば Netlify や GitHub Pages などがありますが，Azure が優れているのは 地理的分散 による高速化のための仕組みや 認証機能，ブランチごとの自動デプロイ機能 などがデフォルトでサポートされている点です。またサーバーレスであり，（定義上）リソースのメンテナンスは不要 ⁵です。

Azure Static Web Apps についてのより詳しい話は miyake さんの『Azure App Service に Static Web Apps が登場！』をご覧ください。

📚　NOTE

現在 Azure Static Web Apps は preview 版 であり， GitHub + GitHub Actions 以外のコードベースと CI/CD サービスをサポートしていません⁶ 。以下に該当する方は，Azure Storage Blob を用いる方法 ⁷ をオススメします。

production 環境で使用することを検討している場合

GitHub を利用していない場合（GitLab, Azure DevOps など）

Azure Storage Blob を使ったデプロイの方法は，この記事の後半の方に簡単に書いています。

使用する技術スタック

以上をまとめると，この記事で使用する技術スタックは以下の感じになります。

名前	用途
GitHub Repos	記事・設定・パイプラインの管理
GitHub Actions	ビルド・デプロイ用パイプライン
MkDocs	静的サイトジェネレータ。アプリのソースコード（HTML，CSS，JS）を生成する
Azure Static Web Apps	静的サイトのホスティング

それでは早速，やり方に入っていきます。

📖 具体的な方法

MkDocs のローカルセットアップ

ローカル環境で mkdocs のセットアップを行います。この手順を省略したい場合はこのリポジトリを clone してください。

1. インストール

pip install mkdocs                # mkdocs のインストール
pip install mkdocs-material       # mkdocs のテーマのインストール
mkdocs new my-docs && cd my-docs  # mkdocs プロジェクトの作成
mkdocs serve                      # 開発サーバーを立ち上げる

↑ テーマのインストールは任意ですが，ここでは1番人気のある mkdocs-material をインストールします。他のテーマはこちらから見ることができます。

2. 動作確認

プロジェクトのルートディレクトリで mkdocs serve を実行して，開発サーバを立ち上げたらブラウザから http://localhost:8000 にアクセスしてみましょう。

ちなみに，プロダクション用のビルドは mkdocs build --clean で実行できます。これを実行すると，/site ディレクトリが生成され，その中に静的なコンテンツ (HTML, CSS, JS...) が生成されます。

以降の手順では，このプロジェクトを Git で管理し GitHub 上のリモートリポジトリに push していきます。説明されなくても分かるよ！と言う人は飛ばしてください。

3. Git リポジトリとして管理する

動作確認ができたら，このプロジェクトを Git で管理します。

git init

4. .gitignore を作成

mkdocs では，コンテンツ（markdown ファイル）や設定ファイルをビルドして HTML,CSS,JS のファイルを生成し，これらを site ディレクトリに格納します。ただし，これらは Git で管理したいものではないので，無視するために .gitignore ファイルを生成します。

echo 'site' > .gitignore

5. コミットする

git add .
git commit -m "init mkdocs project"

GitHub のセットアップ

GitHub で空のリポジトリを作成します。
作成したリモートリポジトリに，先ほど作成したローカルリポジトリの内容を push します。

git remote add origin https://github.com/${user_id}/${repos_name}.git
git branch -M main
git push -u origin main

${user_id} と ${repos_name} にはそれぞれあなたの GitHub ユーザー ID と作成したリポジトリ名を指定します。

Azure Static Web Apps の作成

次は，さっき作った mkdocs の静的コンテンツをデプロイする Azure Static Web Apps のリソースを作成します。

1. VSCode の Azure Static Web Apps 拡張機能のインストール

VSCode に下記の拡張機能を追加します。これにより，リポジトリと Azure リソースの統合がシームレスになります。

以降の手順では，VSCode の Azure Static Web Apps 拡張機能の README.md に書いてある手順を実行します。

2. リソース作成

VSCode の左側タブの Azure アイコンをクリックすると，認証のためのダイアログが表示されます。認証に成功して自分のサブスクリプションが VSCode に表示されれば OK です。
そのあと + アイコンをクリックすると，リソース作成ダイアログに進みます。

ダイアログには下記の情報を入力します。

Azure のリソース名 → 例）document-site
デプロイするブランチ名 → 例）main
ソースコードの場所 → /site
Functions コードの場所⁸ → "Skip for now"
ビルド生成物が配置される場所 → "Skip for now"

3. GitHub Actions のワークフロー定義ファイルを確認する

↑ でリソースを作成すると，（GitHub 上の）リモートリポジトリに Azure のボットが自動でワークフロー定義ファイルを commit してきます。git pull して確認してみましょう。

すると，.github/workflows/azure-static-web-apps-{app_name}.yml というファイルがあるのが確認できると思います。

GitHub Actions のセットアップ

ワークフローの修正

先ほど，ワークフロー定義ファイルが自動生成されたのを確認しました。しかし，このままだとパイプラインは失敗します。理由は，以下のジョブが不足しているからです：

GitHub Actions の仮想マシンでの Python 実行環境セットアップ
mkdocs と mkdocs-material のインストール
ビルドして /site ディレクトリに静的コンテンツ (HTML,CSS,JS) を生成する処理

ということで，uses: actions/checkout@v2 以降に，それぞれのジョブを以下のように追加してみましょう

    steps:
      - uses: actions/checkout@v2

      # 1. GitHub Actions の仮想マシンでの Python 実行環境セットアップ
      - name: Set up Python 3.9
        uses: actions/setup-python@v2
        with:
          python-version: 3.9

      # 2. mkdocs と mkdocs-material のインストール
      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install mkdocs
          pip install mkdocs-material

      # 3. ビルドして `/site` ディレクトリに HTML,CSS,JS を生成する
      - name: Build Web App
        run: |
          mkdocs build --clean

push & deploy!

それでは更新した内容で commit & push しましょう！

git add .
git commit -m "ci: Add steps to build web app"
git push origin main

※ push すると自動で GitHub Actions が走り，Azure Static Web Apps へのデプロイが走ります。

GitHub Actions の画面を開くと，パイプラインが走っているのが見えます。

だいたい 2分ほどでデプロイが完了します。

デプロイされたページの確認

デプロイされたリソースを Azure Portal で確認してみると...

「概要」からウェブサイトの URL をクリックして，所望のページが見えればおｋです。

おまけ：環境ごとのデプロイ

Static Web Apps では，環境ごとのデプロイを設定レスでやってくれます。

例えば，ステージング用のブランチ stage を作ってプルリクを出すと，プルリクを契機に自動でステージング環境用の静的サイトをデプロイしてくれます。試しに，プルリクを発行してみると，こんな感じになりました↓

同じプルリク画面から，差分とその結果が確認できて便利ですし，1からこういう仕組みを作らなくても良いのがすばらしいです。

⭐ まとめ

長くなり色々書いてしまいましたが，特に難しいことをせずともドキュメントサイトをデプロイできるということが分かっていただけたのではないでしょうか！？

🧸 おまけ: Azure Strorage Blob へのデプロイ

何らかの都合で，コードベースとして GitLab や Azure DevOps などのサービスを使わねばならないという方も多いと思います。そんな方は Azure Storage を使いましょう！Static Web Apps ほどの便利機能はありませんが，こちらもリソース費用を抑えながら静的サイトをデプロイすることができると言う点で良い選択肢です。

とりあえずデプロイするだけなら，以下の方法でできます。

1. VSCode の Azure Storage 拡張機能のインストール

2. MkDocs プロジェクトのビルド

リポジトリのルートに移動して，次のコマンドを実行してビルドします。

mkdocs build --clean

すると，/site ディレクトリが生成されるので， VSCode のファイルエクスプローラからこのディレクトリを右クリックし，"Deploy to Static Website via Azure Storage..." をクリックします。

すると例によってリソース作成 or 選択ダイアログが表示されるので，GUI からポチポチしていくと，無事デプロイされるかと思います。

静的サイトジェネレータ とは，Web サイトの静的コンテンツ（HTML，CSS，JS）を生成するアプリ・フレームワークのことです。生成した HTML,CSS,JS はホスティングサーバからブラウザに配信することができます。ホスティングサーバはあくまでソースコードを配信するだけであって，サーバ上で 動的に HTML を生成することがない（＝HTML レンダリングのための実行環境が不要）ので，ホスティングに最適化したクラウドサービスを使うことでランニングコストを抑えることができます。静的サイトジェネレータについてもっと興味がある方は「静的サイトジェネレーター」について網羅的に説明します - Dyno を読んでみてください。

ちなみに，「動的サイト」（とは普通言いませんが）なるものは，ユーザーが Web サイトにアクセスした時に HTML を動的に生成するものです。これには，HTML がサーバー側・ブラウザ側のどっちで生成されるか という観点から次の2種類があります。1つは，ユーザーからアクセスが来た時に サーバー側 で HTML を動的に生成して，生成した HTML をブラウザに配信するアーキテクチャであり， SSR (Server-Side Rendering) と呼ばれます。一方，ブラウザ上 で JavaScript によって HTML を生成する Web アプリのことを SPA (Single Page Application) といいます。SPA も動的と言えば動的ですが，サーバーサイドに HTML 生成のための実行環境が不要という点では静的サイトと同じであり，Azure Static Web Apps にデプロイ可能です。
SSR，SPA，静的サイト の違いをもっと知りたい！という方は，ACADEMIND, "Dynamic vs SPA vs Static Websites" を読んでみてください。 ↩
もちろん，フロントエンドのアーキテクチャにも依存しますが，サーバーサイドに HTML 生成の実行環境を必要としない 静的サイト や SPA (Single Page Application) を採用する場合は最良の選択肢と言えます。 ↩
正式版がリリースされると課金対象になる可能性がありますが，その場合でも App Service などと比較すればごく微々たるものになると想定されます。 ↩
Static Web Apps では、静的アセットは従来の Web サーバーから分離され、世界各地の地理的に分散したポイントから提供されます。この分散により、ファイルがエンドユーザーに物理的に近づくため、ファイルの提供が大幅に高速になります。 - Azure Document, "Azure Static Web Apps"

↩
リソースのメンテは不要ですが，もちろんフロントエンド部分の依存パッケージ（今回は MkDocs）に関しては，必要に応じてアップデートや脆弱性対応を行う必要があります。 ↩
近々 Azure DevOps + Azure Pipelines もサポートされると MS の人が言っています。https://github.com/Azure/static-web-apps/issues/5#issuecomment-727289989 ↩
Azure Docs, Azure Storage での静的 Web サイトホスティング ↩
Azure Static Web Apps で "Functions コード"，または "Functions の統合" と呼ばれる機能は、文字通り Static Web Apps と Functions の統合をシームレスにできますよ！という機能です。フロントエンドで Functions で作った API を使うと何が嬉しいのでしょうか？具体的には、次のようなユースケースで役に立ちます↓

フロントエンド開発において、バックエンドから何かしらの値をとってきて表示したいということがあります。ただし、バックエンドのインタフェースは必ずしもフロントエンドにとってうれしいものではないときがあります。そこで、中間的なバックエンドを作ってバックエンドをラップしようというアプローチがあります（このアーキテクチャを BFF（Backend for Frontend） といいます）。フロントエンド寄りの「バックエンド」なので、同じリポジトリで管理できた方が良いということでこのようなオプションが表示されるのだと思います。 ↩

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up