add pgo and cluster

Author: ranchodeluxe

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -8,15 +8,6 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-  - type: input
-    id: title
-    attributes:
-      label: Title
-      description: A clear and concise title of the issue
-      placeholder: "Type the issue title here"
-    validations:
-      required: true
-
   - type: checkboxes
     id: labels
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -8,15 +8,6 @@ body:
       value: |
         Thanks for taking the time to suggest a feature!
 
-  - type: input
-    id: title
-    attributes:
-      label: Title
-      description: A clear and concise title of the feature request
-      placeholder: "Type the feature title here"
-    validations:
-      required: true
-
   - type: textarea
     id: description
     attributes:

.github/workflows/helm-tests.yml

@@ -1,17 +1,11 @@
 name: CI
 
-
-# On every pull request, but only on push to main
 on:
   push:
-    branches:
-    - main
-    paths: []
-    # only run jobs if some code have changed
-    #- 'helm-chart/eoapi/**'
+    branches: [ "main" ]
   pull_request:
-    branches:
-      - main
+    branches: [ "main" ]
+    types: [ opened, reopened, synchronize, labeled ]
 
 jobs:
   helm-tests:
@@ -25,8 +19,15 @@ jobs:
       - run: |
           cd helm-chart
           helm unittest eoapi -f 'tests/*.yaml' -v eoapi/test-helm-values.yaml
-  integration-tests:
-    if: github.event.pull_request.head.repo.full_name == github.repository
+  integration-tests-gcp:
+    # run on:
+    #  - all pushes to specified branch(es)
+    #  - a PR was just labeled 'test-integration'
+    #  - a PR with 'test-integration' label was opened, reopened, or synchronized
+    if: |
+      github.event_name == 'push' ||
+      github.event.label.name == 'test-integration-gcp' ||
+      contains( github.event.pull_request.labels.*.name, 'test-integration-gcp')
     permissions:
       contents: 'read'
       id-token: 'write'
@@ -78,24 +79,13 @@ jobs:
 
       - name: helm render/install eoapi templates
         run: |
-          export PGUSER=username
-          export POSTGRES_USER=username
-          export PGPASSWORD=password
-          export POSTGRES_PASSWORD=password
           export GITSHA='${{github.sha}}'
 
           cd helm-chart
 
           helm install $RELEASE_NAME \
-            --namespace eoapitest \
+            --namespace $RELEASE_NAME \
             --create-namespace \
-            --set db.settings.secrets.POSTGRES_HOST=pgstac-$RELEASE_NAME \
-            --set db.settings.secrets.POSTGRES_HOST_READER=pgstac-$RELEASE_NAME \
-            --set db.settings.secrets.POSTGRES_HOST_WRITER=pgstac-$RELEASE_NAME \
-            --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 \
             -f ./eoapi/values.yaml \
             -f ./eoapi/test-unittest-values.yaml \
             ./eoapi
@@ -109,7 +99,7 @@ jobs:
         timeout-minutes: 10
         continue-on-error: true
         run: |
-          kubectl config set-context --current --namespace=eoapitest
+          kubectl config set-context --current --namespace=$RELEASE_NAME
           while [[ -z "$(kubectl get pod  | grep "^raster-$RELEASE_NAME-.*$" | cut -d' ' -f1 | xargs -I{} kubectl logs pod/{} | grep "GET /.*/healthz" | head -n 1)" ]]; do
             echo "still waiting for raster service to start..."
             sleep 1
@@ -131,6 +121,10 @@ jobs:
         run: |
           echo "The previous step failed or timed out. Running cleanup logic..."
           helm uninstall $RELEASE_NAME
+
+          # need to ticket in crunchy b/c depedencies are not uninstalling via above uninstall
+          kubectl delete cm,secrets,statefulset,replicaset,deploy,pods,services,endpoints,sa,deployments --all --namespace=$RELEASE_NAME
+
           # force GH action to show failed result
           exit 128
 
@@ -145,7 +139,7 @@ jobs:
         id: testrunner
         continue-on-error: true
         run: |
-          kubectl config set-context --current --namespace=eoapitest
+          kubectl config set-context --current --namespace=$RELEASE_NAME
           PUBLICIP='http://'$(kubectl -n ingress-nginx get svc/ingress-nginx-controller -o jsonpath='{.spec.loadBalancerIP}')
           echo '#################################'
           echo vector=$PUBLICIP/vector$RELEASE_NAME
@@ -172,9 +166,16 @@ jobs:
         run: |
           echo "The previous step failed or timed out. Running cleanup logic..."
           helm uninstall $RELEASE_NAME
+
+          # need to ticket in crunchy b/c depedencies are not uninstalling via above uninstall
+          kubectl delete cm,secrets,statefulset,replicaset,deploy,pods,services,endpoints,sa,deployments --all --namespace=$RELEASE_NAME
+
           # force GH action to show failed result
           exit 128
 
       - name: helm uinstall eoapi templates
         run: |
           helm uninstall $RELEASE_NAME
+
+          # need to ticket in crunchy b/c depedencies are not uninstalling via above uninstall
+          kubectl delete cm,secrets,statefulset,replicaset,deploy,pods,services,endpoints,sa,deployments --all --namespace=$RELEASE_NAME

README.md

@@ -53,16 +53,16 @@ Once you have a k8s cluster set up you can `helm install` eoAPI as follows:
       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)
+      # optionally override keys/values in the default `values.yaml` with a custom `config.yaml` like below:
       $ cat config.yaml 
-      db:
+      vector:
+        enable: false
+      pgstacBootstrap:
         settings:
-          secrets:
-            PGUSER: "username"
-            POSTGRES_USER: "username"
-            PGPASSWORD: "password"
-            POSTGRES_PASSWORD: "password"
-    
+          envVars:
+            LOAD_FIXTURES: "0"
+            RUN_FOREVER: "1"
+   
       # then run `helm install` with those overrides 
       $ helm install -n eoapi --create-namespace eoapi eoapi/eoapi --version 0.1.2 -f config.yaml
     ```
@@ -74,21 +74,13 @@ Once you have a k8s cluster set up you can `helm install` eoAPI as follows:
       # 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
     ```

docs/aws-eks.md

@@ -2,7 +2,7 @@
 
 This is a verbose walkthrough. It uses `eksctl` and assumes you already have an AWS account, have the [eksctl prerequisites installed](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html) including `eksctl` and `helm`.
 
-If you are familiar with Terraform would like an IaC choice that is more terse consider setting up your cluster with that: https://github.com/developmentseed/eoapi-k8s-terraform
+If you're familiar with Terraform and would like an IaC choice that is more terse consider setting up your cluster with that: https://github.com/developmentseed/eoapi-k8s-terraform
 
 
 ## Table of Contents:

docs/configuration.md

@@ -10,19 +10,16 @@ $ head -n 9 <eoapi-k8s-repo>/values.schema.json
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "required": [
-    "db",
     "service",
     "gitSha"
   ],
 ```
 
-Most of the required fields have common-sense defaults except traditional username and password secrets under `db`. 
+Most of the required fields have common-sense defaults. 
 The table below and the `values.yaml` comments should explain what the options and defaults are:
 
 |                               **Values Key**                              |                                                              **Description**                                                              |  **Default** | **Choices**            |
 |:-------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------|:------------------------|
-| `db.settings.secrets.PGUSER`<br>`db.settings.secrets.PGPASSWORD`              | username and password used by application for connections<br>https://www.postgresql.org/docs/current/libpq-envars.html                    |              |                        |
-| `db.settings.secrets.POSTGRES_USER`<br>`db.settings.secrets.POSTGRES_PASSWORD` | username and password used by<br>base postgresl image for admin purposes<br>see https://www.postgresql.org/docs/current/libpq-envars.html |              |                        |
 | `service.port`                                                              | the port that all vector/raster/stac services run on<br>used in `kind: Service` and `kind: Ingress`                                       |     8080     |   your favorite port   |
 | `gitSha`                                                                    | sha attached to a `kind: Deployment` key `metadata.labels`                                                                                | gitshaABC123 | your favorite sha      |
 
@@ -31,23 +28,11 @@ The table below and the `values.yaml` comments should explain what the options a
 
 ## Default Configuration
 
-Running `helm install` from https://devseed.com/eoapi-k8s/ with this simple `config.yml` overrides below
-should spin up similar infrastructure in EKS or GKE:
-
-```python
-$ cat config.yaml 
-db:
-  settings:
-    secrets:
-      PGUSER: "username"
-      POSTGRES_USER: "username"
-      PGPASSWORD: "password"
-      POSTGRES_PASSWORD: "password"
-```
+Running `helm install` from https://devseed.com/eoapi-k8s/ should spin up similar infrastructure in EKS or GKE:
 
 In EKS or GKE you'll by default get:
 
-* a pgstac PostgreSQL database deployment and service
+* a HA PostgreSQL database deployment and service via [Crunchdata's Postgresl Operator](https://access.crunchydata.com/documentation/postgres-operator)
 * the same vector and raster data fixtures used for testing loaded into the DB
 * a load balancer and nginx-compatible ingress with the following path rewrites:
     * a `/stac` service for `stac_fastapi.pgstac`

docs/gcp-gke.md

@@ -2,7 +2,7 @@
 
 This is a verbose walkthrough. It uses `gcloud` and assumes you already have an GCP account and project where you want to run eoapi. We also assume that you have some prerequisites installed including `gcloud`, `kubectl` and `helm`.
 
-If you are familiar with Terraform would like an IaC choice that is more terse consider setting up your cluster with that: https://github.com/developmentseed/eoapi-k8s-terraform
+If you're familiar with Terraform and would like an IaC choice that is more terse consider setting up your cluster with that: https://github.com/developmentseed/eoapi-k8s-terraform
 
 # Table of Contents
 - [Pre-requisites](#pre-requisites)

helm-chart/eoapi/Chart.lock

@@ -0,0 +1,9 @@
+dependencies:
+- name: pgo
+  repository: ""
+  version: 5.5.2
+- name: postgrescluster
+  repository: ""
+  version: 5.5.2
+digest: sha256:88b79b5e364db5d6d1b636c5533628b2d874584f119b1630ec0b16ee6d0f9d88
+generated: "2024-06-06T11:50:50.141657-07:00"

helm-chart/eoapi/Chart.yaml

@@ -17,10 +17,18 @@ kubeVersion: ">=1.23.0-0"
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: "0.2.14"
+version: "0.3.0"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.3.1"
+appVersion: "0.3.2"
+
+dependencies:
+  - name: pgo
+    version: 5.5.2
+    respository: "file://charts/pgo"
+  - name: postgrescluster
+    version: 5.5.2
+    respository: "file://charts/postgrescluster"

helm-chart/eoapi/charts/pgo/.gitattributes

@@ -0,0 +1,3 @@
+# https://github.com/github/linguist/issues/4905
+# https://github.com/github/linguist/issues/5092#issuecomment-730262298
+/templates/*.tpl linguist-language=handlebars