create examples

Author: Sohan

README.md

@@ -2,11 +2,13 @@
 
 
 <h1 align="center">
-    Terraform DigitalOcean SSH Key
+    Terraform DigitalOcean SSL Certificate
+
+
 </h1>
 
-<p align="center" style="font-size: 1.2rem;">
-    Provides a DigitalOcean SSH key resource to allow you to manage SSH keys for Droplet access.
+<p align="center" style="font-size: 1.2rem;"> 
+    Provides a DigitalOcean Certificate resource that allows you to manage certificates.
      </p>
 
 <p align="center">
@@ -22,13 +24,13 @@
 </p>
 <p align="center">
 
-<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-digitalocean-ssh-key'>
+<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
   <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
 </a>
-<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+SSH+Key&url=https://github.com/clouddrove/terraform-digitalocean-ssh-key'>
+<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
   <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
 </a>
-<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+SSH+Key&url=https://github.com/clouddrove/terraform-digitalocean-ssh-key'>
+<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
   <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
 </a>
 
@@ -41,7 +43,7 @@
 
 ## Prerequisites
 
-This module has a few dependencies:
+This module has a few dependencies: 
 
 
 
@@ -50,18 +52,28 @@ This module has a few dependencies:
 
 
 
-**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).
+**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-ssl-certificate/releases).
 
 
-### Simple Example
-Here is an example of how you can use this module in your inventory structure:
+Here are examples of how you can use this module in your inventory structure:
+### custom-certificate
+```hcl
+    module "custom_certificate" {
+    source             = "./../../"
+    certificate_name   = "test"
+    private_key        = "./../../../_ssl/private-key.pem"
+    leaf_certificate   = "./../../../_ssl/star.crt"
+    custom_certificate = true
+  }
+```
+### lets-encrypt-certificate
 ```hcl
-    module "ssh-key" {
-      source          = "./../"
-      key             = "~/.ssh/id_rsa.pub"
-      key_name        = "devops"
-      enable_ssh_key  = true
-    }
+    module "lets_encrypt_certificate" {
+    source                   = "./../../"
+    certificate_name         = "test"
+    domain_names             = ["clouddrove.com"]
+    lets_encrypt_certificate = true
+  }
 ```
 
 
@@ -73,27 +85,33 @@ Here is an example of how you can use this module in your inventory structure:
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| enable_ssh_key | A boolean flag to enable/disable ssh key. | bool | `true` | no |
-| key_name | Name  (e.g. `it-admin` or `devops`). | string | `` | no |
-| key_path | Name  (e.g. `~/.ssh/id_rsa.pub` or `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD3F6tyPEFEzV0LX3X8BsXdMsQ`). | string | `` | no |
+| certificate_chain | Path of certificate chain. | string | `` | no |
+| certificate_name | The name of the certificate for identification. | string | `` | no |
+| custom_certificate | A boolean flag to enable/disable custom_certificate. | bool | `false` | no |
+| domain_names | List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean's DNS. Only valid when type is lets_encrypt. | list | `<list>` | no |
+| enable_certificate | A boolean flag to enable/disable certificate. | bool | `true` | no |
+| leaf_certificate | Path of certificate body. | string | `~` | no |
+| lets_encrypt_certificate | A boolean flag to enable/disable lets_encrypt_certificate. | bool | `false` | no |
+| private_key | Path of private key. | string | `` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| id | The unique ID of the key. |
-| name | Name of SSH key. |
-| public_key | The text of the public key. |
+| id | The unique ID of the certificate. |
+| name | The name of the certificate. |
+| not_after | The expiration date of the certificate. |
+| sha1_fingerprint | The SHA-1 fingerprint of the certificate. |
 
 
 
 
 
 
-## Feedback
-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]).
+## Feedback 
+If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-digitalocean-ssl-certificate/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
 
-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)!
+If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-digitalocean-ssl-certificate)!
 
 ## About us
 
@@ -108,4 +126,4 @@ At [CloudDrove][website], we offer expert guidance, implementation support and s
   [linkedin]: https://cpco.io/linkedin
   [twitter]: https://twitter.com/clouddrove/
   [email]: https://clouddrove.com/contact-us.html
-  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
+  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=

README.yaml

@@ -5,13 +5,13 @@
 #
 
 # Name of this project
-name : Terraform DigitalOcean SSH Key
+name : Terraform DigitalOcean SSL Certificate
 
 # License of this project
 license: "MIT"
 
 # Canonical GitHub repo
-github_repo: clouddrove/terraform-digitalocean-ssh-key
+github_repo: clouddrove/terraform-digitalocean-ssl-certificate
 
 # Badges to display
 badges:
@@ -24,21 +24,31 @@ badges:
 
 #  description of this project
 description: |-
-  Provides a DigitalOcean SSH key resource to allow you to manage SSH keys for Droplet access.
+  Provides a DigitalOcean Certificate resource that allows you to manage certificates.
 
 # extra content
 include:
   - "terraform.md"
 
 # How to use this project
 usage : |-
-  ### Simple Example
-  Here is an example of how you can use this module in your inventory structure:
+  Here are examples of how you can use this module in your inventory structure:
+  ### custom-certificate
   ```hcl
-      module "ssh-key" {
-        source          = "./../"
-        key             = "~/.ssh/id_rsa.pub"
-        key_name        = "devops"
-        enable_ssh_key  = true
-      }
+      module "custom_certificate" {
+      source             = "./../../"
+      certificate_name   = "test"
+      private_key        = "./../../../_ssl/private-key.pem"
+      leaf_certificate   = "./../../../_ssl/star.crt"
+      custom_certificate = true
+    }
+  ```
+  ### lets-encrypt-certificate
+  ```hcl
+      module "lets_encrypt_certificate" {
+      source                   = "./../../"
+      certificate_name         = "test"
+      domain_names             = ["clouddrove.com"]
+      lets_encrypt_certificate = true
+    }
   ```

_example/custom_certificate/example.tf

@@ -0,0 +1,14 @@
+
+provider "digitalocean" {
+  # You need to set this in your .bashrc
+  # export DIGITALOCEAN_TOKEN="Your API TOKEN"
+  #
+}
+
+module "custom_certificate" {
+  source             = "./../../"
+  certificate_name   = "test"
+  private_key        = "./../../../_ssl/private-key.pem"
+  leaf_certificate   = "./../../../_ssl/star.crt"
+  custom_certificate = true
+}

_example/custom_certificate/outputs.tf

@@ -0,0 +1,5 @@
+
+output "id" {
+  value       = module.custom_certificate.*.id
+  description = "The unique ID of the certificate."
+}

_example/example.tf

@@ -0,0 +1,16 @@
+
+provider "digitalocean" {
+  # You need to set this in your .bashrc
+  # export DIGITALOCEAN_TOKEN="Your API TOKEN"
+  #
+}
+
+module "lets_encrypt_certificate" {
+  source                   = "./../../"
+  certificate_name         = "test"
+  domain_names             = ["clouddrove.com"]
+  lets_encrypt_certificate = true
+}
+
+
+

_example/lets_encrypt_certificate/example.tf

@@ -0,0 +1,4 @@
+output "id" {
+  value       = module.lets_encrypt_certificate.*.id
+  description = "The unique ID of the certificate."
+}

_example/lets_encrypt_certificate/outputs.tf

@@ -1,25 +1,25 @@
 ## Managed By : CloudDrove
-##Description : This Script is used to create Certificate Key.
+##Description : This Script is used to create SSL Certificate.
 ## Copyright @ CloudDrove. All Right Reserved.
 
 #Module      : Certificate
-#Description :Provides a DigitalOcean Certificate resource that allows you to manage certificates.
+#Description : Provides a DigitalOcean Certificate resource that allows you to manage certificates.
 resource "digitalocean_certificate" "custom" {
-  count = var.enable_certificate  &&  var.custom_certificate   == true ? 1 : 0
+  count = var.enable_certificate && var.custom_certificate == true ? 1 : 0
 
   name              = var.certificate_name
   type              = "custom"
-  private_key       = file(var.private_key)
-  leaf_certificate  = file(var.leaf_certificate)
-  certificate_chain  = file(var.certificate_chain)
+  private_key       = var.private_key != "" ? file(var.private_key) : null
+  leaf_certificate  = var.leaf_certificate != "" ? file(var.leaf_certificate) : null
+  certificate_chain = var.certificate_chain != "" ? file(var.certificate_chain) : null
 }
 
 #Module      : Certificate
 #Description :Provides a DigitalOcean Certificate resource that allows you to manage certificates.
 resource "digitalocean_certificate" "lets_encrypt" {
-  count       = var.enable_certificate  &&  var.lets_encrypt_certificate   == true ? 1 : 0
+  count = var.enable_certificate && var.lets_encrypt_certificate == true ? 1 : 0
 
-  name        = var.certificate_name
+  name    = var.certificate_name
   type    = "lets_encrypt"
-  domains     = var.domain_names
+  domains = var.domain_names
 }

_example/outputs.tf

@@ -0,0 +1,22 @@
+#Module      : Certificate
+#Description :Provides a DigitalOcean Certificate resource that allows you to manage certificates.
+
+output "id" {
+  value       = var.custom_certificate ? join("", digitalocean_certificate.custom.*.id) : join("", digitalocean_certificate.lets_encrypt.*.id)
+  description = "The unique ID of the certificate."
+}
+
+output "name" {
+  value       = var.custom_certificate ? join("", digitalocean_certificate.custom.*.name) : join("", digitalocean_certificate.lets_encrypt.*.name)
+  description = "The name of the certificate."
+}
+
+output "not_after" {
+  value       = var.custom_certificate ? join("", digitalocean_certificate.custom.*.not_after) : join("", digitalocean_certificate.lets_encrypt.*.not_after)
+  description = "The expiration date of the certificate."
+}
+
+output "sha1_fingerprint" {
+  value       = var.custom_certificate ? join("", digitalocean_certificate.custom.*.sha1_fingerprint) : join("", digitalocean_certificate.lets_encrypt.*.sha1_fingerprint)
+  description = "The SHA-1 fingerprint of the certificate."
+}