Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ sections:
- file: applications/publishing_dashboard.md
- file: applications/narrative_editor
- file: applications/argo
sections:
- file: applications/capability_integration
- file: applications/headless_execution
- file: applications/secret_manager
- file: applications/eoapi
Expand Down
4 changes: 4 additions & 0 deletions applications/argo.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ Argo Workflows details of a finished workflow with details of a step

Sample templates will become available in the tutorial section once possible

## Capability requirements for integration

Docker image/capability requirements for integration are described on the [**separate page**](capability_integration.md)

## Argo workflow steps

Each workflow includes usually following types of steps:
Expand Down
63 changes: 63 additions & 0 deletions applications/capability_integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Integration Requirements for Argo Workflows on EOxHub

This document outlines the minimum requirements for integrating a new process into the Argo Workflow system on EOxHub. This includes input definitions, expected Docker image standards, and output formats.

## Input Requirements

If your service should be integrated into the eodash processing widget docker input fields must correspond to our supported options. Beside this we expect to get information regarding:

- Description of expected input data - does the service expect data already present or data are downloaded as part of the dockerized algorithm?
- Description of expected argument and parameters
- Description of expected output - see Output requirements section


### Arguments and parameters

eodash processing widget support multiple ways how to pass input.
- Area/location - process can take as input drawn point or polygon from the eodash user interface. For this integration, input field must accept eather coorinates directly or geoJSON as a string. File input is not accepted.
- Date - standard date formats are supported. eodash also supports start and end time to create range.
- Numeric fields - integer or float values
- Text fields
- Dropdowns with limited options


All fields can have default value


## Docker Image Requirements

Your process must be encapsulated in a Docker image without the strict limitations. It is helpful if the image is "slim" - only with required dependencies installed.

We expect to know resource usage estimation - RAM consumption and CPU estimates.



## Output Requirements

The workflow should store its results in `/output` folder, which will be collected automatically by our processes.

Expected outputs:
- Results (e.g., COG, geoJSON, CSV)
- Inputs are expected to be cloud-native so for raster output formats, COGs are expected, for vector data geoJSON for small files up to 5Mb or flatGeobuf
- Logs (optional but encouraged)


Outputs must be:
- Written with unique filenames if multiple files are generated.
- Validated (e.g., for COG format or JSON schema compliance).



## Sample Checklist

To submit your process for integration, make sure these information are included:
- [ ] Dockerfile included and builds correctly
- [ ] README with usage instructions and input/output description
- [ ] Sample call example
- [ ] License file / link to repository (not mandatory)
- [ ] Sample input/output for testing
- [ ] Visualisation expectations

---

Please contact the EOxHub team or submit a ticket if youneed more information.