Skip to content

Commit 44d5e91

Browse files
Merge branch 'release/v1.0.2' into 'main'
Fix undefined variable in README See merge request sq-ia/aws/ec2-keypair!10
2 parents d7fff3d + ff89533 commit 44d5e91

File tree

2 files changed

+47
-6
lines changed

2 files changed

+47
-6
lines changed

README.md

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,25 @@
33

44
[squareops_avatar]: https://squareops.com/wp-content/uploads/2022/12/squareops-logo.png
55

6-
### [SquareOps Technologies](https://squareops.com/) Provide end to end solution for all your DevOps needs
6+
### [SquareOps Technologies](https://squareops.com/) Your DevOps Partner for Accelerating cloud journey.
7+
78

89
<br>
910

10-
Terraform module which creates EC2 key pair on AWS. The private key will be stored on SSM.
11+
Terraform module which creates EC2 key pair on AWS. The private key will be stored in AWS Systems Manager's Parameter Store.
1112

1213
## Usage Example
1314

1415
```hcl
1516
module "key_pair" {
1617
source = "squareops/keypair/aws"
1718
18-
environment = production
19-
key_name = example-key
20-
ssm_parameter = production-example-key
19+
environment = "production"
20+
key_name = "example-key"
21+
ssm_parameter_path = "production-example-key"
2122
}
2223
```
23-
Refer [examples](https://github.com/squareops/terraform-aws-keypair/tree/main/examples) for all examples.
24+
Refer [this](https://github.com/squareops/terraform-aws-keypair/tree/main/examples) for more examples.
2425

2526

2627
## Retrieve Private Key
@@ -81,3 +82,42 @@ The required IAM permissions to create resources from this module can be found [
8182
| <a name="output_key_pair_name"></a> [key\_pair\_name](#output\_key\_pair\_name) | The key pair name. |
8283
| <a name="output_ssm_parameter_arn"></a> [ssm\_parameter\_arn](#output\_ssm\_parameter\_arn) | The SSM parameter ARN of key pair. |
8384
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
85+
86+
## Contribution & Issue Reporting
87+
88+
To report an issue with a project:
89+
90+
1. Check the repository's [issue tracker](https://github.com/squareops/terraform-aws-keypair/issues) on GitHub
91+
2. Search to see if the issue has already been reported
92+
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 .
93+
94+
## License
95+
96+
Apache License, Version 2.0, January 2004 (http://www.apache.org/licenses/).
97+
98+
## Support Us
99+
100+
To support a GitHub project by liking it, you can follow these steps:
101+
102+
1. Visit the repository: Navigate to the [GitHub repository](https://github.com/squareops/terraform-aws-keypair)
103+
104+
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.
105+
106+
3. Optionally, you can also leave a comment on the repository or open an issue to give feedback or suggest changes.
107+
108+
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.
109+
110+
## Who we are
111+
112+
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.
113+
114+
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.
115+
2. Expertise in Kubernetes and overall container solution helps companies expedite their journey by 10X.
116+
3. Infrastructure Automation is a key component to the success of our Clients and our Expertise helps deliver the same in the shortest time.
117+
4. DevSecOps as a service to implement security within the overall DevOps process and helping companies deploy securely and at speed.
118+
5. Platform engineering which supports scalable,Cost efficient infrastructure that supports rapid development, testing, and deployment.
119+
6. 24*7 SRE service to help you Monitor the state of your infrastructure and eradicate any issue within the SLA.
120+
121+
We provide [support](https://squareops.com/contact-us/) on all of our projects, no matter how small or large they may be.
122+
123+
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/).

examples/complete/main.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@ module "key_pair" {
1717

1818
key_name = format("%s-%s-kp", local.environment, local.name)
1919
ssm_parameter_path = format("%s-%s-ssm", local.environment, local.name) #SSM parameter secret name
20+
environment = local.environment
2021

2122
}

0 commit comments

Comments
 (0)