amazon-web-services - Create Infrastructure Documentation from terraform + gitlab-ci system

Question

Our infra pipeline is setup using terraform + gitlab-ci. I am given with task to provide documentation on setup with what's implemented and what's left. I am new to infra world and finding it hard to come up template to start documentation.

So far I thought of having a table with resources needed with details on dependencies, source of the module, additional notes, etc

If you have a template, can you share OR any other suggestions?

标签： amazon-web-servicesterraformdocumentation

Answer 1

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

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

概括

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

回购的结构如何

对回购结构的解释以及为什么它的结构背后的决定。

如何使用

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

它是如何创建的

提供有关如何设置的步骤，以便任何人都可以管理它并继续工作。