Skip to content

Commit 22169a1

Browse files
committed
update README.md
1 parent cfba767 commit 22169a1

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
Terraform AWS SFTP
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
This terraform module is used to create sftp on AWS for S3.
1212
</p>
1313

1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/terraform-v0.13-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/Terraform-v0.14-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -38,7 +38,7 @@
3838
<hr>
3939

4040

41-
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.
41+
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.
4242

4343
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.
4444

@@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
4949

5050
## Prerequisites
5151

52-
This module has a few dependencies:
52+
This module has a few dependencies:
5353

5454
- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
5555
- [Go](https://golang.org/doc/install)
@@ -73,11 +73,10 @@ Here is an example of how you can use this module in your inventory structure:
7373
```hcl
7474
module "sftp" {
7575
source = "clouddrove/sftp/aws"
76-
version = "0.13.0"
76+
version = "0.14.0"
7777
name = "sftp"
78-
application = "clouddrove"
7978
environment = "test"
80-
label_order = ["environment", "name", "application"]
79+
label_order = ["name", "environment"]
8180
key_path = "~/.ssh/id_rsa.pub"
8281
user_name = "ftp-user"
8382
enable_sftp = true
@@ -95,23 +94,23 @@ Here is an example of how you can use this module in your inventory structure:
9594

9695
| Name | Description | Type | Default | Required |
9796
|------|-------------|------|---------|:--------:|
98-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
99-
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
97+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
10098
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
10199
| enable\_sftp | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
102100
| 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 |
103101
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
104102
| 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 |
105-
| key\_path | Name (e.g. `~/.ssh/id_rsa.pub` or `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | `string` | `""` | no |
106-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
107-
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
103+
| key\_path | Name (e.g. `~/.ssh/id_rsa.pub`). | `string` | `""` | no |
104+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
105+
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no |
108106
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
107+
| public\_key | Name (e.g. `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | `string` | `""` | no |
108+
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/sftp/aws"` | no |
109109
| 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 |
110-
| ssh\_key | SSH key | `string` | `"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQz1x2cEikKDEY0aIj41qgxMCP/iteneqXSIFZBp5vizPvaoIR3Um9xK7PGoW8giupGn+EPuxIA4cDM4vzOqOkiMPhz5XK0whEjkVzTo4+S0puvDZuwIsdiW9mxhJc7tgBNL0cYlWSYVkz4G/fslNfRPW5mYAM49f4fhtxPb5ok4Q2Lg9dPKVHO/Bgeu5woMc7RY0p1ej6D4CKFE6lymSDJpW0YHX/wqE9+cfEauh7xZcG0q9t2ta6F6fmX0agvpFyZo8aFbXeUBr7osSCJNgvavWbM/06niWrOvYX2xwWdhXmXSrbX8ZbabVohBK41 [email protected]"` | no |
111110
| sub\_folder | Landind folder. | `string` | `""` | no |
112-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
111+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
113112
| user\_name | User name for SFTP server. | `string` | n/a | yes |
114-
| vpc\_id | VPC ID | `string` | `"vpc-0ea04e161d1bc836d"` | no |
113+
| vpc\_id | VPC ID | `string` | `""` | no |
115114

116115
## Outputs
117116

@@ -125,7 +124,7 @@ Here is an example of how you can use this module in your inventory structure:
125124

126125

127126
## Testing
128-
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.
127+
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.
129128

130129
You need to run the following command in the testing folder:
131130
```hcl
@@ -134,7 +133,7 @@ You need to run the following command in the testing folder:
134133

135134

136135

137-
## Feedback
136+
## Feedback
138137
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 [[email protected]](mailto:[email protected]).
139138

140139
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-sftp)!

0 commit comments

Comments
 (0)