MRG: Merge pull request #676 from octue/make-signing-output-datasets-…

…optional Make signed URLs for output datasets optional
octue · Aug 15, 2024 · fa2cfdf · fa2cfdf
2 parents e116143 + 42940d1
commit fa2cfdf
Show file tree

Hide file tree

Showing 20 changed files with 361 additions and 168 deletions.
diff --git a/docs/source/creating_apps.rst b/docs/source/creating_apps.rst
@@ -157,4 +157,6 @@ When the analysis has finished, it is automatically finalised. This means:
 
     You can manually call :mod:`analysis.finalise <octue.resources.analysis.Analysis.finalise>` if you want to upload
     any output datasets to a different location to the one specified in the app configuration. If you do this, the
-    analysis will not be finalised again - make sure you only call it when your output data is ready.
+    analysis will not be finalised again - make sure you only call it when your output data is ready. Note that the
+    ``output_location`` and ``use_signed_urls_for_output_datasets`` settings in the app configuration are ignored if you
+    call it manually.
diff --git a/docs/source/creating_services.rst b/docs/source/creating_services.rst
@@ -79,6 +79,7 @@ App configuration file (optional)
         - ``configuration_manifest``
         - ``children``
         - ``output_location``
+        - ``use_signed_urls_for_output_datasets``
 
         If an app configuration file is provided, its path must be specified in ``octue.yaml`` under the
         "app_configuration_path" key.

diff --git a/docs/source/inter_service_compatibility.rst b/docs/source/inter_service_compatibility.rst
diff --git a/octue/configuration.py b/octue/configuration.py
@@ -109,6 +109,7 @@ class AppConfiguration:
     :param str|dict|octue.resources.Manifest|None configuration_manifest: a manifest of datasets to configure the app
     :param str|list(dict)|None children: details of the children the app requires
     :param str|None output_location: the path to a cloud directory to save output datasets at
+    :param bool use_signed_urls_for_output_datasets: if `True`, use signed URLs instead of cloud URIs for dataset paths in the output manifest
     :return None:
     """
 
@@ -118,12 +119,14 @@ def __init__(
         configuration_manifest=None,
         children=None,
         output_location=None,
+        use_signed_urls_for_output_datasets=True,
         **kwargs,
     ):
         self.configuration_values = configuration_values
         self.configuration_manifest = configuration_manifest
         self.children = children
         self.output_location = output_location
+        self.use_signed_urls_for_output_datasets = use_signed_urls_for_output_datasets
 
         if kwargs:
             logger.warning(f"The following keyword arguments were not used by {type(self).__name__}: {kwargs!r}.")