├── .editorconfig ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── images │ ├── peak.gif │ └── terraform.png └── workflows │ └── build.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── dax ├── README.md ├── main.tf ├── outputs.tf └── variables.tf ├── docker_builder ├── README.md ├── main.tf ├── outputs.tf └── variables.tf ├── ecr ├── README.md ├── main.tf ├── outputs.tf └── variables.tf ├── k8s_irsa ├── README.md ├── main.tf ├── outputs.tf └── variables.tf ├── s3 ├── README.md ├── main.tf ├── outputs.tf └── variables.tf └── tags ├── README.md ├── main.tf ├── outputs.tf └── variables.tf /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | max_line_length = 80 11 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce or Sample code** 14 | Steps to reproduce the behavior or a sample code to reproduce it 15 | 16 | 17 | **Expected behavior** 18 | A clear and concise description of what you expected to happen. 19 | 20 | **Screenshots** 21 | If applicable, add screenshots to help explain your problem. 22 | 23 | **Environment (please complete the following information):** 24 | - OS: [e.g.MacOS] 25 | - Version [e.g. v0.2.0] 26 | - Terrform CLI version [output of `terraform -version` command] 27 | 28 | 29 | 30 | **Additional context** 31 | Add any other context about the problem here. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/images/peak.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/peak-ai/terraform-modules/348d6be2b65f71f2cb3feea5300fb27eb9e080f4/.github/images/peak.gif -------------------------------------------------------------------------------- /.github/images/terraform.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/peak-ai/terraform-modules/348d6be2b65f71f2cb3feea5300fb27eb9e080f4/.github/images/terraform.png -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | build: 7 | name: lint 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2 11 | - uses: hashicorp/setup-terraform@v1 12 | - name: Checking formating of all files 13 | run: | 14 | terraform fmt -check -diff -recursive 15 | 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Local .terraform directories 2 | **/.terraform/* 3 | 4 | # .tfstate files 5 | *.tfstate 6 | *.tfstate.* 7 | 8 | # Crash log files 9 | crash.log 10 | 11 | # Ignore any .tfvars files that are generated automatically for each Terraform run. Most 12 | # .tfvars files are managed as part of configuration and so should be included in 13 | # version control. 14 | # 15 | # example.tfvars 16 | 17 | # Ignore override files as they are usually used to override resources locally and so 18 | # are not checked in 19 | override.tf 20 | override.tf.json 21 | *_override.tf 22 | *_override.tf.json 23 | 24 | # Include override files you do wish to add to version control using negated pattern 25 | # 26 | # !example_override.tf 27 | 28 | # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan 29 | # example: *tfplan* 30 | .DS_Store 31 | .dccache 32 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at support@peak.ai. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Contributing to Peak's Terraform Modules 4 | 5 | Despite being primarily maintained by Peak, we welcome pull requests to this repo! We thank you for your time and efforts in making these modules better 🙌🏻 6 | 7 | ## Consider raising an issue first if your proposed PR: 8 | 9 | * introduces breaking changes 10 | * changes a major version of a key dependency 11 | 12 | ## Process/Things to consider 13 | 14 | * `Fork` this repo, make a branch with your changes and then make a PR to `Peak` 15 | 16 | * Follow best pacticies for Terraform modules like 17 | - Folder Structure ( distribute code in `variables.tf`, `main.tf` and `outputs.tf`) 18 | - Name each resource as `default` for consistency of this repo (this makes outputs consistent). 19 | - Do not hardcode values and keep them configurable 20 | - Mention minimum required provider version 21 | - Provide default values when possible 22 | - Make sure code all actions pass. Beast to run `terraform fmt -recursive` before commiting 23 | - Update List in base [README](README.md) when adding or removing a module 24 | 25 | ## Raising a pull request 26 | 27 | When you open a PR, the description will be prepopulated with our template. Please read the notes and add the requested details; **failure to do so will result in your PR being rejected**. 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Peak 2 | 3 | # ![T](.github/images/terraform.png)erraform-modules 4 | 5 | ![Build](https://github.com/peak-ai/terraform-modules/workflows/Build/badge.svg) ![stable](https://img.shields.io/github/v/release/peak-ai/terraform-modules) ![](https://img.shields.io/github/v/release/peak-ai/terraform-modules?include_prereleases) ![](https://img.shields.io/github/license/peak-ai/terraform-modules) ![](https://img.shields.io/github/languages/count/peak-ai/terraform-modules) ![](https://img.shields.io/github/languages/top/peak-ai/terraform-modules) ![](https://img.shields.io/github/issues-raw/peak-ai/terraform-modules) ![](https://img.shields.io/github/issues-pr-raw/peak-ai/terraform-modules) ![](https://img.shields.io/github/languages/code-size/peak-ai/terraform-modules) ![](https://img.shields.io/github/repo-size/peak-ai/terraform-modules) 6 | 7 | This repo list some open to use Terraform modules we use at `Peak AI` because we :heart: IAC(Infrastucture as Code) and Terraform modules are a great way to write reusable Infra. 8 | 9 | ## List of avilable modules 10 | 11 | - [:construction: Docker Builder](/docker_builder) 12 | - [:camera: ECR](/ecr) 13 | - [☸ K8S_IRSA](/k8s_irsa) 14 | - [:open_file_folder: S3](/s3) 15 | - [:oil_drum: Dax](/dax) 16 | - [:bookmark: Tags (aka Labels)](/tags) 17 | 18 | ## Example usage 19 | 20 | There are two approaches to import and use modules in this repo. 21 | 22 | ### Using specific revision (recommended approach) 23 | `Blueprint` 24 | ```hcl 25 | module "" { 26 | source = "git::https://github.com/peak-ai/terraform-modules//?ref=" 27 | . 28 | . 29 | . 30 | # Add inputs here you want to overwrite 31 | } 32 | ``` 33 | `Example` 34 | ```hcl 35 | module "tags" { 36 | source = "git::https://github.com/peak-ai/terraform-modules//tags?ref=v0.1.0" 37 | stage = "latest" 38 | feature = "example" 39 | service = "example" 40 | } 41 | ``` 42 | 43 | ### Importing latest version (Use this approach at your own risk as there can be breaking changes) 44 | 45 | `Blueprint` 46 | ```hcl 47 | module "" { 48 | source = "git::https://github.com/peak-ai/terraform-modules.git//" 49 | . 50 | . 51 | . 52 | # Add inputs here you want to overwrite 53 | } 54 | ``` 55 | 56 | `Example` 57 | ```hcl 58 | module "tags" { 59 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags" 60 | stage = "latest" 61 | feature = "example" 62 | service = "example" 63 | } 64 | ``` 65 | 66 | 67 | ## Contributing 68 | 69 | Despite being primarily maintained by Peak, we welcome and appreciate any contributions from the community! Please see the [contribution guidelines](CONTRIBUTING.md) for more info. 70 | -------------------------------------------------------------------------------- /dax/README.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | | Name | Version | 8 | |------|---------| 9 | | aws | >= 2.62 | 10 | 11 | ## Inputs 12 | 13 | | Name | Description | Type | Default | Required | 14 | |------|-------------|------|---------|:--------:| 15 | | item\_cache\_ttl\_milli\_second | Time after which item cache will invalidate. Default 5 minutes | `number` | `300000` | no | 16 | | name | n/a | `string` | n/a | yes | 17 | | node\_type | (Required) The compute and memory capacity of the nodes | `string` | `"dax.t2.small"` | no | 18 | | query\_cache\_ttl\_\_milli\_second | Time after which item query will invalidate. Default 5 minutes | `number` | `300000` | no | 19 | | region | n/a | `string` | n/a | yes | 20 | | replication\_factor | (Required) The number of nodes in the DAX cluster | `number` | `3` | no | 21 | | security_group_ids | The list of Security Group IDs to be associated with the DAX cluster | `list(string)` | n/a | yes | 22 | | tables | List of tables for using dax | `list(string)` | n/a | yes | 23 | | tags | A map of tags to assign to the resource | `any` | n/a | yes | 24 | | vpc\_id | n/a | `string` | n/a | yes | 25 | 26 | ## Outputs 27 | 28 | | Name | Description | 29 | |------|-------------| 30 | | endpoint\_created | Endpoint of the created cluster. | 31 | 32 | ## Example usage 33 | 34 | ```hcl 35 | provider "aws" { 36 | version = "~> 2.62" 37 | } 38 | 39 | module "tags" { 40 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags?ref=v0.7.0" 41 | tenant = "new-client" 42 | stage = "latest" 43 | feature = "example" 44 | service = "example" 45 | } 46 | 47 | module "my_dax" { 48 | source = "git::https://github.com/peak-ai/terraform-modules.git//dax?ref=v0.7.0" 49 | name = "dax" 50 | tags = module.tags.default 51 | region = "example_region" 52 | vpc_id = "example_vpc_id" 53 | node_type = "dax.t2.small" 54 | replication_factor = 3 55 | query_cache_ttl__milli_second = 30 * 1000 56 | item_cache_ttl_milli_second = 30 * 60 * 1000 57 | security_group_ids = [ 58 | "sg-123456789", 59 | "sg-987654321" 60 | ] 61 | tables = [ 62 | "table1", 63 | "table2" 64 | ] 65 | } 66 | ``` 67 | -------------------------------------------------------------------------------- /dax/main.tf: -------------------------------------------------------------------------------- 1 | provider "aws" { 2 | region = var.region 3 | default_tags { 4 | tags = var.tags 5 | } 6 | } 7 | 8 | data "aws_caller_identity" "current" {} 9 | resource "aws_iam_role" "role" { 10 | name = "${var.name}-dax" 11 | 12 | assume_role_policy = <= 2.62 | 17 | | null | ~> 2.1 | 18 | 19 | ## Providers 20 | 21 | | Name | Version | 22 | |------|---------| 23 | | null | ~> 2.1 | 24 | 25 | ## Inputs 26 | 27 | | Name | Description | Type | Default | Required | 28 | |------|-------------|------|---------|:--------:| 29 | | args | A key value list of additional arguments to be passed into the docker build | `list(string)` | `[]` | no | 30 | | git\_branch | The git branch | `string` | n/a | yes | 31 | | git\_sha | The SHA of the git commit | `string` | n/a | yes | 32 | | path | Path where the dockerfile exists | `string` | n/a | yes | 33 | | region | The AWS region to use | `string` | n/a | yes | 34 | | repository\_url | URL of the ECR repository | `string` | n/a | yes | 35 | 36 | ## Outputs 37 | 38 | | Name | Description | 39 | |------|-------------| 40 | | image | The full path to the docker image | 41 | | tags | The image tags that have been built | 42 | 43 | ## Example usage 44 | 45 | ```hcl 46 | provider "aws" { 47 | version = "~> 2.62" 48 | } 49 | 50 | provider "null" { 51 | version = "~> 2.1" 52 | } 53 | 54 | locals { 55 | npm_token = "123" 56 | } 57 | 58 | module "my_docker_builder" { 59 | source = "git::https://github.com/peak-ai/terraform-modules.git//docker_builder?ref=v0.4.0" 60 | # Here we use the repo which has been created in the basic example. (If you were doing this, you wouldnt hard code these values) 61 | repository_url = ".dkr.ecr..amazonaws.com/latest-my-example" 62 | dockerfile = "./Dockerfile" 63 | args = ["--build-arg NPM_TOKEN=${local.npm_token}"] 64 | } 65 | ``` 66 | -------------------------------------------------------------------------------- /docker_builder/main.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | required_providers { 3 | null = "~> 2.1" 4 | aws = ">= 2.62" 5 | } 6 | } 7 | 8 | locals { 9 | args = join(" ", var.args) 10 | git_branch = lower(replace(var.git_branch, "/", "-")) 11 | 12 | tag = "${var.repository_url}:${local.git_branch}" 13 | extra_tags = local.git_branch == "master" ? ["${var.repository_url}:${var.git_sha}", "${var.repository_url}:latest"] : ["${var.repository_url}:${var.git_sha}"] 14 | } 15 | 16 | resource "null_resource" "build_image" { 17 | triggers = { 18 | image_tag = var.git_sha 19 | } 20 | 21 | provisioner "local-exec" { 22 | command = <= 2.62 | 16 | 17 | ## Providers 18 | 19 | | Name | Version | 20 | |------|---------| 21 | | aws | >= 2.62 | 22 | 23 | ## Inputs 24 | 25 | | Name | Description | Type | Default | Required | 26 | |------|-------------|------|---------|:--------:| 27 | | image\_tag\_mutability | n/a | `string` | `"MUTABLE"` | no | 28 | | name | Name of ECR bucket | `string` | n/a | yes | 29 | | scan\_on\_push | n/a | `bool` | `true` | no | 30 | | tags | Tags to pass | `object` | n/a | yes | 31 | | untagged\_images\_to\_keep | n/a | `number` | `5` | no | 32 | 33 | ## Outputs 34 | 35 | | Name | Description | 36 | |------|-------------| 37 | | arn | Full ARN of the repository | 38 | | name | The name of the repository | 39 | | registry\_id | The registry ID where the repository was created | 40 | | repository\_url | The URL of the repository (in the form aws\_account\_id.dkr.ecr.region.amazonaws.com/repositoryName) | 41 | 42 | ## Example usage 43 | 44 | ```hcl 45 | provider "aws" { 46 | version = "~> 2.62" 47 | } 48 | module "tags" { 49 | source = git::https://github.com/peak-ai/terraform-modules.git//tags?ref=v0.3.0" 50 | tenant = "new-client" 51 | stage = "latest" 52 | feature = "example" 53 | service = "example" 54 | } 55 | 56 | module "my_ecr" { 57 | source = "git::https://github.com/peak-ai/terraform-modules.git//ecr?ref=v0.3.0" 58 | name = "my_ecr" 59 | tags = module.tags.default 60 | } 61 | ``` 62 | -------------------------------------------------------------------------------- /ecr/main.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | required_providers { 3 | aws = ">= 2.62" 4 | } 5 | } 6 | 7 | resource "aws_ecr_repository" "default" { 8 | name = var.name 9 | image_tag_mutability = var.image_tag_mutability 10 | image_scanning_configuration { 11 | scan_on_push = var.scan_on_push 12 | } 13 | tags = var.tags 14 | } 15 | 16 | resource "aws_ecr_lifecycle_policy" "default" { 17 | repository = aws_ecr_repository.default.name 18 | 19 | policy = <= 2.62 | 69 | | kubernetes | >= 1.11 | 70 | 71 | ## Providers 72 | 73 | | Name | Version | 74 | |------|---------| 75 | | aws | >= 2.62 | 76 | 77 | ## Inputs 78 | 79 | | Name | Description | Type | Default | Required | 80 | |------|-------------|------|---------|:--------:| 81 | | cluster | Name of K8S cluster | `string` | n/a | yes | 82 | | namespace | K8S namespace (should already exist) | `string` | n/a | yes | 83 | | policy\_doc | The inline policy document. This is a JSON formatted string. | `string` | n/a | yes | 84 | | policy\_name | Name of policy. If not passed, will be generated randomly at runtime | `string` | `""` | no | 85 | | role\_name | Name of IAM role. If not passed, will be generated randomly at runtime | `string` | `""` | no | 86 | | service\_account | Service account that will be attached to IAM role. Should not exist already | `string` | n/a | yes | 87 | | tags | Tags to pass | `any` | n/a | yes | 88 | 89 | ## Outputs 90 | 91 | | Name | Description | 92 | |------|-------------| 93 | | policy\_name | The name of the policy | 94 | | role\_arn | The Amazon Resource Name (ARN) specifying the role | 95 | | role\_name | The name of the role | 96 | -------------------------------------------------------------------------------- /k8s_irsa/main.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | required_providers { 3 | aws = ">= 2.62" 4 | kubernetes = ">= 1.11" 5 | } 6 | } 7 | 8 | data "aws_caller_identity" "current" {} 9 | data "aws_eks_cluster" "this" { 10 | name = var.cluster 11 | } 12 | 13 | locals { 14 | oidc = replace(data.aws_eks_cluster.this.identity[0].oidc[0].issuer, "https://", "") 15 | } 16 | 17 | # IAM Role that will be used by app POD for access via web tokens 18 | resource "aws_iam_role" "this" { 19 | name = var.role_name 20 | tags = var.tags 21 | assume_role_policy = <= 2.62 | 15 | 16 | ## Providers 17 | 18 | | Name | Version | 19 | |------|---------| 20 | | aws | >= 2.62 | 21 | 22 | ## Inputs 23 | 24 | | Name | Description | Type | Default | Required | 25 | |------|-------------|------|---------|:--------:| 26 | | acl | n/a | `string` | `"bucket-owner-full-control"` | no | 27 | | block\_public\_acls | n/a | `bool` | `true` | no | 28 | | block\_public\_policy | n/a | `bool` | `true` | no | 29 | | enable\_versioning | n/a | `bool` | `false` | no | 30 | | ignore\_public\_acls | n/a | `bool` | `true` | no | 31 | | name | Name of S3 bucket | `string` | n/a | yes | 32 | | restrict\_public\_buckets | n/a | `bool` | `true` | no | 33 | | tags | Tags to pass | `object` | n/a | yes | 34 | 35 | ## Outputs 36 | 37 | | Name | Description | 38 | |------|-------------| 39 | | arn | The ARN of the bucket. Will be of format arn:aws:s3:::bucketname | 40 | | id | The name of the bucket | 41 | 42 | ## Example usage 43 | 44 | ```hcl 45 | provider "aws" { 46 | version = "~> 2.62" 47 | } 48 | 49 | module "tags" { 50 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags?ref=v0.2.0" 51 | tenant = "new-client" 52 | stage = "latest" 53 | feature = "example" 54 | service = "example" 55 | } 56 | 57 | module "my_s3" { 58 | source = "git::https://github.com/peak-ai/terraform-modules.git//s3?ref=v0.2.0" 59 | name = "s3" 60 | tags = module.tags.default 61 | } 62 | ``` 63 | -------------------------------------------------------------------------------- /s3/main.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | required_providers { 3 | aws = ">= 2.62" 4 | } 5 | } 6 | 7 | resource "aws_s3_bucket" "default" { 8 | bucket = var.name 9 | acl = var.acl 10 | versioning { 11 | enabled = var.enable_versioning 12 | } 13 | server_side_encryption_configuration { 14 | rule { 15 | apply_server_side_encryption_by_default { 16 | sse_algorithm = "AES256" 17 | } 18 | } 19 | } 20 | tags = var.tags 21 | } 22 | 23 | resource "aws_s3_bucket_public_access_block" "default" { 24 | bucket = aws_s3_bucket.default.id 25 | 26 | block_public_acls = var.block_public_acls 27 | block_public_policy = var.block_public_policy 28 | ignore_public_acls = var.ignore_public_acls 29 | restrict_public_buckets = var.restrict_public_buckets 30 | } 31 | 32 | -------------------------------------------------------------------------------- /s3/outputs.tf: -------------------------------------------------------------------------------- 1 | output "id" { 2 | value = aws_s3_bucket.default.id 3 | description = "The name of the bucket" 4 | } 5 | 6 | output "arn" { 7 | value = aws_s3_bucket.default.arn 8 | description = "The ARN of the bucket. Will be of format arn:aws:s3:::bucketname" 9 | } 10 | -------------------------------------------------------------------------------- /s3/variables.tf: -------------------------------------------------------------------------------- 1 | variable "name" { 2 | type = string 3 | description = "Name of S3 bucket" 4 | } 5 | 6 | variable "acl" { 7 | type = string 8 | default = "bucket-owner-full-control" 9 | } 10 | 11 | variable "enable_versioning" { 12 | type = bool 13 | default = false 14 | } 15 | 16 | variable "block_public_acls" { 17 | type = bool 18 | default = true 19 | } 20 | 21 | variable "block_public_policy" { 22 | type = bool 23 | default = true 24 | } 25 | 26 | variable "ignore_public_acls" { 27 | type = bool 28 | default = true 29 | } 30 | 31 | variable "restrict_public_buckets" { 32 | type = bool 33 | default = true 34 | } 35 | 36 | variable "tags" { 37 | type = object 38 | description = "Tags to pass" 39 | } 40 | -------------------------------------------------------------------------------- /tags/README.md: -------------------------------------------------------------------------------- 1 | # :bookmark: Tags 2 | 3 | `Tags` for AWS Resources or `Labels` for Kubernetes objects allows Users to add metadta to Resource/Objects. Each tag is simple key-value pair which makes it easier to manage, search for, and filter resources. 4 | 5 | This module defines base `tags` we here at Peak assign to each of our resources and are just a base Idea. You might want change that as per your organisation's needs. In that case feel free to fork this repo and define base tags that fits your organisation needs. 6 | 7 | 8 | ## Gist 9 | 10 | All tags and their values are converted to lower case to avoid confusions and duplications 11 | 12 | `stage`: Stagging environment the resource belogs to. Must be one of [latest, test, beta, prod] 13 | 14 | `tenant`: Tenant the resource belongs to. Defaults to `platform` 15 | 16 | `feature`: Feature this resource belogs to say `shopping-cart` 17 | 18 | `service`: Service this resource belogs to say `shopiing-cart-database` 19 | 20 | ## Requirements 21 | 22 | No requirements. 23 | 24 | ## Providers 25 | 26 | No provider. 27 | 28 | ## Inputs 29 | 30 | | Name | Description | Type | Default | Required | 31 | |------|-------------|------|---------|:--------:| 32 | | feature | n/a | `string` | n/a | yes | 33 | | service | n/a | `string` | n/a | yes | 34 | | stage | Stage on which infra should be deployed | `string` | n/a | yes | 35 | | tenant | n/a | `string` | `"platform"` | no | 36 | 37 | ## Outputs 38 | 39 | | Name | Description | 40 | |------|-------------| 41 | | default | Tags object | 42 | | string | Tags as string | 43 | 44 | ## Example usage 45 | 46 | Once initialised tags added to as many resources as you want. 47 | 48 | ### Example 1 > Using latest module 49 | 50 | ```hcl 51 | # Importing module 52 | module "tags" { 53 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags" 54 | # Passing values from here will overide the default values 55 | tenant = "new-client" 56 | # It is good practice to make workspaces matching four staging environment rather than hardcoing them 57 | stage = terraform.workspace 58 | # hardcoing example 59 | # stage = "latest" 60 | feature = "example" 61 | service = "example" 62 | } 63 | 64 | # Using module to to add tags to a resource say a S3 bucket 65 | provider "aws" { 66 | version = "~> 2.62" 67 | } 68 | 69 | resource "aws_s3_bucket" "example" { 70 | bucket = "example" 71 | tags = module.tags.default 72 | } 73 | ``` 74 | ### Example 2 > Minimal using specific version 75 | 76 | ```hcl 77 | module "tags" { 78 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags?ref=v0.1.0" 79 | tenant = "new-client" 80 | stage = "latest" 81 | feature = "example" 82 | service = "example" 83 | } 84 | 85 | provider "aws" { 86 | version = "~> 2.62" 87 | } 88 | 89 | resource "aws_s3_bucket" "example" { 90 | bucket = "example" 91 | tags = module.tags.default 92 | } 93 | ``` 94 | 95 | ### Example 3 > Adding tags ( aka labels) to K8S objects 96 | 97 | You can assign tags to any kubernetes object as well 98 | 99 | ```hcl 100 | module "tags" { 101 | source = "git::https://github.com/peak-ai/terraform-modules.git//tags?ref=v0.5.0" 102 | tenant = "new-client" 103 | stage = "latest" 104 | feature = "example" 105 | service = "example" 106 | } 107 | 108 | provider "kubernetes" { 109 | version = "~> 1.11" 110 | } 111 | 112 | resource "kubernetes_namespace" "example" { 113 | metadata { 114 | labels = module.tags.default 115 | name = "example" 116 | } 117 | } 118 | ``` 119 | -------------------------------------------------------------------------------- /tags/main.tf: -------------------------------------------------------------------------------- 1 | locals { 2 | tags = { 3 | stage = lower(var.stage) 4 | tenant = lower(var.tenant) 5 | feature = lower(var.feature) 6 | service = lower(var.service) 7 | terraform_resource = true 8 | terraform_workspace = terraform.workspace 9 | } 10 | strigifiedTags = "stage=${lower(var.stage)},tenant=${lower(var.tenant)},feature=${lower(var.feature)},service=${lower(var.service)},terraform_resource=true,terraform_workspace=${terraform.workspace}" 11 | } 12 | -------------------------------------------------------------------------------- /tags/outputs.tf: -------------------------------------------------------------------------------- 1 | output "default" { 2 | description = "Tags object" 3 | value = local.tags 4 | } 5 | 6 | output "string" { 7 | description = "Tags as string" 8 | value = local.strigifiedTags 9 | } 10 | -------------------------------------------------------------------------------- /tags/variables.tf: -------------------------------------------------------------------------------- 1 | variable "stage" { 2 | description = "Stage on which infra should be deployed" 3 | type = string 4 | validation { 5 | condition = can(regex("latest|test|beta|prod|parvati", var.stage)) 6 | error_message = "Invalid stage! Allowed values are [latest, test, beta, prod, parvati]." 7 | } 8 | } 9 | 10 | variable "tenant" { 11 | type = string 12 | default = "platform" 13 | } 14 | 15 | variable "feature" { 16 | type = string 17 | } 18 | 19 | variable "service" { 20 | type = string 21 | } 22 | --------------------------------------------------------------------------------