README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-rsa-encrypt

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Zero A.E., LLC"
    url: "https://zero-ae.com"
    year: "2020"

# Canonical GitHub repo
github_repo: zeroae/terraform-rsa-encrypt

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/zeroae/terraform-shell-rsa-encrypt.svg"
    url: "https://github.com/zeroae/terraform-shell-rsa-encrypt/releases/latest"

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-resource-shell"
    description: "Run (exec) a command in shell and capture the output (stdout, stderr) and status code (exit status)"
    url: "https://github.com/matti/terraform-shell-resource"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "Terraform rsaencrypt hashicorp/terraform#16647"
    description: "Terraform did not include the rsaencrypt function when rsadecrypt was merged"
    url: "https://github.com/hashicorp/terraform/pull/16647"
  - name: "Terraform Standard Module Structure"
    description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
    url: "https://www.terraform.io/docs/modules/index.html#standard-module-structure"
  - name: "Terraform Module Requirements"
    description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
    url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"

# Short description of this project
description: |-
  The `terraform-shell-rsa-encrypt` module can be used for encrypting content using an RSA public key.
  It is the missing part of the built-in "rsadecrypt".

# Introduction to the project
#introduction: |-
#  When `rsadecrypt` was implemented into terraform, the `encrypt` command was [left out](https://github.com/hashicorp/terraform/pull/16647)


# How to use this module. Should be an easy example to copy and paste.
usage: |-
  Here's how to invoke this example module in your projects

  ```hcl
  module "encrypt" {
    source = "zeroae/rsa-encrypt/shell"

    public_key_pem = file("path/to/public-key.pem")
    content_base64 = filebase64("path/to/sensitive.txt")
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](https://github.com/zeroae/terraform-shell-rsa-encrypt/) - complete example of using this module

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Patrick Sodré"
    github: "sodre"