Skip to content

Commit 92d53e3

Browse files
committed
doc: improve docs
1 parent a671016 commit 92d53e3

File tree

3 files changed

+28
-272
lines changed

3 files changed

+28
-272
lines changed

README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,7 @@ Make sure you have an `HARBOR_USERNAME` and `HARBOR_PASSWORD` for OVH container
5959

6060
### Setup port forwarding for webhook access
6161

62-
To submit workflows via the HTTP webhook endpoint, set up port forwarding:
63-
64-
```bash
65-
kubectl port-forward -n devseed-staging svc/eopf-explorer-webhook-eventsource-svc 12000:12000 &
66-
```
67-
68-
This makes the webhook endpoint available at `http://localhost:12000/samples`.
62+
See [operator-tools/README.md](operator-tools/README.md#port-forwarding) for webhook port forwarding setup.
6963

7064
### For development
7165

@@ -109,25 +103,13 @@ docker push w9mllyot.c1.de1.container-registry.ovh.net/eopf-sentinel-zarr-explor
109103

110104
## Submit Workflow
111105

112-
### Method 1: HTTP Webhook (Production - Event-Driven)
113-
114-
Submit STAC items via the HTTP webhook endpoint.
115-
116-
**Using the interactive notebook (recommended):**
117-
118-
```bash
119-
cd operator-tools
120-
jupyter notebook submit_stac_items_notebook.ipynb
121-
```
122-
123-
**Using the Python script for single items:**
124-
125-
```bash
126-
cd operator-tools
127-
python submit_test_workflow_wh.py
128-
```
106+
### Method 1: HTTP Webhook (Recommended)
129107

130-
See [operator-tools/README.md](operator-tools/README.md) for detailed usage instructions.
108+
Use the operator tools to submit STAC items via HTTP webhook. See [operator-tools/README.md](operator-tools/README.md) for:
109+
- Interactive notebook for batch submissions
110+
- Python script for single item testing
111+
- Port forwarding setup
112+
- Common actions and target collections
131113

132114
### Method 2: kubectl (Testing - Direct Workflow Submission)
133115

@@ -250,7 +232,7 @@ kubectl get wf -n devseed-staging --field-selector status.phase=Running
250232
| Problem | Solution |
251233
|---------|----------|
252234
| **"No group found in store"** | Using direct zarr URL instead of STAC item URL |
253-
| **"Webhook not responding"** | Verify port-forward is active: `ps aux \| grep "port-forward.*12000"` |
235+
| **"Webhook not responding"** | See [operator-tools troubleshooting](operator-tools/README.md#troubleshooting) |
254236
| **Workflow not starting** | Check webhook submission returned success, verify port-forward |
255237
| **S3 access denied** | Contact infrastructure team to verify S3 credentials |
256238
| **Workflow stuck/failed** | Check workflow logs: `kubectl logs -n devseed-staging -l workflows.argoproj.io/workflow=<name>` |

operator-tools/README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Submits a single test STAC item via HTTP webhook endpoint.
5151
**Usage:**
5252

5353
```bash
54-
python submit_test_workflow_wh.py
54+
uv run submit_test_workflow_wh.py
5555
```
5656

5757
**Configuration:**
@@ -60,7 +60,7 @@ Edit the script to change:
6060

6161
- `source_url`: STAC item URL to process
6262
- `collection`: Target collection name
63-
- `action`: Processing action (e.g., `convert-v1-s2-hp`)
63+
- `action`: Processing action (e.g., `convert-v1-s2-hp`, or `convert-v1-s2-hp`)
6464

6565
### 2. `submit_stac_items_notebook.ipynb` - Interactive STAC Search & Submit
6666

@@ -78,7 +78,7 @@ Jupyter notebook for searching and batch submitting STAC items.
7878
**Usage:**
7979

8080
```bash
81-
jupyter notebook submit_stac_items_notebook.ipynb
81+
uv run jupyter notebook submit_stac_items_notebook.ipynb
8282
```
8383

8484
**Features:**
@@ -98,22 +98,14 @@ Common target collections for processing:
9898

9999
## Payload Format
100100

101-
All tools submit payloads in this format:
101+
All tools submit payloads with these fields:
102102

103-
```json
104-
{
105-
"source_url": "https://stac.core.eopf.eodc.eu/collections/sentinel-2-l2a/items/ITEM_ID",
106-
"collection": "target-collection-name",
107-
"action": "convert-v1-s2"
108-
}
109-
```
110-
111-
**Fields:**
112-
113-
- `source_url`: Full STAC item URL (self link)
103+
- `source_url`: Full STAC item URL (self link) - Must be a STAC API URL, not direct zarr
114104
- `collection`: Target collection for processed data
115105
- `action`: (Optional) Processing action/trigger to use
116106

107+
See [main README payload examples](../README.md#payload-format) for correct/incorrect formats.
108+
117109
## Common Actions
118110

119111
- `convert-v1-s2` - Standard Sentinel-2 conversion

0 commit comments

Comments
 (0)