terraform-provider-azurerm共享映像库：自定义VM镜像管理-优快云博客

terraform-provider-azurerm共享映像库：自定义VM镜像管理

【免费下载链接】terraform-provider-azurerm Terraform provider for Azure Resource Manager 项目地址: https://gitcode.com/GitHub_Trending/te/terraform-provider-azurerm

在Azure云环境中，管理大量虚拟机（VM）的一致性配置和快速部署是运维人员面临的常见挑战。传统手动配置不仅耗时易错，还难以保证环境一致性。共享映像库（Shared Image Gallery） 作为Azure的原生服务，允许用户集中存储、管理和共享自定义VM镜像，而terraform-provider-azurerm提供了声明式API，让这一过程自动化、可审计且可重复。本文将通过实际案例演示如何使用Terraform创建、管理和共享自定义VM镜像，解决多环境部署中的配置漂移问题。

核心概念与资源关系

共享映像库相关的Terraform资源主要包括三个核心组件，它们通过层级关系协同工作：

共享映像库（Shared Image Gallery）：顶层容器，用于存储和管理映像版本，支持跨订阅和区域共享。对应资源类型为azurerm_shared_image_gallery。
共享映像（Shared Image）：定义VM镜像的元数据（如操作系统类型、Hyper-V代系），包含一个或多个映像版本。对应资源类型为azurerm_shared_image。
共享映像版本（Shared Image Version）：特定版本的映像，通常关联VHD文件，支持版本控制（如1.0.0）和区域复制。对应资源类型为azurerm_shared_image_version。

三者关系可通过以下流程图直观展示：

mermaid

环境准备与依赖检查

在开始前，请确保环境满足以下条件：

Terraform版本：0.13+（推荐使用最新稳定版）
Azure CLI：已安装并登录，可通过az login验证
Provider版本：terraform-provider-azurerm 2.0+（通过go.mod查看项目依赖）

项目中与映像管理相关的示例代码可参考examples/image/目录，包含从VHD和虚拟机创建映像的两种场景。

实战案例：从VM创建共享映像

步骤1：创建基础VM并 generalize

首先需要准备一个已通用化（Generalized） 的VM，这一步会清除机器特有信息（如SSH密钥、计算机名），使其适合作为模板。以下代码片段展示如何创建基础Linux VM：

resource "azurerm_linux_virtual_machine" "example" {
  name                            = "${var.prefix}-vm"
  resource_group_name             = azurerm_resource_group.example.name
  location                        = azurerm_resource_group.example.location
  size                            = "Standard_D2s_v3"
  admin_username                  = "azureuser"
  admin_password                  = "P@ssw0rd1234!"
  disable_password_authentication = false

  source_image_reference {
    publisher = "Canonical"
    offer     = "0001-com-ubuntu-server-jammy"
    sku       = "22_04-lts"
    version   = "latest"
  }

  os_disk {
    storage_account_type = "Standard_LRS"
    caching              = "ReadWrite"
  }
}

完整示例代码：examples/image/from_virtual_machine/main.tf

VM创建后，需通过Azure CLI generalize：

az vm generalize --resource-group <resource-group-name> --name <vm-name>

步骤2：创建共享映像库与映像定义

接下来声明共享映像库和映像资源。注意azurerm_shared_image需指定操作系统类型（如Linux）和Hyper-V代系（如V2）：

resource "azurerm_shared_image_gallery" "example" {
  name                = "example-gallery"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
  description         = "Shared gallery for production VM images"

  tags = {
    Environment = "Production"
  }
}

resource "azurerm_shared_image" "example" {
  name                = "ubuntu-2204"
  gallery_name        = azurerm_shared_image_gallery.example.name
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_shared_image_gallery.example.location
  os_type             = "Linux"
  hyper_v_generation  = "V2"

  identifier {
    publisher = "mycompany"
    offer     = "ubuntu-server"
    sku       = "22_04-lts"
  }
}

步骤3：创建映像版本并复制到多区域

映像版本支持语义化版本号，并可复制到多个区域以提高部署速度。以下示例将版本1.0.0复制到华东和华北区域：

resource "azurerm_shared_image_version" "example" {
  name                = "1.0.0"
  image_name          = azurerm_shared_image.example.name
  gallery_name        = azurerm_shared_image_gallery.example.name
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_shared_image_gallery.example.location

  os_disk_image {
    source_vhd_uri = azurerm_image.example.os_disk[0].vhd_uri
    caching        = "ReadWrite"
  }

  target_region {
    name                   = "chinaeast2"
    regional_replica_count = 1
  }

  target_region {
    name                   = "chinanorth2"
    regional_replica_count = 1
  }
}

注意：source_vhd_uri需从通用化后的VM磁盘获取，实际使用时需替换为真实VHD路径。

高级配置与最佳实践

版本控制策略

建议采用语义化版本（SemVer） 管理映像版本，格式为Major.Minor.Patch（如1.0.0）：

Major：重大变更（如操作系统升级）
Minor：功能更新（如新增软件包）
Patch：安全补丁或小修复

版本历史可通过CHANGELOG-v2.md追溯，例如：

azurerm_shared_image_gallery - validating at import time that the ID is for a Shared Image Gallery (#8240)

权限管理与共享

共享映像库支持通过Azure RBAC授权访问：

读取权限：授予Reader角色允许用户使用映像
管理权限：授予Contributor角色允许用户修改映像

通过Terraform的azurerm_role_assignment资源可自动化权限配置：

resource "azurerm_role_assignment" "gallery_reader" {
  scope                = azurerm_shared_image_gallery.example.id
  role_definition_name = "Reader"
  principal_id         = "00000000-0000-0000-0000-000000000000" # 用户或服务主体ID
}

故障排查与常见问题

映像版本创建失败
检查VM是否已通用化：az vm get-instance-view --resource-group <rg> --name <vm> --query "instanceView.osState"
预期输出："Generalized"

跨区域复制延迟
映像版本复制到多区域可能需要30分钟以上，可通过az sig image-version show查看复制状态：

az sig image-version show --resource-group <rg> --gallery-name <gallery> --gallery-image-definition <image> --gallery-image-version 1.0.0

资源删除顺序
删除时需遵循逆序原则：先删除映像版本，再删除映像定义，最后删除共享映像库。

总结与后续扩展

通过terraform-provider-azurerm管理共享映像库，用户可实现：

标准化VM部署流程，减少人为错误
跨团队、跨区域共享镜像，提高协作效率
版本化管理镜像，支持灰度发布和快速回滚

后续可探索以下高级场景：

自动化映像更新：结合Azure Automation或GitHub Actions，定期从基础VM生成新映像版本
加密映像：使用Azure Key Vault存储加密密钥，保护敏感数据
与VMSS集成：通过共享映像库为虚拟机规模集（VMSS）提供自定义镜像

若需进一步了解资源属性和参数，可参考官方文档：

希望本文能帮助您构建更高效的VM镜像管理体系。如有疑问或建议，欢迎通过项目CONTRIBUTING.md中的方式参与讨论。

提示：定期查看examples/image/目录获取最新示例代码，该目录包含从VHD和VM创建映像的完整配置。

【免费下载链接】terraform-provider-azurerm Terraform provider for Azure Resource Manager 项目地址: https://gitcode.com/GitHub_Trending/te/terraform-provider-azurerm

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考