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-aws-mobius3

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

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Zero A.E., LLC"
    url: "https://zero-ae.com"
    year: "2020"

# Canonical GitHub repo
github_repo: zeroae/terraform-aws-mobius3

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/zeroae/terraform-aws-mobius3.svg"
    url: "https://github.com/zeroae/terraform-aws-mobius3/releases/latest"

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-ecs-container-definition"
    description: "Terraform module to generate well-formed JSON documents (container definitions) that are passed to the aws_ecs_task_definition Terraform resource."
    url: "https://github.com/cloudposse/terraform-aws-ecs-container-definition.git"
  - name: "terraform-null-label"
    description: "Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention."
    url: "https://github.com/cloudposse/terraform-null-label"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "mobius3"
    description: "Continuously and asynchronously sync a local folder to an S3 bucket."
    url: "https://github.com/uktrade/mobius3"
  - name: "Terraform Standard Module Structure"
    description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
    url: "https://www.terraform.io/docs/modules/index.html#standard-module-structure"
  - name: "Terraform Module Requirements"
    description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
    url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
  - name: "Terraform Version Pinning"
    description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
    url: "https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version"

# Short description of this project
description: |-
  The `terraform-aws-mobius3` module creates the a container definition that syncs an ECS task volumes to S3.

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

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  Here's how to invoke this example module in your projects

  ```hcl
  module "example" {
    source = "https://github.com/zeroae/terraform-aws-mobius3.git?ref=master"

    bucket_id = "example-bucket-name"
    bucket_region = "us-east-1"
    bucket_key_prefix = "rootfs/"
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](https://github.com/cloudposse/terraform-example-module/) - 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:
  - name: "Patrick Sodré"
    github: "sodre"