eoapi-k8s

Table of Contents

• What is eoAPI
• Getting Started
• Helm Installation
• Default Configuration and Options
• Autoscaling

What is eoAPI?

https://eoapi.dev/

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

• GCP GKE Cluster Setup

Helm Installation

Once you have a k8s cluster set up you can helm install eoAPI as follows:

1. helm install from https://devseed.com/eoapi-k8s/:

      # 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 --versions
      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 -n eoapi --create-namespace eoapi eoapi/eoapi --version 0.1.2 -f config.yaml
   

2. or helm install from this repo’s helm-chart/ folder:

      ######################################################
      # 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
   

Configuration Options and Defaults

Read about Default Configuration and other Configuration Options in the documentation

This site is open source. Improve this page.