From b8f9e0131082c7ee6e5e244db860c44f4e94f72e Mon Sep 17 00:00:00 2001 From: Julian Whiting <48572565+j2whiting@users.noreply.github.com> Date: Wed, 4 Sep 2024 16:20:14 -0400 Subject: [PATCH] Initial commit --- .dockerignore | 7 + .editorconfig | 26 +++ .github/pull_request_template.md | 6 + .github/workflows/integration-issues.yml | 25 +++ .github/workflows/lint.yaml | 35 ++++ .github/workflows/publish.yaml | 36 ++++ .gitignore | 73 ++++++++ .yamllint | 5 + LICENSE | 201 +++++++++++++++++++++++ README.md | 10 ++ docker-bake.hcl | 52 ++++++ 11 files changed, 476 insertions(+) create mode 100644 .dockerignore create mode 100644 .editorconfig create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/integration-issues.yml create mode 100644 .github/workflows/lint.yaml create mode 100644 .github/workflows/publish.yaml create mode 100644 .gitignore create mode 100644 .yamllint create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docker-bake.hcl diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..647ea89 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,7 @@ + +!build/*-runner +!build/*-runner.jar +!build/lib/* +!build/quarkus-app/* + +**/node_modules diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7ce4a2e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,26 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# https://editorconfig.org + +root = true + +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 +trim_trailing_whitespace = true +indent_style = tab +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false +indent_style = space + +[*.{yml,yaml}] +indent_style = space + +[*.{cmd,bat}] +end_of_line = crlf + +[*.gradle] +indent_size = 4 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d1da148 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,6 @@ +# Description + +* Include a summary of the changes and the related issue. +* Include relevant motivation and context. + +Resolves #(issue) diff --git a/.github/workflows/integration-issues.yml b/.github/workflows/integration-issues.yml new file mode 100644 index 0000000..38fc6c1 --- /dev/null +++ b/.github/workflows/integration-issues.yml @@ -0,0 +1,25 @@ +--- +# Automatically adds issues to the Integration Github project +# if the issue is tagged with `integration` + +name: Add integration tasks to Integration project + +on: + issues: + types: + - reopened + - opened + - labeled + - edited + +jobs: + add-to-project: + name: Add integration issue to project + runs-on: ubuntu-latest + steps: + - uses: actions/add-to-project@16678f07cc736f4fe688569f2d1df41efd2fcefe + with: + project-url: https://github.com/orgs/DARPA-ASKEM/projects/5 + github-token: ${{ secrets.ADD_TO_PROJECT_PAT }} + labeled: integration + label-operator: OR diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..936dc2f --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,35 @@ +--- +# This workflow will lint all YAML and Docker files +name: Global File Linting +# yamllint disable-line rule:truthy +on: + workflow_call: + push: + paths: + - '**.yaml' + - '**.yml' + - '**/Dockerfile*' + branches: ['main'] + pull_request: + paths: + - '**.yaml' + - '**.yml' + - '**/Dockerfile*' + branches: ['main'] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref || github.run_id }} + cancel-in-progress: true + +jobs: + lintYaml: + name: Lint YAML Files + uses: darpa-askem/.github/.github/workflows/lint-yaml.yaml@main + with: + strict: false + + lintDocker: + name: Lint Docker Files + uses: darpa-askem/.github/.github/workflows/lint-docker.yaml@main + with: + failure-threshold: 'error' diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..6c7050a --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,36 @@ +--- +# Automatically build Docker images on changes to main and push them to a +# Container Registry using HCL Bake file. + +name: Build Docker Images +# yamllint disable-line rule:truthy +on: + workflow_dispatch: + push: + branches: ['main'] + tags: ['*'] + +jobs: + # Call the Lint & Format workflow before publishing + verify: + uses: ./.github/workflows/lint.yaml + + # Call the Tag Generator to generate an image tag to use + tag-generator: + uses: darpa-askem/.github/.github/workflows/tag-generator.yaml@main + + # Build and Publish all targets associated with specified group + bake: + needs: + - verify + - tag-generator + uses: darpa-askem/.github/.github/workflows/bake-publish.yml@main + with: + file: 'docker-bake.hcl' + group: 'prod' + registry: 'ghcr.io' + organization: ${{ github.repository_owner }} + tag: ${{ needs.tag-generator.outputs.tag }} + secrets: + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0832ceb --- /dev/null +++ b/.gitignore @@ -0,0 +1,73 @@ +# Gradle +.gradle/ +build/ + +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea/* +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode/* +.factorypath + +# Nova +.nova/* + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Local environment +.env + +# Python +__pycache__ +.mypy_cache +.pytest_cache +dist +.venv +.tmp +.vscode +.cache +.sqlite +experiments-main +api.env + +# Minio +.minio.sys + +# Yarn +.yarn/* +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/sdks +!.yarn/versions +.pnp.* + +# NPM +node_modules +dist +build + +# MISC +create.sql +.eslintcache diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..75da2b7 --- /dev/null +++ b/.yamllint @@ -0,0 +1,5 @@ +--- +extends: default + +rules: + line-length: disable 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 new file mode 100644 index 0000000..c36a842 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +[![Build and Publish](https://github.com/DARPA-ASKEM/service-template/actions/workflows/publish.yaml/badge.svg?event=push)](https://github.com/DARPA-ASKEM/service-template/actions/workflows/publish.yaml) + +# service-template + +This is a template repository to create services for Terarium. + + +## License + +[Apache License 2.0](LICENSE) diff --git a/docker-bake.hcl b/docker-bake.hcl new file mode 100644 index 0000000..0ef71b1 --- /dev/null +++ b/docker-bake.hcl @@ -0,0 +1,52 @@ +variable "DOCKER_REGISTRY" { + default = "ghcr.io" +} +variable "DOCKER_ORG" { + default = "darpa-askem" +} +variable "VERSION" { + default = "local" +} + +# ---------------------------------------------------------------------------------------------------------------------- + +function "tag" { + params = [image_name, prefix, suffix] + result = [ "${DOCKER_REGISTRY}/${DOCKER_ORG}/${image_name}:${check_prefix(prefix)}${VERSION}${check_suffix(suffix)}" ] +} + +function "check_prefix" { + params = [tag] + result = notequal("",tag) ? "${tag}-": "" +} + +function "check_suffix" { + params = [tag] + result = notequal("",tag) ? "-${tag}": "" +} + +# ---------------------------------------------------------------------------------------------------------------------- + +group "prod" { + targets = ["NAME-service"] +} + +group "default" { + targets = ["NAME-service-base"] +} + +# ---------------------------------------------------------------------------------------------------------------------- + +target "_platforms" { + platforms = ["linux/amd64", "linux/arm64"] +} + +target "NAME-service-base" { + context = "." + tags = tag("NAME-service", "", "") + dockerfile = "Dockerfile" +} + +target "NAME-service" { + inherits = ["_platforms", "NAME-service-base"] +}