Repository navigation
docs: Missing reference to Claranet Terraform modules #245
Description
Since the tfwrapper is Claranet-oriented, then it is valid to expect it would support use of Claranet production-ready Terraform modules.
I think, the wrapper documentation, especially Stacks file structure, should touch on best practices on using the modules in a project:
- Does
tfwrapperoffer any features to refer/link/import the modules? - If not, where it is suggested to put them?
- Share between account/environment/stack or make as local as possible?
- Host them as a copy or via Git submodule?
...
Activity
pdecat commentedon Oct 9, 2023
All sorts of modules are supported,
tfwrapperdoes not make any assumption about them.You just use any module with the vanilla
sourceargument of a terraformmoduleblock.For modules that are not really reusable beyond a project, there's effectively a pattern of keeping them at the root of a project under a
modulesorcommondirectory, and then referencing them locally across the stacks.mloskot commentedon Oct 9, 2023
I have encountered convention to use Clara modules like
then export https://github.com/claranet/terraform-azurerm-nsg.git into
terraform/modules/terraform_azurerm_nsg, or add as Git submodule.I wondered how Claranet folks structure it in a project based on the
tfwrapperthat also uses Claranet modules.Including such example in docs would be a nice touch to newbies, I think.
pdecat commentedon Oct 10, 2023
Hmm, I'm not aware of such usage internally. @Shr3ps @BzSpi does that speak to you?
BzSpi commentedon Oct 10, 2023
Hi,
Never heard of that behavior.
Since modules are public, they're mostly retrieved from registry or, for a very few customers, mirrored from Github and used through their git as source.
mloskot commentedon Oct 10, 2023
Good point on the preference of the registry as source of Claranet modules.
Thanks @pdecat @BzSpi
mloskot commentedon Oct 28, 2023
I've been looking for a repo with a good example project that shows Claranet's own best practices of
I think such repo would be a very useful complement to the whole collection here.