From b4e4c86ddeb4c4f3557de495d72a6d0dde889e94 Mon Sep 17 00:00:00 2001 From: Aliaksandr Panasiuk Date: Wed, 5 Jun 2024 11:02:38 +0200 Subject: [PATCH 1/5] #10 - prepare repository to open-source --- LICENSE | 201 ++++++++++++++++++ README.md | 54 +++-- .../emergency-cluster-destroy.sh | 6 +- marketplace/packer/variables.pkr.hcl | 2 +- marketplace/terraform/README.md | 20 ++ marketplace/terraform/main.tf | 2 +- marketplace/terraform/variables.tf | 3 +- terraform/main.tf | 2 + 8 files changed, 267 insertions(+), 23 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 4998dc9..3dd1884 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,56 @@ # aws.provisioner.infra -This repository provides terraform templates and manifests. + +[![Release](https://img.shields.io/github/v/release/edenlabllc/aws.provisioner.infra.svg?style=for-the-badge)](https://github.com/edenlabllc/aws.provisioner.infra/releases/latest) +[![Software License](https://img.shields.io/github/license/edenlabllc/aws.provisioner.infra.svg?style=for-the-badge)](LICENSE) +[![Powered By: Edenlab](https://img.shields.io/badge/powered%20by-edenlab-8A2BE2.svg?style=for-the-badge)](https://edenlab.io) + +This repository provides [Terraform](https://www.terraform.io/) templates and manifests. Mainly it is designed to be managed by administrators, DevOps engineers, SREs. ## Contents + * [Requirements](#requirements) -* [Git flow strategy](#git-flow-strategy) +* [Git workflow](#git-workflow) * [Additional information](#additional-information) * [Emergency cluster destroy](#emergency-cluster-destroy) * [Development](#development) -## Requirements: -terraform = version is specified in the project file of each tenant of the repository in section `tools`. +## Requirements + +`terraform` = version is specified in the [project.yaml](https://github.com/edenlabllc/rmk/blob/develop/docs/configuration/project-management/preparation-of-project-repository.md#projectyaml) file of each tenant of the repository in section `tools`. + +## Git workflow + +This repository uses the classic [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow, +embracing all its advantages and disadvantages. -## Git flow strategy -This repository uses the [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) approach. +**Stable branches:** develop, master -#### Stable branches: develop, master -Each merge in the master branch adds a new SemVer2 tag and a GitHub release is created. +Each merge in the master branch adds a new [SemVer2](https://semver.org/) tag and a GitHub release is created. ## Additional information -This set of terraform manifests can only be launched from the tenant repository via the RMK, + +This set of Terraform manifests can only be launched from the project repository via the [RMK](https://github.com/edenlabllc/rmk), because the entire input set of variables is formed by the RMK at the moment the commands are launched: `rmk cluster provision` or `rmk cluster destroy`. -RMK also keeps track of which version of the release of terraform manifests the tenant repository will use. -The version of terraform manifests artifact is described in the version file of each -tenant repository in the section `inventory.clusters`. +RMK also keeps track of which version of the release of Terraform manifests the project repository will use. +The version of Terraform manifests artifact is described in the [project.yaml](https://github.com/edenlabllc/rmk/blob/develop/docs/configuration/project-management/preparation-of-project-repository.md#projectyaml) file of each +project repository in the section: + +```yaml +inventory: + clusters: + aws.provisioner.infra: + version: + url: git::https://github.com/edenlabllc/{{.Name}}.git?ref={{.Version}} +``` ## Emergency cluster destroy -Script for emergency destroy of a tenant's cluster in the case when native terraform tools fail to do this. -### Requirements: +Script for emergency destroy of a project's cluster in the case when native Terraform tools fail to do this. + +**Requirements:** + * AWS CLI >= 2.9 * curl * aws-nuke >= v2.25.0 @@ -37,12 +58,13 @@ Script for emergency destroy of a tenant's cluster in the case when native terra ```shell cd emergency-cluster-destroy -./emergency-cluster-destroy.sh +./emergency-cluster-destroy.sh ``` > Note: Follow the script's interactive instructions for correct execution. ## Development -For development, you need to use one of the tenant repositories and change the code + +For development, you need to use one of the project repositories and change the code in the directory `.PROJECT/clusters/aws.provisioner.infra-/terraform`. After developing and refactoring code, copy change files to this repository in feature branch and create Pull Request. diff --git a/emergency-cluster-destroy/emergency-cluster-destroy.sh b/emergency-cluster-destroy/emergency-cluster-destroy.sh index 918a1b2..6cf0540 100755 --- a/emergency-cluster-destroy/emergency-cluster-destroy.sh +++ b/emergency-cluster-destroy/emergency-cluster-destroy.sh @@ -6,13 +6,13 @@ set -e export AWS_PROFILE="${1}" export CF_TOKEN="${2}" -export AWS_ACCOUNT_ID=288509344804 -export AWS_REGION=eu-north-1 - export AWS_CONFIG_FILE="${HOME}/.aws/config_${AWS_PROFILE}" export AWS_SHARED_CREDENTIALS_FILE="${HOME}/.aws/credentials_${AWS_PROFILE}" export CLUSTER_NAME="${AWS_PROFILE}" +export AWS_REGION="$(aws configure get region)" +export AWS_ACCOUNT_ID="$(aws sts get-caller-identity --query Account --output text)" + readonly AWS_NUKE_CONFIG_TMPL=aws-nuke.yaml.tmpl readonly AWS_NUKE_CONFIG=aws-nuke.yaml diff --git a/marketplace/packer/variables.pkr.hcl b/marketplace/packer/variables.pkr.hcl index a2dc69e..eb2fc07 100644 --- a/marketplace/packer/variables.pkr.hcl +++ b/marketplace/packer/variables.pkr.hcl @@ -54,7 +54,7 @@ variable "project_env_variables" { SMTP_USERNAME = "notifications@example.com" SMTP_PASSWORD = "XXXXXXXXXXXX" FIXTURES_GIT_PAT = "ghp_XXXXXXXXXXXX" - ERROR_MAIL_RECEIVER = "fhir-notifications-XXXXXXXXXXXX@example.slack.com" + ERROR_MAIL_RECEIVER = "notifications-XXXXXXXXXXXX@example.slack.com" } sensitive = true type = map(string) diff --git a/marketplace/terraform/README.md b/marketplace/terraform/README.md index b0f687c..ba4bf5c 100644 --- a/marketplace/terraform/README.md +++ b/marketplace/terraform/README.md @@ -6,10 +6,12 @@ from AWS Marketplace. ### Quick start guide 1. Create `.env` file with AWS credentials: + ```shell export AWS_REGION= export AWS_ACCESS_KEY_ID= export AWS_SECRET_ACCESS_KEY= +export TF_VAR_AMI_IMAGE_OWNER= export TF_VAR_AWS_REGION="${AWS_REGION}" export TF_VAR_AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID}" export TF_VAR_AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" @@ -18,11 +20,13 @@ export TF_VAR_AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" > Note: `TF_VAR_*` variables are used by Terraform. 2. Run the following commands to initialize environment variables: + ```shell set -a; source .env; set +a ``` 3. Run the following Terraform commands while in the directory with a set of manifests: + ```shell terraform init -reconfigure terraform plan -out kodjin-mini.tfplan @@ -41,6 +45,7 @@ terraform apply kodjin-mini.tfplan By default, this configuration example provide one disk of a `200GB` size for the project. However, you can extend the default size through the `instance_data_disk_size` variable. + ```terraform variable "instance_data_disk_size" { default = 200 @@ -50,6 +55,7 @@ variable "instance_data_disk_size" { ``` After changing the values run `plan` and `apply` Terraform commands: + ```shell terraform plan -out kodjin-mini.tfplan terraform apply kodjin-mini.tfplan @@ -63,26 +69,33 @@ Find the directory according to your environment name: `etc/deps/ Date: Wed, 5 Jun 2024 12:34:48 +0200 Subject: [PATCH 2/5] #10 - refactoring README.md --- README.md | 5 +++-- marketplace/terraform/README.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3dd1884..fcd995b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ Mainly it is designed to be managed by administrators, DevOps engineers, SREs. ## Requirements -`terraform` = version is specified in the [project.yaml](https://github.com/edenlabllc/rmk/blob/develop/docs/configuration/project-management/preparation-of-project-repository.md#projectyaml) file of each tenant of the repository in section `tools`. +`terraform` = version is specified in the [project.yaml](https://github.com/edenlabllc/rmk/blob/develop/docs/configuration/project-management/preparation-of-project-repository.md#projectyaml) file +of each project of the repository in the `tools` section. ## Git workflow @@ -30,7 +31,7 @@ Each merge in the master branch adds a new [SemVer2](https://semver.org/) tag an ## Additional information -This set of Terraform manifests can only be launched from the project repository via the [RMK](https://github.com/edenlabllc/rmk), +This set of Terraform manifests can only be launched from the project repository via [RMK](https://github.com/edenlabllc/rmk), because the entire input set of variables is formed by the RMK at the moment the commands are launched: `rmk cluster provision` or `rmk cluster destroy`. RMK also keeps track of which version of the release of Terraform manifests the project repository will use. diff --git a/marketplace/terraform/README.md b/marketplace/terraform/README.md index ba4bf5c..a247a56 100644 --- a/marketplace/terraform/README.md +++ b/marketplace/terraform/README.md @@ -1,6 +1,7 @@ # Kodjin Mini -A set of Terraform manifests with examples of provisioning a `Kodjin Mini` instance based on `Kodjin` AMI +A set of [Terraform](https://www.terraform.io/) manifests with examples +of provisioning a `Kodjin Mini` instance based on [Kodjin](https://kodjin.com) AMI from AWS Marketplace. ### Quick start guide @@ -17,7 +18,7 @@ export TF_VAR_AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID}" export TF_VAR_AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" ``` -> Note: `TF_VAR_*` variables are used by Terraform. +> `TF_VAR_*` variables are used by Terraform. 2. Run the following commands to initialize environment variables: From 6888c3465c00088c64f099bdf7c4fa3e661b3376 Mon Sep 17 00:00:00 2001 From: Aliaksandr Panasiuk Date: Wed, 5 Jun 2024 13:31:19 +0200 Subject: [PATCH 3/5] #10 - refactoring README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fcd995b..0b6ca36 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Each merge in the master branch adds a new [SemVer2](https://semver.org/) tag an ## Additional information This set of Terraform manifests can only be launched from the project repository via [RMK](https://github.com/edenlabllc/rmk), -because the entire input set of variables is formed by the RMK at the moment +because the entire input set of variables is formed by RMK at the moment the commands are launched: `rmk cluster provision` or `rmk cluster destroy`. RMK also keeps track of which version of the release of Terraform manifests the project repository will use. The version of Terraform manifests artifact is described in the [project.yaml](https://github.com/edenlabllc/rmk/blob/develop/docs/configuration/project-management/preparation-of-project-repository.md#projectyaml) file of each From 2e3a6bd0ccaa2283b346e98a7a880c15eb64a738 Mon Sep 17 00:00:00 2001 From: Aliaksandr Panasiuk Date: Wed, 5 Jun 2024 14:11:57 +0200 Subject: [PATCH 4/5] #10 - refactoring links for README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0b6ca36..c9ce6c6 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,17 @@ Script for emergency destroy of a project's cluster in the case when native Terr **Requirements:** -* AWS CLI >= 2.9 -* curl -* aws-nuke >= v2.25.0 -* yq >= v4.35.2 +* [AWS CLI](https://aws.amazon.com/cli/) >= 2.9 +* [cURL](https://curl.se/) +* [aws-nuke](https://github.com/rebuy-de/aws-nuke) >= v2.25.0 +* [yq](https://mikefarah.gitbook.io/yq) >= v4.35.2 ```shell cd emergency-cluster-destroy ./emergency-cluster-destroy.sh ``` -> Note: Follow the script's interactive instructions for correct execution. +> Follow the script's interactive instructions for correct execution. ## Development From 8e195c43837adfc3c5aa82f9fac122bd22719b61 Mon Sep 17 00:00:00 2001 From: Aliaksandr Panasiuk Date: Wed, 5 Jun 2024 14:45:22 +0200 Subject: [PATCH 5/5] #10 - refactoring Development articles README.md file --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c9ce6c6..e8987fe 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,6 @@ cd emergency-cluster-destroy ## Development -For development, you need to use one of the project repositories and change the code -in the directory `.PROJECT/clusters/aws.provisioner.infra-/terraform`. -After developing and refactoring code, copy change files to this repository in feature branch and create Pull Request. +For development, navigate to the local `.PROJECT/clusters/aws.provisioner.infra-/terraform` directory of a project repository, +then perform the changes directly in the files and test them. +Finally, copy the changed files to a new feature branch of this repository and create a pull request (PR).