terraform-aws-efs/README.yaml at master · Kiranmoka/terraform-aws-efs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-efs

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - networking
  - efs
  - nfs

# Categories of this project
categories:
  - terraform-modules/networking

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-efs

# Badges to display
badges:
  - name: "Codefresh Build Status"
    image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-efs?type=cf-1"
    url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d14d1b47e4d09d76edd0c7e"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-efs.svg"
    url: "https://github.com/cloudposse/terraform-aws-efs/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-efs-backup"
    description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline"
    url: "https://github.com/cloudposse/terraform-aws-efs-backup"
  - name: "terraform-aws-efs-cloudwatch-sns-alarms"
    description: "Terraform module that configures CloudWatch SNS alerts for EFS"
    url: "https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms"

# Short description of this project
description: |-
  Terraform module to provision an AWS [`EFS`](https://aws.amazon.com/efs/) Network File System.

# How to use this project
usage: |-
  Include this repository as a module in your existing terraform code:

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

    namespace          = "eg"
    stage              = "test"
    name               = "app"
    region             = "us-west-1"
    vpc_id             = var.vpc_id
    subnets            = var.private_subnets
    availability_zones = var.availability_zones
    security_groups    = [var.security_group_id]
    zone_id            = var.aws_route53_dns_zone_id
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Sergey Vasilyev"
    github: "s2504s"
  - name: "Mike Eirih"
    github: "maokomioko"
  - name: "Josh Myers"
    github: "joshmyers"