EO Catalog, a eoAPI customization.
Documentation: https://eoapi.dev/customization/
Source Code: https://github.com/developmentseed/eoapi-devseed
This repository shows an example of how users can customize and deploy their own version of eoAPI starting from eoapi-template.
- Add a
TiTilerExtensionand a simpleSearch Viewer(eoAPI-devseed) - Freetext search (Not yet released - Requires a build of pgstac from main branch.)
- Authorization with Openid Connect
- Collection search
When the TITILER_ENDPOINT environment variable is set (pointing to the raster application) and titiler extension is enabled, additional endpoints will be added to the stac-fastapi application:
/collections/{collectionId}/items/{itemId}/tilejson.json: Return therastertilejson for an item/collections/{collectionId}/items/{itemId}/viewer: Redirect to therasterviewer
- Telemetry for performance measurement.
- Distributed caching.
- Timeout long lasting pending requests.
- Automatic compression of API responses in Brotli, GZIP and Deflate.
- Hide successful health pings from logs (from /_mgmt/ping)
The dynamic tiler deployed within eoapi-devseed is built on top of titiler-pgstac and pgstac. It enables large-scale mosaic based on the results of STAC search queries.
The service includes all the default endpoints from titiler-pgstac application and:
/: a custom landing page with links to the different endpoints/mosaic/builder: a virtual mosaic builder UI that helps create and register STAC Search queries/collections: a secret (not in OpenAPI documentation) endpoint used in the mosaic-builder page/collections/{collection_id}/items/{item_id}/viewer: a simple STAC Item viewer
OGC Features and Tiles API built on top of tipg.
The API will look for tables in the database's public schema by default. We've also added three functions that connect to the pgSTAC schema:
- pg_temp.pgstac_collections_view: Simple function which returns PgSTAC Collections
- pg_temp.pgstac_hash: Return features for a specific
searchId(hash) - pg_temp.pgstac_hash_count: Return the number of items per geometry for a specific
searchId(hash)
The A591 CDK code is almost similar to the one found in eoapi-template. We just added some configurations for our custom runtimes.
Before deploying the application on the cloud, you can start by exploring it with a local Docker deployment
docker compose up
Once the applications are up, you'll need to add STAC Collections and Items to the PgSTAC database. If you don't have, you can use the follow the MAXAR open data demo (or get inspired by the other demos).
Then you can start exploring your dataset with:
- the STAC Metadata service http://localhost:8081
- the Raster service http://localhost:8082
- the browser UI http://localhost:8085
If you've added a vector dataset to the public schema in the Postgres database, they will be available through the Vector service at http://localhost:8083.
Before getting started, make sure you retrieve all the external dependencies.
git submodule update --initdocker compose up -dThe repository contains deployment code for hosting this service on Kubernetes through running the published docker image and Helm chart.
The Helm chart only support the STAC API at the moment.
- python >=3.9
- docker
- node >=14
- AWS credentials environment variables configured to point to an account.
- Optional a
config.yamlfile to override the default deployment settings defined inconfig.py.
Install python dependencies with
python -m venv .venv
source .venv/bin/activate
python -m pip install -r requirements.txt
And node dependencies with
npm install
Verify that the cdk CLI is available. Since aws-cdk is installed as a local dependency, you can use the npx node package runner tool, that comes with npm.
npx cdk --version
First, synthesize the app
npx cdk synth --all
Then, deploy
npx cdk deploy --all --require-approval never
EO Catalog is licensed by CS GROUP under the Apache License, version 2.0. A copy of this license is provided in the LICENSE file.