You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-2Lines changed: 37 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,9 @@ python setup.py develop
9
9
```
10
10
11
11
# Usage
12
-
Use the [stac-updater CLI](stac_updater/cli.py) to build and deploy your service. Updating a static collection, for example, is accomplished as follows:
12
+
Use the [stac-updater CLI](stac_updater/cli.py) to build and deploy your service.
Once deployed, any STAC Item uploaded to the `stac-updater-kickoff` bucket will be ingested by the service and added to the `https://stac.com/landsat-8-l1/catalog.json` collection.
29
+
Once deployed, any STAC Item uploaded to the `stac-updater-kickoff` bucket will be ingested by the service and added to the `https://stac.com/landsat-8-l1/catalog.json` collection. Regardless of event source, the service expects the following JSON payload:
30
+
31
+
| Field Name | Type | Description | Example |
32
+
| ---------- | ----- | ----------- | ------- |
33
+
| stac_item | dict |**REQUIRED.**[STAC Item](https://github.com/radiantearth/stac-spec/tree/master/item-spec) to ingest into collection. |[link](https://github.com/radiantearth/stac-spec/blob/dev/item-spec/examples/sample-full.json)|
34
+
| path | str | String pattern indicating subcatalogs. Used by [sat-stac](https://github.com/sat-utils/sat-stac/blob/master/tutorial-1.ipynb#Views) to automatically build sub catalogs from item properties. | '${landsat:path}/${landsat:row}' |
35
+
| filename | str | String pattern indicating filename. Used by [sat-stac](https://github.com/sat-utils/sat-stac/blob/master/tutorial-1.ipynb#Views) to automatically build item filename from item properties.| '${date}/${id}' |
36
+
37
+
Each call to `update-collection` tells the services to update a single collection. Updating multiple collections within a single deployment is accomplished with multiple calls to `update-collection`. When updating multiple collections, the services uses a SNS fanout pattern to distribute messages across multiple queues (1 queue per collection).
38
+
39
+

40
+
41
+
## SNS Notifications
42
+
You may additionally deploy a SNS topic which publishes messages whenever a STAC Item is succesfully uploaded to a collection.
Once deployed, end-users may subscribe to the newly created SNS topic to be notified when new items are added. The SNS Topic supports filtering on bbox and collection through a SNS Filter Policy. The following policy notifies a subscriber only when a new STAC Item is added to the `landsat-8-l1` catalog within a 1x1 degree bounding box.
50
+
51
+
```json
52
+
{
53
+
"bbox.xmin": [{"numeric":[">=",-118]}],
54
+
"bbox.ymin": [{"numeric":[">=",33]}],
55
+
"bbox.xmax": [{"numeric":["<=",-117]}],
56
+
"bbox.ymax": [{"numeric":["<=",34]}],
57
+
"collection": ["landsat-8-l1"]
58
+
}
59
+
```
60
+
61
+
# TODOS
62
+
- Add support for dynamic catalogs ([sat-api](https://github.com/sat-utils/sat-api), [staccato](https://github.com/boundlessgeo/staccato)).
0 commit comments