Skip to content

Commit 258325e

Browse files
drama17const-bon
drama17
authored and
const-bon
committed
Define Reusable Instance Module Leveraging Ansible (#1)
1 parent c59e638 commit 258325e

File tree

6 files changed

+463
-2
lines changed

6 files changed

+463
-2
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Module directory
2+
.terraform/
3+

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2017 Cloud Posse, LLC
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,79 @@
1-
# tf_admin
2-
Terraform Module for providing a server capable of running admin tasks
1+
# tf_instance
2+
3+
Terraform Module for providing a server capable of running admin tasks. Use `tf_instance` to create and manage an admin instance.
4+
5+
## Usage
6+
7+
Note: add `${var.ssh_key_pair}` private key to the `ssh agent`.
8+
9+
Include this repository as a module in your existing terraform code:
10+
11+
```
12+
module "admin_tier" {
13+
source = "git::https://github.com/cloudposse/tf_instance.git?ref=tags/0.1.0"
14+
ansible_playbook = "${var.ansible_playbook}"
15+
ansible_arguments = "${var.ansible_arguments}"
16+
ssh_key_pair = "${var.ssh_key_pair}"
17+
github_api_token = "${var.github_api_token}"
18+
github_organization = "${var.github_organization}"
19+
github_team = "${var.github_team}"
20+
instance_type = "${var.instance_type}"
21+
vpc_id = "${var.vpc_id}"
22+
security_groups = ["${var.security_groups}"]
23+
subnets = ["${var.subnets}"]
24+
associate_public_ip_address = "${var.associate_public_ip_address}"
25+
}
26+
```
27+
28+
This will create a `id`, `public_hostname` and `public_ip`.
29+
30+
This module depends on these modules:
31+
32+
* [tf_label](https://github.com/cloudposse/tf_label)
33+
* [tf_github_authorized_keys](https://github.com/cloudposse/tf_github_authorized_keys)
34+
* [tf_ansible](https://github.com/cloudposse/tf_ansible)
35+
36+
It is necessary to run `terraform get` to download those modules.
37+
38+
Now reference the label when creating an instance (for example):
39+
```
40+
resource "aws_ami_from_instance" "example" {
41+
name = "terraform-example"
42+
source_instance_id = "${module.admin_tier.id}"
43+
}
44+
```
45+
46+
## Variables
47+
48+
| Name | Default | Description | Required |
49+
|:----------------------------:|:--------------:|:--------------------------------------------------------:|:---------------:|
50+
| `namespace` | `global` | Namespace (e.g. `cp` or `cloudposse`) - required for `tf_label` module | Yes |
51+
| `stage` | `default` | Stage (e.g. `prod`, `dev`, `staging` - required for `tf_label` module | Yes |
52+
| `name` | `admin` | Name (e.g. `bastion` or `db`) - required for `tf_label` module | Yes |
53+
| `ec2_ami` | `ami-cd0f5cb6` | By default it is an AMI provided by Amazon with Ubuntu 16.04 | No |
54+
| `ssh_key_pair` | `` | SSH key pair to be provisioned on instance | Yes |
55+
| `github_api_token` | `` | GitHub API token | Yes |
56+
| `github_organization` | `` | GitHub organization name | Yes |
57+
| `github_team` | `` | GitHub team | Yes |
58+
| `ansible_playbook` | `` | Path to the playbook - required for `tf_ansible` (e.g. `./admin_tier.yml`)|Yes|
59+
| `ansible_arguments` | [] | List of ansible arguments (e.g. `["--user=ubuntu"]`) | No |
60+
| `instance_type` | `t2.micro` | The type of the creating instance (e.g. `t2.micro`) | No |
61+
| `vpc_id` | `` | The id of the VPC that the creating instance security group belongs to | Yes |
62+
| `security_groups` | [] | List of Security Group IDs allowed to connect to creating instance | Yes |
63+
| `subnets` | [] | List of VPC Subnet IDs creating instance launched in | Yes |
64+
| `associate_public_ip_address`| `true` | Associate a public ip address with the creating instance. Boolean value | No |
65+
66+
## Outputs
67+
68+
| Name | Decription |
69+
|:-------------------:|:-----------------------:|
70+
| `id` | Disambiguated ID |
71+
| `public_hostname` | Normalized name |
72+
| `public_ip` | Normalized namespace |
73+
| `ssh_key_pair` | Name of used AWS SSH key|
74+
| `security_group_id` | ID on the new AWS Security Group associated with creating instance|
75+
| `role` | Name of AWS IAM Role associated with creating instance|
76+
77+
78+
## References
79+
* Thanks to https://github.com/cloudposse/tf_bastion for the inspiration

‎main.tf‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Using tf_ansible module
2+
3+
data "aws_iam_policy_document" "default" {
4+
statement {
5+
sid = ""
6+
7+
actions = [
8+
"sts:AssumeRole",
9+
]
10+
11+
principals {
12+
type = "Service"
13+
identifiers = ["ec2.amazonaws.com"]
14+
}
15+
16+
effect = "Allow"
17+
}
18+
}
19+
20+
# Apply the tf_label module for this resource
21+
module "label" {
22+
source = "git::https://github.com/cloudposse/tf_label.git?ref=tags/0.1.0"
23+
namespace = "${var.namespace}"
24+
stage = "${var.stage}"
25+
name = "${var.name}"
26+
}
27+
28+
# Apply the tf_github_authorized_keys module for this resource
29+
module "github_authorized_keys" {
30+
source = "git::https://github.com/cloudposse/tf_github_authorized_keys.git?ref=tags/0.1.0"
31+
github_api_token = "${var.github_api_token}"
32+
github_organization = "${var.github_organization}"
33+
github_team = "${var.github_team}"
34+
}
35+
36+
resource "aws_iam_instance_profile" "default" {
37+
name = "${module.label.id}"
38+
role = "${aws_iam_role.default.name}"
39+
}
40+
41+
resource "aws_iam_role" "default" {
42+
name = "${module.label.id}"
43+
path = "/"
44+
45+
assume_role_policy = "${data.aws_iam_policy_document.default.json}"
46+
}
47+
48+
resource "aws_security_group" "default" {
49+
name = "${module.label.id}"
50+
vpc_id = "${var.vpc_id}"
51+
description = "Instance default security group (only egress access is allowed)"
52+
53+
tags {
54+
Name = "${module.label.id}"
55+
Namespace = "${var.namespace}"
56+
Stage = "${var.stage}"
57+
}
58+
59+
egress {
60+
protocol = "-1"
61+
from_port = 0
62+
to_port = 0
63+
64+
cidr_blocks = [
65+
"0.0.0.0/0",
66+
]
67+
}
68+
69+
lifecycle {
70+
create_before_destroy = true
71+
}
72+
}
73+
74+
resource "aws_instance" "default" {
75+
ami = "${var.ec2_ami}"
76+
instance_type = "${var.instance_type}"
77+
78+
user_data = "${module.github_authorized_keys.user_data}"
79+
80+
vpc_security_group_ids = [
81+
"${compact(concat(list(aws_security_group.default.id), var.security_groups))}"
82+
]
83+
84+
iam_instance_profile = "${aws_iam_instance_profile.default.name}"
85+
associate_public_ip_address = "${var.associate_public_ip_address}"
86+
87+
key_name = "${var.ssh_key_pair}"
88+
89+
subnet_id = "${var.subnets[0]}"
90+
91+
tags {
92+
Name = "${module.label.id}"
93+
Namespace = "${var.namespace}"
94+
Stage = "${var.stage}"
95+
}
96+
}
97+
98+
resource "aws_eip" "default" {
99+
count = "${signum(length(var.associate_public_ip_address)) == 1 ? 1 : 0}"
100+
instance = "${aws_instance.default.id}"
101+
vpc = true
102+
}
103+
104+
# Apply the provisioner module for this resource
105+
module "ansible" {
106+
source = "git::https://github.com/cloudposse/tf_ansible.git?ref=tags/0.2.0"
107+
arguments = "${var.ansible_arguments}"
108+
envs = ["host=${aws_eip.default.public_ip}"]
109+
playbook = "${var.ansible_playbook}"
110+
}

0 commit comments

Comments
 (0)