Skip to content

Commit

Permalink
[GDB-10328] Added support for Amazon Linux 2
Browse files Browse the repository at this point in the history
  • Loading branch information
simonzhekoff committed Jun 3, 2024
1 parent 1e915bb commit 5ebeb40
Show file tree
Hide file tree
Showing 18 changed files with 1,016 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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 = "<your-vpc-id>"
build_subnet_id = "<your-subnet-id>"
Expand Down Expand Up @@ -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).
74 changes: 74 additions & 0 deletions amazon-linux-build/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions amazon-linux-build/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@Ontotext-AD/tes
48 changes: 48 additions & 0 deletions amazon-linux-build/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
201 changes: 201 additions & 0 deletions amazon-linux-build/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
Loading

0 comments on commit 5ebeb40

Please sign in to comment.