From 70f7472e6311600cb6d447399887ae6934ca53e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?readme-action=20=F0=9F=93=96?= Date: Fri, 14 Jun 2024 15:56:30 +0000 Subject: [PATCH] chore: update README.md --- README.md | 56 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 38 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ba978f7..663c860 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,9 @@ Terraform module to provision a CloudFlare zone with: DNS records, Argo, Firewall filters and rules. + > [!TIP] -> -> ### 👽 Use Atmos with Terraform -> +> #### 👽 Use Atmos with Terraform > Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform.
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift). > @@ -33,7 +39,11 @@ Terraform module to provision a CloudFlare zone with: DNS records, Argo, Firewal > Watch demo of using Atmos with Terraform >
> Example of running atmos to manage infrastructure from our Quick Start tutorial. -> +> + + + + ## Usage @@ -85,14 +95,20 @@ module "zone" { > you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic > approach for updating versions to avoid unexpected changes. + + + + ## Examples Here is an example of using this module: - - [`examples/complete`](examples/complete) - complete example of using this module -## Makefile Targets + + + +## Makefile Targets ```text Available targets: @@ -102,7 +118,8 @@ Available targets: lint Lint terraform code ``` - + + ## Requirements | Name | Version | @@ -115,8 +132,8 @@ Available targets: | Name | Version | |------|---------| -| [cloudflare](#provider\_cloudflare) | 4.34.0 | -| [time](#provider\_time) | 0.11.2 | +| [cloudflare](#provider\_cloudflare) | >= 4.0 | +| [time](#provider\_time) | >= 0.8 | ## Modules @@ -188,6 +205,7 @@ Available targets: | [verification\_key](#output\_verification\_key) | Contains the TXT record value to validate domain ownership. This is only populated for zones of type `partial`. | + ## Related Projects Check out these related projects. @@ -195,15 +213,17 @@ Check out these related projects. - [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes]) - [terraform-cloudflare-waf-rulesets](https://github.com/cloudposse/terraform-cloudflare-waf-rulesets) - Terraform module to manage CloudFlare WAF rulesetes + ## References For additional context, refer to some of these links. - [terraform-provider-cloudflare](https://registry.terraform.io/providers/cloudflare/cloudflare/latest) - Cloudflare Terraform Provider + + > [!TIP] -> -> ### Use Terraform Reference Architectures for AWS +> #### Use Terraform Reference Architectures for AWS > > Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly. > @@ -221,9 +241,7 @@ For additional context, refer to some of these links. > *Your team can operate like a pro today.* > > Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed. -> -> ### Day-0: Your Foundation for Success -> +> #### Day-0: Your Foundation for Success > - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code. > - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases. > - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance. @@ -232,8 +250,7 @@ For additional context, refer to some of these links. > > Request Quote > -> ### Day-2: Your Operational Mastery -> +> #### Day-2: Your Operational Mastery > - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency. > - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it. > - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity. @@ -249,6 +266,8 @@ For additional context, refer to some of these links. This project is under active development, and we encourage contributions from our community. + + Many thanks to our outstanding contributors: @@ -258,7 +277,6 @@ Many thanks to our outstanding contributors: For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-cloudflare-zone/issues). In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. - 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-cloudflare-zone/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md). 2. **Fork** the repo on GitHub 3. **Clone** the project to your own machine @@ -310,17 +328,19 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ``` - ## Trademarks All other trademarks referenced herein are the property of their respective owners. + ## Copyrights Copyright © 2021-2024 [Cloud Posse, LLC](https://cloudposse.com) + + README footer Beacon