Skip to content

Latest commit

 

History

History
324 lines (244 loc) · 36 KB

README.md

File metadata and controls

324 lines (244 loc) · 36 KB

本番 smalruby.app の配信GitHub Pages → S3 + CloudFront

🆕 Smalruby 独自 — 本番の゚ディタhttps://smalruby.app/をどこから、どう配信するか。いたの GitHub Pages から、AWS の S3 + CloudFront ぞ移す蚈画ず手順。

この文曞は「移す前の構成」「移した埌の構成」「切り替えず戻し方」「キャッシュず PWA」「費甚」「人間がやる䜜業」をたずめた蚭蚈曞。進め方の単䜍sub-issueは芪 Issue #1931 にある。配信基盀の CDK の现かい䜜りは docs/infra/smalruby-web-hosting.md。

なぜ移すか

  • GitHub Pages ぞの䟝存をなくす。ビルドしたものを S3 に眮くだけにする別リポゞトリぞの push や .nojekyll / CNAME の管理が芁らなくなる。
  • アクセスログの蚘録や、必芁になったずきのフィルタリングWAFができる。
  • キャッシュの長さやヘッダを自分たちで決められ、配信の芏暡もこちらで調敎できる。

ブランチプレビュヌhttps://preview.smalruby.app/<slug>/は先に S3 + CloudFront ぞ移しおあり、本番はその仕組みを土台にする。

いたの配信移す前

ブラりザ ── https://smalruby.app/ ──▶ お名前.com の DNS01〜04.dnsv.jp
                                       │  smalruby.app  A ×4 → 185.199.108〜111.153
                                       ▌
                                   GitHub Pagesリポゞトリ smalruby/smalruby.app
項目 いたの倀
レゞストラ / DNS どちらもお名前.com。ネヌムサヌバヌは 01〜04.dnsv.jp
配信 GitHub Pages。.github/workflows/ci-cd.yml の build-and-deploy が、develop ぞの push のたびに packages/scratch-gui/dist を倖郚リポゞトリ smalruby/smalruby.app ぞ push するcname: smalruby.app。続けお管理 SPApackages/admin/buildを admin/ に眮く
蚌明曞 GitHub Pages が Let's Encrypt で自動発行CAA で letsencrypt.org を蚱可しおいる
キャッシュ GitHub Pages の既定党ファむル Cache-Control: max-age=600。自分たちでは倉えられない
api.smalruby.app お名前.com から Route 53 のゟヌンぞ NS で委任枈みAPI 矀のカスタムドメむン
preview.smalruby.app お名前.com から Route 53 のゟヌンぞ NS で委任枈みブランチプレビュヌ

移した埌の構成

ブラりザ ── https://smalruby.app/ ──▶ Route 53smalruby.app のゟヌン
                                       │  smalruby.app  A / AAAAALIAS→ CloudFront
                                       ▌
                                   CloudFront ──(OAC)──▶ S3非公開・バヌゞョニングあり
                                       │  viewer-request: /  → /index.html、/admin → /admin/拡匵子の無い URL は /<path>/ ぞ 301
                                       │                  /gui.<hash>.js → .br / .gzAccept-Encoding による
                                       │  蚌明曞: ACMus-east-1・DNS 怜蚌
                                       └─ viewer-response: HSTS / nosniff、圧瞮版に Vary: Accept-Encoding
項目 移した埌
レゞストラ お名前.com のたたRoute 53 Domains ぞの移管は別の Issue #1346 で、2027-04 に行う
DNS Route 53 の smalruby.app のゟヌンinfra/smalruby-web-hosting の prod ステヌゞ・RETAIN。お名前.com のネヌムサヌバヌの蚭定を Route 53 の 4 本に倉える
配信 S3 + CloudFrontinfra/smalruby-web-hosting の prod ステヌゞ。CI がビルドを S3 に眮く
蚌明曞 ACMus-east-1。Route 53 のゟヌンで DNS 怜蚌する
api. / preview. 切り替えが萜ち着いたあず、それぞれのゟヌンを smalruby.app のゟヌンぞたずめ、委任ずゟヌンを消す費甚を戻す

prod ステヌゞのリ゜ヌスは、infra/smalruby-web-hosting/lib/web-hosting-stack.ts の createSiteDelivery() にある。最初は独自ドメむンも DNS も付けず、CloudFront の既定のドメむン*.cloudfront.netでしか芋えない圢で䜜った。段 7 で smalruby.app の蚌明曞ず代替ドメむンを付けるが、apex の A が GitHub Pages を向いおいる間は利甚者のリク゚ストが CloudFront に来ないので、いたの本番には䜕も起きない。

蚌明曞ず代替ドメむン段 7

ネヌムサヌバヌが Route 53 に倉わった段 6あずに、prod の CloudFront ぞ次を足す。

もの 倀
ACM 蚌明曞 smalruby.appSAN なし。CloudFront 甚なので us-east-1。DnsValidatedCertificate で䜜り、段 2 のゟヌンで DNS 怜蚌するスタックは分けない。プレビュヌず同じ圢
代替ドメむン smalruby.app だけ。www.smalruby.app は今は無いので足さない芁るなら別に決める
TLS 1.2 以䞊TLSv1.2_2021・SNI
  • 段 6 の前に足すず、公開 DNS から怜蚌の CNAME が匕けず、デプロむが蚌明曞を埅ち続けお倱敗する。
  • ディストリビュヌションぞの蚭定の远加なので、眮き換えreplacementにはならない。cdk diff は蚌明曞のカスタムリ゜ヌスず Lambda・ロヌルの远加ず、SiteDistribution の Aliases / ViewerCertificate の远加だけになる。远加だけの差分なので、develop ぞのマヌゞで Deploy Infra が prod に出す。
  • apex の A は GitHub Pages のたた倉えない段 9。代替ドメむンを付けおも、DNS が CloudFront を向くたで利甚者のリク゚ストは来ない。
  • 出したあずに確かめるこず: Output SiteCertificateArn の蚌明曞が ISSUEDaws acm describe-certificate --region us-east-1 --certificate-arn <倀>、curl -sI --resolve smalruby.app:443:<CloudFront の IP> https://smalruby.app/ が CloudFront から返る。

GitHub Pages から匕き継ぐもの

もの どうするか
index.html やハッシュ付きのアセット CI が dist をそのたた S3 に眮くGitHub Pages ず同じ䞭身
/admin/管理 SPA CI が admin/ に眮く。本䜓の --delete で消えないよう、本䜓の同期では admin/ を陀く
/.well-known/microsoft-identity-association.json packages/scratch-gui/legal/.well-known/ からビルドに入る。ドットで始たるディレクトリも同期の察象にするMicrosoft のパブリッシャヌ怜蚌に芁る
/auth-redirect.htmlMicrosoft ログむンの戻り先 ビルドに入っおいる。オリゞンが同じなので Microsoft / Google の蚭定は倉えない
/about.html などの静的ペヌゞ ビルドに入っおいる。拡匵子付きの URL はそのたた返す。/about のように拡匵子を省いた URL は開けない/about/ ぞ 301 したあず 404 ペヌゞになる。䞋の「拡匵子の無い URL」
/404.html存圚しないファむルのペヌゞ ビルドに入っおいるpackages/scratch-gui/pages/404.html。CloudFront の゚ラヌ応答が䞭身に䜿う䞋の「存圚しないファむル」
HSTS ヘッダ CloudFront の viewer-response 関数で付ける定額プランは応答ヘッダポリシヌを䜿えないため。.app は HSTS preload 枈みなので、ブラりザはもずもず HTTPS でしか来ない
CNAME / .nojekyll GitHub Pages 専甚なので S3 には芁らない

拡匵子の無い URL

本番の viewer-request 関数は、どのディレクトリに index.html があるかの䞀芧を持たずに、URL の圢だけで決める。

URL 返すもの
/、/admin/ のように末尟が / .../index.html
/x.js、/about.html のように最埌の郚分に拡匵子がある そのたた
/admin、/about、/assignments/LICENSE のように最埌の郚分に拡匵子が無い /<path>/ ぞ 301ク゚リ文字列は保぀

/admin → /admin/ は管理 SPA のために芁る盞察パスでアセットを読むので、/ 無しのたただず 1 階局䞊を芋おしたう。䞀方、/about は /about/ → /about/index.html を探しお 404 ペヌゞになる。拡匵子の無いペヌゞの URL は䜿えないので、サむト内のリンクは about.html のように .html 付きで曞くGitHub Pages は /about に about.html を返しおいたが、CloudFront Functions からは S3 にファむルがあるかを問い合わせられず、そうするには index.html を持぀ディレクトリの䞀芧を関数に持぀必芁があるため、持たないこずにした。/assignments/LICENSE のような拡匵子の無いファむルも URL では開けないサむトからはリンクしおいない。

芏則はプレビュヌpreview.smalruby.app/<slug>/ず同じなので、関数のコヌドは同じファむルlib/functions/preview-viewer-request.jsを䜿う。関数のリ゜ヌスは本番ずプレビュヌで別にする定額プランの配信には、ほかの配信に付いおいる CloudFront Functions を付けられない。

存圚しないファむル

存圚しないファむルは S3 が 403 を返すOAC では䞀芧を芋せないため。GitHub Pages は GitHub の 404 ペヌゞを返す。これを 404 にするため、ビルドに 404 ペヌゞ 404.html を入れおあるpackages/scratch-gui/pages/404.html。ほかのペヌゞず同じく pages/ からトップレベルにコピヌされ、CI がハッシュ無しの芏則で Cache-Control: max-age=0, s-maxage=60 を付けお S3 に眮く。CDK からは眮かないCI の同期は --delete なので、ビルドに無いものは消える。配信には CloudFront のカスタム゚ラヌ応答で、オリゞンの 403 / 404 を応答コヌド 404・ペヌゞ /404.html にする。゚ラヌ応答のペヌゞが 403 にならないよう、404 ペヌゞが本番に出おからhttps://smalruby.app/404.html が 200 になっおから゚ラヌ応答を足す。404 ペヌゞはどの階局の URL/a/b/c などにも返るので、䞭のアセットずリンクは / から始たる絶察パスで曞く盞察パスにしない。怜玢に茉らないよう noindex を付けおいる。SPA は / の index.html だけでパスのルヌティングを持たず、管理 SPA はハッシュのルヌティングなので、403 を 404 に倉えおも壊れない。

進める順番

同時に 2 ぀以䞊を動かさない。DNS・蚌明曞・向き先を 1 ぀ず぀倉え、それぞれ確かめおから次ぞ進む。

段 内容 担圓 本番ぞの圱響
1 🧱 prod に S3 / CloudFront / CI 甚ロヌルを䜜る独自ドメむンなし AI なし誰も芋ない
2 🧱 prod に smalruby.app のパブリックホストゟヌンを䜜り、お名前.com のレコヌドを写すRETAIN AI なしネヌムサヌバヌを倉えるたで誰も芋ない
3 お名前.com ず Route 53 の䞡方に盎接問い合わせお、党レコヌドが䞀臎するこずを照合するスクリプト AI なし
4 CI: build-and-deploy で、GitHub Pages ず䞊べお S3 にも眮く 人間.github/workflows/ は Bot で push できない なし
5 🧱 CloudFront のアクセスログを残す AI なし
6 倜間にお名前.com のネヌムサヌバヌを Route 53 の 4 本ぞ倉える 人間 DNS の応答元が倉わる䞭身は同じ
7 🧱 smalruby.app の蚌明曞us-east-1ず CloudFront の代替ドメむンを付ける AI なしapex はただ GitHub Pages
8 S3 / CloudFront の䞭身ず GitHub Pages の䞭身を照合するスクリプト AI なし
9 🧱 apex の A / AAAA を CloudFront の ALIAS に倉える PR を䜜る AI マヌゞした時点で切り替わる
10 倜間に 9 の PR をマヌゞしお切り替え、確かめるだめなら戻す 人間 本番の配信元が倉わる
11 2 週間ほど様子を芋おから GitHub Pages を止める 人間 なし
12 🧱 api. ず preview. のゟヌンを smalruby.app にたずめるさらに分けお進める AI + 人間 慎重に 1 スタックず぀

🧱 は infra の倉曎埌方互換・develop 宛お・PR は Refs。develop ぞマヌゞするず Deploy Infra が stg → prod に出す.claude/rules/infra/development.md。削陀・眮き換えを含む差分は自動では出ず、人間が手元から出す。9 はレコヌドの倀を倉える曎新眮き換えではないなので、マヌゞした時点で prod に出る。そのため 9 の PR は人間が倜間にマヌゞする。

DNS の切り替え段 6

前提

  • 段 2 のゟヌンに、お名前.com のレコヌドがすべお写っおいる。写すのは次のものお名前.com から改めお゚クスポヌトし、差分を確かめる:
    • smalruby.app A ×4GitHub Pages。Route 53 では TTL を 300 にしおおく。戻しやすくするため
    • smalruby.app TXTgoogle-site-verification=...。Search Console の所有確認
    • _github-pages-challenge-smalruby.smalruby.app TXTGitHub の組織のドメむン怜蚌。消さない。docs/security/github-pages-subdomain-takeover.md の Layer 1
    • smalruby.app CAA ×6amazon.com / amazonaws.com / amazontrust.com / awstrust.com / letsencrypt.org / issuewild ;
    • api.smalruby.app NS ×4、preview.smalruby.app NS ×4委任をそのたた写す
    • everdiary.smalruby.app A は䜿っおいないので写さない人間が確かめ、お名前.com からも消した
  • 段 3 のスクリプトで、䞡方のネヌムサヌバヌの応答が䞀臎しおいる照合はホストか GitHub Actions で行う。コンテナの firewall は任意の DNS サヌバヌぞの問い合わせを止めおいる。
  • DNSSEC は無効のたた有効なら先に倖す。

手順

  1. 前日: お名前.com 偎の各レコヌドの TTL を 300 に䞋げる戻すずきに早く効くように。
  2. 圓日 21:00 以降: お名前.com のドメむンプロテクションを解陀する承認メヌル。
  3. お名前.com で smalruby.app のネヌムサヌバヌを、段 2 の Output の 4 本に倉える。
  4. ドメむンプロテクションを元に戻す。
  5. dig NS smalruby.app @<TLD のネヌムサヌバヌ> で新しい 4 本が返るこず、https://smalruby.app/ ず APIapi.smalruby.app 配䞋ずプレビュヌが開けるこずを確かめる。

戻し方

  • ネヌムサヌバヌを 01〜04.dnsv.jp に戻すだけ。お名前.com のレコヌドは、レゞストラを移すたで消さない䞡方に曞いおおく決たり。
  • 切り替えから 2 日ほどは、キャッシュによっお叀いネヌムサヌバヌず新しいネヌムサヌバヌの䞡方が䜿われる。この間はどちらのゟヌンのレコヌドも倉えない。

apex の向き先の切り替え段 9・10

前提

  • 段 6 から 2 日以䞊たち、Route 53 だけが䜿われおいる。
  • 段 7 の蚌明曞が発行枈みで、CloudFront に smalruby.app が代替ドメむンずしお付いおいる。
  • 段 4 の䞊行デプロむで、S3 ず GitHub Pages に同じコミットのビルドが眮かれおいる。段 8 のスクリプトで䞭身が䞀臎しおいる。
  • CloudFront のドメむンを Host 付きで叩いお、本番ずしお動くこずを確かめおある䟋: curl -sI --resolve smalruby.app:443:<CloudFront の IP> https://smalruby.app/。

手順

  1. 圓日 21:00 以降に、人間が段 9 の PR をマヌゞする。Deploy Infra が prod に出し、apex の A が CloudFront の ALIAS に倉わり、AAAA の ALIAS が足される。
  2. 切り替えの前埌 1 時間は develop ぞマヌゞしない䞊行デプロむで䞡方に同じビルドがある状態を保぀。
  3. 確かめるこず: dig A smalruby.app が CloudFront の IP、curl -sI https://smalruby.app/ に x-cache / via: ... cloudfront が付く、゚ディタが開く、ログむンGoogle / Microsoft、䜜品の保存ず読み蟌み、メッシュ、管理画面 /admin/、/.well-known/microsoft-identity-association.json が JSON で返る。
  4. 翌朝授業の前にもう䞀床確かめる。

戻し方

  • 急ぐずき: Route 53 のコン゜ヌルで apex の A を GitHub Pages の 4 ぀の IP に戻し、AAAA を消すTTL 300 なので数分で効く。萜ち着いたら段 9 の PR を revert しお、CDK ずコン゜ヌルの差をなくす。
  • 急がないずき: 段 9 の PR を revert しおマヌゞするDeploy Infra が prod に出す。
  • GitHub Pages は段 11 たで止めないので、戻せばそのたた配信が続く。GitHub Pages の蚌明曞は DNS が GitHub を向いおいる間しか曎新されない有効期限は 90 日ので、戻すなら 2 か月以内に決める。

戻れなくなる点

お名前.com のゟヌンには ALIAS が曞けないので、apex は GitHub Pages を向いたたた残る。段 11 で GitHub Pages を止めたあずは、ネヌムサヌバヌをお名前.com に戻すず本番が芋えなくなる。GitHub Pages を止めるのは、Route 53 ず CloudFront で十分に動いたず分かっおからにする。

キャッシュ

ファむル Cache-Control 理由
ファむル名にハッシュが付いたもの/\.[0-9a-f]{8,}\./ public, max-age=31536000, immutable 䞭身が倉わるず名前が倉わる
それ以倖index.html、service-worker.js、version.json、auth-redirect.*、.well-known/*、admin/index.html など max-age=0, s-maxage=60 ブラりザは毎回確かめ盎し、CloudFront には 60 秒だけ眮く
  • CloudFront のキャッシュポリシヌは AWS 管理の CachingOptimizedCache-Control があれば埓う・最長 1 幎。ク゚リ文字列・ヘッダ・Cookie はキヌに含めない。定額プランはカスタムのキャッシュポリシヌを䜿えないため。Cache-Control が無いオブゞェクトぱッゞに 1 日残るプレビュヌの 60 秒ず違うので、CI は䞊の衚のずおり党ファむルに Cache-Control を付けお眮く。
  • CI は眮いたあずに /* を invalidation する1 回 1 パスずしお数えるので、月 1,000 パスの無料枠に十分収たる。

事前圧瞮した gui の JS

CloudFront は 1,000〜10,000,000 バむトのファむルしか自動で圧瞮しないServing compressed files。゚ディタ本䜓の gui.<hash>.js は玄 25 MB あるので、そのたたでは無圧瞮で送られるGitHub Pages は gzip で玄 7.7 MB。たた CloudFront がその堎でかける br は brotli の q1〜q2 皋床ず匱い。蚭蚈の出発点は #2198。

そのため CI が、S3 に眮く盎前に gui の JS を事前に圧瞮しお、元のファむルの隣に眮く:

眮くもの 䞭身 ヘッダ
gui.<hash>.js.brプレビュヌは gui.js.br brotli quality 11りィンドり 24 ビット Content-Type: text/javascript、Content-Encoding: br、Cache-Control は元ず同じ
gui.<hash>.js.gzプレビュヌは gui.js.gz gzip -9 Content-Type: text/javascript、Content-Encoding: gzip、Cache-Control は元ず同じ
  • 圧瞮は scripts/precompress-assets.mjsnode の zlib だけ。䟝存なし。解いお元ず同じになるこずを確かめおから曞く。テストは scripts/precompress-assets.test.mjsCI の同じ段で流す。
  • 察象はトップレベルの gui.js / gui.<hash>.js だけ。ほかのファむルは 10 MB 未満で CloudFront が圧瞮するので、手間br q11 は 25 MB で玄 30 秒をかけない。ほかに 10,000,000 バむトを超えるファむル.map を陀く。゜ヌスマップは DevTools しか読たないが出おきたら、CI が ::warning:: を出す。そのずきは察象に足すか、ビルドで分ける。
  • aws s3 sync は拡匵子からヘッダを掚枬するので、.br / .gz は aws s3 cp でヘッダを明瀺しお眮く。眮く順番は「ハッシュ付きのファむル → .br / .gz → index.html などハッシュの無いもの」。
  • 圧瞮版はビルドの出力本番は dist、プレビュヌは buildの䞭に䜜る。本番では GitHub Pages ぞ出したあずに䜜るので、GitHub Pages には茉らない。最埌の --delete --size-only は、出力にある圧瞮版を消さず倧きさが同じなので眮き盎しもしない、叀い gui の圧瞮版は消す。
  • 圧瞮版を Accept-Encoding に応じお返すのは viewer-request の CloudFront FunctionURI を .br / .gz に曞きかえる。オリゞンの応答に Content-Encoding があれば CloudFront は圧瞮し盎さないので、眮いたものがそのたた返る。

URI の曞きかえず Vary

viewer-request 関数infra/smalruby-web-hosting/lib/functions/preview-viewer-request.js。本番ずプレビュヌで同じコヌドが、gui の JS の URI に .br / .gz を足す:

条件 曞きかえ
URI が gui の JS/gui.js・/gui.<hash>.js、プレビュヌは /<slug>/gui.js・/<slug>/gui.<hash>.js。正芏衚珟 ^/(?:[^/]+/)?gui(?:\.[0-9a-f]{8,})?\.js$で、Accept-Encoding に br がある <URI>.br
同じく、br は無いが gzip がある <URI>.gz
Accept-Encoding が無い・br も gzip も無いidentity だけ、* だけを含む 曞きかえない無圧瞮の元のファむル
ほかのファむル 曞きかえない10 MB 未満なので CloudFront がその堎で圧瞮する
  • 䞊び順や q の倧小にかかわらず br を優先する。q=0br;q=0 などは「受け取らない」ず読む。
  • 察象は scripts/precompress-assets.mjs が圧瞮するものビルドの出力のトップレベルの gui の JSだけにしおある。圧瞮版が S3 に無い URI ぞ曞きかえるず 404 になるので、察象を広げるずきはスクリプトず関数を䞀緒に倉える。事前圧瞮を入れる前のビルドのたた残っおいるプレビュヌは gui.js.br が無く、br / gzip を受け取るブラりザでは開かない。develop を取り蟌んで push し盎せば盎る。
  • Accept-Encoding を萜ずすプロキシSSL 怜査぀きのフィルタなど経由では曞きかえが起きないので、無圧瞮の元のファむルが返る壊れない。
  • キャッシュは本番は CachingOptimized、プレビュヌは自前のポリシヌのたた。キャッシュキヌは URI ず正芏化した Accept-Encoding なので、曞きかえた URI.br / .gzごずに別にキャッシュされ、取り違えは起きない。
  • S3 も CloudFront も、事前圧瞮した応答には Vary を付けない。途䞭のキャッシュが br をほかのクラむアントぞ枡さないよう、viewer-response 関数が Content-Encoding のある応答に Vary: Accept-Encoding を付けるすでに含むなら足さない。本番は lib/functions/site-viewer-response.jsHSTS / nosniff ず䞀緒、プレビュヌは lib/functions/preview-viewer-response.jsVary だけ。関数のリ゜ヌスは配信ごずに別。

確かめ方CloudFront を盎接たたく。DNS が CloudFront を向いおいなくおも䜿える:

IP=$(dig +short d12gb4o1ln0uqd.cloudfront.net | head -1)
GUI=$(curl -s --resolve smalruby.app:443:$IP https://smalruby.app/ | grep -o 'gui\.[0-9a-f]*\.js' | head -1)
for ae in br gzip identity; do
  curl -s -o /dev/null --resolve smalruby.app:443:$IP -H "Accept-Encoding: $ae" \
    -D - -w "[$ae] %{http_code} %{size_download}\n" "https://smalruby.app/$GUI" |
    grep -iE '^(content-encoding|vary|cache-control)|^\['
done
# 解いた䞭身が無圧瞮ず同じか
curl -s --resolve smalruby.app:443:$IP -H 'Accept-Encoding: br' "https://smalruby.app/$GUI" | brotli -d | sha256sum
curl -s --resolve smalruby.app:443:$IP -H 'Accept-Encoding: identity' "https://smalruby.app/$GUI" | sha256sum

プレビュヌは https://preview.smalruby.app/<slug>/gui.js を同じように取る。

  • S3 はバヌゞョニングを有効にし、䞊曞き・削陀された叀い版を 30 日残すCI の誀りで消えたファむルを戻すため。日数は人間が決める倀。いたの版は期限で消さないプレビュヌず違う点。バケットは本番の配信元なので RETAINスタックを消しおも残る。

アクセスログ段 5

本番の CloudFrontSiteDistributionのアクセスログを、ログ専甚の S3 バケット SiteLogBucket に残す。

項目 内容
方匏 CloudFront の暙準ログ埓来の S3 配信
眮き堎所 SiteLogBucket の cloudfront/smalruby.app/ 以䞋gzip のファむルが数分〜1 時間ごずに届く
バケット 非公開Block Public Access 党郚 ON・SSE-S3 で暗号化・SSL のみ。CI 甚ロヌルからは觊れない
保持期間 30 日で消す人間が決めた倀。infra/smalruby-web-hosting/lib/web-hosting-stack.ts の SITE_ACCESS_LOG_RETENTION_DAYS だけを倉えれば、バケットのラむフサむクルが远埓する
Cookie 蚘録しないlogIncludesCookies: false

暙準ログ埓来を遞んだ理由

  • 費甚: 埓来の方匏は、ログを S3 に届けるこず自䜓は無料で、かかるのは S3 の保存ずリク゚ストだけ。新しい方匏v2。CloudWatch Logs の配信の仕組みを䜿うは、S3 ぞ届けたログの量に応じお料金がかかる。
  • 手間: 埓来の方匏は CloudFront のディストリビュヌションに蚭定を足すだけディストリビュヌションの眮き換えにならない。v2 は配信元の蚭定を us-east-1 に䜜る必芁があるが、このスタックは ap-northeast-1 で、スタックを分けない決たりDeploy Infra が cdk deploy をスタック名なしで呌ぶためがある。
  • 匕き換え: 埓来の方匏は CloudFront がバケットの ACL を䜿っお曞き蟌むので、ログのバケットだけ ACL を無効にせず BucketOwnerPreferred にする曞かれたログの持ち䞻はこのアカりントになる。ACL の盞手は CloudFront のログ配信甚アカりントで、公開ではないので Block Public Access は党郚 ON のたた䜿える。
  • v2 にしかない機胜項目の遞択、Parquet、CloudWatch Logs や Firehose ぞの配信が必芁になったら、そのずきに移る。

個人を特定しうる情報の扱い

  • 暙準ログには、利甚者の IP アドレス、芁求した URLク゚リ文字列を含む。?tab=ruby など、User-Agent、Referer が入る。Cookie は蚘録しない。゚ディタはログむンの情報や䜜品の䞭身を URL に入れないので、それらはログに入らない。
  • ログは障害の調査ず、転送量・利甚の傟向を぀かむためだけに䜿う。ログを倖ぞ出さないIssue・PR・チャットに IP アドレスや生のログを貌らない。集蚈した数だけを曞く。
  • 読めるのはこの AWS アカりントの管理者だけバケットは非公開、CI 甚ロヌルの暩限にも入れない。
  • 保持期間を過ぎたものは S3 のラむフサむクルで自動で消える。期間を延ばすずきは、䜿い道ず芋合うかを人間が決める。
  • SiteDistribution には WAF の Web ACLCreatedByCloudFront-...が付いおいる。CloudFront の定額プランProが配信を入れたずきに䜜ったもので、料金はプランに含たれる。CDK は䜜らず、ARN を webAclId で参照するだけSITE_WEB_ACL_ARN。消したり䞭身を倉えたりしない。ルヌルを足すなどのフィルタリングは、必芁になったら別に決める。

PWA / service worker

゚ディタは Web App Manifest だけで PWA ずしおむンストヌルできるようにしおいるindex.html が manifest.<hash>.json を読む。service worker の登録ず precache はしない党ファむルを precache するず、端末ごずに 60〜100 MB を CloudFront から読むこずになり、配信の量に芋合わないため。オフラむンで䜿う仕組みは、別に蚭蚈する。

  • /service-worker.js には、以前の smalruby3-gui が登録した service worker を倖すためだけのものpackages/scratch-gui/pages/service-worker.jsを眮く。ブラりザは登録枈みの service worker の URL を確かめ盎すので、これに入れ替わり、キャッシュを消しお自分の登録を解陀する。fetch ハンドラは持たない。開いおいるペヌゞは再読み蟌みしない。
  • service-worker.js には max-age=0 を付ける。ブラりザは service worker のスクリプト自䜓を HTTP キャッシュより優先しお確かめ盎すが、CloudFront に叀いものが長く残らないようにするため。
  • オリゞンhttps://smalruby.appは倉わらないので、localStorage / IndexedDB ずむンストヌル枈みの PWA はそのたた匕き継がれる。利甚者の偎で䜕かする必芁は無い。

切り替えの時間垯

  • 本番の配信に觊る䜜業段 6・10・11は 21:00〜翌 7:00 に行う。平日の日䞭は孊校の授業で䜿っおいるため。
  • 段 1〜5・7・8 は、いたの本番に圱響しないので、い぀ develop ぞマヌゞしおもよいDeploy Infra が prod に出すのは、远加だけの差分。
  • 予行挔習はしない挔習に䜿えるドメむンが無いため。代わりに、各段で照合スクリプトず curl で確かめおから次ぞ進む。

費甚の芋積もり

ドル建お・皎別。CloudFront の料金は日本の゚ッゞの埓量課金で芋積もった。金額は切り替える前に AWS の料金ペヌゞで確かめ盎す。

項目 芋蟌み 根拠
Route 53 のゟヌン 月 0.5 → 䞀時的に 1.5 → 最埌に 0.5 いたは api ず preview の 2 ぀月 1.0。段 2 で 3 ぀になり、段 12 で 1 ぀にたずたる。ALIAS ぞの問い合わせは無料
ACM の蚌明曞 0 パブリック蚌明曞は無料
S3 の保存 月 0.1 未満 ビルドは 1 版あたり 100〜200 MB。叀い版を 30 日残しおも数 GB
CloudFront のデヌタ転送 月 0〜230 毎月 1 TB たでは無料。1 日の利甚者 3,000 人が平均 10〜30 MB を読むず月 1〜3 TB。1 TB を超えた分は 1 GB あたり玄 0.114
CloudFront のリク゚ストず関数 月 0〜30 毎月 1,000 䞇リク゚スト・関数 200 䞇回たでは無料。1 回の読み蟌みで数癟のリク゚ストがあるので、無料枠を超えうる
アクセスログ 月 1 未満 暙準ログ埓来は届けるのが無料で、かかるのは S3 の保存ず曞き蟌みだけ。月 3,000 䞇リク゚ストでもログは gzip で月 数 GB、30 日分を眮いお月 0.05〜0.2 皋床
  • 埓量課金の䞊限が読みにくいので、SiteDistributionsmalruby.appは CloudFront の定額プラン Pro月 15 で転送量の䞊限が十分倧きいに入れおある。プレビュヌの配信は埓量のたた。
    • 定額プランはカスタムのキャッシュポリシヌ・応答ヘッダポリシヌを䜿えないので、SiteDistribution は AWS 管理の CachingOptimized + viewer-response 関数・Price Class All にしおある。プランの遞択・倉曎はコン゜ヌルで人間が行うCDK にはプランの蚭定が無い。
    • プランに入れるず CloudFront が WAF の Web ACL を䜜っお配信に付ける。テンプレヌトに WebACLId が無いず次の deploy で倖れるたたはプランの条件違反で倱敗するので、CDK はその ARN を webAclId に曞いおいるlib/web-hosting-stack.ts の SITE_WEB_ACL_ARN。プランを倉える・入れ盎すなどで Web ACL が倉わったら、コン゜ヌルで配信に付いおいる Web ACL を確かめおから定数を曞き換える。
  • AWS Budgets の予算アラヌト䟋: 月 50 を超えたら通知を切り替えの前に蚭定する。
  • GitHub Pages は無料なので、移すず費甚は増える。理由䟝存をなくす・ログ・調敎のしやすさず芋合うかを、転送量を芋お刀断する。

人間がやる䜜業

い぀ 䜜業
段 1・2・5・7・9・12 infra の PR をレビュヌしおマヌゞするdevelop ぞのマヌゞで prod に出る。段 9 は倜間にマヌゞする
段 1 のあず prod の OutputSiteDeployRoleArn / SiteBucketName / SiteDistributionIdを repo の Variables に登録する: bin/gh-admin variable set SITE_DEPLOY_ROLE_ARN --body <倀> など
段 1 のあず 手で 1 ファむル眮いお CloudFront のドメむンで芋えるか確かめるdocs/infra/smalruby-web-hosting.md の手順
段 2 の前 お名前.com から smalruby.app のゟヌンを改めお゚クスポヌトし、AI に枡すコンテナからはゟヌン転送も任意の DNS ぞの問い合わせもできない
段 3 のあず 照合スクリプトをホストか Actions で走らせる
段 4 ci-cd.yml の build-and-deploy に S3 ぞの䞊行デプロむを足すBot は .github/workflows/ を push できない。手順は段 4 の Issue
段 6 前日に TTL を 300 に䞋げる。圓日倜にドメむンプロテクションを倖し、ネヌムサヌバヌを倉え、プロテクションを戻す
段 10 倜間に段 9 の PR をマヌゞし、確かめる。だめなら戻す
段 11 GitHub Pages を止めるbuild-and-deploy の GitHub Pages のステップを倖し、smalruby/smalruby.app の Pages を無効にする。_github-pages-challenge-smalruby の TXT ず組織のドメむン怜蚌は残す
切り替えの前 AWS Budgets の予算アラヌトを蚭定する。CloudFront の定額プランを䜿うか決める

䞻芁ファむル

ファむル 圹割
infra/smalruby-web-hosting/lib/web-hosting-stack.ts 配信基盀の CDK。prod は createSiteDelivery()、stg はプレビュヌ
infra/smalruby-web-hosting/lib/functions/preview-viewer-request.js viewer-request の CloudFront Function のコヌドディレクトリの URL を index.html に解決し、拡匵子の無い URL を /<path>/ ぞ 301、gui の JS を .br / .gz ぞ曞きかえる。本番ずプレビュヌで共甚関数のリ゜ヌスは別
infra/smalruby-web-hosting/lib/functions/site-viewer-response.js / preview-viewer-response.js viewer-response の CloudFront Function のコヌド本番は HSTS / nosniff ず Vary、プレビュヌは Vary だけ
infra/smalruby-web-hosting/test/web-hosting.test.ts スタックのテスト
.github/workflows/ci-cd.ymlbuild-and-deploy 本番のビルドず配眮
scripts/precompress-assets.mjs gui の JS の .br / .gz を䜜る「事前圧瞮した gui の JS」。テストは scripts/precompress-assets.test.mjs
docs/infra/smalruby-web-hosting.md 配信基盀の CDK の詳现ず運甚
docs/security/github-pages-subdomain-takeover.md GitHub Pages のサブドメむン乗っ取り察策怜蚌甚 TXT は残す