README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-cloudflare-zone

# Logo for this project
#logo: docs/logo.png

# License of this project
license: APACHE2

# Copyrights
copyrights:
  - name: Cloud Posse, LLC
    url: https://cloudposse.com
    year: '2021'

# Canonical GitHub repo
github_repo: cloudposse/terraform-cloudflare-zone

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-cloudflare-zone.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-cloudflare-zone/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-cloudflare-zone.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-cloudflare-zone/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: terraform-null-label
    description: Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])
    url: https://github.com/cloudposse/terraform-null-label
  - name: terraform-cloudflare-waf-rulesets
    description: Terraform module to manage CloudFlare WAF rulesetes
    url: https://github.com/cloudposse/terraform-cloudflare-waf-rulesets
references:
  - name: terraform-provider-cloudflare
    description: Cloudflare Terraform Provider
    url: https://registry.terraform.io/providers/cloudflare/cloudflare/latest
description: |-
  Terraform module to provision a CloudFlare zone with: DNS records, Argo, Firewall filters and rules.

# Introduction to the project
#introduction: |-
#  This is an introduction.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
  (which tests and deploys the example on AWS), see [test](test).

  ```hcl
  module "label" {
    source = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace  = "eg"
    stage      = "prod"
    name       = "cf"
    delimiter  = "-"
  }

  module "zone" {
    source = "cloudposse/zone/cloudflare"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    account_id = "example-account-id"
    zone       = "cloudposse.co"
    records    = [
      {
        name  = "bastion"
        value = "192.168.1.11"
        type  = "A"
        ttl   = 3600
      },
      {
        name  = "api"
        value = "192.168.2.22"
        type  = "A"
        ttl   = 3600
      }
    ]

    context = module.label.context
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](examples/complete) - complete example of using this module

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - docs/targets.md
  - docs/terraform.md

# Contributors to this project
contributors: []