diff --git a/README.md b/README.md index ea2c2db..cfbc902 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@ [squareops_avatar]: https://squareops.com/wp-content/uploads/2022/12/squareops-logo.png -### [SquareOps Technologies](https://squareops.com/) Provide end to end solution for all your DevOps needs +### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey. +
-Terraform module which creates EC2 key pair on AWS. The private key will be stored on SSM. +Terraform module which creates EC2 key pair on AWS. The private key will be stored in AWS Systems Manager's Parameter Store. ## Usage Example @@ -15,12 +16,12 @@ Terraform module which creates EC2 key pair on AWS. The private key will be stor module "key_pair" { source = "squareops/keypair/aws" - environment = production - key_name = example-key - ssm_parameter = production-example-key + environment = "production" + key_name = "example-key" + ssm_parameter_path = "production-example-key" } ``` -Refer [examples](https://github.com/squareops/terraform-aws-keypair/tree/main/examples) for all examples. +Refer [this](https://github.com/squareops/terraform-aws-keypair/tree/main/examples) for more examples. ## Retrieve Private Key @@ -81,3 +82,42 @@ The required IAM permissions to create resources from this module can be found [ | [key\_pair\_name](#output\_key\_pair\_name) | The key pair name. | | [ssm\_parameter\_arn](#output\_ssm\_parameter\_arn) | The SSM parameter ARN of key pair. | + +## Contribution & Issue Reporting + +To report an issue with a project: + + 1. Check the repository's [issue tracker](https://github.com/squareops/terraform-aws-keypair/issues) on GitHub + 2. Search to see if the issue has already been reported + 3. If you can't find an answer to your question in the documentation or issue tracker, you can ask a question by creating a new issue. Make sure to provide enough context and details . + +## License + +Apache License, Version 2.0, January 2004 (http://www.apache.org/licenses/). + +## Support Us + +To support a GitHub project by liking it, you can follow these steps: + + 1. Visit the repository: Navigate to the [GitHub repository](https://github.com/squareops/terraform-aws-keypair) + + 2. Click the "Star" button: On the repository page, you'll see a "Star" button in the upper right corner. Clicking on it will star the repository, indicating your support for the project. + + 3. Optionally, you can also leave a comment on the repository or open an issue to give feedback or suggest changes. + +Starring a repository on GitHub is a simple way to show your support and appreciation for the project. It also helps to increase the visibility of the project and make it more discoverable to others. + +## Who we are + +We believe that the key to success in the digital age is the ability to deliver value quickly and reliably. That’s why we offer a comprehensive range of DevOps & Cloud services designed to help your organization optimize its systems & Processes for speed and agility. + + 1. We are an AWS Advanced consulting partner which reflects our deep expertise in AWS Cloud and helping 100+ clients over the last 5 years. + 2. Expertise in Kubernetes and overall container solution helps companies expedite their journey by 10X. + 3. Infrastructure Automation is a key component to the success of our Clients and our Expertise helps deliver the same in the shortest time. + 4. DevSecOps as a service to implement security within the overall DevOps process and helping companies deploy securely and at speed. + 5. Platform engineering which supports scalable,Cost efficient infrastructure that supports rapid development, testing, and deployment. + 6. 24*7 SRE service to help you Monitor the state of your infrastructure and eradicate any issue within the SLA. + +We provide [support](https://squareops.com/contact-us/) on all of our projects, no matter how small or large they may be. + +To find more information about our company, visit [squareops.com](https://squareops.com/), follow us on [Linkedin](https://www.linkedin.com/company/squareops-technologies-pvt-ltd/), or fill out a [job application](https://squareops.com/careers/). If you have any questions or would like assistance with your cloud strategy and implementation, please don't hesitate to [contact us](https://squareops.com/contact-us/). diff --git a/examples/complete/main.tf b/examples/complete/main.tf index 3d829c5..398cbaa 100644 --- a/examples/complete/main.tf +++ b/examples/complete/main.tf @@ -17,5 +17,6 @@ module "key_pair" { key_name = format("%s-%s-kp", local.environment, local.name) ssm_parameter_path = format("%s-%s-ssm", local.environment, local.name) #SSM parameter secret name + environment = local.environment }