Gh-364: Add Proxy Store example (#365)

* Add proxy store example

* Use modern name convention for compose file

* Add details of proxy example to README

docker/gaffer-rest/README.md

@@ -46,3 +46,23 @@ at runtime.
 * Gaffer REST
 
 Access the Gaffer REST API at: http://localhost:8080/rest/
+
+# Proxy Example
+
+A demo/example of using Gaffer REST with a Proxy Store is available under the `proxy-example` directory.
+
+## Running
+To run it from the `proxy-example` directory you'll need to specify the environment file path:
+
+```bash
+docker compose --env-file ../.env up
+```
+
+Or to run it from this directory, the compose file path and environment file path:
+
+```bash
+docker compose -f proxy-example/compose.yaml --env-file .env up
+```
+
+With this deployment both a standard Gaffer REST API and a Gaffer REST API using the Proxy Store will be started.
+Only the port for the Proxy REST endpoint is exposed, this will forward operations to the standard Gaffer REST Endpoint.

docker/gaffer-rest/proxy-example/compose.yaml

@@ -0,0 +1,34 @@
+# Copyright 2024 Crown Copyright
+#
+# 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.
+
+services:
+
+  gaffer-rest:
+    image: gchq/gaffer-rest:${GAFFER_VERSION}-accumulo-${ACCUMULO_VERSION}
+    healthcheck:
+      test: sleep 15
+      timeout: 20s
+    restart: always
+
+  gaffer-rest-proxy:
+    image: gchq/gaffer-rest:${GAFFER_VERSION}-accumulo-${ACCUMULO_VERSION}
+    depends_on:
+      gaffer-rest:
+        condition: service_healthy
+    restart: always
+    ports:
+    - 8080:8080
+    volumes:
+    - ./config/store.properties:/gaffer/store/store.properties:ro
+    - ./config/operationsDeclarations.json:/gaffer/store/operationsDeclarations.json:ro

docker/gaffer-rest/proxy-example/config/operationsDeclarations.json

@@ -0,0 +1,16 @@
+{
+    "operations": [
+        {
+            "operation": "uk.gov.gchq.gaffer.proxystore.operation.GetProxyUrl",
+            "handler": {
+                "class": "uk.gov.gchq.gaffer.proxystore.operation.handler.GetProxyUrlHandler"
+            }
+        },
+        {
+            "operation": "uk.gov.gchq.gaffer.proxystore.operation.GetProxyProperties",
+            "handler": {
+                "class": "uk.gov.gchq.gaffer.proxystore.operation.handler.GetProxyPropertiesHandler"
+            }
+        }
+    ]
+}

docker/gaffer-rest/proxy-example/config/store.properties

@@ -0,0 +1,21 @@
+# Copyright 2024 Crown Copyright
+#
+# 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.
+gaffer.store.properties.class=uk.gov.gchq.gaffer.proxystore.ProxyProperties
+gaffer.store.class=uk.gov.gchq.gaffer.proxystore.ProxyStore
+gaffer.store.operation.declarations=/gaffer/store/operationsDeclarations.json
+
+# Proxy config
+gaffer.host=gaffer-rest
+gaffer.port=8080
+gaffer.context-root=/rest