Runbook: Terraform Module Authoring Guide

[sj-williams]

Background

** This is for the team rather than user custom terraform guidance

We should have a small runbook section and associated guidance in the module github template that provides guidance for writing new Terraform Modules. This should cover subjects like:

• User facing modules
• Infra/components modules
• Module testing patterns
• Considerations/strategies for masking sensitive values from pipeline output
• Relevant references / links added to our module template

Proposed user journey

Approach

As described above.

Which part of the user docs does this impact

Cloud Platform runbooks / appropriate links in User Guide if necessary

Communicate changes

• [ ] post for #cloud-platform-update
• [ ] Weeknotes item
• [ ] Show the Thing/P&A All Hands/User CoP
• [ ] Announcements channel

Questions / Assumptions

Definition of done

• [ ] readme has been updated
• [ ] user docs have been updated
• [ ] another team member has reviewed
• [ ] smoke tests are green
• [ ] prepare demo for the team

Reference

How to write good user stories