Skip to content

Latest commit

 

History

History
160 lines (107 loc) · 8.08 KB

README.md

File metadata and controls

160 lines (107 loc) · 8.08 KB
Raw

Terraform AWS SFTP

This terraform module is used to create sftp on AWS for S3.

Terraform Licence tfsec static-checks

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 Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source 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. 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:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple Example

Here is an example of how you can use this module in your inventory structure:

  module "sftp" {
        source                    = "clouddrove/sftp/aws"
        version                   = "0.15.0"
        name                      = "sftp"
        environment               = "test"
        label_order               = ["name", "environment"]
        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
attributes Additional attributes (e.g. 1). list(any) [] 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). string "" no
label_order Label order, e.g. name,application. list(any) [] no
managedby ManagedBy, eg 'CloudDrove'. string "[email protected]" no
name Name (e.g. app or cluster). string "" no
public_key Name (e.g. ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ). string "" no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-sftp" 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
sub_folder Landind folder. string "" no
tags Additional tags (e.g. map(BusinessUnit,XYZ). map(any) {} no
user_name User name for SFTP server. string n/a yes
vpc_id VPC ID string "" 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 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 in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at [email protected].

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, 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.

We are The Cloud Experts!

We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.