|
1 |
| -# eoAPI CDK Constructs |
2 |
| - |
3 |
| -eoapi-cdk is a package of [AWS CDK constructs](https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/constructs-best-practices.html) designed to encapsulate eoAPI services and best practices as simple reusable components. |
4 |
| - |
5 |
| - |
6 |
| -For more background on the included services see [The Earth Observation API](https://eoapi.dev/) |
7 |
| - |
8 |
| -## Included constructs |
9 |
| -Detailed API docs for the constructs can be found [here](https://developmentseed.org/eoapi-cdk/). |
10 |
| - |
11 |
| -### [pgSTAC Database](https://developmentseed.org/eoapi-cdk/#pgstacdatabase-) |
12 |
| -An [RDS](https://aws.amazon.com/rds/) instance with [pgSTAC](https://github.com/stac-utils/pgstac) installed and the Postgres parameters optimized for the selected instance type. |
13 |
| - |
14 |
| -### [STAC API](https://developmentseed.org/eoapi-cdk/#pgstacapilambda-) |
15 |
| -A STAC API implementation using [stac-fastapi](https://github.com/stac-utils/stac-fastapi) with a [pgSTAC backend](https://github.com/stac-utils/stac-fastapi-pgstac). Packaged as a complete runtime for deployment with API Gateway and Lambda. |
16 |
| - |
17 |
| -### [pgSTAC Titiler API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-) |
18 |
| -A complete dynamic tiling API using [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) to create dynamic mosaics of assets based on [STAC Search queries](https://github.com/radiantearth/stac-api-spec/tree/master/item-search). Packaged as a complete runtime for deployment with API Gateway and Lambda and fully integrated with the pgSTAC Database construct. |
19 |
| - |
20 |
| -### [STAC browser](https://developmentseed.org/eoapi-cdk/#stacbrowser-) |
21 |
| -A CDK construct to host a static [Radiant Earth STAC browser](https://github.com/radiantearth/stac-browser) on S3. |
22 |
| - |
23 |
| -### [OGC Features/Tiles API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-) |
24 |
| -A complete OGC Features/Tiles API using [tipg](https://github.com/developmentseed/tipg). Packaged as a complete runtime for deployment with API Gateway and Lambda. By default the API will be connected to the Database's `public` schema. |
25 |
| - |
26 |
| -### [STAC Ingestor](https://developmentseed.org/eoapi-cdk/#stacingestor-) |
27 |
| -An API for large scale STAC data ingestion and validation into a pgSTAC instance. |
28 |
| - |
29 |
| - |
30 |
| - |
31 |
| -Authentication for the STAC Ingestor API can be configured with JWTs authenticated by JWKS. To learn more about securing FastAPI applications with this approach see [Securing FastAPI with JWKS (AWS Cognito, Auth0)](https://alukach.com/posts/fastapi-rs256-jwt/). |
32 |
| - |
33 |
| -A sample Cognito-based authentication system is available at [aws-asdi-auth](https://github.com/developmentseed/aws-asdi-auth). |
34 |
| - |
35 |
| -### [Bastion Host](https://developmentseed.org/eoapi-cdk/#bastionhost-) |
36 |
| -A bastion host is a secure gateway that provides access to resources in a private subnet. In this case it provides the ability to make administrative connections to eoAPI's pgSTAC instance. |
37 |
| - |
38 |
| - |
39 |
| - |
40 |
| -For more background on bastion hosts in AWS see [this article](https://dev.to/aws-builders/bastion-host-in-aws-vpc-2i63). |
41 |
| - |
42 |
| -And for configuration instructions for this construct see [the docs](https://developmentseed.org/eoapi-cdk/#bastionhost-). |
43 |
| - |
44 |
| - |
45 |
| -## Published Packages |
46 |
| - |
47 |
| -- https://pypi.org/project/eoapi-cdk/ |
48 |
| -- https://www.npmjs.com/package/eoapi-cdk/ |
49 |
| - |
50 |
| -## Release |
51 |
| - |
52 |
| -Versioning is automatically handled via [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Semantic Release](https://semantic-release.gitbook.io/semantic-release/). |
53 |
| - |
54 |
| -_Warning_: If you rebase `main`, you must ensure that the commits referenced by tags point to commits that are within the `main` branch. If a commit references a commit that is no longer on the `main` branch, Semantic Release will fail to detect the correct version of the project. [More information](https://github.com/semantic-release/semantic-release/issues/1121#issuecomment-517945233). |
55 |
| - |
56 |
| - |
57 |
| -## Tests |
58 |
| - |
| 1 | +# eoAPI CDK Constructs |
| 2 | + |
| 3 | +eoapi-cdk is a package of [AWS CDK constructs](https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/constructs-best-practices.html) designed to encapsulate eoAPI services and best practices as simple reusable components. |
| 4 | + |
| 5 | +For more background on the included services see [The Earth Observation API](https://eoapi.dev/) |
| 6 | + |
| 7 | +## Included constructs |
| 8 | + |
| 9 | +Detailed API docs for the constructs can be found [here](https://developmentseed.org/eoapi-cdk/). |
| 10 | + |
| 11 | +### [pgSTAC Database](https://developmentseed.org/eoapi-cdk/#pgstacdatabase-) |
| 12 | + |
| 13 | +An [RDS](https://aws.amazon.com/rds/) instance with [pgSTAC](https://github.com/stac-utils/pgstac) installed and the Postgres parameters optimized for the selected instance type. |
| 14 | + |
| 15 | +### [STAC API](https://developmentseed.org/eoapi-cdk/#pgstacapilambda-) |
| 16 | + |
| 17 | +A STAC API implementation using [stac-fastapi](https://github.com/stac-utils/stac-fastapi) with a [pgSTAC backend](https://github.com/stac-utils/stac-fastapi-pgstac). Packaged as a complete runtime for deployment with API Gateway and Lambda. |
| 18 | + |
| 19 | +### [pgSTAC Titiler API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-) |
| 20 | + |
| 21 | +A complete dynamic tiling API using [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) to create dynamic mosaics of assets based on [STAC Search queries](https://github.com/radiantearth/stac-api-spec/tree/master/item-search). Packaged as a complete runtime for deployment with API Gateway and Lambda and fully integrated with the pgSTAC Database construct. |
| 22 | + |
| 23 | +### [STAC browser](https://developmentseed.org/eoapi-cdk/#stacbrowser-) |
| 24 | + |
| 25 | +A CDK construct to host a static [Radiant Earth STAC browser](https://github.com/radiantearth/stac-browser) on S3. |
| 26 | + |
| 27 | +### [OGC Features/Tiles API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-) |
| 28 | + |
| 29 | +A complete OGC Features/Tiles API using [tipg](https://github.com/developmentseed/tipg). Packaged as a complete runtime for deployment with API Gateway and Lambda. By default the API will be connected to the Database's `public` schema. |
| 30 | + |
| 31 | +### [STAC Ingestor](https://developmentseed.org/eoapi-cdk/#stacingestor-) |
| 32 | + |
| 33 | +An API for large scale STAC data ingestion and validation into a pgSTAC instance. |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +Authentication for the STAC Ingestor API can be configured with JWTs authenticated by JWKS. To learn more about securing FastAPI applications with this approach see [Securing FastAPI with JWKS (AWS Cognito, Auth0)](https://alukach.com/posts/fastapi-rs256-jwt/). |
| 38 | + |
| 39 | +A sample Cognito-based authentication system is available at [aws-asdi-auth](https://github.com/developmentseed/aws-asdi-auth). |
| 40 | + |
| 41 | +### [Bastion Host](https://developmentseed.org/eoapi-cdk/#bastionhost-) |
| 42 | + |
| 43 | +A bastion host is a secure gateway that provides access to resources in a private subnet. In this case it provides the ability to make administrative connections to eoAPI's pgSTAC instance. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +For more background on bastion hosts in AWS see [this article](https://dev.to/aws-builders/bastion-host-in-aws-vpc-2i63). |
| 48 | + |
| 49 | +And for configuration instructions for this construct see [the docs](https://developmentseed.org/eoapi-cdk/#bastionhost-). |
| 50 | + |
| 51 | +## Published Packages |
| 52 | + |
| 53 | +- https://pypi.org/project/eoapi-cdk/ |
| 54 | +- https://www.npmjs.com/package/eoapi-cdk/ |
| 55 | + |
| 56 | +## Release |
| 57 | + |
| 58 | +Versioning is automatically handled via [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Semantic Release](https://semantic-release.gitbook.io/semantic-release/). |
| 59 | + |
| 60 | +_Warning_: If you rebase `main`, you must ensure that the commits referenced by tags point to commits that are within the `main` branch. If a commit references a commit that is no longer on the `main` branch, Semantic Release will fail to detect the correct version of the project. [More information](https://github.com/semantic-release/semantic-release/issues/1121#issuecomment-517945233). |
| 61 | + |
| 62 | +## Tests |
| 63 | + |
59 | 64 | Each pull request to `main` is added to a [merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#triggering-merge-group-checks-with-github-actions) so that a "deployment test" workflow can run before the merge actually happens. If the deployment fails, the merge is cancelled. Here is [the definition of this workflow](https://github.com/developmentseed/eoapi-cdk/blob/main/.github/workflows/deploy.yaml) and the [tests definition](https://github.com/developmentseed/eoapi-cdk/blob/main/tests).
|
0 commit comments