/terraform-cloudflare-modules

A simple but useful collection of modules for CloudFlare ☁️

Primary LanguageHCLOtherNOASSERTION

logo
Terraform CloudFlare ☁️ Modules

An easy to understand, opinionated terraform composable set of modules for CloudFlare, with batteries included 🔋.

Available modules

These mono-repo contains a set of Terraform modules and recipes for provisioning CloudFlare resources. The modules are designed to be composable, and opinionated. The recipes are designed to be easy to understand, and easy to use.

Module Description
✅Stable CloudFlare Zone This module provide a way to create a CloudFlare zone with all the necessary configurations.

Module documentation

The documentation is automatically generated by terraform-docs, and it's available in the module's README.md file.

Mono-repo structure

  • ⚡️Modules: refers to the actual module's directory. Where the .tf files reside. Each subdirectory is a module.
  • ⚡️Examples: refers to the examples directory, where the examples recipes lives. These are also used for testing the infrastructure using Terratest. For its specific documentation, query this link
  • ⚡️Tests: refers to the tests directory, where the tests recipes lives. These are also used for testing the infrastructure using Terratest. For its specific documentation, query this link

Developer Experience

Some tools that this repo uses:

  • 🧰 Terraform — strongly recommended the latest versions
  • 🧰 Go — justified mostly for Terratest
  • 🧰 TaskFile — for the automation of the tasks.
  • 🧰 Make — for the automation of the tasks.

NOTE: For automation during the development process, I use precommit, which is a framework for managing and maintaining multi-language pre-commit hooks. It's a great tool, and I highly recommend it. All the hooks required are installed by this script. It's recommended though to run it through the TaskFile task pre-commit-init.

To initialize your pre-commit configuration, and ensure all the hooks are installed, run the following command:

# Using taskFiles
task pc-init
# Using make
make pc-init

To run these hooks against all the files, you can use the following Task command:

# Using taskFiles
task pc-run
# Using make
make pc-run

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Given a version number MAJOR.MINOR.PATCH, we increment the:

  1. MAJOR version when we make incompatible changes,
  2. MINOR version when we add functionality in a backwards compatible manner, and
  3. PATCH version when we make backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • Backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • Backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

NOTE: The releases are automatically generated using release-please-action. For more information, please refer to the release-please-action documentation

Contributing

Contributions are always encouraged and welcome! ❤️. For the process of accepting changes, please refer to the CONTRIBUTING.md file, and for a more detailed explanation, please refer to this guideline here.

License

license

This module is licensed under the Apache License Version 2.0, January 2004. Please see LICENSE for full details.

Contact

made/with ❤️ 🤟