cosmotech-acceleration-library 1.0.0__py3-none-any.whl

cosmotech/csm_data/main.py

@@ -0,0 +1,57 @@
+# Copyright (C) - 2023 - 2025 - Cosmo Tech
+# This document and all information contained herein is the exclusive property -
+# including all intellectual property rights pertaining thereto - of Cosmo Tech.
+# Any use, reproduction, translation, broadcasting, transmission, distribution,
+# etc., to any person is prohibited unless it has been previously and
+# specifically authorized by written means by Cosmo Tech.
+import click_log
+
+from cosmotech.coal import __version__
+from cosmotech.csm_data.commands.adx_send_runnerdata import adx_send_runnerdata
+from cosmotech.csm_data.commands.api.api import api
+from cosmotech.csm_data.commands.az_storage_upload import az_storage_upload
+from cosmotech.csm_data.commands.s3_bucket_download import s3_bucket_download
+from cosmotech.csm_data.commands.s3_bucket_upload import s3_bucket_upload
+from cosmotech.csm_data.commands.s3_bucket_delete import s3_bucket_delete
+from cosmotech.csm_data.commands.adx_send_data import adx_send_data
+from cosmotech.csm_data.commands.store.store import store
+from cosmotech.csm_data.utils.click import click
+from cosmotech.csm_data.utils.decorators import translate_help, web_help
+from cosmotech.coal.utils.logger import LOGGER
+from cosmotech.orchestrator.utils.translate import T
+
+
+def print_version(ctx, param, value):
+    if not value or ctx.resilient_parsing:
+        return
+    click.echo(f"Cosmo Tech Data Interface {__version__}")
+    ctx.exit()
+
+
+@click.group("csm-data")
+@click_log.simple_verbosity_option(LOGGER, "--log-level", envvar="LOG_LEVEL", show_envvar=True)
+@click.option(
+    "--version",
+    is_flag=True,
+    callback=print_version,
+    expose_value=False,
+    is_eager=True,
+    help="Print version number and return.",
+)
+@web_help("csm-data")
+@translate_help("csm-data.commands.main.description")
+def main():
+    pass
+
+
+main.add_command(api, "api")
+main.add_command(store, "store")
+main.add_command(s3_bucket_download, "s3-bucket-download")
+main.add_command(s3_bucket_upload, "s3-bucket-upload")
+main.add_command(s3_bucket_delete, "s3-bucket-delete")
+main.add_command(adx_send_runnerdata, "adx-send-runnerdata")
+main.add_command(az_storage_upload, "az-storage-upload")
+main.add_command(adx_send_data, "adx-send-data")
+
+if __name__ == "__main__":
+    main()

cosmotech/csm_data/utils/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (C) - 2023 - 2025 - Cosmo Tech
+# This document and all information contained herein is the exclusive property -
+# including all intellectual property rights pertaining thereto - of Cosmo Tech.
+# Any use, reproduction, translation, broadcasting, transmission, distribution,
+# etc., to any person is prohibited unless it has been previously and
+# specifically authorized by written means by Cosmo Tech.

cosmotech/csm_data/utils/click.py

@@ -0,0 +1,18 @@
+# Copyright (C) - 2023 - 2025 - Cosmo Tech
+# This document and all information contained herein is the exclusive property -
+# including all intellectual property rights pertaining thereto - of Cosmo Tech.
+# Any use, reproduction, translation, broadcasting, transmission, distribution,
+# etc., to any person is prohibited unless it has been previously and
+# specifically authorized by written means by Cosmo Tech.
+
+import rich_click as click
+
+click.rich_click.USE_MARKDOWN = True
+click.rich_click.USE_RICH_MARKUP = True
+click.rich_click.SHOW_ARGUMENTS = True
+click.rich_click.GROUP_ARGUMENTS_OPTIONS = False
+click.rich_click.STYLE_OPTION_ENVVAR = "yellow"
+click.rich_click.ENVVAR_STRING = "ENV: {}"
+click.rich_click.STYLE_OPTION_DEFAULT = "dim yellow"
+click.rich_click.DEFAULT_STRING = "DEFAULT: {}"
+click.rich_click.OPTIONS_PANEL_TITLE = "OPTIONS"

cosmotech/csm_data/utils/decorators.py

@@ -0,0 +1,75 @@
+# Copyright (C) - 2023 - 2025 - Cosmo Tech
+# This document and all information contained herein is the exclusive property -
+# including all intellectual property rights pertaining thereto - of Cosmo Tech.
+# Any use, reproduction, translation, broadcasting, transmission, distribution,
+# etc., to any person is prohibited unless it has been previously and
+# specifically authorized by written means by Cosmo Tech.
+
+import os
+import webbrowser
+from functools import wraps
+
+from cosmotech.coal.utils import WEB_DOCUMENTATION_ROOT
+from cosmotech.csm_data.utils.click import click
+from cosmotech.coal.utils.logger import LOGGER
+from cosmotech.orchestrator.utils.translate import T
+
+
+def translate_help(translation_key):
+    """Decorator that sets the function's __doc__ to the translated help text."""
+
+    def wrap_function(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return func(*args, **kwargs)
+
+        wrapper.__doc__ = T(translation_key)
+        return wrapper
+
+    return wrap_function
+
+
+def require_env(envvar, envvar_desc):
+    def wrap_function(func):
+        @wraps(func)
+        def f(*args, **kwargs):
+            if envvar not in os.environ:
+                raise EnvironmentError(T("coal.errors.environment.missing_var").format(envvar=envvar))
+            return func(*args, **kwargs)
+
+        f.__doc__ = "\n".join([f.__doc__ or "", f"Requires env var `{envvar:<15}` *{envvar_desc}*  "])
+        return f
+
+    return wrap_function
+
+
+def web_help(effective_target="", base_url=WEB_DOCUMENTATION_ROOT):
+    documentation_url = base_url + effective_target
+
+    def open_documentation(ctx: click.Context, param, value):
+        if value:
+            if not webbrowser.open(documentation_url):
+                LOGGER.warning(T("coal.web.failed_open").format(url=documentation_url))
+            else:
+                LOGGER.info(T("coal.web.opened").format(url=documentation_url))
+            ctx.exit(0)
+
+    def wrap_function(func):
+        @wraps(func)
+        @click.option(
+            "--web-help",
+            is_flag=True,
+            help="Open the web documentation",
+            is_eager=True,
+            callback=open_documentation,
+        )
+        def f(*args, **kwargs):
+            if kwargs.get("web_help"):
+                return
+            if "web_help" in kwargs:
+                del kwargs["web_help"]
+            return func(*args, **kwargs)
+
+        return f
+
+    return wrap_function

cosmotech/orchestrator_plugins/csm-data/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (C) - 2023 - 2025 - Cosmo Tech
+# This document and all information contained herein is the exclusive property -
+# including all intellectual property rights pertaining thereto - of Cosmo Tech.
+# Any use, reproduction, translation, broadcasting, transmission, distribution,
+# etc., to any person is prohibited unless it has been previously and
+# specifically authorized by written means by Cosmo Tech.
+from cosmotech.orchestrator.templates.plugin import Plugin
+
+plugin = Plugin(__file__)
+
+__all__ = [plugin]

cosmotech/orchestrator_plugins/csm-data/templates/api/postgres_send_runner_metadata.json

@@ -0,0 +1,40 @@
+{
+  "id": "csm-data postgres-send-runner-metadata",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "postgres-send-runner-metadata"
+  ],
+  "description": "Use csm-data to send runner metadata to a PostgreSQL database",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    },
+    "POSTGRES_HOST_URI": {
+      "description": "PostgreSQL host URI"
+    },
+    "POSTGRES_HOST_PORT": {
+      "description": "PostgreSQL host port",
+      "defaultValue": "5432"
+    },
+    "POSTGRES_DB_NAME": {
+      "description": "PostgreSQL database name"
+    },
+    "POSTGRES_DB_SCHEMA": {
+      "description": "PostgreSQL database schema"
+    },
+    "POSTGRES_USER_NAME": {
+      "description": "PostgreSQL user name"
+    },
+    "POSTGRES_USER_PASSWORD": {
+      "description": "PostgreSQL user password"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_load_csv.json

@@ -0,0 +1,27 @@
+{
+  "id": "csm-data rds-load-csv",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "rds-load-csv"
+  ],
+  "description": "Use csm-data to query the results api and store it in a csv file, you need to add your arguments for filename and query while using this template",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the resulting CSV file"
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    },
+    "CSM_RUN_ID": {
+      "description": "A run id for the Cosmo Tech API"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_send_csv.json

@@ -0,0 +1,27 @@
+{
+  "id": "csm-data rds-send-csv",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "rds-send-csv"
+  ],
+  "description": "Use csm-data to send the content of all csv of a folder to the Cosmo Tech API as custom results data",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to find CSV files to send to the Cosmo Tech API"
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    },
+    "CSM_RUN_ID": {
+      "description": "A run id for the Cosmo Tech API"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_send_store.json

@@ -0,0 +1,27 @@
+{
+  "id": "csm-data rds-send-store",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "rds-send-store"
+  ],
+  "description": "Use csm-data to send the content of a store to the Cosmo Tech API as custom results data",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_PARAMETERS_ABSOLUTE_PATH": {
+      "description": "Folder containing the store to send to the Cosmo Tech API"
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    },
+    "CSM_RUN_ID": {
+      "description": "A run id for the Cosmo Tech API"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/run_load_data.json

@@ -0,0 +1,30 @@
+{
+  "id": "csm-data run-load-data",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "run-load-data"
+  ],
+  "description": "Use csm-data to download runner data from the Cosmo Tech API",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    },
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the dataset from the Cosmo Tech API"
+    },
+    "CSM_PARAMETERS_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the parameters from the Cosmo Tech API"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/runtemplate_load_handler.json

@@ -0,0 +1,27 @@
+{
+  "id": "csm-data runtemplate-load-handler",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "runtemplate-load-handler"
+  ],
+  "description": "Use csm-data to load run template handlers from the Cosmo Tech API",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUN_TEMPLATE_ID": {
+      "description": "A run template id for the Cosmo Tech API"
+    },
+    "CSM_CONTAINER_MODE": {
+      "description": "Comma-separated list of handlers to load"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/tdl_load_files.json

@@ -0,0 +1,32 @@
+{
+  "id": "csm-data tdl-load-files",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "tdl-load-files"
+  ],
+  "description": "Use csm-data to query a twingraph and loads all the data from it",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the resulting CSV files"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_SCENARIO_ID": {
+      "description": "A scenario id for the Cosmo Tech API",
+      "optional": true
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API",
+      "optional": true
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/tdl_send_files.json

@@ -0,0 +1,27 @@
+{
+  "id": "csm-data tdl-send-files",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "tdl-send-files"
+  ],
+  "description": "Use csm-data to send a folder content to the Cosmo Tech API as a Twin Graph",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Folder containing the files to send to the API"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "A runner id for the Cosmo Tech API"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/try_api_connection.json

@@ -0,0 +1,9 @@
+{
+  "id": "csm-data try-api-connection",
+  "command": "csm-data",
+  "arguments": [
+    "api"
+  ],
+  "description": "Use csm-data check if a valid Cosmo Tech API connection exists.",
+  "useSystemEnvironment": true
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/wsf_load_file.json

@@ -0,0 +1,36 @@
+{
+  "id": "csm-data wsf-load-file",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "wsf-load-file"
+  ],
+  "description": "Use csm-data to load files from a workspace inside the API",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the file from the Cosmo Tech API"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    },
+    "CSM_API_KEY": {
+      "description": "An API key defined during the setup of the API instance granting access to the Run/data/send endpoint",
+      "optional": true
+    },
+    "CSM_API_KEY_HEADER": {
+      "description": "The header key required to use the API key previously defined",
+      "defaultValue": "X-CSM-API-KEY",
+      "optional": true
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_PATH": {
+      "description": "Path inside the workspace to load (end with '/' for a folder)"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/api/wsf_send_file.json

@@ -0,0 +1,36 @@
+{
+  "id": "csm-data wsf-send-file",
+  "command": "csm-data",
+  "arguments": [
+    "api",
+    "wsf-send-file"
+  ],
+  "description": "Use csm-data to send a file to a workspace inside the API",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_FILE_PATH": {
+      "description": "Path to the file to send as a workspace file"
+    },
+    "CSM_API_URL": {
+      "description": "The URL to a Cosmo Tech API instance"
+    },
+    "CSM_API_KEY": {
+      "description": "An API key defined during the setup of the API instance granting access to the Run/data/send endpoint",
+      "optional": true
+    },
+    "CSM_API_KEY_HEADER": {
+      "description": "The header key required to use the API key previously defined",
+      "defaultValue": "X-CSM-API-KEY",
+      "optional": true
+    },
+    "CSM_ORGANIZATION_ID": {
+      "description": "An organization id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_ID": {
+      "description": "A workspace id for the Cosmo Tech API"
+    },
+    "CSM_WORKSPACE_PATH": {
+      "description": "Path inside the workspace to store the file (end with '/' for a folder))"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/main/adx_send_runnerdata.json

@@ -0,0 +1,29 @@
+{
+  "id": "csm-data adx-send-runnerdata",
+  "command": "csm-data",
+  "arguments": [
+    "adx-send-runnerdata"
+  ],
+  "description": "Use csm-data to send runner data to Azure Data Explorer. Requires a valid Azure Data Explorer configuration, here using environment variables.",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder containing dataset files to send to ADX"
+    },
+    "CSM_PARAMETERS_ABSOLUTE_PATH": {
+      "description": "Folder containing parameter files to send to ADX"
+    },
+    "CSM_RUNNER_ID": {
+      "description": "Unique identifier for the runner"
+    },
+    "AZURE_DATA_EXPLORER_RESOURCE_URI": {
+      "description": "URI required to connect to Azure Data Explorer"
+    },
+    "AZURE_DATA_EXPLORER_RESOURCE_INGEST_URI": {
+      "description": "Ingestion URI for Azure Data Explorer"
+    },
+    "AZURE_DATA_EXPLORER_DATABASE_NAME": {
+      "description": "Name of the database in Azure Data Explorer"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/main/az_storage_upload.json

@@ -0,0 +1,25 @@
+{
+  "id": "csm-data az-storage-upload",
+  "command": "csm-data",
+  "arguments": [
+    "az-storage-upload"
+  ],
+  "description": "Use csm-data to upload files from a folder to Azure Blob Storage. Requires a valid Azure Storage configuration, here using environment variables.",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Source folder containing files to upload to Azure Blob Storage"
+    },
+    "AZURE_STORAGE_BLOB_NAME": {
+      "description": "Name of the blob container in Azure Storage"
+    },
+    "CSM_DATA_BLOB_PREFIX": {
+      "description": "Prefix to add to uploaded files",
+      "optional": true,
+      "defaultValue": ""
+    },
+    "AZURE_STORAGE_SAS_URL": {
+      "description": "SAS URL for Azure Storage access"
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/main/s3_bucket_delete.json

@@ -0,0 +1,31 @@
+{
+  "id": "csm-data s3-bucket-delete",
+  "command": "csm-data",
+  "arguments": [
+    "s3-bucket-delete"
+  ],
+  "description": "Use csm-data to delete objects from an S3 bucket with an optional prefix filter. Requires a valid S3 configuration, here using environment variables.",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATA_BUCKET_NAME": {
+      "description": "Name of the bucket in the S3 instance to delete from"
+    },
+    "CSM_DATA_BUCKET_PREFIX": {
+      "description": "Prefix to filter objects to delete",
+      "optional": true
+    },
+    "AWS_ENDPOINT_URL": {
+      "description": "URI required to connect to a given S3 instance"
+    },
+    "AWS_ACCESS_KEY_ID": {
+      "description": "User access key required to authenticate to the S3 instance"
+    },
+    "AWS_SECRET_ACCESS_KEY": {
+      "description": "User secret required to authenticate to the S3 instance"
+    },
+    "CSM_S3_CA_BUNDLE": {
+      "description": "Path to SSL certificate bundle",
+      "optional": true
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/main/s3_bucket_download.json

@@ -0,0 +1,34 @@
+{
+  "id": "csm-data s3-bucket-download",
+  "command": "csm-data",
+  "arguments": [
+    "s3-bucket-download"
+  ],
+  "description": "Use csm-data to connect to an S3 bucket and download its content. Requires a valid S3 configuration, here using environment variables.",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Target folder in which to write the content of the S3 Bucket"
+    },
+    "CSM_DATA_BUCKET_NAME": {
+      "description": "Name of the bucket in the S3 instance to download"
+    },
+    "CSM_DATA_BUCKET_PREFIX": {
+      "description": "Prefix to filter objects to download",
+      "optional": true
+    },
+    "AWS_ENDPOINT_URL": {
+      "description": "URI required to connect to a given S3 instance"
+    },
+    "AWS_ACCESS_KEY_ID": {
+      "description": "User access key required to authenticate to the S3 instance"
+    },
+    "AWS_SECRET_ACCESS_KEY": {
+      "description": "User secret required to authenticate to the S3 instance"
+    },
+    "CSM_S3_CA_BUNDLE": {
+      "description": "Path to SSL certificate bundle",
+      "optional": true
+    }
+  }
+}

cosmotech/orchestrator_plugins/csm-data/templates/main/s3_bucket_upload.json

@@ -0,0 +1,35 @@
+{
+  "id": "csm-data s3-bucket-upload",
+  "command": "csm-data",
+  "arguments": [
+    "s3-bucket-upload"
+  ],
+  "description": "Use csm-data to upload files from a folder to an S3 bucket. Requires a valid S3 configuration, here using environment variables.",
+  "useSystemEnvironment": true,
+  "environment": {
+    "CSM_DATASET_ABSOLUTE_PATH": {
+      "description": "Source folder containing files to upload to S3"
+    },
+    "CSM_DATA_BUCKET_NAME": {
+      "description": "Name of the bucket in the S3 instance to upload to"
+    },
+    "CSM_DATA_BUCKET_PREFIX": {
+      "description": "Prefix to add to uploaded files",
+      "optional": true,
+      "defaultValue": ""
+    },
+    "AWS_ENDPOINT_URL": {
+      "description": "URI required to connect to a given S3 instance"
+    },
+    "AWS_ACCESS_KEY_ID": {
+      "description": "User access key required to authenticate to the S3 instance"
+    },
+    "AWS_SECRET_ACCESS_KEY": {
+      "description": "User secret required to authenticate to the S3 instance"
+    },
+    "CSM_S3_CA_BUNDLE": {
+      "description": "Path to SSL certificate bundle",
+      "optional": true
+    }
+  }
+}