Skip to content

Commit

Permalink
Added icon for eoapi-k8s.
Browse files Browse the repository at this point in the history
  • Loading branch information
pantierra committed Oct 31, 2024
1 parent 6a90664 commit fedbb4e
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# eoapi-k8s

<p align="center">
<img height=200 src="https://raw.githubusercontent.com/developmentseed/eoapi-k8s/refs/heads/feature/icon/docs/eoapi-k8s.svg" alt="eoapi-k8s">
</p>
<p>
<a href="https://github.com/developmentseed/eoapi-k8s/actions?query=workflow%3ACI" target="_blank">
<img src="https://github.com/developmentseed/eoapi-k8s/actions/workflows/helm-tests.yml/badge.svg?branch=main" alt="Test">
</a>
Expand Down Expand Up @@ -34,7 +37,7 @@ If you don't have a k8s cluster set up on AWS or GCP then follow an IaC guide be
* [AWS EKS Cluster Setup](./docs/aws-eks.md)

* [GCP GKE Cluster Setup](./docs/gcp-gke.md)

<a name="helminstall"/>

## Helm Installation
Expand All @@ -55,17 +58,17 @@ Once you have a k8s cluster set up you can `helm install` eoAPI with the followi
```

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:
Expand All @@ -87,7 +90,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 \
Expand All @@ -97,9 +100,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
68 changes: 68 additions & 0 deletions docs/eoapi-k8s.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fedbb4e

Please sign in to comment.