Skip to content
This repository was archived by the owner on Jan 25, 2023. It is now read-only.

Commit fa8a91c

Browse files
josh-padnickjosh-padnick
authored
Merge pull request #1 from hashicorp/v0.0.1
Initial release of v0.0.1
2 parents f8926f4 + dd5c419 commit fa8a91c

38 files changed

+3623
-1
lines changed

‎LICENSE

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

‎NOTICE

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
terraform-google-nomad
2+
Copyright 2017 Gruntwork, Inc.
3+
4+
This product includes software developed at Gruntwork (http://www.gruntwork.io/).

‎README.md

+144-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,144 @@
1-
# terraform-google-nomad
1+
# Nomad GCP Module
2+
3+
This repo contains a Module for how to deploy a [Nomad](https://www.nomadproject.io/) cluster on [Google Cloud](
4+
https://cloud.google.com/) using [Terraform](https://www.terraform.io/). Nomad is a distributed, highly-available
5+
data-center aware scheduler. A Nomad cluster typically includes a small number of server nodes, which are responsible
6+
for being part of the [consensus protocol](https://www.nomadproject.io/docs/internals/consensus.html), and a larger
7+
number of client nodes, which are used for running jobs:
8+
9+
![Nomad architecture](https://github.com/hashicorp/terraform-google-nomad/master/_docs/architecture.png?raw=true)
10+
11+
This Module includes:
12+
13+
* [install-nomad](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/install-nomad): This module can
14+
be used to install Nomad. It can be used in a [Packer](https://www.packer.io/) template to create a Nomad
15+
[Google Image](https://cloud.google.com/compute/docs/images).
16+
17+
* [run-nomad](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/run-nomad): This module can be
18+
used to configure and run Nomad. It can be used in a [Startup Script](https://cloud.google.com/compute/docs/startupscript)
19+
script to fire up Nomad while the server is booting.
20+
21+
* [nomad-cluster](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/nomad-cluster): Terraform code\
22+
to deploy a cluster of Nomad servers using a [Managed Instance Group](https://cloud.google.com/compute/docs/instance-groups/).
23+
24+
25+
26+
27+
28+
## What's a Terraform Module?
29+
30+
A Terraform Module refers to a self-contained packages of Terraform configurations that are managed as a group. This repo
31+
is a Terraform Module and contains many "submodules" which can be composed together to create useful infrastructure patterns.
32+
33+
34+
35+
## Who maintains this Module?
36+
37+
This Module is maintained by [Gruntwork](http://www.gruntwork.io/). If you're looking for help or commercial
38+
support, send an email to [modules@gruntwork.io](mailto:modules@gruntwork.io?Subject=Nomad%20Module).
39+
Gruntwork can help with:
40+
41+
* Setup, customization, and support for this Module.
42+
* Modules for other types of infrastructure, such as VPCs, Docker clusters, databases, and continuous integration.
43+
* Modules that meet compliance requirements, such as HIPAA.
44+
* Consulting & Training on AWS, Google Cloud, Terraform, and DevOps.
45+
46+
47+
48+
## How do you use this Module?
49+
50+
This Module has the following folder structure:
51+
52+
* [root](https://github.com/hashicorp/terraform-google-nomad/tree/master): This folder shows an example of Terraform code
53+
to deploy a [Nomad](https://www.nomadproject.io/) cluster co-located with a [Consul](https://www.consul.io/) cluster
54+
in [Google Cloud](https://cloud.google.com/)
55+
* [modules](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules): This folder contains the reusable
56+
code for this Module, broken down into one or more submodules.
57+
* [examples](https://github.com/hashicorp/terraform-google-nomad/tree/master/examples): This folder contains examples of
58+
how to use the submodules.
59+
* [test](https://github.com/hashicorp/terraform-aws-nomad/tree/master/test): Automated tests for the modules and examples.
60+
61+
To run a Nomad cluster, you need to deploy a small number of server nodes (typically 3), which are responsible
62+
for being part of the [consensus protocol](https://www.nomadproject.io/docs/internals/consensus.html), and a larger
63+
number of client nodes, which are used for running jobs. You must also have a [Consul](https://www.consul.io/) cluster
64+
deployed (see the [Consul GCP Module](https://github.com/hashicorp/terraform-google-consul)) in one of the following
65+
configurations:
66+
67+
1. [Deploy Nomad and Consul in the same cluster](#deploy-nomad-and-consul-in-the-same-cluster)
68+
1. [Deploy Nomad and Consul in separate clusters](#deploy-nomad-and-consul-in-separate-clusters)
69+
70+
71+
### Deploy Nomad and Consul in the same cluster
72+
73+
1. Use the [install-consul module](https://github.com/hashicorp/terraform-google-consul/tree/master/modules/install-consul)
74+
from the Consul GCP Module and the [install-nomad module](
75+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/install-nomad) from this Module in a Packer
76+
template to create a Google Image with Consul and Nomad.
77+
78+
Ideally, we would publish a "public" image you can use for trail purposes, but Google Cloud does not yet support
79+
custom public Images so, for now, you must build your own Google Image to use this module.
80+
81+
1. Deploy a small number of server nodes (typically, 3) using the [consul-cluster
82+
module](https://github.com/hashicorp/terraform-google-consul/tree/master/modules/consul-cluster). Execute the
83+
[run-consul script](https://github.com/hashicorp/terraform-google-consul/tree/master/modules/run-consul) and the
84+
[run-nomad script](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/run-nomad) on each node
85+
during boot, setting the `--server` flag in both scripts.
86+
87+
1. Deploy as many client nodes as you need using the [nomad-cluster module](
88+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/nomad-cluster). Execute the [run-consul script](
89+
https://github.com/hashicorp/terraform-googe-consul/tree/master/modules/run-consul) and the [run-nomad script](
90+
https://github.com/hashicorp/terraform-aws-nomad/tree/master/modules/run-nomad) on each node during boot, setting the
91+
`--client` flag in both scripts.
92+
93+
Check out the [nomad-consul-colocated-cluster example](https://github.com/hashicorp/terraform-google-nomad/tree/master/examples/root-example)
94+
for working sample code.
95+
96+
97+
### Deploy Nomad and Consul in separate clusters
98+
99+
1. Deploy a standalone Consul cluster by following the instructions in the [Consul GCP Module](
100+
https://github.com/hashicorp/terraform-google-consul).
101+
102+
1. Use the scripts from the [install-nomad module](https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/install-nomad)
103+
in a Packer template to create a Google Image with Nomad installed.
104+
105+
1. Deploy a small number of server nodes (typically, 3) using the [nomad-cluster module](
106+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/nomad). Execute the [run-nomad script](
107+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/run-nomad) on each node during boot, setting
108+
the `--server` flag. You will need to configure each node with the connection details for your standalone Consul cluster.
109+
110+
1. Deploy as many client nodes as you need using the [nomad-cluster module](
111+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/nomad). Execute the [run-nomad script](
112+
https://github.com/hashicorp/terraform-google-nomad/tree/master/modules/run-nomad) on each node during boot, setting
113+
the `--client` flag.
114+
115+
Check out the [nomad-consul-separate-cluster example](
116+
https://github.com/hashicorp/terraform-google-nomad/tree/master/examples/nomad-consul-separate-cluster) for working sample code.
117+
118+
119+
120+
121+
122+
## How do I contribute to this Module?
123+
124+
Contributions are very welcome! Check out the [Contribution Guidelines](
125+
https://github.com/hashicorp/terraform-google-nomad/tree/master/CONTRIBUTING.md) for instructions.
126+
127+
128+
129+
## How is this Module versioned?
130+
131+
This Module follows the principles of [Semantic Versioning](http://semver.org/). You can find each new release,
132+
along with the changelog, in the [Releases Page](https://github.com/hashicorp/terraform-google-nomad/releases).
133+
134+
During initial development, the major version will be 0 (e.g., `0.x.y`), which indicates the code does not yet have a
135+
stable API. Once we hit `1.0.0`, we will make every effort to maintain a backwards compatible API and use the MAJOR,
136+
MINOR, and PATCH versions on each release to indicate any incompatibilities.
137+
138+
139+
140+
## License
141+
142+
This code is released under the Apache 2.0 License. Please see [LICENSE](https://github.com/hashicorp/terraform-google-nomad/tree/master/LICENSE) and [NOTICE](https://github.com/hashicorp/terraform-aws-nomad/tree/master/NOTICE) for more details.
143+
144+
Copyright © 2017 Gruntwork, Inc.

‎_docs/architecture-colocated.png

455 KB
Loading

‎_docs/architecture-nomad-consul-separate.png

485 KB
Loading

‎_docs/architecture.png

444 KB
Loading

0 commit comments

Comments
 (0)