Skip to content

Update configuration.md #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Update configuration.md #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ Most of the required fields have common-sense defaults except traditional userna
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 | | |
| providerContext | deprecated: used as a switch in helm templates for <br>provider-specific logic if needed | minikube | minikube |
| 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 |
|:-------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------|:------------------------|
| `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 | | |
| `providerContext ` | deprecated: used as a switch in helm templates for <br>provider-specific logic if needed | minikube | minikube |
| `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 |


---
Expand Down Expand Up @@ -66,8 +66,8 @@ Here's a simplified high-level diagram to grok:
### Key `ingress.className`

| **Values Key** | **Description** | **Default** | **Choices** |
|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------:|:-----------:|--------------|
| ingress.className | used as switch in helm templates for specific<br>functionality regarding `kind: Ingress` and cloud-provider<br>specific load balancing options | nginx | nginx<br>alb<br>gce<br> |
|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:-----------|:--------------|
| `ingress.className` | used as switch in helm templates for specific<br>functionality regarding `kind: Ingress` and cloud-provider<br>specific load balancing options | nginx | nginx<br>alb<br>gce<br> |

#### Given `ingress.className=nginx`
![](./images/default_architecture.png)
Expand Down