Update README and Chart.yaml for improved installation instructions and add logo

emmanuelmathot · emmanuelmathot · commit 8d3f24f28b2a · 2025-04-30T15:18:24.000+02:00
diff --git a/README.md b/README.md
@@ -17,47 +17,98 @@
 
 ## What is eoAPI?
 
-[https://eoapi.dev/](https://eoapi.dev/)
+[eoAPI](https://eoapi.dev/) is a collection of REST APIs for Earth Observation data access and analysis. This repository provides a production-ready Kubernetes deployment solution with flexible database options, unified ingress configuration, and built-in monitoring.
 
-## Getting Started
+## Quick Start
 
-Make sure you have [helm](https://helm.sh/docs/intro/install/) installed on your machine.
-Additionally, you will need a cluster to deploy the eoAPI helm chart. This can be on a cloud provider, like AWS, GCP, or any other that supports Kubernetes. You can also run a local cluster using minikube.
+### Prerequisites
 
-### Local
+- [helm](https://helm.sh/docs/intro/install/)
+- A Kubernetes cluster (local or cloud-based)
+- `kubectl` configured for your cluster
 
-For a local installation you can use a preinstalled [Minikube](https://minikube.sigs.k8s.io/), and simply execute the following command:
+### Option 1: One-Command Installation
 
+The fastest way to get started is using our Makefile commands:
+
+For local development with Minikube:
 ```bash
-$ make minikube
+make minikube
 ```
 
-Once the deployment is done, the url to access eoAPI will be printed to your terminal.
+For cloud deployment:
+```bash
+make deploy
+```
 
-### Cloud
+This will automatically:
+1. Install the PostgreSQL operator
+2. Add the eoAPI helm repository
+3. Install the eoAPI helm chart
+4. Set up necessary namespaces and configurations
 
-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
+### Option 2: Step-by-Step Installation
 
-> &#9432; 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
+If you prefer more control over the installation process:
 
-* [AWS EKS Cluster Setup](./docs/aws-eks.md)
-* [GCP GKE Cluster Setup](./docs/gcp-gke.md)
+1. Install the PostgreSQL operator:
+```bash
+helm upgrade --install \
+  --set disable_check_for_upgrades=true pgo \
+  oci://registry.developers.crunchydata.com/crunchydata/pgo \
+  --version 5.7.4
+```
+
+2. Add the eoAPI helm repository:
+```bash
+helm repo add eoapi https://devseed.com/eoapi-k8s/
+```
+
+3. Get your current git SHA:
+```bash
+export GITSHA=$(git rev-parse HEAD | cut -c1-10)
+```
+
+4. Install eoAPI:
+```bash
+helm upgrade --install \
+  --namespace eoapi \
+  --create-namespace \
+  --set gitSha=$GITSHA \
+  eoapi devseed/eoapi
+```
+
+### Post-Installation
 
-Make sure you have your `kubectl` configured to point to the cluster you want to deploy eoAPI to. Then simply execute the following command:
+1. Enable ingress (for Minikube):
+```bash
+minikube addons enable ingress
+```
 
+2. Optional: Load sample data:
 ```bash
-$ make deploy
+make ingest
 ```
 
-### Manual step-by-step installation
+## Cloud Provider Setup
+
+For cloud-based deployments, refer to our detailed setup guides:
+* [AWS EKS Cluster Setup](./docs/aws-eks.md)
+* [GCP GKE Cluster Setup](./docs/gcp-gke.md)
+* [Azure Setup](./docs/azure.md)
+
+## Documentation
+
+* [Configuration Guide](./docs/configuration.md)
+* [Data Management](./docs/manage-data.md)
+* [Autoscaling and Monitoring](./docs/autoscaling.md)
+* [Health Checks](./docs/health.md)
+* [Unified Ingress Configuration](./docs/unified-ingress.md)
 
-Instead of using the `make` commands above you can also [manually `helm install` eoAPI](./docs/helm-install.md).
+## Contributing
 
+We welcome contributions! See our [contributing guide](./CONTRIBUTING.md) for details.
 
-## More information
+## License
 
-* Read about [Default Configuration](./docs/configuration.md#default-configuration) and
-other [Configuration Options](./docs/configuration.md#additional-options)
-* [Manage your data](./docs/manage-data.md) in eoAPI
-* Learn about [Autoscaling / Monitoring / Observability](./docs/autoscaling.md)
+This project is licensed under the [MIT License](./LICENSE).
diff --git a/helm-chart/eoapi/Chart.yaml b/helm-chart/eoapi/Chart.yaml
@@ -13,6 +13,7 @@ type: application
 kubeVersion: ">=1.23.0-0"
 
 # Artifacthub metadata
+icon: logo.png
 annotations:
   artifacthub.io/changes: |
     - Adds integration with Artifacthub.io
diff --git a/helm-chart/eoapi/README.md b/helm-chart/eoapi/README.md
@@ -1,141 +1,121 @@
-# EOAPI Helm Chart
+# eoAPI Helm Chart
 
-This Helm chart deploys the EOAPI (Earth Observation API) stack, which includes STAC API, raster tile services, vector tile services, and a multidimensional data service.
+![Version: 0.7.0](https://img.shields.io/badge/Version-0.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 5.0.2](https://img.shields.io/badge/AppVersion-5.0.2-informational?style=flat-square)
 
-## Overview
+A Helm chart for deploying Earth Observation APIs with integrated STAC, raster, vector, and multidimensional services.
 
-The chart sets up:
+## Features
 
-- A PostgreSQL database with PostGIS and PgSTAC extensions
-- STAC API service for metadata discovery and search
-- Titiler for raster tile services
-- TIPG for vector tile services
-- Optional multidimensional data service
+- STAC API for metadata discovery and search
+- Raster tile services (TiTiler)
+- Vector tile services (TIPG)
+- Multidimensional data support
+- Built-in STAC Browser interface
+- Flexible database configuration
+- Unified ingress system
 
-## Prerequisites
-
-- Kubernetes 1.16+
-- Helm 3.0+
-- PV provisioner support in the underlying infrastructure
-- CrunchyData Postgres Operator (for the PostgreSQL database)
-
-## Installation
+## TL;DR
 
 ```bash
-# Install Postgres Operator first
-helm install --set disable_check_for_upgrades=true pgo oci://registry.developers.crunchydata.com/crunchydata/pgo
+# Add the eoAPI repository
+helm repo add eoapi https://devseed.com/eoapi-k8s/
+
+# Install the PostgreSQL operator (required)
+helm install --set disable_check_for_upgrades=true pgo \
+  oci://registry.developers.crunchydata.com/crunchydata/pgo \
+  --version 5.7.4
 
-# Then install eoapi
-helm install eoapi ./eoapi
+# Install eoAPI
+helm install eoapi eoapi/eoapi
 ```
 
-## Configuration
+## Prerequisites
 
-The chart can be configured via `values.yaml`. See the chart's `values.yaml` file for all available options and detailed descriptions.
+- Kubernetes 1.23+
+- Helm 3.0+
+- PV provisioner support
+- PostgreSQL operator
 
-Key configuration sections:
+## Quick Start Configuration
 
 ```yaml
-# Services to enable
+# Enable desired services
 apiServices:
   - raster
   - stac
   - vector
-  # - multidim (disabled by default)
+  - stac-browser
+  # - multidim  # Optional
 
-# Ingress configuration
+# Configure ingress
 ingress:
   enabled: true
-  className: "nginx"
-  # ...
-
-# Database configuration
-postgrescluster:
-  enabled: true
-  # ...
-```
-
-## PgSTAC Bootstrap Process
-
-The chart includes a streamlined process for initializing and setting up the PgSTAC database.
-
-### PgSTAC Bootstrap Overview
-
-The setup process consists of two main jobs:
-
-1. **pgstac-migrate job**: Runs the pypgstac migrate command to initialize the database schema, applies settings, and sets necessary permissions.
-2. **pgstac-load-samples job**: (Optional) Loads sample STAC data only when sample loading is enabled.
-
-### Improvements in PgSTAC Bootstrap
-
-- Replaced custom Python script with pypgstac migrate command
-- Moved SQL settings to a dedicated SQL file for better maintainability
-- Separated sample data loading into an optional job
-- Uses standard PostgreSQL environment variables
-- Ensures the process remains idempotent for safe re-runs
+  className: "nginx"  # or "traefik"
+  host: "your-domain.com"  # Optional
 
-### PgSTAC Directory Structure
+# Database options
+postgresql:
+  type: "postgrescluster"  # or "external-plaintext" or "external-secret"
 
-The codebase has been reorganized to separate different types of files:
-
-- `initdb-data/settings/`: Contains configuration settings like the PgSTAC settings SQL file
-- `initdb-data/samples/`: Contains sample data files that are loaded only when sample loading is enabled
-
-### PgSTAC Configuration
-
-- Enable/disable the setup process through `pgstacBootstrap.enabled`
-- Control sample data loading: 
-  - New approach: `pgstacBootstrap.settings.loadSamples` (recommended)
-  - Legacy approach: `pgstacBootstrap.settings.envVars.LOAD_FIXTURES` (deprecated)
-
-Example configuration:
-
-```yaml
+# Load sample data
 pgstacBootstrap:
   enabled: true
   settings:
-    # General configuration options
-    loadSamples: true      # Set to false to disable sample data loading
-    
-    resources:
-      requests:
-        cpu: "512m"
-        memory: "1024Mi"
-      limits:
-        cpu: "512m"
-        memory: "1024Mi"
+    loadSamples: true
 ```
 
-## Services
-
-### STAC API
-
-The STAC API service provides a standardized way to search and discover geospatial data.
-
-### Raster Services (Titiler)
+## Configuration Options
 
-Provides dynamic tiling for raster data through the TiTiler implementation.
+### Key Parameters
 
-### Vector Services (TIPG)
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `postgresql.type` | Database deployment type | `postgrescluster` |
+| `ingress.enabled` | Enable ingress | `true` |
+| `ingress.className` | Ingress controller class | `nginx` |
+| `browser.enabled` | Enable STAC Browser interface | `true` |
+| `pgstacBootstrap.enabled` | Enable database initialization | `true` |
 
-Provides vector tile services for PostGIS data through the TIPG implementation.
+Refer to the [values.schema.json](./values.schema.json) for the complete list of configurable parameters.
 
-### Multidimensional Services (Optional)
+### Database Options
 
-Provides services for multidimensional data (time series, etc.).
+1. Integrated PostgreSQL Operator:
+```yaml
+postgresql:
+  type: "postgrescluster"
+```
 
-## Persistence
+2. External Database:
+```yaml
+postgresql:
+  type: "external-plaintext"
+  external:
+    host: "your-db-host"
+    port: "5432"
+    database: "eoapi"
+    credentials:
+      username: "your-user"
+      password: "your-password"
+```
 
-The chart uses PostgreSQL for data persistence. Make sure to configure appropriate storage for production use.
+3. External Database with Secrets:
+```yaml
+postgresql:
+  type: "external-secret"
+  external:
+    existingSecret:
+      name: "your-secret"
+```
 
-## Upgrading
+## Documentation
 
-When upgrading the chart, consider any changes to values.yaml and migrations that might need to be applied.
+For detailed configuration and usage:
 
-## Uninstallation
+- [Configuration Guide](https://github.com/developmentseed/eoapi-k8s/blob/main/docs/configuration.md)
+- [Data Management](https://github.com/developmentseed/eoapi-k8s/blob/main/docs/manage-data.md)
+- [Autoscaling Guide](https://github.com/developmentseed/eoapi-k8s/blob/main/docs/autoscaling.md)
 
-```bash
-helm delete eoapi
-```
+## License
 
-Note that PVs may need to be manually deleted if you want to remove all data.
+[MIT License](https://github.com/developmentseed/eoapi-k8s/blob/main/LICENSE)
diff --git a/helm-chart/eoapi/logo.png b/helm-chart/eoapi/logo.png
