From 7a000122d7728af645d5766d45aca365588218c2 Mon Sep 17 00:00:00 2001 From: Petro Kolosov Date: Fri, 1 Sep 2023 20:14:54 +0200 Subject: [PATCH] Initial commit --- .config/terraform-docs.yml | 25 ++ .config/tflint.hcl | 66 ++++ .gitattributes | 5 + .github/workflows/terraform-ci.yml | 66 ++++ .gitignore | 9 + .pre-commit-config.yaml | 32 ++ LICENSE | 339 +++++++++++++++++++++ README.INFO.md | 30 ++ README.md | 84 +++++ azure-pipelines/azdo-terraform-apply.yml | 140 +++++++++ azure-pipelines/azdo-terraform-ci.yml | 55 ++++ azure-pipelines/azdo-terraform-destroy.yml | 140 +++++++++ locals.tf | 5 + main.tf | 12 + modules/example_submodule/main.tf | 8 + modules/example_submodule/output.tf | 3 + modules/example_submodule/variables.tf | 9 + output.tf | 0 provider.tf | 7 + scripts/CreateAzureStorageAccount.ps1 | 25 ++ scripts/CreateSelfSignedCert.ps1 | 6 + scripts/GenerateLetsEncryptSSLCert.ps1 | 18 ++ scripts/generate_letsencrypt_cert.sh | 16 + terraform.auto.tfvars.json | 5 + variables.tf | 14 + versions.tf | 10 + 26 files changed, 1129 insertions(+) create mode 100644 .config/terraform-docs.yml create mode 100644 .config/tflint.hcl create mode 100644 .gitattributes create mode 100644 .github/workflows/terraform-ci.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 LICENSE create mode 100644 README.INFO.md create mode 100644 README.md create mode 100644 azure-pipelines/azdo-terraform-apply.yml create mode 100644 azure-pipelines/azdo-terraform-ci.yml create mode 100644 azure-pipelines/azdo-terraform-destroy.yml create mode 100644 locals.tf create mode 100644 main.tf create mode 100644 modules/example_submodule/main.tf create mode 100644 modules/example_submodule/output.tf create mode 100644 modules/example_submodule/variables.tf create mode 100644 output.tf create mode 100644 provider.tf create mode 100644 scripts/CreateAzureStorageAccount.ps1 create mode 100644 scripts/CreateSelfSignedCert.ps1 create mode 100644 scripts/GenerateLetsEncryptSSLCert.ps1 create mode 100644 scripts/generate_letsencrypt_cert.sh create mode 100644 terraform.auto.tfvars.json create mode 100644 variables.tf create mode 100644 versions.tf diff --git a/.config/terraform-docs.yml b/.config/terraform-docs.yml new file mode 100644 index 0000000..f684299 --- /dev/null +++ b/.config/terraform-docs.yml @@ -0,0 +1,25 @@ +--- +formatter: "markdown" + +settings: + anchor: false + lockfile: false + +output: + file: "README.md" + +sections: + hide: [requirements] + +content: |- + + {{ .Providers }} + + {{ .Modules }} + + {{ .Resources }} + + {{ .Inputs }} + + {{ .Outputs }} +... diff --git a/.config/tflint.hcl b/.config/tflint.hcl new file mode 100644 index 0000000..11d71c7 --- /dev/null +++ b/.config/tflint.hcl @@ -0,0 +1,66 @@ +plugin "azurerm" { + enabled = true + source = "github.com/terraform-linters/tflint-ruleset-azurerm" + version = "0.21.0" +} + +config { + module = true + force = false + disabled_by_default = false + + varfile = ["terraform.tfvars.ci"] +} + +rule "terraform_deprecated_interpolation" { + enabled = true +} + +rule "terraform_deprecated_index" { + enabled = true +} + +rule "terraform_unused_declarations" { + enabled = true +} + +rule "terraform_comment_syntax" { + enabled = true +} + +rule "terraform_documented_outputs" { + enabled = true +} + +rule "terraform_documented_variables" { + enabled = true +} + +rule "terraform_typed_variables" { + enabled = true +} + +rule "terraform_module_pinned_source" { + enabled = true +} + +rule "terraform_naming_convention" { + enabled = true +} + +rule "terraform_required_version" { + enabled = true +} + +rule "terraform_required_providers" { + enabled = true +} + +rule "terraform_unused_required_providers" { + enabled = true +} + +# Disabled since we have files like "variables-xxxx.tf" instead of a single "variables.tf" +rule "terraform_standard_module_structure" { + enabled = false +} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..ccf37d7 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +* text=auto eol=lf +*.html linguist-detectable=false +*.cshtml linguist-detectable=false +*.htm linguist-detectable=false +*.razor linguist-detectable=false diff --git a/.github/workflows/terraform-ci.yml b/.github/workflows/terraform-ci.yml new file mode 100644 index 0000000..6f6f458 --- /dev/null +++ b/.github/workflows/terraform-ci.yml @@ -0,0 +1,66 @@ +name: Validate Terraform + +on: + push: + branches: + - master + - main + - develop + + pull_request: + branches: + - master + - main + - develop + + workflow_dispatch: + +# schedule: +# - cron: '0 0 * * 0' + +jobs: + build-webapp: + name: Validate Terraform + runs-on: ${{ matrix.environment }} + strategy: + matrix: + environment: + - ubuntu-latest + + env: + DOTNET_NOLOGO: 1 + DOTNET_CLI_TELEMETRY_OPTOUT: 1 + ACTIONS_RUNNER_DEBUG: true + TF_LOG: INFO + ARM_CLIENT_ID: "" + ARM_CLIENT_SECRET: ${{ secrets.TF_ARM_CLIENT_SECRET }} + ARM_SUBSCRIPTION_ID: "" + ARM_TENANT_ID: "" + WORKING_DIR: "./" + + steps: + - name: Fetch Sources + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Setup Terraform + uses: hashicorp/setup-terraform@v2 + with: + terraform_version: latest + + - name: Terraform Version + run: terraform -v + working-directory: ${{ env.WORKING_DIR }} + + - name: Terraform Init + run: terraform init -backend=false + working-directory: ${{ env.WORKING_DIR }} + + - name: Terraform Validate + run: terraform validate + working-directory: ${{ env.WORKING_DIR }} + + - name: Terraform Format + run: terraform fmt -check + working-directory: ${{ env.WORKING_DIR }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e0676c2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.idea +.ssh +*.conf +.terraform +*.tfplan +*.tfstate +*.lock.info +*.tfstate.backup +*.lock.hcl diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..28d07b5 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,32 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-json + - id: check-yaml + args: + - --unsafe + - id: check-symlinks + - id: check-added-large-files + - id: detect-private-key + + - repo: https://github.com/antonbabenko/pre-commit-terraform.git + rev: v1.77.1 + hooks: + - id: terraform_fmt + - id: terraform_docs + args: + - --hook-config=--path-to-file=README.md + - --hook-config=--add-to-existing-file=true + - --hook-config=--create-file-if-not-exist=true + exclude: '^modules|^example|^tools' + - id: terraform_validate + exclude: '^examples|^modules' + + - id: terraform_tflint + exclude: '^examples' + args: + - --args=--config=__GIT_WORKING_DIR__/.config/tflint.hcl + - --env-vars=TFLINT_LOG="info" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.INFO.md b/README.INFO.md new file mode 100644 index 0000000..a9c8b27 --- /dev/null +++ b/README.INFO.md @@ -0,0 +1,30 @@ +## Terraform commands + +- Init examples: + - `terraform init -backend-config="azure.sas.conf"` + - `terraform init -backend-config="azure.sas.conf" -reconfigure` +- Plan examples + - `terraform plan -var "prefix=${prefix}" -out "main.tfplan"` + - `terraform plan -var "prefix=${prefix}" -var "sql_admin_password=$env:MANGO_TF_SQL_PASS" -out "main.tfplan"` + - `terraform plan -var "prefix=${prefix}" -var "os_profile_admin_password=1wSWB2Mbl8918kFvtwac" -out "main.tfplan"` + - `terraform plan -var-file='terraform.dev.tfvars' -var sql_admin_username='razumovsky_r' -var sql_admin_password='Zd2yqLgyV4uHVC0eTPiH' -out 'main.tfplan'` + - `terraform plan -var-file='terraform.dev.tfvars' -out 'dev.tfplan'` +- Apply examples: + - `terraform apply main.tfplan` + - `terraform fmt --check` +- Import examples + - /subscriptions/42f3171c-7f76-4241-8b33-17e610e83143/resourceGroups/rg-vm-linux-l03 + - az group show --name rg-vm-linux-l03 --query id --output tsv + - terraform import -var "prefix=${prefix}" azurerm_resource_group.public + /subscriptions/42f3171c-7f76-4241-8b33-17e610e83143/resourceGroups/rg-vm-linux-l03 +- Destroy examples: + - `terraform plan -var "sql_admin_password=$env:MANGO_TF_SQL_PASS" -var "prefix=${prefix}" -destroy -out "main.destroy.tfplan"` + - `terraform plan -var "prefix=${prefix}" -destroy -out "main.destroy.tfplan"` + - `terraform apply -destroy -auto-approve "main.destroy.tfplan"` +- Workspace examples: + - `terraform workspace new d01` + - `terraform workspace select d01` + +## Terraform docs + +- `terraform-docs markdown table ./ --output-file README.md` diff --git a/README.md b/README.md new file mode 100644 index 0000000..65c8b81 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Terraform template + +Terraform template for modules and sub-modules. +Includes pre-commit hooks that lint the terraform code and generate module's +documentation as part of README file. +Contains examples of terraform CI/CD pipelines for GitHub Actions and Azure Pipelines. + +## Pre-commit configuration + +- Install python3 via windows store +- `pip install --upgrade pip` +- `pip install pre-commit` +- Update PATH variable +- `pre-commit install` + +## Install terraform docs + +- `choco install terraform-docs` + +## Install tflint + +- `choco install tflint` + +## Documentation + +- https://github.com/antonbabenko/pre-commit-terraform +- https://github.com/kolosovpetro/AzureTerraformBackend +- https://github.com/terraform-docs/terraform-docs +- https://terraform-docs.io/user-guide/installation/ +- https://pre-commit.com/ + +## Storage account configuration file + +```bash +storage_account_name = "storage_account_name" +container_name = "container_name" +key = "terraform.tfstate" +sas_token = "sas_token" +``` + +## Deploy storage account for terraform state + +- See [CreateAzureStorageAccount.ps1](./CreateAzureStorageAccount.ps1) + +# Module documentation + + +## Requirements + +| Name | Version | +|------|---------| +| [azurerm](#requirement\_azurerm) | =3.71.0 | + +## Providers + +| Name | Version | +|------|---------| +| [azurerm](#provider\_azurerm) | 3.71.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [resource\_group](#module\_resource\_group) | ./modules/example_submodule | n/a | + +## Resources + +| Name | Type | +|------|------| +| [azurerm_resource_group.public](https://registry.terraform.io/providers/hashicorp/azurerm/3.71.0/docs/resources/resource_group) | resource | +| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/3.71.0/docs/data-sources/client_config) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [prefix](#input\_prefix) | Prefix for all resources | `string` | n/a | yes | +| [resource\_group\_location](#input\_resource\_group\_location) | Resource group location | `string` | n/a | yes | +| [resource\_group\_name](#input\_resource\_group\_name) | Resource group name | `string` | n/a | yes | + +## Outputs + +No outputs. + diff --git a/azure-pipelines/azdo-terraform-apply.yml b/azure-pipelines/azdo-terraform-apply.yml new file mode 100644 index 0000000..07d3a3b --- /dev/null +++ b/azure-pipelines/azdo-terraform-apply.yml @@ -0,0 +1,140 @@ +#trigger: +# batch: true +# branches: +# include: +# - master +# +#pr: +# branches: +# include: +# - '*' + +trigger: none +pr: none + +variables: + - name: TF_LOG + value: INFO + - name: workingDir + value: '$(System.DefaultWorkingDirectory)' + - group: 'TF_SETTINGS' # update to your variable group name + +stages: + - stage: "Terraform_Plan" + displayName: "Terraform_Plan" + jobs: + - job: 'Terraform_Plan' + displayName: "Terraform_Plan" + pool: + vmImage: "ubuntu-latest" + steps: + - checkout: self + fetchDepth: 0 + + - script: | + terraform init -backend=false + terraform validate + terraform fmt -check + displayName: "Run tf validate" + workingDirectory: '$(workingDir)' + + - task: AzureCLI@2 + name: SasTokenStep + displayName: 'Set SAS Token' + inputs: + azureSubscription: 'TerraformTemplateServiceConnection' # update to your service connection name + scriptType: 'pscore' + scriptLocation: 'inlineScript' + inlineScript: | + $Date = (Get-Date).AddDays(1).ToString('yyyy-MM-dd') + $key = $( az storage account keys list --resource-group $(rgName) --account-name $(storageAccount) --query [0].value -o tsv ) + $sas = $( az storage container generate-sas --name $(container) --expiry $Date --permissions "racwdli" --account-name $(storageAccount) --account-key "$key" ) + $sas = $sas.Replace("`"","") + Write-Host "##vso[task.setvariable variable=SAS_TOKEN;isOutput=true]$sas" + + - bash: | + terraform init \ + -backend-config="storage_account_name=$TF_STATE_BLOB_ACCOUNT_NAME" \ + -backend-config="container_name=$TF_STATE_BLOB_CONTAINER_NAME" \ + -backend-config="key=$TF_STATE_BLOB_FILE" \ + -backend-config="sas_token=$TF_STATE_BLOB_SAS_TOKEN" + displayName: Terraform Init + workingDirectory: $(workingDir) + env: + TF_STATE_BLOB_ACCOUNT_NAME: $(storageAccount) + TF_STATE_BLOB_CONTAINER_NAME: $(container) + TF_STATE_BLOB_FILE: $(stateFile) + TF_STATE_BLOB_SAS_TOKEN: $(SasTokenStep.SAS_TOKEN) + + - bash: | + terraform plan -var "prefix=$PREFIX" -out main.tfplan + workingDirectory: $(workingDir) + displayName: 'Terraform Plan' + env: + PREFIX: $(prefix) + ARM_SUBSCRIPTION_ID: $(subscriptionId) + ARM_CLIENT_ID: $(clientId) + ARM_CLIENT_SECRET: $(clientSecret) + ARM_TENANT_ID: $(tenantId) + + - bash: cp main.tfplan $(Build.ArtifactStagingDirectory) + displayName: 'Copy Plan' + workingDirectory: $(workingDir) + + - task: PublishBuildArtifacts@1 + displayName: 'Publish Artifacts' + inputs: + PathtoPublish: '$(Build.ArtifactStagingDirectory)' + ArtifactName: 'drop' + publishLocation: 'Container' + + - stage: 'Terraform_Apply' + displayName: 'Terraform_Apply' + dependsOn: 'Terraform_Plan' + condition: succeeded('Terraform_Plan') + jobs: + - deployment: 'Terraform_Apply' + displayName: 'Terraform_Apply' + pool: + vmImage: 'ubuntu-latest' + environment: 'terraform' # update to your environment name + variables: + SasToken: $[ stageDependencies.Terraform_Plan.Terraform_Plan.outputs['SasTokenStep.SAS_TOKEN'] ] + strategy: + runOnce: + deploy: + steps: + - checkout: self + fetchDepth: 0 + + - download: current + artifact: drop + + - bash: | + terraform init \ + -backend-config="storage_account_name=$TF_STATE_BLOB_ACCOUNT_NAME" \ + -backend-config="container_name=$TF_STATE_BLOB_CONTAINER_NAME" \ + -backend-config="key=$TF_STATE_BLOB_FILE" \ + -backend-config="sas_token=$TF_STATE_BLOB_SAS_TOKEN" + displayName: 'Terraform Init' + workingDirectory: $(workingDir) + env: + TF_STATE_BLOB_ACCOUNT_NAME: $(storageAccount) + TF_STATE_BLOB_CONTAINER_NAME: $(container) + TF_STATE_BLOB_FILE: $(stateFile) + TF_STATE_BLOB_SAS_TOKEN: $(SasToken) + + - bash: | + cp $(Agent.BuildDirectory)/drop/main.tfplan main.tfplan + displayName: 'Copy Plan' + workingDirectory: $(workingDir) + + - bash: | + terraform apply -auto-approve main.tfplan + displayName: 'Terraform Apply' + workingDirectory: $(workingDir) + env: + ARM_SUBSCRIPTION_ID: $(subscriptionId) + ARM_CLIENT_ID: $(clientId) + ARM_CLIENT_SECRET: $(clientSecret) + ARM_TENANT_ID: $(tenantId) diff --git a/azure-pipelines/azdo-terraform-ci.yml b/azure-pipelines/azdo-terraform-ci.yml new file mode 100644 index 0000000..01aecec --- /dev/null +++ b/azure-pipelines/azdo-terraform-ci.yml @@ -0,0 +1,55 @@ +#trigger: +# batch: true +# branches: +# include: +# - master +# paths: +# include: +# - '*' +# +#pr: +# branches: +# include: +# - '*' + +trigger: none +pr: none + +variables: + - name: TF_LOG + value: INFO + - name: WORKING_DIR + value: '$(System.DefaultWorkingDirectory)' + +stages: + - stage: "Terraform_CI" + displayName: "Terraform Validate" + jobs: + - job: Terraform_CI + displayName: "Terraform Validate" + pool: + vmImage: "ubuntu-latest" + steps: + - checkout: self + fetchDepth: 0 + + - task: TerraformInstaller@0 + displayName: 'Terraform Installer' + inputs: + terraformVersion: 'latest' + + - script: terraform -v + displayName: 'Terraform Version' + workingDirectory: '$(WORKING_DIR)' + + - script: terraform init -backend=false + displayName: 'Terraform Init' + workingDirectory: '$(WORKING_DIR)' + + - script: terraform validate + displayName: 'Terraform Validate' + workingDirectory: '$(WORKING_DIR)' + + - script: terraform fmt -check + displayName: 'Terraform Format' + workingDirectory: '$(WORKING_DIR)' diff --git a/azure-pipelines/azdo-terraform-destroy.yml b/azure-pipelines/azdo-terraform-destroy.yml new file mode 100644 index 0000000..bf31336 --- /dev/null +++ b/azure-pipelines/azdo-terraform-destroy.yml @@ -0,0 +1,140 @@ +#trigger: +# batch: true +# branches: +# include: +# - master +# +#pr: +# branches: +# include: +# - '*' + +trigger: none +pr: none + +variables: + - name: TF_LOG + value: INFO + - name: workingDir + value: '$(System.DefaultWorkingDirectory)' + - group: 'TF_SETTINGS' # update to your variable group name + +stages: + - stage: "Terraform_Plan" + displayName: "Terraform_Plan" + jobs: + - job: 'Terraform_Plan' + displayName: "Terraform_Plan" + pool: + vmImage: "ubuntu-latest" + steps: + - checkout: self + fetchDepth: 0 + + - script: | + terraform init -backend=false + terraform validate + terraform fmt -check + displayName: "Run tf validate" + workingDirectory: '$(workingDir)' + + - task: AzureCLI@2 + name: SasTokenStep + displayName: 'Set SAS Token' + inputs: + azureSubscription: 'TerraformTemplateServiceConnection' # update to your service connection name + scriptType: 'pscore' + scriptLocation: 'inlineScript' + inlineScript: | + $Date = (Get-Date).AddDays(1).ToString('yyyy-MM-dd') + $key = $( az storage account keys list --resource-group $(rgName) --account-name $(storageAccount) --query [0].value -o tsv ) + $sas = $( az storage container generate-sas --name $(container) --expiry $Date --permissions "racwdli" --account-name $(storageAccount) --account-key "$key" ) + $sas = $sas.Replace("`"","") + Write-Host "##vso[task.setvariable variable=SAS_TOKEN;isOutput=true]$sas" + + - bash: | + terraform init \ + -backend-config="storage_account_name=$TF_STATE_BLOB_ACCOUNT_NAME" \ + -backend-config="container_name=$TF_STATE_BLOB_CONTAINER_NAME" \ + -backend-config="key=$TF_STATE_BLOB_FILE" \ + -backend-config="sas_token=$TF_STATE_BLOB_SAS_TOKEN" + displayName: Terraform Init + workingDirectory: $(workingDir) + env: + TF_STATE_BLOB_ACCOUNT_NAME: $(storageAccount) + TF_STATE_BLOB_CONTAINER_NAME: $(container) + TF_STATE_BLOB_FILE: $(stateFile) + TF_STATE_BLOB_SAS_TOKEN: $(SasTokenStep.SAS_TOKEN) + + - bash: | + terraform plan -destroy -var "prefix=$PREFIX" -out main.tfplan + workingDirectory: $(workingDir) + displayName: 'Terraform Plan' + env: + PREFIX: $(prefix) + ARM_SUBSCRIPTION_ID: $(subscriptionId) + ARM_CLIENT_ID: $(clientId) + ARM_CLIENT_SECRET: $(clientSecret) + ARM_TENANT_ID: $(tenantId) + + - bash: cp main.tfplan $(Build.ArtifactStagingDirectory) + displayName: 'Copy Plan' + workingDirectory: $(workingDir) + + - task: PublishBuildArtifacts@1 + displayName: 'Publish Artifacts' + inputs: + PathtoPublish: '$(Build.ArtifactStagingDirectory)' + ArtifactName: 'drop' + publishLocation: 'Container' + + - stage: 'Terraform_Destroy' + displayName: 'Terraform_Destroy' + dependsOn: 'Terraform_Plan' + condition: succeeded('Terraform_Plan') + jobs: + - deployment: 'Terraform_Destroy' + displayName: 'Terraform_Destroy' + pool: + vmImage: 'ubuntu-latest' + environment: 'terraform' # update to your environment name + variables: + SasToken: $[ stageDependencies.Terraform_Plan.Terraform_Plan.outputs['SasTokenStep.SAS_TOKEN'] ] + strategy: + runOnce: + deploy: + steps: + - checkout: self + fetchDepth: 0 + + - download: current + artifact: drop + + - bash: | + terraform init \ + -backend-config="storage_account_name=$TF_STATE_BLOB_ACCOUNT_NAME" \ + -backend-config="container_name=$TF_STATE_BLOB_CONTAINER_NAME" \ + -backend-config="key=$TF_STATE_BLOB_FILE" \ + -backend-config="sas_token=$TF_STATE_BLOB_SAS_TOKEN" + displayName: 'Terraform Init' + workingDirectory: $(workingDir) + env: + TF_STATE_BLOB_ACCOUNT_NAME: $(storageAccount) + TF_STATE_BLOB_CONTAINER_NAME: $(container) + TF_STATE_BLOB_FILE: $(stateFile) + TF_STATE_BLOB_SAS_TOKEN: $(SasToken) + + - bash: | + cp $(Agent.BuildDirectory)/drop/main.tfplan main.tfplan + displayName: 'Copy Plan' + workingDirectory: $(workingDir) + + - bash: | + terraform apply -auto-approve main.tfplan + displayName: 'Terraform Destroy' + workingDirectory: $(workingDir) + env: + ARM_SUBSCRIPTION_ID: $(subscriptionId) + ARM_CLIENT_ID: $(clientId) + ARM_CLIENT_SECRET: $(clientSecret) + ARM_TENANT_ID: $(tenantId) diff --git a/locals.tf b/locals.tf new file mode 100644 index 0000000..72e80a0 --- /dev/null +++ b/locals.tf @@ -0,0 +1,5 @@ +locals { + rg_name = "${var.resource_group_name}-${var.prefix}" + test_var = "test5" + test_var2 = "test5" +} diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..b14aaef --- /dev/null +++ b/main.tf @@ -0,0 +1,12 @@ +data "azurerm_client_config" "current" {} + +resource "azurerm_resource_group" "public" { + location = var.resource_group_location + name = local.rg_name +} + +module "resource_group" { + source = "./modules/example_submodule" + resource_group_location = "northeurope" + resource_group_name = "rg-from-module" +} diff --git a/modules/example_submodule/main.tf b/modules/example_submodule/main.tf new file mode 100644 index 0000000..6a486fe --- /dev/null +++ b/modules/example_submodule/main.tf @@ -0,0 +1,8 @@ +locals { + rg_name = var.resource_group_name +} + +resource "azurerm_resource_group" "public" { + location = var.resource_group_location + name = local.rg_name +} diff --git a/modules/example_submodule/output.tf b/modules/example_submodule/output.tf new file mode 100644 index 0000000..555885d --- /dev/null +++ b/modules/example_submodule/output.tf @@ -0,0 +1,3 @@ +output "rg_id" { + value = azurerm_resource_group.public.id +} diff --git a/modules/example_submodule/variables.tf b/modules/example_submodule/variables.tf new file mode 100644 index 0000000..c944ef3 --- /dev/null +++ b/modules/example_submodule/variables.tf @@ -0,0 +1,9 @@ +variable "resource_group_name" { + type = string + description = "Resource group name" +} + +variable "resource_group_location" { + type = string + description = "Resource group location" +} diff --git a/output.tf b/output.tf new file mode 100644 index 0000000..e69de29 diff --git a/provider.tf b/provider.tf new file mode 100644 index 0000000..73809ee --- /dev/null +++ b/provider.tf @@ -0,0 +1,7 @@ +provider "azurerm" { + features { + resource_group { + prevent_deletion_if_contains_resources = false + } + } +} diff --git a/scripts/CreateAzureStorageAccount.ps1 b/scripts/CreateAzureStorageAccount.ps1 new file mode 100644 index 0000000..7c7124a --- /dev/null +++ b/scripts/CreateAzureStorageAccount.ps1 @@ -0,0 +1,25 @@ +$rgName = "rg-terraform-tfstate-01" +$location = "northeurope" +$storageAccount = "tfstatestorage011" +$container = "tfstatecontainer01" + +# create resource group +az group create --name $rgName --location $location + +# create storage account +az storage account create ` + --name $storageAccount ` + --resource-group $rgName ` + --kind StorageV2 ` + --sku Standard_LRS ` + --https-only true ` + --allow-blob-public-access false + +# create storage container +az storage container create --name $container --account-name $storageAccount --public-access "off" + +# get SAS token +$Date = (Get-Date).AddDays(5).ToString('yyyy-MM-dd') +$key = $( az storage account keys list --resource-group $rgName --account-name $storageAccount --query [0].value -o tsv ) +$sas = $( az storage container generate-sas --name $container --expiry $Date --permissions "racwdli" --account-name $storageAccount --account-key "$key" ) +Write-Host "SAS Token: $sas" diff --git a/scripts/CreateSelfSignedCert.ps1 b/scripts/CreateSelfSignedCert.ps1 new file mode 100644 index 0000000..a5e1193 --- /dev/null +++ b/scripts/CreateSelfSignedCert.ps1 @@ -0,0 +1,6 @@ +# Create the Certificates +$AppName = "HrbCloud" +$RootCert = New-SelfSignedCertificate -Type Custom -KeySpec Signature -Subject "CN=$( $AppName )RootCert" -KeyExportPolicy Exportable -HashAlgorithm sha256 -KeyLength 2048 -CertStoreLocation "Cert:\CurrentUser\My" -KeyUsageProperty Sign -KeyUsage CertSign +$ChildCert = New-SelfSignedCertificate -Type Custom -DnsName "$( $AppName )ChildCert" -KeySpec Signature -Subject "CN=$( $AppName )ChildCert" -KeyExportPolicy Exportable -HashAlgorithm sha256 -KeyLength 2048 -CertStoreLocation "Cert:\CurrentUser\My" -Signer $rootcert -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2") +# Export the Certificate +Export-Certificate -Type CERT -Cert $rootcert -FilePath ".\$( $AppName )-RootCert.crt" diff --git a/scripts/GenerateLetsEncryptSSLCert.ps1 b/scripts/GenerateLetsEncryptSSLCert.ps1 new file mode 100644 index 0000000..bb18f10 --- /dev/null +++ b/scripts/GenerateLetsEncryptSSLCert.ps1 @@ -0,0 +1,18 @@ +$domain = "mangomesenger.company"; +$email = "kolosovp94@gmail.com"; +$server = "https://acme-v02.api.letsencrypt.org/directory"; + +certbot certonly ` + --manual ` + --preferred-challenges=dns ` + --email $email ` + --server $server ` + -d "*.$domain" ` + -d "$domain" + +nslookup -type=txt _acme-challenge.$domain + +# From folder C:\Certbot\live\mangomesenger.company in CMD as Admin +type fullchain.pem privkey.pem > bundle.pem + +openssl pkcs12 -export -out "certificate_combined.pfx" -inkey "privkey.pem" -in "cert.pem" -certfile bundle.pem diff --git a/scripts/generate_letsencrypt_cert.sh b/scripts/generate_letsencrypt_cert.sh new file mode 100644 index 0000000..d4bbe13 --- /dev/null +++ b/scripts/generate_letsencrypt_cert.sh @@ -0,0 +1,16 @@ +domain="devtest.team" \ +email="kolosovp94@gmail.com" \ +server="https://acme-v02.api.letsencrypt.org/directory" + +sudo certbot certonly --manual --preferred-challenges=dns --email $email \ + --server $server -d "*.${domain}" -d "$domain" + +nslookup -type=txt _acme-challenge.$domain + +## Create AKS secret with SSL cert + +kubectl create secret tls tls-secret \ + --cert=/etc/letsencrypt/live/devtest.team/fullchain.pem \ + --key=/etc/letsencrypt/live/devtest.team/privkey.pem + +kubectl create secret tls tls-secret --cert=live/devtest.team/fullchain.pem --key=live/devtest.team/privkey.pem diff --git a/terraform.auto.tfvars.json b/terraform.auto.tfvars.json new file mode 100644 index 0000000..7483d3e --- /dev/null +++ b/terraform.auto.tfvars.json @@ -0,0 +1,5 @@ +{ + "resource_group_name": "rg-terraform-template", + "resource_group_location": "northeurope", + "prefix": "tf01" +} diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..b86663a --- /dev/null +++ b/variables.tf @@ -0,0 +1,14 @@ +variable "resource_group_name" { + type = string + description = "Resource group name" +} + +variable "resource_group_location" { + type = string + description = "Resource group location" +} + +variable "prefix" { + type = string + description = "Prefix for all resources" +} diff --git a/versions.tf b/versions.tf new file mode 100644 index 0000000..2fb26cb --- /dev/null +++ b/versions.tf @@ -0,0 +1,10 @@ +terraform { + required_providers { + azurerm = { + source = "hashicorp/azurerm" + version = "=3.71.0" + } + } + + backend "azurerm" {} +}