kryndex / terraform-ppwcode-modules

Common Terraform modules.

This repository contains a number of general Terraform modules.

The Terraform documentation describes how to use modules. You import the modules from Github, as described in the documentation. Use the format for public Github repositories, using the "double-slash" to refer to the correct subdirectory.

module "MODULE_INSTANCE_NAME" {
    source = "github.com/peopleware/terraform-ppwcode-modules//MODULE_NAME"
}

On the other hand, …

The module domain_version/ directly, and thus the module subdomain/ that depends on it, uses a Node.js JavaScript script (though a Terraform external data source provider) to get information about the SOA serial and the state of the git repository of the Terraform configuration it is used in. Node.js JavaScript code depends on other npm packages, that need to be installed for the script to be able to work. This repository is therefor, apart from being a collection of Terraform modules, also a Node.js npm package, with dependencies described in package.json. The dependencies need to be available in a node_modules/ folder next to the script, or in one of its ancestor folders, before Terraform can use the modules in > terraform plan or > terraform apply.

This is done by running (preferred) > yarn or (legacy) > npm install in the project that uses these modules.

For this to work, this collection of Terraform modules / npm / yarn package must itself be loaded in the Terraform configuration in which it is used via > yarn (preferred) or > npm install (legacy). These commands work recursively.

This is done by making the configuration in which these modules are used an npm / yarn package itself, with this collection of Terraform modules defined as a development dependency in its package.json. Once > yarn (preferred) or > npm install (legacy) is executed, these modules will be available in node_modules/terraform-ppwcode-modules/. To create an instance of a module MODULE_NAME then, the Terraform configuration has to refer to it via a relative path, like this:

module "MODULE_INSTANCE_NAME" {
    source = "./node_modules/terraform-ppwcode-modules/MODULE_NAME"
}

Note to the Terraform maintainers: go with the flow, and promote npm / yarn as the primary method to distribute modules.

// TODO

@ppwcode/node-gitinfo should be updated asap, to use a more recent version of nodegit (because there is no pre-build binary for the latest node of the older version).