From 5ebeb401be3a1fac1fbe994a83579994485df7f2 Mon Sep 17 00:00:00 2001 From: "simeon.zhekov" Date: Fri, 31 May 2024 11:40:32 +0300 Subject: [PATCH] [GDB-10328] Added support for Amazon Linux 2 --- .gitignore | 6 +- README.md | 8 +- amazon-linux-build/CHANGELOG.md | 74 +++++++ amazon-linux-build/CODEOWNERS | 1 + amazon-linux-build/CONTRIBUTING.md | 48 +++++ amazon-linux-build/LICENSE | 201 ++++++++++++++++++ amazon-linux-build/README.md | 82 +++++++ amazon-linux-build/aws-ami.pkr.hcl | 148 +++++++++++++ amazon-linux-build/build.pkr.hcl | 27 +++ .../files/cloudwatch-agent-config.json | 99 +++++++++ .../files/graphdb-cluster-proxy.service | 17 ++ amazon-linux-build/files/graphdb.env | 1 + amazon-linux-build/files/graphdb.service | 17 ++ amazon-linux-build/files/install_graphdb.sh | 70 ++++++ amazon-linux-build/files/prometheus.yaml | 19 ++ amazon-linux-build/plugins.pkr.hcl | 8 + amazon-linux-build/variables.pkr.hcl | 194 +++++++++++++++++ variables.pkr.hcl | 2 +- 18 files changed, 1016 insertions(+), 6 deletions(-) create mode 100644 amazon-linux-build/CHANGELOG.md create mode 100644 amazon-linux-build/CODEOWNERS create mode 100644 amazon-linux-build/CONTRIBUTING.md create mode 100644 amazon-linux-build/LICENSE create mode 100644 amazon-linux-build/README.md create mode 100644 amazon-linux-build/aws-ami.pkr.hcl create mode 100644 amazon-linux-build/build.pkr.hcl create mode 100644 amazon-linux-build/files/cloudwatch-agent-config.json create mode 100644 amazon-linux-build/files/graphdb-cluster-proxy.service create mode 100644 amazon-linux-build/files/graphdb.env create mode 100644 amazon-linux-build/files/graphdb.service create mode 100644 amazon-linux-build/files/install_graphdb.sh create mode 100644 amazon-linux-build/files/prometheus.yaml create mode 100644 amazon-linux-build/plugins.pkr.hcl create mode 100644 amazon-linux-build/variables.pkr.hcl diff --git a/.gitignore b/.gitignore index 6259374..4403bab 100644 --- a/.gitignore +++ b/.gitignore @@ -9,9 +9,9 @@ packer_cache/ crash.log # https://www.packer.io/guides/hcl/variables -# Exclude all .pkrvars.hcl files, which are likely to contain sensitive data, -# such as password, private keys, and other secrets. These should not be part of -# version control as they are data points which are potentially sensitive and +# Exclude all .pkrvars.hcl files, which are likely to contain sensitive data, +# such as password, private keys, and other secrets. These should not be part of +# version control as they are data points which are potentially sensitive and # subject to change depending on the environment. # *.pkrvars.hcl diff --git a/README.md b/README.md index 87d237d..5f35cc7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Packer Configuration for Creating GraphDB AMI +# Packer Configuration for Creating GraphDB Ubuntu AMI This guide explains how to use Packer to create an Amazon Machine Image (AMI) for GraphDB. The Packer configuration in this repository automates the process of installing and configuring GraphDB on an Ubuntu-based EC2 instance. @@ -35,7 +35,7 @@ Follow these steps to build an AMI for GraphDB using Packer: The Packer configuration allows you to customize various parameters, such as the GraphDB version, AWS region, instance type, VPC ID, and subnet ID. To do so, create a variables file `variables.pkrvars.hcl`, example file: ```bash - graphdb_version = "10.3.3" + graphdb_version = "10.6.3" ami_regions = ["us-east-1"] build_vpc_id = "" build_subnet_id = "" @@ -77,6 +77,10 @@ The following points can be customized in a packer variables file `variables.pkr - **Provisioning Scripts**: You can replace or modify the provisioning scripts located in the `./files/` directory. These scripts and files are copied and executed during the AMI creation process. +## Amazon Linux Image Build + +You can also build your own Amazon Linux Image when you navigate to the amazon-linux-build folder and follow the same steps from the above. + ## Support For questions or issues related to this Packer configuration, please [submit an issue](https://github.com/Ontotext-AD/packer-aws-graphdb/issues). diff --git a/amazon-linux-build/CHANGELOG.md b/amazon-linux-build/CHANGELOG.md new file mode 100644 index 0000000..612d730 --- /dev/null +++ b/amazon-linux-build/CHANGELOG.md @@ -0,0 +1,74 @@ +# Changelog + +All notable changes to the Packer template for creating GraphDB AMIs will be documented in this file. + +## 1.5.0 + +- Restructured the sources and grouped the variables +- Increased default GraphDB version to 10.6.1 +- Renamed some variables for clarity + - `gdb_version` is now named `graphdb_version` + - `source_ami_name_filter_x86-64` is now named `source_ami_name_filter_x86_64` + - `iam_instance_profile` is now named `build_iam_instance_profile` +- Added new configuration variables + - `access_key` and `secret_key` for static credentials authentication + - `shared_credentials_file` and `shared_credentials_file_profile` + - `source_ami_owners_x86_64` and `source_ami_owners_arm64` for filtering the source AMI owners + - `skip_create_ami` to avoid packaging and publishing the AMIs + - `ami_org_arns` and `ami_ou_arns` for additional access control + - `ami_tags` and `build_tags` for extra AMI tags + - `build_region` to specify the exact region where AMIs are built + - `build_assign_public_ip_address`, `build_security_group_cidrs` and `build_security_group_source_public_ip` to control the public access + to the build EC2 instances + - `user_data_file` to provide custom user data script + - `ssh_interface` and `ssh_username` to control how remote access is established + +## 1.4.0 + +- Installed cloudwatch agent and its needed configurations to be able to push metrics +- Added editorconfig to the project +- Added `yq` utility +- Moved variables block to variables.pkr.hcl +- Moved plugins block to plugins.pkr.hcl +- Moved build block to build.pkr.hcl +- Updated README.md +- Added `ssh_clear_authorized_keys` in favor of shredding them in the installation script. + +## 1.3.0 + +- Tuned GraphDB's max RAM percentage to allow bigger heap sizes +- Limited the cluster proxy to 1GB heap at most +- Configured GraphDB logs to be within GraphDB's data directory +- Updated the directory structure under /var/opt/graphdb/ +- Properly configured the home directories of GraphDB and its proxy +- Removed provisioning of graphdb.properties +- Added `ebs_optimized` to be true +- Added `encrypt_boot` to be false +- Added shredding of `/root/.ssh/authorized_keys` and `/home/ubuntu/.ssh/authorized_keys` + +## 1.2.0 + +- Added new configuration for AMI groups `ami_groups` +- Changed `ssh_interface` to `session_manager` +- Added `iam_instance_profile` variable required from the `session_manager` +- Added `Build_Timestamp` tag to the AMIs + +## 1.1.0 + +- Added parallel building of `arm64` and `amd64` based AMIs +- Added AWS cli to be installed based on the architecture +- Added new variables for `arm64` instance type and source AMI +- Renamed `build_instance_type` and `build_instance_type` variables +- Added default values for `source_ami_name_filter_arm64` and `source_ami_name_filter_x86-64` +- Changed default instance type for x86-64 to `t3.small` +- Added tags to the AMIs + +## 1.0.0 + +- Initial release of the Packer template. +- Added configuration to create GraphDB AMIs on AWS. +- Added basic provisioning with installation scripts. +- Added customizable instance type, region, VPC, and subnet. +- Added README.md with usage instructions. +- Added CONTRIBUTING.md +- Added CHANGELOG.md diff --git a/amazon-linux-build/CODEOWNERS b/amazon-linux-build/CODEOWNERS new file mode 100644 index 0000000..44517ec --- /dev/null +++ b/amazon-linux-build/CODEOWNERS @@ -0,0 +1 @@ +@Ontotext-AD/tes diff --git a/amazon-linux-build/CONTRIBUTING.md b/amazon-linux-build/CONTRIBUTING.md new file mode 100644 index 0000000..7f28adb --- /dev/null +++ b/amazon-linux-build/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing + +Here are a few guidelines to help you get started. + +## Getting Started + +1. Fork this repository. +2. Clone your forked repository to your local machine. +3. Create a new branch for your changes: `git checkout -b feature/my-new-feature`. +4. Make your changes and test them thoroughly. +5. Commit your changes: `git commit -m "Add some feature"`. +6. Push your changes to your fork: `git push origin feature/my-new-feature`. +7. Create a pull request from your branch to the main repository's `main` branch. + +## Code Style + +Make sure your code follows our and Terraform coding styles. + +## Tests + +If applicable, add or update tests to ensure your changes work as intended. + +## Documentation + +If your changes introduce new features, update the documentation to reflect those changes. + +## Commit Message Guidelines + +Please use meaningful commit messages. Follow the format: + +``` +[Type] Short description + +Longer description of the changes, especially whys. +``` + +Types: `[Feature]`, `[Fix]`, `[Docs]`, `[Refactor]`, `[Chore]`, `[Style]` + +## Pull Request Checklist + +- [ ] I have tested these changes thoroughly. +- [ ] My code follows the project's coding style. +- [ ] I have added appropriate comments to my code, especially in complex areas. +- [ ] All new and existing tests passed locally. + +## Feedback + +Feedback and suggestions are welcome! Feel free to open an issue if you have any questions or ideas. diff --git a/amazon-linux-build/LICENSE b/amazon-linux-build/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/amazon-linux-build/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/amazon-linux-build/README.md b/amazon-linux-build/README.md new file mode 100644 index 0000000..702830a --- /dev/null +++ b/amazon-linux-build/README.md @@ -0,0 +1,82 @@ +# Packer Configuration for Creating GraphDB Amazon Linux AMI + +This guide explains how to use Packer to create an Amazon Machine Image (AMI) for GraphDB. +The Packer configuration in this repository automates the process of installing and configuring GraphDB on an Amazon Linux-based EC2 instance. + +## Prerequisites + +Before you begin, make sure you have the following prerequisites in place: + +1. **Packer**: Ensure that you have Packer installed on your local machine. + You can download it from the official Packer website: [Packer Downloads](https://www.packer.io/downloads). +2. **AWS Account**: You should have an AWS account with necessary permissions to create EC2 instances and AMIs. +3. **AWS VPC**: You should create a VPC, required by Packer to create a temporary security group within the VPC +4. **AWS Subnet**: You should create a public subnet, required by Packer to launch the EC2 instances. + +Please note that if you are using an account with the global "Always encrypt new EBS volumes" option set to true, +Packer will be unable to override this setting, and the final image will be encrypted whether you set this value or not. +To build public AMI image this option should be set to `false`. + +## Usage + +Follow these steps to build an AMI for GraphDB using Packer: + +1. **Clone the Repository**: + ```bash + git clone https://github.com/Ontotext-AD/packer-aws-graphdb.git + ``` + +2. **Set Your AWS Credentials**: + + Ensure that your AWS credentials are correctly configured in the AWS CLI configuration. + +3. **Edit Variables (Optional)**: + + The Packer configuration allows you to customize various parameters, such as the GraphDB version, AWS region, + instance type, VPC ID, and subnet ID. To do so, create a variables file `variables.pkrvars.hcl`, example file: + ```bash + graphdb_version = "10.6.3" + ami_regions = ["us-east-1"] + build_vpc_id = "" + build_subnet_id = "" + build_iam_instance_profile = "" + ami_groups = [] # Value "all" will make the AMI public + build_instance_type_x86_64 = "t3.small" # default + build_instance_type_arm64 = "t4g.small" # default + source_ami_name_filter_arm64 = "amzn2-ami-hvm-*-arm64-gp2" # default + source_ami_name_filter_x86_64 = "amzn2-ami-hvm-*-x86_64-gp2" # default + ``` + +4. **Build the AMI**: + + Run Packer to build the AMI: + ```bash + packer build -var-file="variables.pkrvars.hcl" . + ``` + This command will initiate the Packer build process. Packer will launch an EC2 instance, install GraphDB, + and create an AMI based on the instance. + +## Customization + +You can customize the Packer configuration and provisioning scripts to suit your specific requirements. + +The following points can be customized in a packer variables file `variables.pkrvars.hcl`: +- **GraphDB Version**: You can change the GraphDB version by modifying the `graphdb_version` variable. +- **AWS Regions**: Modify the `build_region` variable to specify a different AWS region. +- **Instance Type**: Adjust the `build_instance_type_arm64` and `build_instance_type_x86_64` variables to select + different EC2 instance types for building the AMI images. +- **AMI Groups**: You can specify the groups the AMIs will be made available to via the `ami_groups` variable. + A list of strings is accepted. +- **build_iam_instance_profile**: AIM Instance profile required for the session manager access. + See https://developer.hashicorp.com/packer/integrations/hashicorp/amazon/latest/components/builder/ebs#session-manager-connections +- **Network Configuration**: Update the `build_vpc_id` and `build_subnet_id` variables to match your VPC and subnet settings. +- **Source AMI**: Use the `source_ami_name_filter_arm64` and `source_ami_name_filter_x86_64` variables to specify the + source ami name filter for each AMI, for example: + - `"amzn2-ami-hvm-*-arm64-gp2"` - Amazon Linux with `arm64` architecture. + - `"amzn2-ami-hvm-*-x86_64-gp2"` - Amazon Linux with `amd64` architecture. +- **Provisioning Scripts**: You can replace or modify the provisioning scripts located in the `./files/` directory. + These scripts and files are copied and executed during the AMI creation process. + +## Support + +For questions or issues related to this Packer configuration, please [submit an issue](https://github.com/Ontotext-AD/packer-aws-graphdb/issues). diff --git a/amazon-linux-build/aws-ami.pkr.hcl b/amazon-linux-build/aws-ami.pkr.hcl new file mode 100644 index 0000000..2e23ca6 --- /dev/null +++ b/amazon-linux-build/aws-ami.pkr.hcl @@ -0,0 +1,148 @@ +locals { + # Generates a timestamp for unique AMI naming. + timestamp = regex_replace(timestamp(), "[- TZ:]", "") +} + +data "amazon-ami" "amzn2_x86_64" { + filters = { + name = var.source_ami_name_filter_x86_64 + root-device-type = "ebs" + virtualization-type = "hvm" + } + most_recent = true + owners = var.source_ami_owners_x86_64 +} + +source "amazon-ebs" "amzn2_x86_64" { + skip_create_ami = var.skip_create_ami + + # + # AMI configurations + # + ami_name = "ami-ontotext-graphdb-${var.graphdb_version}-x86-64-${local.timestamp}" + ami_description = "GraphDB v${var.graphdb_version} by Ontotext" + + ami_virtualization_type = "hvm" + encrypt_boot = false + ebs_optimized = true + ena_support = true + + ami_regions = var.ami_regions + ami_users = var.ami_users + ami_groups = var.ami_groups + ami_org_arns = var.ami_org_arns + ami_ou_arns = var.ami_ou_arns + + tags = merge({ + GraphDB_Version = var.graphdb_version + CPU_Architecture = "x86-64" + Build_Timestamp = local.timestamp + }, var.ami_tags) + + # + # Access configurations + # + access_key = var.access_key + secret_key = var.secret_key + + shared_credentials_file = var.shared_credentials_file + profile = var.shared_credentials_file_profile + + # + # Build configurations + # + region = var.build_region + vpc_id = var.build_vpc_id + subnet_id = var.build_subnet_id + + instance_type = var.build_instance_type_x86_64 + source_ami = data.amazon-ami.amzn2_x86_64.id + iam_instance_profile = var.build_iam_instance_profile + user_data_file = var.user_data_file + + associate_public_ip_address = var.build_assign_public_ip_address + temporary_security_group_source_cidrs = var.build_security_group_cidrs + temporary_security_group_source_public_ip = var.build_security_group_source_public_ip + + run_tags = var.build_tags + + # + # SSH / Session Manager + # + communicator = "ssh" + ssh_interface = var.ssh_interface + ssh_username = "ec2-user" + ssh_clear_authorized_keys = true +} + +data "amazon-ami" "amzn2_arm64" { + filters = { + name = var.source_ami_name_filter_arm64 + root-device-type = "ebs" + virtualization-type = "hvm" + } + most_recent = true + owners = var.source_ami_owners_arm64 +} + +source "amazon-ebs" "amzn2_arm64" { + skip_create_ami = var.skip_create_ami + + # + # AMI configurations + # + ami_name = "ami-ontotext-graphdb-${var.graphdb_version}-arm64-${local.timestamp}" + ami_description = "GraphDB v${var.graphdb_version} by Ontotext" + + ami_virtualization_type = "hvm" + encrypt_boot = false + ebs_optimized = true + ena_support = true + + ami_regions = var.ami_regions + ami_users = var.ami_users + ami_groups = var.ami_groups + ami_org_arns = var.ami_org_arns + ami_ou_arns = var.ami_ou_arns + + tags = merge({ + GraphDB_Version = var.graphdb_version + CPU_Architecture = "arm64" + Build_Timestamp = local.timestamp + }, var.ami_tags) + + # + # Access configurations + # + access_key = var.access_key + secret_key = var.secret_key + + shared_credentials_file = var.shared_credentials_file + profile = var.shared_credentials_file_profile + + # + # Build configurations + # + region = var.build_region + vpc_id = var.build_vpc_id + subnet_id = var.build_subnet_id + + instance_type = var.build_instance_type_arm64 + source_ami = data.amazon-ami.amzn2_arm64.id + iam_instance_profile = var.build_iam_instance_profile + user_data_file = var.user_data_file + + associate_public_ip_address = var.build_assign_public_ip_address + temporary_security_group_source_cidrs = var.build_security_group_cidrs + temporary_security_group_source_public_ip = var.build_security_group_source_public_ip + + run_tags = var.build_tags + + # + # SSH / Session Manager + # + communicator = "ssh" + ssh_interface = var.ssh_interface + ssh_username = "ec2-user" + ssh_clear_authorized_keys = true +} diff --git a/amazon-linux-build/build.pkr.hcl b/amazon-linux-build/build.pkr.hcl new file mode 100644 index 0000000..5584aaa --- /dev/null +++ b/amazon-linux-build/build.pkr.hcl @@ -0,0 +1,27 @@ +build { + name = "graphdb-ami" + sources = [ + "source.amazon-ebs.amzn2_x86_64", + "source.amazon-ebs.amzn2_arm64" + ] + + provisioner "file" { + sources = [ + "./files/graphdb.service", + "./files/graphdb-cluster-proxy.service", + "./files/install_graphdb.sh", + "./files/cloudwatch-agent-config.json", + "./files/prometheus.yaml", + "./files/graphdb.env" + ] + destination = "/tmp/" + } + + provisioner "shell" { + environment_vars = [ + "GRAPHDB_VERSION=${var.graphdb_version}", + ] + inline = ["sudo -E bash /tmp/install_graphdb.sh"] + max_retries = 3 + } +} diff --git a/amazon-linux-build/files/cloudwatch-agent-config.json b/amazon-linux-build/files/cloudwatch-agent-config.json new file mode 100644 index 0000000..54c0c4d --- /dev/null +++ b/amazon-linux-build/files/cloudwatch-agent-config.json @@ -0,0 +1,99 @@ +{ + "agent": { + "debug": false + }, + "logs": { + "metrics_collected": { + "prometheus": { + "log_group_name": "graphdb", + "prometheus_config_path": "/etc/prometheus/prometheus.yaml", + "emf_processor": { + "metric_declaration_dedup": true, + "metric_namespace": "GraphDB-Metrics", + "metric_unit": { + "graphdb_nonheap_used_mem": "Bytes", + "graphdb_work_dir_used": "Bytes", + "graphdb_threads_count": "Count", + "graphdb_logs_dir_free": "Bytes", + "graphdb_heap_committed_mem": "Bytes", + "graphdb_logs_dir_used": "Bytes", + "graphdb_heap_max_mem": "Bytes", + "graphdb_heap_init_mem": "Bytes", + "graphdb_nonheap_init_mem": "Bytes", + "graphdb_class_count": "Count", + "graphdb_mem_garbage_collections_count": "Count", + "graphdb_data_dir_free": "Bytes", + "graphdb_nonheap_max_mem": "Bytes", + "graphdb_work_dir_free": "Bytes", + "graphdb_cpu_load": "Percent", + "graphdb_data_dir_used": "Bytes", + "graphdb_nonheap_committed_mem": "Bytes", + "graphdb_heap_used_mem": "Bytes", + "graphdb_open_file_descriptors": "Count", + "graphdb_nodes_in_cluster": "Count", + "graphdb_nodes_in_sync": "Count", + "graphdb_nodes_out_of_sync": "Count", + "graphdb_nodes_disconnected": "Count", + "graphdb_nodes_syncing": "Count", + "graphdb_leader_elections_count": "Count", + "graphdb_failure_recoveries_count": "Count" + }, + "metric_declaration": [ + { + "source_labels": [ + "job" + ], + "label_matcher": "graphdb_infrastructure_monitor", + "dimensions": [ + [ + "host" + ] + ], + "metric_selectors": [ + "^graphdb_nonheap_used_mem$", + "^graphdb_work_dir_used$", + "^graphdb_threads_count$", + "^graphdb_logs_dir_free$", + "^graphdb_heap_committed_mem$", + "^graphdb_logs_dir_used$", + "^graphdb_heap_max_mem$", + "^graphdb_heap_init_mem$", + "^graphdb_nonheap_init_mem$", + "^graphdb_class_count$", + "^graphdb_mem_garbage_collections_count$", + "^graphdb_data_dir_free$", + "^graphdb_nonheap_max_mem$", + "^graphdb_work_dir_free$", + "^graphdb_cpu_load$", + "^graphdb_data_dir_used$", + "^graphdb_nonheap_committed_mem$", + "^graphdb_heap_used_mem$", + "^graphdb_open_file_descriptors$" + ] + }, + { + "source_labels": [ + "job" + ], + "label_matcher": "graphdb_cluster_monitor", + "dimensions": [ + [ + "host" + ] + ], + "metric_selectors": [ + "^graphdb_nodes_in_cluster$", + "^graphdb_nodes_in_sync$", + "^graphdb_nodes_out_of_sync$", + "^graphdb_nodes_disconnected$", + "^graphdb_nodes_syncing$", + "^graphdb_leader_elections_count$", + "^graphdb_failure_recoveries_count$" + ] + } + ] + } + } + } + } +} diff --git a/amazon-linux-build/files/graphdb-cluster-proxy.service b/amazon-linux-build/files/graphdb-cluster-proxy.service new file mode 100644 index 0000000..804a820 --- /dev/null +++ b/amazon-linux-build/files/graphdb-cluster-proxy.service @@ -0,0 +1,17 @@ +[Unit] +Description="GraphDB Cluster Proxy" +Wants=network-online.target +After=network-online.target + +[Service] +Restart=on-failure +RestartSec=5s +User=graphdb +Group=graphdb +Environment="GDB_JAVA_OPTS=-Dgraphdb.home=/var/opt/graphdb/cluster-proxy -Dgraphdb.home.conf=/etc/graphdb-cluster-proxy -Dhttp.socket.keepalive=true -Xmx1g" +ExecStart=/opt/graphdb/bin/cluster-proxy +TimeoutSec=120 +SuccessExitStatus=143 + +[Install] +WantedBy=multi-user.target diff --git a/amazon-linux-build/files/graphdb.env b/amazon-linux-build/files/graphdb.env new file mode 100644 index 0000000..9fd428f --- /dev/null +++ b/amazon-linux-build/files/graphdb.env @@ -0,0 +1 @@ +GDB_JAVA_OPTS="-Dgraphdb.home=/var/opt/graphdb/node -Dgraphdb.home.conf=/etc/graphdb -Dhttp.socket.keepalive=true -XX:MaxRAMPercentage=85.0 -XX:-UseCompressedOops" diff --git a/amazon-linux-build/files/graphdb.service b/amazon-linux-build/files/graphdb.service new file mode 100644 index 0000000..632b108 --- /dev/null +++ b/amazon-linux-build/files/graphdb.service @@ -0,0 +1,17 @@ +[Unit] +Description="GraphDB Engine" +Wants=network-online.target +After=network-online.target + +[Service] +Restart=on-failure +RestartSec=5s +User=graphdb +Group=graphdb +EnvironmentFile=/etc/graphdb/graphdb.env +ExecStart=/opt/graphdb/bin/graphdb +TimeoutSec=120 +SuccessExitStatus=143 + +[Install] +WantedBy=multi-user.target diff --git a/amazon-linux-build/files/install_graphdb.sh b/amazon-linux-build/files/install_graphdb.sh new file mode 100644 index 0000000..7c2baff --- /dev/null +++ b/amazon-linux-build/files/install_graphdb.sh @@ -0,0 +1,70 @@ +#!/bin/bash + +set -euxo pipefail + +until ping -c 1 google.com &>/dev/null; do + echo "waiting for outbound connectivity" + sleep 5 +done + +timedatectl set-timezone UTC + +# Install Tools +yum update -y +yum install -y java-11-amazon-corretto + +# Get the server architecture and corresponding AWS CLI +server_arch=$(uname -m) + +if [[ "$server_arch" == "x86_64" ]]; then + curl "https://amazoncloudwatch-agent.s3.amazonaws.com/amazon_linux/amd64/latest/amazon-cloudwatch-agent.rpm" -o "amazon-cloudwatch-agent.rpm" +elif [[ "$server_arch" == "aarch64" ]]; then + curl "https://amazoncloudwatch-agent.s3.amazonaws.com/amazon_linux/arm64/latest/amazon-cloudwatch-agent.rpm" -o "amazon-cloudwatch-agent.rpm" +else + echo "Unknown server architecture: $server_arch." + exit 1 +fi + +yum install -y ./amazon-cloudwatch-agent.rpm +rm amazon-cloudwatch-agent.rpm + +# Create the GraphDB user +useradd --comment "GraphDB Service User" --create-home --system --shell /bin/bash --user-group graphdb + +# Create GraphDB directories +mkdir -p /etc/graphdb \ + /etc/graphdb-cluster-proxy \ + /var/opt/graphdb/node \ + /var/opt/graphdb/cluster-proxy + +# Download and install GraphDB +cd /tmp +curl -O https://maven.ontotext.com/repository/owlim-releases/com/ontotext/graphdb/graphdb/"${GRAPHDB_VERSION}"/graphdb-"${GRAPHDB_VERSION}"-dist.zip + +unzip graphdb-"${GRAPHDB_VERSION}"-dist.zip +rm graphdb-"${GRAPHDB_VERSION}"-dist.zip +mv graphdb-"${GRAPHDB_VERSION}" /opt/graphdb-"${GRAPHDB_VERSION}" +ln -s /opt/graphdb-"${GRAPHDB_VERSION}" /opt/graphdb + +mv /tmp/graphdb.env /etc/graphdb/graphdb.env + +chown -R graphdb:graphdb /etc/graphdb \ + /etc/graphdb-cluster-proxy \ + /opt/graphdb \ + /opt/graphdb-${GRAPHDB_VERSION} \ + /var/opt/graphdb + +# Configure systemd for GraphDB and GraphDB proxy +mv /tmp/graphdb-cluster-proxy.service /lib/systemd/system/graphdb-cluster-proxy.service +mv /tmp/graphdb.service /lib/systemd/system/graphdb.service + +# Move the prometheus and cloudwatch configurations +mkdir "/etc/prometheus" +mv /tmp/prometheus.yaml /etc/prometheus/prometheus.yaml +mv /tmp/cloudwatch-agent-config.json /etc/graphdb/cloudwatch-agent-config.json +# Disable the agent by default, should be enabled explicitly in the EC2 if needed. +amazon-cloudwatch-agent-ctl -a stop + +systemctl daemon-reload +systemctl enable graphdb.service +systemctl start graphdb.service diff --git a/amazon-linux-build/files/prometheus.yaml b/amazon-linux-build/files/prometheus.yaml new file mode 100644 index 0000000..243ae90 --- /dev/null +++ b/amazon-linux-build/files/prometheus.yaml @@ -0,0 +1,19 @@ +global: + scrape_interval: 1m + scrape_timeout: 10s +scrape_configs: + - job_name: graphdb_infrastructure_monitor + metrics_path: /rest/monitor/infrastructure + scrape_interval: 10s + static_configs: + - targets: [ 'localhost:7200' ] + - job_name: graphdb_structures_monitor + metrics_path: /rest/monitor/structures + scrape_interval: 10s + static_configs: + - targets: [ 'localhost:7200' ] + - job_name: graphdb_cluster_monitor + metrics_path: /rest/monitor/cluster + scrape_interval: 10s + static_configs: + - targets: [ 'localhost:7200' ] diff --git a/amazon-linux-build/plugins.pkr.hcl b/amazon-linux-build/plugins.pkr.hcl new file mode 100644 index 0000000..1d99243 --- /dev/null +++ b/amazon-linux-build/plugins.pkr.hcl @@ -0,0 +1,8 @@ +packer { + required_plugins { + amazon = { + version = ">= 1.2.6" + source = "github.com/hashicorp/amazon" + } + } +} diff --git a/amazon-linux-build/variables.pkr.hcl b/amazon-linux-build/variables.pkr.hcl new file mode 100644 index 0000000..4d59bd3 --- /dev/null +++ b/amazon-linux-build/variables.pkr.hcl @@ -0,0 +1,194 @@ +##################### +# GraphDB variables # +##################### + +variable "graphdb_version" { + description = "GraphDB version to install and package as an AMI" + type = string + default = "10.6.3" +} + +#################### +# Access variables # +#################### + +variable "access_key" { + description = "Access key used to communicate with AWS" + type = string + default = null +} + +variable "secret_key" { + description = "Secret key used to communicate with AWS." + type = string + default = null +} + +variable "shared_credentials_file" { + description = "Path to a credentials file to load credentials from" + type = string + default = null +} + +variable "shared_credentials_file_profile" { + description = "Profile to use in the shared credentials file for AWS" + type = string + default = null +} + +######################## +# Source AMI variables # +######################## + +variable "source_ami_name_filter_x86_64" { + description = "Name filter for the source x86-64 AMI image" + type = string + default = "amzn2-ami-hvm-*-x86_64-gp2" +} + +variable "source_ami_owners_x86_64" { + description = "Owners of the source AMI image for x86-64" + type = list(string) + default = ["amazon"] +} + +variable "source_ami_name_filter_arm64" { + description = "Name filter for the source arm64 AMI image" + type = string + default = "amzn2-ami-hvm-*-arm64-gp2" +} + +variable "source_ami_owners_arm64" { + description = "Owners of the arm64 source AMI image" + type = list(string) + default = ["amazon"] +} + +################# +# AMI variables # +################# + +variable "skip_create_ami" { + description = "Skip packaging and releasing the AMI" + type = bool + default = false +} + +variable "ami_regions" { + description = "AWS regions where the AMIs will be published" + type = list(string) + default = ["us-east-1"] +} + +variable "ami_users" { + description = "Users that will have access to the build AMIs" + type = list(string) + default = [] +} + +variable "ami_groups" { + description = "Groups that will have access to the build AMIs" + type = list(string) + default = [] +} + +variable "ami_org_arns" { + description = "ARNs of organizations that will have access to the built AMIs" + type = list(string) + default = [] +} + +variable "ami_ou_arns" { + description = "ARNs of organizational units that will have access to the built AMIs" + type = list(string) + default = [] +} + +variable "ami_tags" { + description = "Additional tags to apply to the built AMI" + type = map(string) + default = {} +} + +################### +# Build variables # +################### + +variable "build_region" { + description = "Region in which to launch EC2 instances to create the AMIs" + type = string + default = "us-east-1" +} + +variable "build_instance_type_x86_64" { + description = "EC2 instance type to use for building the x86-64 AMI" + type = string + default = "t3.small" +} + +variable "build_instance_type_arm64" { + description = "EC2 instance type to use for building the arm64 AMI" + type = string + default = "t4g.small" +} + +variable "build_vpc_id" { + description = "VPC ID where the AMI will be built" + type = string +} + +variable "build_subnet_id" { + description = "Subnet ID where the AMI will be built" + type = string +} + +variable "build_assign_public_ip_address" { + description = "Controls if the EC2 instances will be publicly accessible" + type = bool + default = true +} + +variable "build_security_group_cidrs" { + description = "List of IPv4 CIDR blocks authorized to access to the instance" + type = list(string) + default = null +} + +variable "build_security_group_source_public_ip" { + description = "Use public IP of the host as allowed inbound CIDR" + type = bool + default = true +} + +variable "build_iam_instance_profile" { + description = "IAM instance profile to use when launching EC2" + type = string +} + +variable "user_data_file" { + description = "Optional file that will be used as user data script when launching EC2" + type = string + default = null +} + +variable "build_tags" { + description = "Tags to apply to build resources and the resulting AMI" + type = map(string) + default = {} +} + +########################## +# Communicator variables # +########################## + +variable "ssh_interface" { + description = "Specifies how to connect to the remote EC2 instances" + type = string + default = "session_manager" +} + +variable "ssh_username" { + description = "The username to use when connecting over SSH" + type = string + default = "ec2-user" +} diff --git a/variables.pkr.hcl b/variables.pkr.hcl index d627445..3510c37 100644 --- a/variables.pkr.hcl +++ b/variables.pkr.hcl @@ -5,7 +5,7 @@ variable "graphdb_version" { description = "GraphDB version to install and package as an AMI" type = string - default = "10.6.1" + default = "10.6.3" } ####################