From 5935a05282b5aeec287f50ca9254806f57b2a44a Mon Sep 17 00:00:00 2001 From: thomas loubrieu Date: Thu, 13 Apr 2023 13:31:22 -0700 Subject: [PATCH] refinement for v1.2.0, add provenance docker README --- .github/workflows/stable-cicd.yaml | 4 ++-- README.md | 2 +- model/swagger.yml | 2 +- support/provenance/README.md | 17 +++++++++++++++++ 4 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 support/provenance/README.md diff --git a/.github/workflows/stable-cicd.yaml b/.github/workflows/stable-cicd.yaml index f1d66265..4fd7d8f2 100644 --- a/.github/workflows/stable-cicd.yaml +++ b/.github/workflows/stable-cicd.yaml @@ -85,8 +85,8 @@ jobs: name: 🫙 Jar and Tag Determination id: jartag run: | - echo "jar_file=$(ls ./service/target/*.jar)" >> $GITHUB_OUTPUT - echo "image_tag=$(echo ${{github.ref}} | awk -F/ '{print $NF}')" >> $GITHUB_OUTPUT + echo "::set-output name=jar_file::$(ls ./service/target/*.jar)" + echo "::set-output name=image_tag::$(echo ${{github.ref}} | awk -F/ '{print $NF}')" - name: 💳 Docker Hub Identification uses: docker/login-action@v2 diff --git a/README.md b/README.md index be7cd72b..cac7aee4 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Follow instructions in README.txt in the decompressed folder To build and run the application you need: -- jdk 11 +- jdk 17 - maven Additionally, harvested data will only be picked up correctly by the API if all of the following are true: diff --git a/model/swagger.yml b/model/swagger.yml index 0ec4c347..6ab447e7 100644 --- a/model/swagger.yml +++ b/model/swagger.yml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: | Registry API enabling advanced search on PDS data and metadata. The API provides end-points to search for bundles, collections and any PDS products with advanced search queries. It also enables to browse the archive hierarchically downward (e.g. collection/s products) or upward (e.g. bundles containing a product). - version: 1.1.0 + version: 1.2.0 title: PDS Registry Search API termsOfService: 'http://pds.nasa.gov' contact: diff --git a/support/provenance/README.md b/support/provenance/README.md new file mode 100644 index 00000000..7566efd3 --- /dev/null +++ b/support/provenance/README.md @@ -0,0 +1,17 @@ + + +Build the docker image: + + docker build -t nasapds/registry-sweepers . + +Push it to docker hub (for integration tests): + + docker push nasapds/registry-sweepers + +Run it: + + docker run -e PROV_ENDPOINT='https://elasticsearch:9200/' -e PROV_CREDENTIALS='{"admin": "admin"}' nasapds/registry-sweepers + +With: +- PROV_ENDPOINT: the URL to the OpenSearch web server +- PROV_CREDENTIALS: the credentials for the OpenSearch connection as a JSO string, for example `{"username1": "secret_password"}`