从 terraform + gitlab-ci 系统创建基础设施文档

Question

我们的基础设施管道是使用 terraform + gitlab-ci 设置的。我的任务是提供有关已实现内容和剩余内容的设置文档。我是 infra world 的新手，发现很难拿出模板来开始文档。

到目前为止，我想有一个包含所需资源的表格，其中包含有关依赖项、模块来源、附加说明等的详细信息

如果您有模板，您可以分享或有其他建议吗？

Answer 1

对于初学者，您可以尝试以下一种或两种方法：

a) 使用其 graph command

创建 Terraform 资源的图表

b) 分组，然后使用 AWS Resource Groups 列出特定标签的所有资源，特别是其 Create Resource Group 功能

Answer 2

我做文档的方式是尽可能简单，解释它是如何工作的，如何使用它，并提供有关如何从头开始设置的说明以供参考和作为保险单。这样，如果它被摧毁，除了设置它的人之外的其他人可以重新创建它。

由于这只是一个管道，因此可能没有太多可绘制的图。我将提供的文档结构类似于这样，我会将其作为 README.md 的一部分添加到 Confluence 中，或者您的团队以其他方式添加文档。

总结

1-2 句关于作品及其创作原因的句子。

回购的结构

对回购结构的解释以及其结构背后的决定。

如何使用

提供有关用户如何使用管道的步骤

它是如何创建的

提供有关如何设置的步骤，以便任何人都可以对其进行管理和处理。