Terraform AWS Keypair
Terraform module for generating or importing an SSH public key file into AWS.
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:
- Terraform 1.x.x
- Go
- github.com/stretchr/testify/assert
- github.com/gruntwork-io/terratest/modules/terraform
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 "keypair" {
source = "clouddrove/keypair/aws"
version = "1.3.0"
public_key = ""
create_private_key_enabled = true
enable_key_pair = true
}
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
attributes | Additional attributes (e.g. 1 ). |
list(string) |
[] |
no |
create_private_key_enabled | Determines whether a private key will be created | bool |
false |
no |
enable_key_pair | A boolean flag to enable/disable key pair. | bool |
true |
no |
environment | Environment (e.g. prod , dev , staging ). |
string |
"" |
no |
key_name | Name (e.g. it-admin or devops ). |
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 |
private_key_algorithm | Name of the algorithm to use when generating the private key. Currently-supported values are RSA and ED25519 |
string |
"RSA" |
no |
private_key_rsa_bits | When algorithm is RSA , the size of the generated RSA key, in bits (default: 4096 ) |
number |
4096 |
no |
public_key | Name (e.g. ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ ). |
string |
"" |
no |
repository | Terraform current module repo | string |
"https://github.com/clouddrove/terraform-aws-keypair" |
no |
tags | Additional tags (e.g. map(BusinessUnit ,XYZ ). |
map(string) |
{} |
no |
Outputs
Name | Description |
---|---|
arn | The key pair ARN. |
id | The key pair name. |
name | Name of SSH key. |
private_key_id | Unique identifier for this resource: hexadecimal representation of the SHA1 checksum of the resource |
public_key_openssh | The public key data in "Authorized Keys" format. This is populated only if the configured private key is supported: this includes all RSA and ED25519 keys |
public_key_pem | Public key data in PEM (RFC 1421) format |
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.