Skip to content

Commit 500302f

Browse files
s2504sconst-bon
authored andcommitted
Updated README (#14)
1 parent 70fb952 commit 500302f

File tree

2 files changed

+91
-4
lines changed

2 files changed

+91
-4
lines changed

README.md

Lines changed: 89 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# terraform-aws-ec2-instance [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-ec2-instance.svg)](https://travis-ci.org/cloudposse/terraform-aws-ec2-instance)
22

3-
Terraform Module for providing a server capable of running admin tasks. Use `terraform-aws-ec2-instance` to create and manage an admin instance.
3+
Terraform Module for providing a general purpose EC2 host.
4+
5+
Included features:
6+
* Automatically create a Security Group
7+
* Option to switch EIP attachment
8+
* CloudWatch monitoring and automatic reboot if instance hangs
9+
* [Github Authorized Keys](https://github.com/cloudposse/terraform-template-user-data-github-authorized-keys)
10+
* Assume Role capability
411

512
## Usage
613

@@ -92,4 +99,84 @@ resource "aws_ami_from_instance" "example" {
9299

93100

94101
## References
95-
* Thanks to https://github.com/cloudposse/tf_bastion for the inspiration
102+
* https://github.com/cloudposse/terraform-aws-ec2-bastion-server
103+
104+
## Help
105+
106+
**Got a question?**
107+
108+
Review the [docs](docs/), file a GitHub [issue](https://github.com/cloudposse/terraform-aws-ec2-instance/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
109+
110+
111+
## Contributing
112+
113+
### Bug Reports & Feature Requests
114+
115+
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ec2-instance/issues) to report any bugs or file feature requests.
116+
117+
### Developing
118+
119+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
120+
121+
1. **Fork** the repo on GitHub
122+
2. **Clone** the project to your own machine
123+
3. **Commit** changes to your own branch
124+
4. **Push** your work back up to your fork
125+
5. Submit a **Pull request** so that we can review your changes
126+
127+
**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
128+
129+
## License
130+
131+
[APACHE 2.0](LICENSE) © 2016-2017 [Cloud Posse, LLC](https://cloudposse.com)
132+
133+
Licensed to the Apache Software Foundation (ASF) under one
134+
or more contributor license agreements. See the NOTICE file
135+
distributed with this work for additional information
136+
regarding copyright ownership. The ASF licenses this file
137+
to you under the Apache License, Version 2.0 (the
138+
"License"); you may not use this file except in compliance
139+
with the License. You may obtain a copy of the License at
140+
141+
http://www.apache.org/licenses/LICENSE-2.0
142+
143+
Unless required by applicable law or agreed to in writing,
144+
software distributed under the License is distributed on an
145+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
146+
KIND, either express or implied. See the License for the
147+
specific language governing permissions and limitations
148+
under the License.
149+
150+
151+
## About
152+
153+
This module is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
154+
155+
We love [Open Source Software](https://github.com/cloudposse/)!
156+
157+
See [our other projects][community]
158+
or [hire us][hire] to help build your next cloud-platform.
159+
160+
[website]: http://cloudposse.com/
161+
[community]: https://github.com/cloudposse/
162+
[hire]: http://cloudposse.com/contact/
163+
164+
### Contributors
165+
166+
| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Igor Rodionov][igor_img]][igor_web]<br/>[Igor Rodionov][igor_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] | [![Sergey Vasilyev][sergey_img]][sergey_web]<br/>[Sergey Vasilyev][sergey_web] | [![Konstantin B][konstantin_img]][konstantin_web]<br/>[Konstantin B][konstantin_web] | [![Valeriy][valeriy_img]][valeriy_web]<br/>[Valeriy][valeriy_web] | [![Vladimir][vladimir_img]][vladimir_web]<br/>[Vladimir][vladimir_web] |
167+
|---------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -----------------------------------------------------------------------|
168+
169+
[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
170+
[erik_web]: https://github.com/osterman/
171+
[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
172+
[igor_web]: https://github.com/goruha/
173+
[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
174+
[andriy_web]: https://github.com/aknysh/
175+
[sergey_img]: https://avatars1.githubusercontent.com/u/1134449?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
176+
[sergey_web]: https://github.com/s2504s/
177+
[konstantin_img]: https://avatars1.githubusercontent.com/u/11299538?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
178+
[konstantin_web]: https://github.com/comeanother/
179+
[valeriy_img]: https://avatars1.githubusercontent.com/u/10601658?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
180+
[valeriy_web]: https://github.com/drama17/
181+
[vladimir_img]: https://avatars1.githubusercontent.com/u/26582191?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
182+
[vladimir_web]: https://github.com/SweetOps/

main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ data "aws_iam_policy_document" "default" {
1717

1818
# Apply the tf_label module for this resource
1919
module "label" {
20-
source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.2.1"
20+
source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.3.1"
2121
namespace = "${var.namespace}"
2222
stage = "${var.stage}"
2323
name = "${var.name}"
@@ -74,7 +74,7 @@ resource "aws_security_group" "default" {
7474

7575
# Apply the tf_github_authorized_keys module for this resource
7676
module "github_authorized_keys" {
77-
source = "git::https://github.com/cloudposse/terraform-template-user-data-github-authorized-keys.git?ref=tags/0.1.1"
77+
source = "git::https://github.com/cloudposse/terraform-template-user-data-github-authorized-keys.git?ref=tags/0.1.2"
7878
github_api_token = "${var.github_api_token}"
7979
github_organization = "${var.github_organization}"
8080
github_team = "${var.github_team}"

0 commit comments

Comments
 (0)