Bicepのバージョン管理とモジュール化の促進 #Azure – Qiita

皆様、いかがお過ごしでしょうか。
私は以前から Azure の IaC ツールである Bicep についてよく触っているのですが、最近以下のようなことを感じていました。

• 自分が作った Bicep のモジュールを他の人（チーム）に展開したい場合ってどうするの？
• 展開したいけど、バージョン管理ってどうするの？
• Bicep って Java でいう Maven Central Repository、JavaScript でいう npm Registry みたいなパッケージ管理ツールってないの？
• そもそも Bicep ってどういう単位でバージョン管理するのがいいの？

という疑問を持ったわけです。
今回はそんな同じような課題を抱えている方や、Bicep を学んでいる方に対して少しでもお役に立てればと、Bicep のバージョン管理方法について検討していこうと思います。

その前に、Azure の IaC って他に何があるの？そこから知りたい！ という方は、以下の記事を出したためこちらもご覧いただけると大変嬉しいです。

先程、Azure の IaC ツールについては私の以前の記事を掲載しましたが、Bicep については本記事でも簡単に紹介しておきます。

Bicep は、ARM Template の後継として Microsoft が提供している新しい DSL（Domain Specific Language）ベースの IaC ツールです。

ARM Template とは異なり、Bicep は JSON ではなく、独自のより簡潔な構文を提供しており、これにより Azure リソースの管理を容易にしています。

Bicep のコードは ARM Template にコンパイルされるため、同様に ARM REST API を通じて Azure リソースに対する操作を行います。
これにより、ARM Template と同等の Azure リソースのサポートと、新サービスや機能の迅速なサポートを実現しています。

本題に入る前に、Bicep にはモジュールという機能があります。

モジュールとは、Bicep ファイルを別の Bicep ファイルから参照し、特定のリソースや構成を再利用するための単位です。モジュール化し、複数回呼び出したり異なるパラメーターを渡したりすることで、基本的なリソース構築のパターンを統一することができます。

例えば、仮想ネットワーク(VNet)を作成する専用のテンプレートをモジュール化すれば、別々のファイルからそのモジュールを呼び出すことで仮想ネットワークを簡単に作成することができ、設定を変更したい時はそのモジュールだけを編集すれば呼び出している全てのファイルに変更を反映できます。

以下のようなフォルダ構成の場合を想定します。

├── main.bicep       # メインのBicepファイル
├── vnetModule.bicep # VNet構成用のモジュール

この時、vnetModule.bicep は以下のような仮想ネットワークを作成する Bicep ファイルです。

@description('仮想ネットワークのリソース名')
param vnetName string

@description('仮想ネットワークのIPアドレスプレフィックス')
param addressPrefix string

resource vnet 'Microsoft.Network/virtualNetworks@2024-05-01' = {
  name: vnetName
  location: resourceGroup().location
  properties: {
    addressSpace: {
      addressPrefixes: [
        addressPrefix
      ]
    }
  }
}

output vnetId string = vnet.id

main.bicep ファイルでは、module と宣言することで先程の vnetModule.bicep を読み込み、仮想ネットワークを作成することができます。

@description('仮想ネットワークのリソース名')
param vnetName string = 'myVnet'

@description('仮想ネットワークのIPアドレスプレフィックス')
param addressPrefix string = '10.0.0.0/16'

module vnet 'vnetModule.bicep' = { // `vnetModule.bicep` を読み込んで仮想ネットワークを作成する
  name: 'vnetDeployment'
  params: {
    vnetName: vnetName
    addressPrefix: addressPrefix
  }
}

output vnetId string = vnet.outputs.vnetId

このように、パラメータ（vnetName, addressPrefix）を変更するだけで、別々のファイルから仮想ネットワークを作成することができます。
モジュールは他の言語でいう関数のようなもので Bicep コードの再利用性や保守性を高める重要な機能です。
モジュールを効果的に使用することで、複雑な構築プロセスを簡素化し、プロジェクトの一貫性を保つことができます。

それでは本題に移ります。
今回は以下のようなケースを考えます。

• 「A」Git リポジトリで Bicep のモジュール集を作成する
• そのモジュールを他のプロジェクト（以下でいう「B」Git リポジトリ）で使用する

Bicep のモジュール化に記載した通り、Bicep はファイル単位で読み込むことができるため、バージョン管理をする単位として、以下の 2 通りが挙げられます。

Git サブモジュールを利用し、リポジトリ単位でバージョニングする

[submodule ""]
    path = 
    url = 
    tag = v1.0.0 # ここに取り込みたいバージョンを記載する

git submodule update --remote

az bicep publish --file vnetModule.bicep --target br:.azurecr.io/bicep/modules/vnet:

@description('仮想ネットワークのリソース名')
param vnetName string = 'myVnet'

@description('仮想ネットワークのIPアドレスプレフィックス')
param addressPrefix string = '10.0.0.0/16'

- module vnet 'vnetModule.bicep' = {
+ module vnet 'br:myazurecontainerregisry.azurecr.io/bicep/modules/vnet:v1.0.0' = { // Azure Container Registry の URL にする
  name: 'vnetDeployment'
  params: {
    vnetName: vnetName
    addressPrefix: addressPrefix
  }
}

output vnetId string = vnet.outputs.vnetId

using 'br:myazurecontainerregisry.azurecr.io/bicep/modules/vnet:v1.0.0'