Proxmox Deploy 项目使用文档

Proxmox Deploy 项目使用文档

proxmox-deployA cli-based deployment tool for Proxmox项目地址:https://gitcode.com/gh_mirrors/pr/proxmox-deploy

1. 项目的目录结构及介绍

proxmox-deploy/
├── README.md
├── main.tf
├── variables.tf
├── outputs.tf
├── modules/
│   ├── vm/
│   │   ├── main.tf
│   │   ├── variables.tf
│   │   └── outputs.tf
│   └── network/
│       ├── main.tf
│       ├── variables.tf
│       └── outputs.tf
└── scripts/
    └── setup.sh

• README.md: 项目说明文件，包含项目的基本介绍和使用说明。
• main.tf: 主配置文件，定义了 Terraform 的主要资源和模块调用。
• variables.tf: 变量定义文件，包含项目中使用的所有变量。
• outputs.tf: 输出定义文件，定义了 Terraform 执行后的输出信息。
• modules/: 模块目录，包含多个子模块，如 vm 和 network。
  • vm/: 虚拟机模块，定义了虚拟机的创建和配置。
  • network/: 网络模块，定义了网络资源的创建和配置。
• scripts/: 脚本目录，包含一些辅助脚本，如 setup.sh。

2. 项目的启动文件介绍

main.tf

main.tf 是项目的启动文件，主要负责定义 Terraform 的主要资源和模块调用。以下是 main.tf 的基本结构和内容：

provider "proxmox" {
  pm_api_url = var.pm_api_url
  pm_user = var.pm_user
  pm_password = var.pm_password
}

module "vm" {
  source = "./modules/vm"
  vm_name = var.vm_name
  vm_template = var.vm_template
}

module "network" {
  source = "./modules/network"
  network_name = var.network_name
}

• provider "proxmox": 定义了 Proxmox 的提供者配置，包括 API URL、用户名和密码。
• module "vm": 调用了 vm 模块，传入了虚拟机名称和模板。
• module "network": 调用了 network 模块，传入了网络名称。

3. 项目的配置文件介绍

variables.tf

variables.tf 文件定义了项目中使用的所有变量。以下是 variables.tf 的基本结构和内容：

variable "pm_api_url" {
  description = "Proxmox API URL"
  type = string
}

variable "pm_user" {
  description = "Proxmox user"
  type = string
}

variable "pm_password" {
  description = "Proxmox password"
  type = string
}

variable "vm_name" {
  description = "Virtual machine name"
  type = string
}

variable "vm_template" {
  description = "Virtual machine template"
  type = string
}

variable "network_name" {
  description = "Network name"
  type = string
}

• variable "pm_api_url": 定义了 Proxmox API URL 变量。
• variable "pm_user": 定义了 Proxmox 用户变量。
• variable "pm_password": 定义了 Proxmox 密码变量。
• variable "vm_name": 定义了虚拟机名称变量。
• variable "vm_template": 定义了虚拟机模板变量。
• variable "network_name": 定义了网络名称变量。

通过以上文档，您可以了解 proxmox-deploy 项目的目录结构、启动文件和配置文件的基本内容和使用方法。

proxmox-deployA cli-based deployment tool for Proxmox项目地址:https://gitcode.com/gh_mirrors/pr/proxmox-deploy