👓

【GCP】dbt docsをGCSでホスト

2023/08/26に公開

目的

ドキュメントを確認するたびにdbt docs serveでサーバを稼働させる手間を省くため、
dbt docs serveを利用せずにGCSに静的htmlを配置してホストします。

前提

docsの表示には以下のファイルが必要です。

  • target/manifest.json
  • target/catalog.json
  • target/index.html
    ただし、上記ファイルをそのままGCSに配置してindex.htmlをホストしてもエラーになります。

方法

以下で公開されている静的html生成用の処理を利用します。
docsの表示に必要なtarget/manifest.jsonとtarget/catalog.jsonをhtmlにインサートして単一ファイルを生成してくれます。

https://github.com/aibazhang/dbt-metadata-management/blob/main/generate_static_html.py

python generate_static_html.py

生成されたtarget/index2.htmlは静的htmlファイルのため、
任意のGCSバケット配下に配置すれば、サーバを立ち上げることなく簡単にdocsを参照できます。


Discussion