Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hadenlabs/terraform-aws-key-pair

Terraform Module to Automatically Generate SSH Key Pairs (Public/Private Keys)
https://github.com/hadenlabs/terraform-aws-key-pair

aws hadenlabs key-pair peru terraform terraform-modules

Last synced: 2 days ago
JSON representation

Terraform Module to Automatically Generate SSH Key Pairs (Public/Private Keys)

Awesome Lists containing this project

README

        

[![Latest Release](https://img.shields.io/github/release/hadenlabs/terraform-aws-key-pair)](https://github.com/hadenlabs/terraform-aws-key-pair/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/terraform-aws-key-pair/lint-code)](https://github.com/hadenlabs/terraform-aws-key-pair/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/terraform-aws-key-pair/ci)](https://github.com/hadenlabs/terraform-aws-key-pair/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/terraform-aws-key-pair/test)](https://github.com/hadenlabs/terraform-aws-key-pair/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com)

# terraform-aws-key-pair

terraform-aws-key-pair for project

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [Pyenv](https://github.com/pyenv/pyenv)
- [Docker](https://www.docker.com/)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Usage

```hcl
module "main" {
source = "hadenlabs/key-pair/aws"
version = "0.1.1"
name = "name of key pair"
tags = {
"key": "value"
}
public_key = "filename public key"
}
```

Full working examples can be found in [examples](./examples) folder.

## Examples

### common

```hcl
module "main" {
source = "hadenlabs/key-pair/aws"
version = "0.1.1"

}
```

## Requirements

| Name | Version |
| ------------------------------------------------------------------------ | ------- |
| [terraform](#requirement_terraform) | >= 0.13 |
| [aws](#requirement_aws) | >=3.2.0 |

## Providers

| Name | Version |
| ------------------------------------------------ | ------- |
| [aws](#provider_aws) | >=3.2.0 |

## Modules

No modules.

## Resources

| Name | Type |
| --------------------------------------------------------------------------------------------------------- | -------- |
| [aws_key_pair.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/key_pair) | resource |

## Inputs

| Name | Description | Type | Default | Required |
| --- | --- | --- | --- | :-: |
| [name](#input_name) | name of key pair, e.g. 'key-1' or 'key-2' | `string` | n/a | yes |
| [public_key](#input_public_key) | public key | `string` | n/a | yes |
| [tags](#input_tags) | tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |

## Outputs

| Name | Description |
| ----------------------------------------------------------- | --------------------- |
| [instance](#output_instance) | key_pair of instance. |
| [name](#output_name) | name of key_pair. |

## Help

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/terraform-aws-key-pair/issues).

## Contributing

### Bug Reports & Feature Requests

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

### Development

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 rebase the latest changes from "upstream" before making a pull request!

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like terraform-aws-key-pair

[Your feedback is appreciated](https://github.com/hadenlabs/terraform-aws-key-pair/issues)