Merge branch 'main' into removeStamen

Author: vincentsarago

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
           pre-commit run --all-files
 
       - name: Launch services
-        run: docker-compose up -d stac raster vector
+        run: docker compose up -d stac raster vector
 
       - name: install lib postgres
         run: |
@@ -67,8 +67,8 @@ jobs:
       # see https://github.com/developmentseed/tipg/issues/37
       - name: Restart the Vector service
         run: |
-          docker-compose stop vector
-          docker-compose up -d vector
+          docker compose stop vector
+          docker compose up -d vector
 
       - name: Sleep for 10 seconds
         run: sleep 10s
@@ -78,7 +78,7 @@ jobs:
         run: python -m pytest .github/workflows/tests/
 
       - name: Stop services
-        run: docker-compose stop
+        run: docker compose stop
 
 
   publish-docker:

README.md

@@ -33,12 +33,20 @@
 
 - **OGC Features and Vector Tiles** API built on top of [https://github.com/developmentseed/tipg](https://github.com/developmentseed/tipg)
 
+---
+
+## 🌍 eoAPI: An Open-Source Community Project
+
+`eoAPI` is proudly open-source and driven by a dedicated community of contributors. We believe in the power of open collaboration and welcome anyone to contribute, discuss, and grow this tool with us. Join the conversations on [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions) and make a difference in the Earth Observation realm.
+
+
+---
 
 ## Getting started
 
 - Clone the repository: `git clone https://github.com/developmentseed/eoAPI.git`
 - Navigate to the project: `cd eoAPI`
-- Run services with `docker-compose up`
+- Run services with `docker compose up`
 - Follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](./demo/)) to load some data into eoAPI
 - Check out the [Search Viewer](http://localhost:8081/index.html), and the API documentation ([STAC Metadata](http://localhost:8081/docs), [Raster Tiles](http://localhost:8082/docs), [Vector Tiles](http://localhost:8083/api.html))
 
@@ -62,23 +70,34 @@ Note: services might have incompatible dependencies which you can resolve by usi
 
 ## Deployment
 
-This repository has the demonstration runtimes that are consistently updated with new functionality.
+This repository has current runtimes that are consistently updated with new functionality. 
+
+The services can be deployed locally via docker with `docker-compose up`. The official runtimes can be launched with `docker-compose -f docker-compose.yml -f docker-compose.official.yml up stac-fastapi titiler-pgstac tipg`. 
 
-The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)). 
+Two Infrastructure as Code (IaC) repositories are available:
+- [eoapi-cdk](https://github.com/developmentseed/eoapi-cdk): A set of AWS CDK constructs to deploy eoAPI services
+- [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s): IaC and Helm charts for deploying eoAPI services on AWS and GCP
 
-A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).
+Finally, [eoapi-template](https://github.com/developmentseed/eoapi-template) is an AWS CDK app that shows how to configure the eoapi-cdk constructs.
 
 ## Contribution & Development
 
-See [CONTRIBUTING.md](https://github.com/developmentseed/eoAPI/blob/main/CONTRIBUTING.md)
+We highly value and rely on our community! Whether you're an expert or just getting started, you can make a difference. Here's how:
+
+- **Contribute**: Check out our [CONTRIBUTING.md](https://github.com/developmentseed/eoAPI/blob/main/CONTRIBUTING.md) guide to understand how you can contribute.
+- **Engage in Discussions**: Share your ideas, ask questions, or provide feedback through [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions). This is where most of our project conversations take place.
+- **Report Issues**: Found a bug or have a feature request? Raise it on our [issues page](https://github.com/developmentseed/eoAPI/issues).
 
+---
 ## License
 
-See [LICENSE](https://github.com/developmentseed/eoAPI/blob/main/LICENSE)
+At Development Seed, we believe in open collaboration and making tools and data more accessible. In line with this ethos, we've explicitly chosen a MIT license for `eoAPI`.
+
+For full license details, see [LICENSE](https://github.com/developmentseed/eoAPI/blob/main/LICENSE).
 
 ## Authors
 
-Created by [Development Seed](<http://developmentseed.org>)
+Nurtured by [Development Seed](<http://developmentseed.org>)
 
 See [contributors](https://github.com/developmentseed/eoAPI/graphs/contributors) for a listing of individual contributors.
 

docs/src/deployment.md

@@ -3,13 +3,15 @@ hide:
   - navigation
 ---
 
-The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)). 
 
-A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).
+## Via [eoapi-cdk](https://github.com/developmentseed/eoapi-cdk)
 
-## AWS (Lambda)
 
-An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs)
+[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) is a set of AWS CDK constructs to deploy eoAPI services.
+
+[eoapi-template](https://github.com/developmentseed/eoapi-template) is an AWS CDK app that shows how to configure the [eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) constructs.
+
+An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs).
 
 The stack is deployed by the [AWS CDK](https://aws.amazon.com/cdk/) utility. Under the hood, CDK will create the deployment packages required for AWS Lambda, upload it to AWS, and handle the creation of the Lambda and API Gateway resources.
 
@@ -86,6 +88,73 @@ The example commands here will deploy a CloudFormation stack called `eoAPI-stagi
 
 If you get an error saying that the max VPC's has been reached, this means that you have hit the limit for the amount of VPCs per unique AWS account and region combination. You can change the AWS region to a region that has less VPCs and deploy again to fix this.
 
-## K8S
+## Via [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)
+
+[eoapi-k8s](https://github.com/developmentseed/eoapi-k8s) has the IaC and Helm charts for deploying eoAPI services on AWS and GCP.
+
+**Getting started**
+
+If you don't have a k8s cluster set up on AWS or GCP then follow an IaC guide below that is relevant to you
+
+> ⓘ The helm chart in this repo assumes your cluster has a few third-party add-ons and controllers installed. So
+> it's in your best interest to read through the IaC guides to understand what those defaults are
+
+* [AWS EKS Cluster Setup](./docs/aws-eks.md)
 
-A Kubernetes chart is currently being developed at https://github.com/developmentseed/eoapi-k8s
+* [TBD: GCP GKE Cluster Setup](./docs/gcp-gke.md)
+ 
+**Helm Installation** 
+
+Once you have a k8s cluster set up you can `helm install` eoAPI as follows
+
+1. `helm install` from this repo's `helm-chart/` folder:
+
+    ```python
+      ######################################################
+      # create os environment variables for required secrets
+      ######################################################
+      $ export GITSHA=$(git rev-parse HEAD | cut -c1-10)
+      $ export PGUSER=s00pers3cr3t
+      $ export POSTGRES_USER=s00pers3cr3t
+      $ export POSTGRES_PASSWORD=superuserfoobar
+      $ export PGPASSWORD=foobar
+   
+      $ cd ./helm-chart
+
+      $ helm install \
+          --namespace eoapi \
+          --create-namespace \
+          --set gitSha=$GITSHA \
+          --set db.settings.secrets.PGUSER=$PGUSER \
+          --set db.settings.secrets.POSTGRES_USER=$POSTGRES_USER \
+          --set db.settings.secrets.PGPASSWORD=$PGPASSWORD \
+          --set db.settings.secrets.POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
+          eoapi \
+          ./eoapi
+    ```
+
+2. or `helm install` from https://devseed.com/eoapi-k8s/:
+
+    ```python
+      # add the eoapi helm repo locally
+      $ helm repo add eoapi https://devseed.com/eoapi-k8s/
+    
+      # list out the eoapi chart versions
+      $ helm search repo eoapi 
+      NAME            CHART VERSION   APP VERSION     DESCRIPTION                                       
+      eoapi/eoapi     0.1.1           0.1.0           Create a full Earth Observation API with Metada...
+      eoapi/eoapi     0.1.2           0.1.0           Create a full Earth Observation API with Metada...
+   
+      # add the required secret overrides to an arbitrarily named `.yaml` file (`config.yaml` below)
+      $ cat config.yaml 
+      db:
+        settings:
+          secrets:
+            PGUSER: "username"
+            POSTGRES_USER: "username"
+            PGPASSWORD: "password"
+            POSTGRES_PASSWORD: "password"
+    
+      # then run `helm install` with those overrides 
+      helm install eoapi eoapi/eoapi --version 0.1.1 -f config.yaml
+    ```

docs/src/intro.md

@@ -9,6 +9,9 @@ hide:
   <p align="center">Create a full Earth Observation API with Metadata, Raster and Vector services.</p>
 </p>
 
+
+---
+
 ## **E**arth **O**bservation **API**
 
 `eoAPI` combines several *state-of-the-art* projects to create a full Earth Observation API. Each service can be used and deployed independently but `eoAPI` creates the interconnections between each service:
@@ -23,6 +26,12 @@ hide:
 
 ---
 
+## 🌍 eoAPI: An Open-Source Community Project
+
+`eoAPI` is proudly open-source and driven by a dedicated community of contributors. We believe in the power of open collaboration and welcome anyone to contribute, discuss, and grow this tool with us. Join the conversations on [GitHub Discussions](https://github.com/developmentseed/eoAPI/discussions) and make a difference in the Earth Observation realm.
+
+---
+
 ## Why should you use `eoAPI`
 
 - **Focus on your use case:** `eoAPI` is used for large-scale data processing, building geographic information systems (GIS), creating real-time data applications, climate research and environmental monitoring, machine learning model training, and more.
@@ -52,16 +61,16 @@ hide:
 
 See [service details](./services.md) for more information.
 
-*Note: The documentation links referenced require lauching the application with `docker-compose` or another deployment*.
+*Note: The documentation links referenced require lauching the application with `docker compose` or another deployment*.
 
 ---
 
 ## Getting started
 
 - Clone the repository: `git clone https://github.com/developmentseed/eoAPI.git`
 - Navigate to the project: `cd eoAPI`
-- Run services with `docker-compose up`
-- Follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](./demo/)) to load some data into eoAPI
+- Run services with `docker compose up`
+- Follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)) to load some data into eoAPI
 - Checkout the [Search Viewer](http://localhost:8081/index.html), and the API documentation ([STAC Metadata](http://localhost:8081/docs), [Raster Tiles](http://localhost:8082/docs), [Vector Tiles](http://localhost:8083/api.html))
 
 Alternatively, you may launch the application locally:

docs/src/services.md

@@ -11,9 +11,9 @@ A custom version of [stac-fastapi.pgstac](https://github.com/stac-utils/stac-fas
 
 The service includes:
 
-- Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs) if using the `docker-compose` configuration.
+- Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs) if using the `docker compose` configuration.
 
-- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker-compose` configuration.
+- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker compose` configuration.
 
 - **Proxy** to the Tiler endpoint for STAC Items