6、编写干净的基础设施即代码

编写干净的基础设施即代码

在基础设施即代码（IaC）的实践中，确保配置的正确性、可重复性和安全性至关重要。本文将深入探讨如何编写干净的 IaC 代码，包括版本控制、代码检查与格式化、资源命名、变量与常量的使用、依赖参数化以及秘密管理等方面。

1. 配置的幂等性与测试

在迁移配置时，由于幂等性，重新运行迁移后的配置不应改变现有基础设施。应该重新应用配置并进行预运行检查。如果预运行显示有更改，说明配置没有准确反映资源的实际状态，必须修正配置。这个过程需要反复试验，因此建议对每组资源进行测试和验证。

2. 编写干净的 IaC 代码的实践

2.1 版本控制传达上下文

• 有效使用版本控制 ：结构化的版本控制实践有助于快速重现配置并做出明智的更改。在编写 IaC 的提交消息时，不需要解释配置本身，而是解释为什么要进行更改以及它将如何影响其他基础设施。
• 示例 ：

$ git commit -m "Allow app to connect to queues
app-network needs to connect to shared-services-network 
because the application uses queues. 
All ports need to be open."

• 添加工作项或票据信息 ：为了便于跟踪更改，可以在提交消息前添加问题编号或票据