From b0084503951a1702d3efa428bff2585f3d99a04e Mon Sep 17 00:00:00 2001 From: Aysylu Greenberg Date: Mon, 3 Jun 2019 09:45:18 -0700 Subject: [PATCH] Added Docker Compose for Grafeas standalone with PostgreSQL --- .gitignore | 1 + LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 26 +++++- docker-compose.yaml | 10 +++ postgres/Dockerfile | 4 + postgres/init.sh | 15 ++++ server/Dockerfile | 8 ++ server/config.yaml | 45 ++++++++++ server/start.sh | 26 ++++++ server/wait.sh | 19 +++++ 10 files changed, 354 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 docker-compose.yaml create mode 100644 postgres/Dockerfile create mode 100644 postgres/init.sh create mode 100644 server/Dockerfile create mode 100644 server/config.yaml create mode 100755 server/start.sh create mode 100755 server/wait.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c49bd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.env diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c5aedc5 --- /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 2017 The Grafeas Authors + + 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 d16fdf7..9c460d9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # grafeas-pgsql -Grafeas with PostgreSQL backend + +[Grafeas](https://github.com/grafeas/grafeas) with PostgreSQL backend as a Docker Compose, provides a standalone instance of the Grafeas server with PostgreSQL as the storage layer. + +## Running Standalone Grafeas with PostgreSQL + +To start the standalone instance of Grafeas with PostgreSQL, follow these steps: + +1. Install [Docker Compose](https://docs.docker.com/compose/install/). +2. Build the images and run the containers: + + ```bash + docker-compose build + docker-compose up + ``` + +## Support + +Please refer to [Grafeas Support](https://github.com/grafeas/grafeas#support) page. + +## Contributing + +Pull requests and feature requests as GH issues are welcome! + +## License +Grafeas is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..6fa11d1 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,10 @@ +version: '3' +services: + server: + build: 'server' + ports: + - '8080:8080' + depends_on: + - db + db: + build: 'postgres' diff --git a/postgres/Dockerfile b/postgres/Dockerfile new file mode 100644 index 0000000..da605b4 --- /dev/null +++ b/postgres/Dockerfile @@ -0,0 +1,4 @@ +FROM postgres:latest +WORKDIR / +COPY ./init.sh /docker-entrypoint-initdb.d/init.sh +EXPOSE 5432 diff --git a/postgres/init.sh b/postgres/init.sh new file mode 100644 index 0000000..12cbc01 --- /dev/null +++ b/postgres/init.sh @@ -0,0 +1,15 @@ +#!/bin/bash +set -e + +echo 'Setting up PostgreSQL database' + +# Replace with extracting username and password from config +# Set password and utilize username from extracted var +psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL + CREATE USER grafeas; + ALTER ROLE grafeas WITH CREATEDB; + CREATE DATABASE grafeas_db; + GRANT ALL PRIVILEGES ON DATABASE grafeas_db TO grafeas; +EOSQL + +echo 'Database is up' diff --git a/server/Dockerfile b/server/Dockerfile new file mode 100644 index 0000000..113df10 --- /dev/null +++ b/server/Dockerfile @@ -0,0 +1,8 @@ +FROM us.gcr.io/grafeas/grafeas-server +WORKDIR / +COPY ./config.yaml /config.yaml +COPY ./wait.sh /wait.sh +COPY ./start.sh /start.sh +EXPOSE 8080 + +ENTRYPOINT ["./start.sh"] diff --git a/server/config.yaml b/server/config.yaml new file mode 100644 index 0000000..23e3178 --- /dev/null +++ b/server/config.yaml @@ -0,0 +1,45 @@ +# Copyright 2019 The Grafeas Authors. All rights reserved. +# +# 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. + +grafeas: + # Grafeas api server config + api: + # Endpoint address + address: "0.0.0.0:8080" + # PKI configuration (optional) + cafile: + keyfile: + certfile: + # CORS configuration (optional) + cors_allowed_origins: + # - "http://example.net" + storage_type: "postgres" + # Postgres options + postgres: + # Database host + host: "db:5432" + # Database name + dbname: "db" + # Database username + user: "grafeas" + # Database password + password: "changeme" + # Valid sslmodes disable, allow, prefer, require, verify-ca, verify-full. + # See https://www.postgresql.org/docs/current/static/libpq-connect.html for details + sslmode: "disable" + # 32-bit URL-safe base64 key used to encrypt pagination tokens + # If one is not provided, it will be generated. + # Multiple grafeas instances in the same cluster need the same value. + paginationkey: + diff --git a/server/start.sh b/server/start.sh new file mode 100755 index 0000000..38aad5c --- /dev/null +++ b/server/start.sh @@ -0,0 +1,26 @@ +#!/bin/sh + +config='config.yaml' +timeout=10 + +if [ -f $config ] +then + db=`grep -Eo "host:\s*\"(.+:[0-9]+)\"" $config | cut -d \" -f2` + echo "Database: $db" + + $(./wait.sh $db $timeout) + up=$? + echo "Database up=0? $up" + + if [ $up -eq 0 ] ; then + $(./grafeas-server --config $config) + else + echo "Database is down, exiting" 1>&2 + exit 1 + fi +else + echo "No config file is specified, exiting" 1>&2 + exit 1 +fi + +echo "Done" diff --git a/server/wait.sh b/server/wait.sh new file mode 100755 index 0000000..34b916d --- /dev/null +++ b/server/wait.sh @@ -0,0 +1,19 @@ +#!/bin/sh + +HOST=$(printf "%s\n" "$1"| cut -d : -f 1) +PORT=$(printf "%s\n" "$1"| cut -d : -f 2) +TIMEOUT="$2" + +if [ "$HOST" = "" ]; then exit 1; fi +if [ "$PORT" = "" ]; then exit 1; fi +if [ "$TIMEOUT" = "" ]; then exit 1; fi + +for i in `seq $TIMEOUT` ; do + nc -z "$HOST" "$PORT" + out=$? + if [ $out -eq 0 ]; then + exit 0 + fi + sleep 1 +done +exit 1