Skip to content

Commit

Permalink
Migrate readme yaml (#26)
Browse files Browse the repository at this point in the history 
* Migrate readme yaml
  • Loading branch information
@vadim-gleif
vadim-gleif authored Jul 17, 2018
1 parent 82fe791 commit 8e75969
Show file tree
Hide file tree
Showing 9 changed files with 432 additions and 56 deletions.
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ secrets.tfvars
.terraform
.idea
*.iml

.build-harness
build-harness
10 changes: 5 additions & 5 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ install:
- make init

script:
- make terraform:install
- make terraform:get-plugins
- make terraform:get-modules
- make terraform:lint
- make terraform:validate
- make terraform/install
- make terraform/get-plugins
- make terraform/get-modules
- make terraform/lint
- make terraform/validate
6 changes: 5 additions & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
SHELL := /bin/bash

# List of targets the `readme` target should call before generating the readme
export README_DEPS ?= docs/targets.md docs/terraform.md

-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)

## Lint terraform code
lint:
$(SELF) terraform:install terraform:get-modules terraform:get-plugins terraform:lint terraform:validate
$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate
242 changes: 205 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# terraform-aws-efs-backup [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-efs-backup.svg)](https://travis-ci.org/cloudposse/terraform-aws-efs-backup)
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->

[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)

# terraform-aws-efs-backup [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-efs-backup.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-efs-backup) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-efs-backup.svg)](https://github.com/cloudposse/terraform-aws-efs-backup/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)


Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline.

Expand All @@ -12,6 +17,21 @@ The workflow is simple:
* Automatically rotate the backups using `S3 lifecycle rule`


---

This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps.


It's 100% Open Source and licensed under the [APACHE2](LICENSE).









## Usage

Include this module in your existing terraform code:
Expand All @@ -36,39 +56,6 @@ output "efs_backup_security_group" {
value = "${module.efs_backup.security_group_id}"
}
```


## Variables

| Name | Default | Description | Required |
|:-----------------------------------|:--------------:|:----------------------------------------------------------------------------------------------|:--------:|
| namespace | `` | Namespace (e.g. `cp` or `cloudposse`) | Yes |
| stage | `` | Stage (e.g. `prod`, `dev`, `staging`) | Yes |
| name | `` | Name (e.g. `app` or `wordpress`) | Yes |
| region | `us-east-1` | (Optional) AWS Region. If not specified, will be derived from 'aws_region' data source | No |
| vpc_id | `` | AWS VPC ID where module should operate (_e.g._ `vpc-a22222ee`) | Yes |
| efs_mount_target_id | `` | Elastic File System Mount Target ID (_e.g._ `fsmt-279bfc62`) | Yes |
| use_ip_address | `false` | If set to `true`, will use IP address instead of DNS name to connect to the `EFS` | Yes |
| modify_security_group | `false` | Should the module modify the `EFS` security group | No |
| noncurrent_version_expiration_days | `35` | S3 object versions expiration period (days) | Yes |
| ssh_key_pair | `` | `SSH` key that will be deployed on DataPipeline's instance | No |
| datapipeline_config | `${map("instance_type", "t2.micro", "email", "", "period", "24 hours", "timeout", "60 Minutes")}"`| DataPipeline configuration options | Yes |
| attributes | `[]` | Additional attributes (_e.g._ `efs-backup`) | No |
| tags | `{}` | Additional tags (e.g. `map("BusinessUnit","XYZ")` | No |
| delimiter | `-` | Delimiter to be used between `name`, `namespace`, `stage` and `attributes` | No |


### `datapipeline_config` variables

| Name | Default | Description | Required |
|:-----------------------------------|:--------------:|:-----------------------------------------------------------------------------|:--------:|
| instance_type | `t2.micro` | Instance type to use | Yes |
| email | `` | Email to use in `SNS`. Needs to be provided, otherwise the module will fail | Yes |
| period | `24 hours` | Frequency of pipeline execution (frequency of backups) | Yes |
| timeout | `60 Minutes` | Pipeline execution timeout | Yes |



## Integration with `EFS`

To enable connectivity between the `DataPipeline` instances and the `EFS`, use one of the following methods to configure Security Groups:
Expand Down Expand Up @@ -129,11 +116,192 @@ At this time you cannot use a Security Group with in-line rules in conjunction w
Doing so will cause a conflict of rule settings and will overwrite rules.






## Makefile Targets
```
Available targets:
help This help screen
help/all Display help for all targets
lint Lint terraform code
```

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| attributes | Additional attributes (e.g. `efs-backup`) | list | `<list>` | no |
| datapipeline_config | DataPipeline configuration options | map | `<map>` | no |
| delimiter | Delimiter to be used between `name`, `namespace`, `stage`, etc. | string | `-` | no |
| efs_mount_target_id | EFS Mount Target ID (e.g. `fsmt-279bfc62`) | string | - | yes |
| modify_security_group | Should the module modify the `EFS` security group | string | `false` | no |
| name | The Name of the application or solution (e.g. `bastion` or `portal`) | string | - | yes |
| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes |
| noncurrent_version_expiration_days | S3 object versions expiration period (days) | string | `35` | no |
| region | (Optional) AWS Region. If not specified, will be derived from 'aws_region' data source | string | `` | no |
| ssh_key_pair | `SSH` key that will be deployed on DataPipeline's instance | string | - | yes |
| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes |
| tags | Additional tags (e.g. `map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
| use_ip_address | If set to `true`, will use IP address instead of DNS name to connect to the `EFS` | string | `false` | no |
| vpc_id | VPC ID | string | `` | no |

## Outputs

| Name | Description |
|------|-------------|
| backups_bucket_name | Backups bucket name |
| datapipeline_ids | Datapipeline ids |
| logs_bucket_name | Logs bucket name |
| security_group_id | Security group id |




## Related Projects

Check out these related projects.

- [terraform-aws-efs](https://github.com/cloudposse/terraform-aws-efs) - Terraform Module to define an EFS Filesystem (aka NFS)
- [terraform-aws-efs-cloudwatch-sns-alarms](https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms) - Terraform module that configures CloudWatch SNS alerts for EFS




## References

* Thanks https://github.com/knakayama/datapipeline-efs-backup-demo for inspiration
For additional context, refer to some of these links.

- [datapipeline-efs-backup-demo](https://github.com/knakayama/datapipeline-efs-backup-demo) - Thanks for inspiration


## Help

**Got a question?**

File a GitHub [issue](https://github.com/cloudposse/terraform-aws-efs-backup/issues), send us an [email][email] or join our [Slack Community][slack].

## Commerical Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide *commercial support* for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer.

[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com)

- **Questions.** We'll use a Shared Slack channel between your team and ours.
- **Troubleshooting.** We'll help you triage why things aren't working.
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure.
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
- **Implementation.** We'll provide hands on support to implement our reference architectures.


## Community Forum

Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure.

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-efs-backup/issues) to report any bugs or file feature requests.

### Developing

If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!


## Copyright

Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)



## License

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

See [LICENSE](LICENSE) for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
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.

## About

This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>

[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)

We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!

We offer paid support on all of our projects.

Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.

[docs]: https://docs.cloudposse.com/
[website]: https://cloudposse.com/
[github]: https://github.com/cloudposse/
[jobs]: https://cloudposse.com/jobs/
[hire]: https://cloudposse.com/contact/
[slack]: https://slack.cloudposse.com/
[linkedin]: https://www.linkedin.com/company/cloudposse
[twitter]: https://twitter.com/cloudposse/
[email]: mailto:hello@cloudposse.com


### Contributors

| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Sergey Vasilyev][s2504s_avatar]][s2504s_homepage]<br/>[Sergey Vasilyev][s2504s_homepage] | [![abferm][abferm_avatar]][abferm_homepage]<br/>[abferm][abferm_homepage] |
|---|---|---|---|

[osterman_homepage]: https://github.com/osterman
[osterman_avatar]: https://github.com/osterman.png?size=150
[aknysh_homepage]: https://github.com/aknysh
[aknysh_avatar]: https://github.com/aknysh.png?size=150
[s2504s_homepage]: https://github.com/s2504s
[s2504s_avatar]: https://github.com/s2504s.png?size=150
[abferm_homepage]: https://github.com/abferm
[abferm_avatar]: https://github.com/abferm.png?size=150

## License

Apache 2 License. See [`LICENSE`](LICENSE) for full details.
Loading

0 comments on commit 8e75969

Please sign in to comment.