https://github.com/excoriate/terraform-cloudflare-modules
A simple but useful collection of modules for CloudFlare ☁️
https://github.com/excoriate/terraform-cloudflare-modules
Last synced: 6 months ago
JSON representation
A simple but useful collection of modules for CloudFlare ☁️
- Host: GitHub
- URL: https://github.com/excoriate/terraform-cloudflare-modules
- Owner: Excoriate
- License: other
- Created: 2024-02-05T10:20:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T06:51:07.000Z (over 1 year ago)
- Last Synced: 2025-02-05T12:18:34.361Z (over 1 year ago)
- Language: HCL
- Size: 87.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
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](./modules/cloudflare-zone) | This module provide a way to create a CloudFlare zone with all the necessary configurations. |
| ✅**Stable** [CloudFlare Records](./modules/cloudflare-zone) | This module provide a way to create one or many records |
---
## Module documentation
The documentation is **automatically generated** by [terraform-docs](https://terraform-docs.io), and it's available in the module's [README.md](modules/default/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](https://terratest.gruntwork.io/). For its specific documentation, query [this link](examples/README.md)
* **⚡️Tests**: refers to the tests directory, where the tests recipes lives. These are also used for testing the infrastructure using [Terratest](https://terratest.gruntwork.io/). For its specific documentation, query [this link](tests/README.md)
---
## Developer Experience
Some tools that this repo uses:
* 🧰 Terraform — strongly recommended the latest versions
* 🧰 Go — justified mostly for **[Terratest](https://terratest.gruntwork.io/)**
* 🧰 [TaskFile](https://taskfile.dev/#/) — for the automation of the tasks.
* 🧰 [Make](https://www.gnu.org/software/make/) — for the automation of the tasks.
>**NOTE**: For automation during the development process, I use [precommit](https://pre-commit.com/), 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](./DevEx/scripts/hooks/install-pre-commit-hooks-deps.sh) script. It's recommended though to run it through the [TaskFile](./TaskFile.yml) task `pre-commit-init`.
To initialize your pre-commit configuration, and ensure all the hooks are installed, run the following command:
```bash
# 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:
```bash
# 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](https://github.com/google-github-actions/release-please-action). For more information, please refer to the [release-please-action documentation](https://github.com/google-github-actions/release-please-action)
## Contributing
Contributions are always encouraged and welcome! ❤️. For the process of accepting changes, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file, and for a more detailed explanation, please refer to this guideline [here](docs/contribution_guidelines.md).
## License
![license][badge-license]
This module is licensed under the Apache License Version 2.0, January 2004.
Please see [LICENSE] for full details.
## Contact
* 📧 **Email**: [Alex T.](mailto:alex@ideaup.cl)
* 🧳 **Linkedin**: [Alex T.](https://www.linkedin.com/in/alextorresruiz/)
_made/with_ ❤️ 🤟
[LICENSE]: ./LICENSE
[badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
[Semantic Versioning (SemVer)]: https://semver.org/