The OpenEO Engine building block provides early access to a unified processing platform for Earth observation data. It brings together two key components: openEO Geotrellis and openEO Aggregator. These components work together to offer a standards-based API for connecting to diverse EO cloud back-ends and to federate multiple openEO services into a cohesive processing platform.
-Note: Integration of the openEO Engine is still in early access. The steps provided here are work-in-progress and may evolve in future releases.
+Note: You must have a valid OIDC Provider to submit jobs to the OpenEO Engine. If you do not have one, refer to the IAM Deployment Guide to set up an OIDC Provider.
Clone the Deployment Guide Repository:
@@ -1998,7 +1947,7 @@bash configure-openeo-geotrellis.sh
+
During this process, you will be prompted for:
@@ -2039,19 +1988,11 @@ Step 3: Deploy openEO Geotre
Deploy ingress
-Step 4: Deploy openEO Aggregator using Helm⚓︎
-The openEO Aggregator federates multiple openEO back-ends into a unified processing platform.
-helm upgrade -i openeofed \
- https://artifactory.vgt.vito.be/artifactory/helm-charts/openeo-aggregator-2025.01.10-14.tgz \
- --namespace openeo-geotrellis \
- --create-namespace \
- --values openeo-aggregator/generated-values.yaml
-
Validation⚓︎
After deploying the OpenEO Engine components, perform the following checks to verify that the system is working as expected.
1. Automated Validation (Optional)⚓︎
-bash validation.sh
+
This script verifies that:
@@ -2061,57 +2002,92 @@ 1. Automated Validation (Optional)
2. Manual Validation⚓︎
To easily run these commands, we recommend first setting ${INGRESS_HOST} in your environment.
-source ~/.eoepca/state
+
Use the following commands to interact directly with the APIs:
Check API Metadata⚓︎
-curl -L https://openeo.${INGRESS_HOST}/openeo/1.2/ | jq .
+
Expected output: A JSON object containing api_version, backend_version, endpoints, etc.
List Collections⚓︎
-curl -L https://openeo.${INGRESS_HOST}/openeo/1.2/collections | jq .
+
Expected output: A JSON array listing available collections, such as the sample collection TestCollection-LonLat16x16.
List Processes⚓︎
-curl -L https://openeo.${INGRESS_HOST}/openeo/1.2/processes | jq .
+
Expected output: A JSON object with an array of processes. Use your terminal’s scroll or jq to inspect the output.
-Validate Aggregator Response⚓︎
-
-Expected output: A JSON response including federation details and links, confirming that the aggregator is aware of multiple back-ends.
3. Usage⚓︎
-If your deployment includes sample processes and supports job submissions, you can test job execution as follows:
-1. Submit a Job Using the “add” Process⚓︎
-Submit a job that adds 5 and 2.5 by sending a process graph to the /jobs endpoint:
-curl -X POST "https://openeofed.${INGRESS_HOST}/openeo/1.2/jobs" \
- -H "Content-Type: application/json" \
- -d '{
- "process_graph": {
- "sum": {
- "process_id": "add",
- "arguments": {
- "x": 5,
- "y": 2.5
- },
- "result": true
- }
- }
- }' | jq .
+Before running any jobs, you must obtain an access token from your OIDC Provider. Use the following command to get an access token if you followed our IAM Deployment Guide.
+Create a Keycloak Client⚓︎
+Use the create-client.sh script in the /scripts/utils/ directory. This script prompts you for basic details and automatically creates a Keycloak client in your chosen realm:
+
+When prompted:
+
+- Keycloak Admin Username and Password: Enter the credentials of your Keycloak admin user (these are also in
~/.eoepca/state if you have them set).
+- Keycloak base domain: e.g.
auth.example.com
+-
+
Realm: Typically eoepca.
+
+-
+
Client ID: Use demo-openeo-eoepca.
+
+- Client name and description: Provide any helpful text (e.g., “OpenEO Client”).
+- Client secret: Leave blank and let Keycloak generate one.
+- Subdomain: Use
openeo.
+- Additional Subdomains: Leave blank.
+
+After it completes, you should see a JSON snippet confirming the newly created client.
+Create a Keycloak User⚓︎
+If you have not already created a user, you can do so using the helper scripts or through the Keycloak UI. To create a user using the helper script, run
+
-The response should include a job_id (e.g., "job_id": "12345") along with other job details.
-2. Monitor the Job Status⚓︎
-Replace <JOB_ID> with the actual job ID from the previous step and run:
-curl -X GET "https://openeo.${INGRESS_HOST}/openeo/1.2/jobs/<JOB_ID>" | jq .
+Get an Accces Token⚓︎
+source ~/.eoepca/state
+
+ACCESS_TOKEN=$(
+ curl --silent --show-error \
+ -X POST \
+ -d "username=<YOUR-USERNAME>" \
+ --data-urlencode "password=<YOUR-PASSWORD>" \
+ -d "grant_type=password" \
+ -d "client_id=demo-openeo-eoepca" \
+ -d "client_secret=<CLIENT-SECRET>" \
+ -d "scope=openid profile email" \
+ "https://${KEYCLOAK_HOST}/realms/${REALM}/protocol/openid-connect/token" |
+ jq -r '.access_token'
+)
+
+AUTH_TOKEN="oidc/eoepca/${ACCESS_TOKEN}"
-Check that the job’s status changes from submitted to running and eventually to successful.
-3. Retrieve the Job Result⚓︎
-Once the job has completed, retrieve the output:
-curl -X GET "https://openeo.${INGRESS_HOST}/openeo/1.2/jobs/<JOB_ID>/results" | jq .
+Make sure that you replace the following values:
+- with your username
+- with your password
+- with your client secret
+We need to format the token as oidc/eoepca/${ACCESS_TOKEN} to comply with the oidc_providers variable seen in the Helm values.
+Submit a Job Using the “add” Process⚓︎
+Submit a job that adds 5 and 6.5 by sending a process graph to the /jobs endpoint:
+curl -X POST "https://openeo.${INGRESS_HOST}/openeo/1.2/result" \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer ${AUTH_TOKEN}" \
+ -d '{
+ "process": {
+ "process_graph": {
+ "arccos_node": {
+ "process_id": "sum",
+ "arguments": {
+ "data": [5,6.5]
+ },
+ "result": true
+ }
+ }
+ }
+ }'
Expected output:
A simple numeric result:
-7.5
+
This confirms that the “add” process is operational and returning the correct computed sum.
@@ -2120,7 +2096,6 @@ Further Reading & Official DocsopenEO Documentation
- openEO Geotrellis GitHub Repository
- openEO Aggregator Documentation
-- EOEPCA+ Documentation
diff --git a/current/sitemap.xml.gz b/current/sitemap.xml.gz
index 4dbe768..b7220c8 100644
Binary files a/current/sitemap.xml.gz and b/current/sitemap.xml.gz differ