Terraform 系列-Terraform 项目的典型文件布局

terraform,系列,项目,典型,文件,布局 · 浏览次数 : 79

小编点评

## Terraform 系列文章典型文件布局 **目录结构** ``` . ├── data-storage │ └── mysql │ └── prod/ │ └── main.tf ├── provider │ └── main.tf ├── versions.tf ├── main.tf ├── outputs.tf ├── vars.tf ├── user-data.sh ├── README.md ├── versions.tf ├── terraform.tfvars ├── main.tfvars ├── main.tfvars ├── data-storage │ └── mysql │ └── prod/ │ └── outputs.tf │└── provider │ └── main.tf ├── main.tf ├── outputs.tf ├── vars.tf ├── user-data.sh ├── README.md ├── provider.tf ├── versions.tf └── terraform.tfvars ``` **主要配置文件** * **vars.tf**: 输入变量 * **main.tf**: 资源定义 * **outputs.tf**: 输出变量 * **provider.tf**: provider 信息 * **versions.tf**: Terraform 版本信息 **其他文件** * **user-data.sh**: 用户自定义脚本 * **README.md**: 文档 * **provider.tf**: 提供器配置 * **versions.tf**: Terraform 版本信息

正文

系列文章

👉 Terraform 系列文章

典型文件布局

- modules/
    - services/
        - webserver-cluster/
            - examples/
            - main.tf
            - outputs.tf
            - vars.tf
            - user-data.sh
            - README.md
            - [ ] versions.tf
- stage/
    - vpc/
    - services/
        - frontend-app/
        - backend-app/
            - main.tf
            - outputs.tf
            - vars.tf
            - user-data.sh
            - README.md
            - [ ] provider.tf
            - [ ] versions.tf
            - [ ] terraform.tfvars(or `*.auto.tfvars`)
            - [ ] main.tfvars
    - data-storage/
        - mysql/
        - redis/
- prod/
    - vpc/
    - services/
        - frontend-app/
        - backend-app/
    - data-storage/
        - mysql/
        - redis/
- mgmt/
    - vpc/
    - services/
        - bastion-host/
        - jenkins/
- global/
    - iam/
    - s3/
        - main.tf
        - outputs.tf
        - vars.tf
        - user-data.sh
        - README.md
        - [ ] provider.tf
        - [ ] versions.tf

🔥 提示

  • - [ ] 表示该项为可选内容
  • 示例如 examples/ 表示该项为文件夹

详细说明

顶层文件夹

用于隔离环境

  • modules:Terraform (可复用)模块文件夹
  • stage:预发布 Env
  • prod:生产 env
  • mgmt:管理/DevOps 环境(如:堡垒机、Jenkins 等)
  • global:用于运行各种环境下都要共享的资源(如:Terraform backend - S3、IAM)

二级文件夹

用于环境中的组件

  • vpc:网络拓扑
  • services:此环境中运行的应用环境或微服务,例如 NGINX 前端或 Java 后端。每个应用程序甚至都应该驻留在单独的文件夹中,与其他应用程序隔离
  • data-storage:在此环境中运行的数据存储,例如 MySQL 或 Redis。每个数据存储应该驻留在它自己的文件夹中,与其他数据存储隔离。

文件

每一个组件中,都会有相应的 Terraform 的配置文件,其命名规则如下:

  • vars.tf: 输入变量
  • outputs.tf: 输出变量
  • main.tf: 资源定义
  • user-data.sh:(可选),用户自定义脚本
  • README.md:说明文档
  • provider.tf:(可选),provider 信息,典型如:provider、region。不同环境,甚至同一环境的不同组件的 provider 可能不同。
  • versions.tf:(可选),Terraform version、provider version、Terraform backend 信息。
  • terraform.tfvars(or *.auto.tfvars): (可选),terraform plan 及 apply 默认会传入该文件中的变量值
  • main.tfvars:(可选),terraform plan 及 apply可以通过 -var-file=filename 来手动指定。

变量赋值

可以通过如下 3 种方式指定变量:

  -var 'foo=bar'      Set a value for one of the input variables in the root
                      module of the configuration. Use this option more than
                      once to set more than one variable.

  -var-file=filename  Load variable values from the given file, in addition
                      to the default files terraform.tfvars and *.auto.tfvars.
                      Use this option more than once to include more than one
                      variables file.
  1. 命令行参数:-var 'foo=bar'

  2. 参数文件:默认读取 terraform.tfvars(or *.auto.tfvars) 或通过命令行 -var-file=filename 指定

  3. 环境变量:可以通过设置名为TF_VAR_<NAME>的环境变量为输入变量赋值,例如:

    $ export TF_VAR_image_id=ami-abc123
    $ terraform plan
    ...
    

    环境变量传值非常适合在自动化流水线中使用,尤其适合用来传递敏感数据,类似密码、访问密钥等

三人行, 必有我师; 知识共享, 天下为公. 本文由东风微鸣技术博客 EWhisper.cn 编写.

与Terraform 系列-Terraform 项目的典型文件布局相似的内容:

Terraform 系列-Terraform 项目的典型文件布局

系列文章 👉 Terraform 系列文章 典型文件布局 - modules/ - services/ - webserver-cluster/ - examples/ - main.tf - outputs.tf - vars.tf - user-data.sh - README.md - [

Terraform 系列-Terraform 简介

系列文章 👉 Terraform 系列文章 前言 最近在使用 Terraform 来置备 OCI 的 Always Free Tier, 发现它非常好用。总结学习下:Terraform 的基础知识。 什么是 Terraform? Terraform 是一种基础架构即代码(IaC)工具,可让您安全高

Terraform 系列-Terraform Cloud 比 Terraform OSS 有哪些增强?

系列文章 👉 Terraform 系列文章 前言 最近在使用 Terraform Cloud 来置备 OCI 的 Always Free Tier, 发现它非常好用,相比 Terraform OSS, 用起来省心多了。 也借此总结学习下:Terraform Cloud 比 Terraform OS

Terraform 系列-使用 for-each 对本地 json 进行迭代

## 系列文章 * [Terraform 系列文章](https://ewhisper.cn/tags/Terraform/) * [Grafana 系列文章](https://ewhisper.cn/tags/Grafana/) ## 概述 前文 [Grafana 系列 - Grafana Ter

Terraform 系列-什么是 IaC?

聊到 Terraform, 必然绕不开 IaC 这个概念?那么,什么是 IaC?

Terraform 系列-批量创建资源时如何根据某个字段判断是否创建

这几天碰到一个情况, 使用 Terraform 批量创建日志数据源时, 有的数据源类型是 ElasticSearch, 有些是 Opensearch. 那么, 如何根据某个字段(如:`es_type`)判断是否创建?

Grafana系列-GaC-1-Grafana即代码的几种实现方式

## 系列文章 * [Grafana 系列文章](https://ewhisper.cn/tags/Grafana/) * [Terraform 系列文章](https://ewhisper.cn/tags/Terraform/) ## 概述 GaC(Grafana as Code, Grafana

Grafana 系列-GaC-2-Grafana Terraform Provider 基础

本文为系列文章-Grafana GaC(Grafana 即代码) 的第二篇 - Grafana Terraform Provider 基础。

Terraform 新手村指南,萌新必读!

基础设施即代码(IaC)是指使用代码和软件开发技术来配置和管理基础设施的实践。IaC 背后的逻辑是尽量消除手动配置基础设施和资源的需求,比如服务器、负载均衡以及数据库等。由于基础设施是整个软件开发流程的一个组成部分,并且与应用交付更紧密地联系在一起,因此让基础设施的更改更容易交付十分重要。 使用代码

Terraform 改善基础架构的十个最佳实践

Terraform 是一种非常流行的开源 IaC(基础设施即代码)工具,用于定义和提供完整的基础设施。Terraform 于 2014 年推出,其采用率已在全球范围内快速增长,越来越多的开发人员正在学习 Terraform 并尝试在其组织中部署基础设施。 如果您已经开始使用 Terraform,则必