terraform-docsインストールでハマったこと

はじめに

業務でterraform-docsを使用する機会があり、ツール導入から行ったのですが、詰まったところがあったので、共有します。

terraform-docsとは

terraformモジュールからドキュメントを生成するツールです。
どんなリソースブロックを使用しているのか、変数に指定しているものはどんなものがあるのかなどをdocs化してくれるツールです。

ざっくり手順

Chocolateyインストール

terraform-docsはmacの場合、Homebrewでインストールでき、Windowsの場合、ScoopかChocolateyでインストールできます。今回はChocolateyでインストールするので、まずChocolateyの導入から。

通常は以下のコマンドでインストールできるのですが、セキュリティソフトで弾かれることがあります。(今回詰まったのはここでした…)

@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"

そこで今回はオフラインインストールをします。

1. ChocolateyのサイトからChocolateyのパッケージをダウンロード(https://chocolatey.org/api/v2/package/chocolatey/)
2. ダウンロードしたnupkgをzip解凍ソフトで解凍
3. 解凍した chocolatey.0.XX.XX\toolsにてコマンドプロンプト実行(管理者権限)
4. 以下のコマンドを実行

@powershell -NoProfile -ExecutionPolicy Bypass -Command  .\chocolateyInstall.ps1

※プロンプトの応答後、chocoと入力し、インストールしたバージョンが表示されたら完了

C:\ProgramData\chocolatey\bin>choco
Chocolatey v2.2.2
Please run 'choco -?' or 'choco <command> -?' for help menu.

terraformインストール

以下のコマンドを実行

choco install terraform-docs

プロンプトの応答後、terraform-docs -vと入力し、インストールしたバージョンが表示されたら完了

おわりに

以下の記事を参考にインストール実施しましたが、terraform-docsインストールまで記事になっているものがなかったので、まとめさせて頂きました。

参考