|
| 1 | +<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> |
| 2 | + |
| 3 | + |
| 4 | +<h1 align="center"> |
| 5 | + Terraform DigitalOcean SSH Key |
| 6 | +</h1> |
| 7 | + |
| 8 | +<p align="center" style="font-size: 1.2rem;"> |
| 9 | + Provides a DigitalOcean SSH key resource to allow you to manage SSH keys for Droplet access. |
| 10 | + </p> |
| 11 | + |
| 12 | +<p align="center"> |
| 13 | + |
| 14 | +<a href="https://www.terraform.io"> |
| 15 | + <img src="https://img.shields.io/badge/Terraform-v0.12-green" alt="Terraform"> |
| 16 | +</a> |
| 17 | +<a href="LICENSE.md"> |
| 18 | + <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence"> |
| 19 | +</a> |
| 20 | + |
| 21 | + |
| 22 | +</p> |
| 23 | +<p align="center"> |
| 24 | + |
| 25 | +<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-digitalocean-ssh-key'> |
| 26 | + <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" /> |
| 27 | +</a> |
| 28 | +<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+SSH+Key&url=https://github.com/clouddrove/terraform-digitalocean-ssh-key'> |
| 29 | + <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" /> |
| 30 | +</a> |
| 31 | +<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+SSH+Key&url=https://github.com/clouddrove/terraform-digitalocean-ssh-key'> |
| 32 | + <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" /> |
| 33 | +</a> |
| 34 | + |
| 35 | +</p> |
| 36 | +<hr> |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +## Prerequisites |
| 43 | + |
| 44 | +This module has a few dependencies: |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +**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-digitalocean-ssh-key/releases). |
| 54 | + |
| 55 | + |
| 56 | +### Simple Example |
| 57 | +Here is an example of how you can use this module in your inventory structure: |
| 58 | +```hcl |
| 59 | + module "ssh-key" { |
| 60 | + source = "./../" |
| 61 | + key = "~/.ssh/id_rsa.pub" |
| 62 | + key_name = "devops" |
| 63 | + enable_ssh_key = true |
| 64 | + } |
| 65 | +``` |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +## Inputs |
| 73 | + |
| 74 | +| Name | Description | Type | Default | Required | |
| 75 | +|------|-------------|:----:|:-----:|:-----:| |
| 76 | +| enable_ssh_key | A boolean flag to enable/disable ssh key. | bool | `true` | no | |
| 77 | +| key_name | Name (e.g. `it-admin` or `devops`). | string | `` | no | |
| 78 | +| key_path | Name (e.g. `~/.ssh/id_rsa.pub` or `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | string | `` | no | |
| 79 | + |
| 80 | +## Outputs |
| 81 | + |
| 82 | +| Name | Description | |
| 83 | +|------|-------------| |
| 84 | +| id | The unique ID of the key. | |
| 85 | +| name | Name of SSH key. | |
| 86 | +| public_key | The text of the public key. | |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | +## Feedback |
| 94 | +If you come accross a bug or have any feedback, please log it in our [issue tracker ](https://github.com/clouddrove/terraform-digitalocean-ssh-key/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]). |
| 95 | + |
| 96 | +If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-digitalocean-ssh-key)! |
| 97 | + |
| 98 | +## About us |
| 99 | + |
| 100 | +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. |
| 101 | + |
| 102 | +<p align="center">We are <b> The Cloud Experts!</b></p> |
| 103 | +<hr /> |
| 104 | +<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> |
| 105 | + |
| 106 | + [website]: https://clouddrove.com |
| 107 | + [github]: https://github.com/clouddrove |
| 108 | + [linkedin]: https://cpco.io/linkedin |
| 109 | + [twitter]: https://twitter.com/clouddrove/ |
| 110 | + [email]: https://clouddrove.com/contact-us.html |
| 111 | + [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language= |
0 commit comments