Added basic makefile to automatize the installation steps.

Author: pantierra

Makefile

@@ -0,0 +1,34 @@
+# Makefile for eoapi-k8s
+
+# Variables
+HELM_REPO_URL=https://devseed.com/eoapi-k8s/
+HELM_CHART_NAME=eoapi/eoapi
+PGO_CHART_VERSION=5.5.2
+
+.PHONY: all deploy help minikube
+
+# Default target
+all: deploy
+
+deploy:
+	@echo "Installing dependencies."
+	helm install --set disable_check_for_upgrades=true pgo oci://registry.developers.crunchydata.com/crunchydata/pgo --version $(PGO_CHART_VERSION)
+	@echo "Adding eoAPI helm repository."
+	helm repo add eoapi $(HELM_REPO_URL)
+	@echo "Installing eoAPI helm chart."
+	cd ./helm-chart && \
+	helm install --namespace eoapi --create-namespace --set gitSha=$$(git rev-parse HEAD | cut -c1-10) eoapi ./eoapi
+
+minikube:
+	@echo "Starting minikube."
+	minikube start
+	make deploy
+	minikube addons enable ingress
+	@echo "eoAPI is now available at:"
+	minikube service ingress-nginx-controller -n ingress-nginx --url
+
+help:
+	@echo "Makefile commands:"
+	@echo "  make deploy         -  Install eoAPI on a cluster kubectl is connected to."
+	@echo "  make minikube       -  Install eoAPI on minikube."
+	@echo "  make help           -  Show this help message."

README.md

@@ -26,46 +26,72 @@
 
 ## Getting Started
 
+Make sure you have the following installed:
+
+* [Helm](https://helm.sh/docs/intro/install/)
+* [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
+
+Additionally, wou will need a cluster set up to deploy the eoAPI helm chart. This can be on AWS, GCP, or any other cloud provider that supports k8s. You can also run a local cluster using minikube.
+
+### Local
+
+For a local installation you can use:
+
+* [Minikube](https://minikube.sigs.k8s.io/)
+
+And simply execute the following commands:
+
+```bash
+$ make minikube
+```
+
+### Cloud
+
 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)
-
 * [GCP GKE Cluster Setup](./docs/gcp-gke.md)
- 
+
+Then simply execute the following command:
+
+```bash
+$ make deploy
+```
+
 <a name="helminstall"/>
 
-## Helm Installation
+## Manual helm installation
 
-Once you have a k8s cluster set up you can `helm install` eoAPI with the following steps:
+Instead of using the `make` commands above you can also manually `helm install` eoAPI with the following steps:
 
 0. `eoapi-k8s` depends on the [Crunchydata Postgresql Operator](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/helm). Install that first:
 
    ```python
    $ helm install --set disable_check_for_upgrades=true pgo oci://registry.developers.crunchydata.com/crunchydata/pgo --version 5.5.2
    ```
 
-
 1. Add the eoapi repo from https://devseed.com/eoapi-k8s/:
 
     ```python
     $ helm repo add eoapi https://devseed.com/eoapi-k8s/
     ```
 
 2. List out the eoapi chart versions
-    
+
    ```python
    $ helm search repo eoapi --versions
-   NAME            CHART VERSION   APP VERSION     DESCRIPTION                                       
+   NAME            CHART VERSION   APP VERSION     DESCRIPTION
    eoapi/eoapi     0.2.14          0.3.1           Create a full Earth Observation API with Metada...
    eoapi/eoapi     0.1.13          0.2.11          Create a full Earth Observation API with Metada...
    ```
+
 3. Optionally override keys/values in the default `values.yaml` with a custom `config.yaml` like below:
 
    ```python
-   $ cat config.yaml 
+   $ cat config.yaml
    vector:
      enable: false
    pgstacBootstrap:
@@ -74,6 +100,7 @@ Once you have a k8s cluster set up you can `helm install` eoAPI with the followi
          LOAD_FIXTURES: "0"
          RUN_FOREVER: "1"
    ```
+
 4. Then `helm install` with those `config.yaml` values:
 
    ```python
@@ -87,7 +114,7 @@ Once you have a k8s cluster set up you can `helm install` eoAPI with the followi
       # create os environment variables for required secrets
       ######################################################
       $ export GITSHA=$(git rev-parse HEAD | cut -c1-10)
-   
+
       $ cd ./helm-chart
 
       $ helm install \
@@ -97,9 +124,9 @@ Once you have a k8s cluster set up you can `helm install` eoAPI with the followi
           eoapi \
           ./eoapi
     ```
-   
+
 <a name="options"/>
 
 ## Configuration Options and Defaults
-Read about [Default Configuration](./docs/configuration.md#default-configuration) and 
+Read about [Default Configuration](./docs/configuration.md#default-configuration) and
 other [Configuration Options](./docs/configuration.md#additional-options) in the documentation