-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3aa2a5b
commit 53026c2
Showing
1 changed file
with
155 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| <!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
|
|
||
| <p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p> | ||
|
|
||
|
|
||
| <h1 align="center"> | ||
| Terraform AWS SFTP | ||
| </h1> | ||
|
|
||
| <p align="center" style="font-size: 1.2rem;"> | ||
| This terraform module is used to create sftp on AWS for S3. | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
||
| <a href="https://www.terraform.io"> | ||
| <img src="https://img.shields.io/badge/terraform-v0.13-green" alt="Terraform"> | ||
| </a> | ||
| <a href="LICENSE.md"> | ||
| <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence"> | ||
| </a> | ||
|
|
||
|
|
||
| </p> | ||
| <p align="center"> | ||
|
|
||
| <a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-sftp'> | ||
| <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" /> | ||
| </a> | ||
| <a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+SFTP&url=https://github.com/clouddrove/terraform-aws-sftp'> | ||
| <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" /> | ||
| </a> | ||
| <a href='https://twitter.com/intent/tweet/?text=Terraform+AWS+SFTP&url=https://github.com/clouddrove/terraform-aws-sftp'> | ||
| <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" /> | ||
| </a> | ||
|
|
||
| </p> | ||
| <hr> | ||
|
|
||
|
|
||
| We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure. | ||
|
|
||
| This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself. | ||
|
|
||
| We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| This module has a few dependencies: | ||
|
|
||
| - [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html) | ||
| - [Go](https://golang.org/doc/install) | ||
| - [github.com/stretchr/testify/assert](https://github.com/stretchr/testify) | ||
| - [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
|
|
||
| **IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-sftp/releases). | ||
|
|
||
|
|
||
| ### Simple Example | ||
| Here is an example of how you can use this module in your inventory structure: | ||
| ```hcl | ||
| module "sftp" { | ||
| source = "clouddrove/sftp/aws" | ||
| version = "0.13.0" | ||
| name = "sftp" | ||
| application = "clouddrove" | ||
| environment = "test" | ||
| label_order = ["environment", "name", "application"] | ||
| key_path = "~/.ssh/id_rsa.pub" | ||
| user_name = "ftp-user" | ||
| enable_sftp = true | ||
| s3_bucket_id = clouddrove_dev_s3_bucket | ||
| endpoint_type = "PUBLIC" | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no | | ||
| | attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no | | ||
| | delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no | | ||
| | enable\_sftp | Set to false to prevent the module from creating any resources. | `bool` | `true` | no | | ||
| | endpoint\_type | The type of endpoint that you want your SFTP server connect to. If you connect to a VPC (or VPC\_ENDPOINT), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC. Defaults to PUBLIC | `string` | `"PUBLIC"` | no | | ||
| | environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no | | ||
| | identity\_provider\_type | The mode of authentication enabled for this service. The default value is SERVICE\_MANAGED, which allows you to store and access SFTP user credentials within the service. API\_GATEWAY. | `string` | `"SERVICE_MANAGED"` | no | | ||
| | key\_path | Name (e.g. `~/.ssh/id_rsa.pub` or `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | `string` | `""` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no | | ||
| | managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no | | ||
| | name | Name (e.g. `app` or `cluster`). | `string` | `""` | no | | ||
| | s3\_bucket\_id | The landing directory (folder) for a user when they log in to the server using their SFTP client. | `string` | n/a | yes | | ||
| | ssh\_key | SSH key | `string` | `"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQz1x2cEikKDEY0aIj41qgxMCP/iteneqXSIFZBp5vizPvaoIR3Um9xK7PGoW8giupGn+EPuxIA4cDM4vzOqOkiMPhz5XK0whEjkVzTo4+S0puvDZuwIsdiW9mxhJc7tgBNL0cYlWSYVkz4G/fslNfRPW5mYAM49f4fhtxPb5ok4Q2Lg9dPKVHO/Bgeu5woMc7RY0p1ej6D4CKFE6lymSDJpW0YHX/wqE9+cfEauh7xZcG0q9t2ta6F6fmX0agvpFyZo8aFbXeUBr7osSCJNgvavWbM/06niWrOvYX2xwWdhXmXSrbX8ZbabVohBK41 example@example.com"` | no | | ||
| | sub\_folder | Landind folder. | `string` | `""` | no | | ||
| | tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no | | ||
| | user\_name | User name for SFTP server. | `string` | n/a | yes | | ||
| | vpc\_id | VPC ID | `string` | `"vpc-0ea04e161d1bc836d"` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | id | The Server ID of the Transfer Server (e.g. s-12345678). | | ||
| | tags | A mapping of tags to assign to the resource. | | ||
| | transfer\_server\_endpoint | The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com). | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Testing | ||
| In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. | ||
|
|
||
| You need to run the following command in the testing folder: | ||
| ```hcl | ||
| go test -run Test | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ## Feedback | ||
| If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-sftp/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com). | ||
|
|
||
| If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-sftp)! | ||
|
|
||
| ## About us | ||
|
|
||
| At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering. | ||
|
|
||
| <p align="center">We are <b> The Cloud Experts!</b></p> | ||
| <hr /> | ||
| <p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p> | ||
|
|
||
| [website]: https://clouddrove.com | ||
| [github]: https://github.com/clouddrove | ||
| [linkedin]: https://cpco.io/linkedin | ||
| [twitter]: https://twitter.com/clouddrove/ | ||
| [email]: https://clouddrove.com/contact-us.html | ||
| [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language= |