Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
BWibo committed Jan 17, 2023
1 parent 03a6ac4 commit 235b6d0
Show file tree
Hide file tree
Showing 15 changed files with 275 additions and 142 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ The documentation for this helm chart is available in [helm/charts](helm/charts)
--values my-values.yml
```

## :construction_worker: Building
## :blue_book: Documentation

The detailed documentation

### Build Chart documentation

Expand Down
11 changes: 5 additions & 6 deletions helm/charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,11 @@ Kubernetes: `>= 1.23.0`
| frostdb.enabled | bool | `true` | Enable/disable PostGIS Database. Disable if an external database is used. |
| frostweb.enabled | bool | `true` | Enable/disable FROST-Server web interface. |
| fullnameOverride | string | `""` | Override fullname |
| global.db.auth.password | string | `"changeMe"` | Database password |
| global.db.auth.username | string | `"postgres"` | Database username |
| global.db.dbname | string | `"frost"` | Database name |
| global.db.host | string | `"frostdb"` | Database host, allows using external databases. Use DNS name of the `frostdb` service when using frostdb subchart. |
| global.db.port | int | `5432` | Database port |
| global.ingress | object | `{"annotations":{},"certManager":{"issuerEmail":"[email protected]","issuerName":"letsencrypt-staging","issuerType":"namespace"},"className":"nginx","domains":["localhost"]}` | Fully qualified domain name, used for all Ingress routes. Use localhost for local testing deployments. |
| global.db.auth.password | string | `"changeMe"` | Database password. Can be overwritten by values specified in subcharts. |
| global.db.auth.username | string | `"postgres"` | Database username. Can be overwritten by values specified in subcharts. |
| global.db.dbname | string | `"frost"` | Database name. Can be overwritten by values specified in subcharts. |
| global.db.host | string | `"frostdb"` | Database host, allows using external databases. Use DNS name of the `frostdb` service when using frostdb subchart. Can be overwritten by values specified in subcharts. |
| global.db.port | int | `5432` | Database port. Can be overwritten by values specified in subcharts. |
| global.ingress.annotations | object | `{}` | Additional ingress annotations, that are set for all ingress routes of subcharts. |
| global.ingress.certManager.issuerEmail | string | `"[email protected]"` | eMail address for ACME registration with Let's Encrypt. Only used for issuerType = namespace. |
| global.ingress.certManager.issuerName | string | `"letsencrypt-staging"` | Name of the Issuer to use. For certManager.type = namespace `letsencrypt-staging`, `letsencrypt-production` and `self-signed` are available. |
Expand Down
40 changes: 30 additions & 10 deletions helm/charts/charts/caddy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Caddy webserver
| image.repository | string | `"caddy"` | Image repository |
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
| imagePullSecrets | list | `[]` | [Image pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) |
| ingress | object | `{"annotations":null,"certManager":{"issuerEmail":"[email protected]","issuerName":"letsencrypt-staging","issuerType":"namespace"},"className":"nginx","domains":[],"enabled":true,"subpath":null}` | Ingress configuration |
| ingress.annotations | string | `nil` | Additional Ingress annotations |
| ingress.certManager.issuerEmail | string | `"[email protected]"` | eMail address for ACME registration with Let's Encrypt. Only used for issuerType = namespace. |
| ingress.certManager.issuerName | string | `"letsencrypt-staging"` | Name of the Issuer to use. For certManager.type = namespace `letsencrypt-staging`, `letsencrypt-prod` and `self-signed` are available. |
Expand All @@ -30,9 +29,16 @@ Caddy webserver
| ingress.domains | list | `[]` | List of [FQDNs](https://de.wikipedia.org/wiki/Fully-Qualified_Host_Name) for this Ingress. Note: All FQDNs will be used for Ingress hosts and TLS certificate. |
| ingress.enabled | bool | `true` | Enable/disable ingress |
| ingress.subpath | string | `nil` | Make Caddy available at a subpath. By default Caddy will be available from [DOMAIN]/ Don't append or prepend :// or / |
| livenessProbe | object | `{"enabled":false,"failureThreshold":5,"initialDelaySeconds":10,"periodSeconds":5,"probe":{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}},"successThreshold":1,"terminationGracePeriodSeconds":null,"timeoutSeconds":1}` | [Liveness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. |
| livenessProbe.enabled | bool | `false` | Enable/disable liveness probe |
| livenessProbe.probe | object | `{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}}` | Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| livenessProbe.enabled | bool | `false` | Enable/disable liveness probe [Liveness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. Use `livenessProbe.probe: {}` to configure [livenessProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| livenessProbe.failureThreshold | int | `5` | |
| livenessProbe.initialDelaySeconds | int | `10` | |
| livenessProbe.periodSeconds | int | `5` | |
| livenessProbe.probe.httpGet.path | string | `"/"` | |
| livenessProbe.probe.httpGet.port | string | `"http"` | |
| livenessProbe.probe.httpGet.scheme | string | `"HTTP"` | |
| livenessProbe.successThreshold | int | `1` | |
| livenessProbe.terminationGracePeriodSeconds | string | `nil` | |
| livenessProbe.timeoutSeconds | int | `1` | |
| nameOverride | string | `nil` | Override name |
| nodeSelector | object | `{}` | |
| persistence.data.accessModes | list | `["ReadOnlyMany"]` | Storage [access modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) |
Expand All @@ -42,9 +48,16 @@ Caddy webserver
| persistence.storageClassName | string | `nil` | StorageClass to use, leave empty to use default StorageClass. |
| podAnnotations | object | `{}` | Additional pod annotations |
| podSecurityContext | object | `{}` | |
| readinessProbe | object | `{"enabled":false,"failureThreshold":5,"initialDelaySeconds":10,"periodSeconds":5,"probe":{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}},"successThreshold":1,"terminationGracePeriodSeconds":null,"timeoutSeconds":1}` | [Readiness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. |
| readinessProbe.enabled | bool | `false` | Enable/disable readiness probe |
| readinessProbe.probe | object | `{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}}` | Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| readinessProbe.enabled | bool | `false` | Enable/disable readiness probe [Readiness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. Use `readinessProbe.probe: {}` to configure [readinessProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| readinessProbe.failureThreshold | int | `5` | |
| readinessProbe.initialDelaySeconds | int | `10` | |
| readinessProbe.periodSeconds | int | `5` | |
| readinessProbe.probe.httpGet.path | string | `"/"` | |
| readinessProbe.probe.httpGet.port | string | `"http"` | |
| readinessProbe.probe.httpGet.scheme | string | `"HTTP"` | |
| readinessProbe.successThreshold | int | `1` | |
| readinessProbe.terminationGracePeriodSeconds | string | `nil` | |
| readinessProbe.timeoutSeconds | int | `1` | |
| replicaCount | int | `1` | Number of replicas. Only used if autoscaling.enabled = false |
| resources.limits.cpu | string | `"500m"` | |
| resources.limits.memory | string | `"500Mi"` | |
Expand All @@ -56,9 +69,16 @@ Caddy webserver
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| serviceAccount.create | bool | `false` | Specifies whether a service account should be created |
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
| startupProbe | object | `{"enabled":false,"failureThreshold":5,"initialDelaySeconds":10,"periodSeconds":5,"probe":{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}},"successThreshold":1,"terminationGracePeriodSeconds":null,"timeoutSeconds":1}` | [Startup probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. |
| startupProbe.enabled | bool | `false` | Enable/disable startup probe |
| startupProbe.probe | object | `{"httpGet":{"path":"/","port":"http","scheme":"HTTP"}}` | Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| startupProbe.enabled | bool | `false` | Enable/disable startup probe [Startup probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details. Use `startup.probe: {}` to configure [startupProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| startupProbe.failureThreshold | int | `5` | |
| startupProbe.initialDelaySeconds | int | `10` | |
| startupProbe.periodSeconds | int | `5` | |
| startupProbe.probe.httpGet.path | string | `"/"` | |
| startupProbe.probe.httpGet.port | string | `"http"` | |
| startupProbe.probe.httpGet.scheme | string | `"HTTP"` | |
| startupProbe.successThreshold | int | `1` | |
| startupProbe.terminationGracePeriodSeconds | string | `nil` | |
| startupProbe.timeoutSeconds | int | `1` | |
| tolerations | list | `[]` | |

----------------------------------------------
Expand Down
22 changes: 12 additions & 10 deletions helm/charts/charts/caddy/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ autoscaling:
targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80

# -- Ingress configuration
ingress:
# -- Enable/disable ingress
enabled: true
Expand Down Expand Up @@ -103,54 +102,57 @@ caddyfile: |-
file_server
}
# -- [Startup probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
startupProbe:
# -- Enable/disable startup probe
# [Startup probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
# Use `startup.probe: {}` to configure
# [startupProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
enabled: false
initialDelaySeconds: 10
periodSeconds: 5
timeoutSeconds: 1
successThreshold: 1
failureThreshold: 5
terminationGracePeriodSeconds:
# -- Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
probe:
httpGet:
path: /
port: http
scheme: HTTP

# -- [Liveness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
livenessProbe:
# -- Enable/disable liveness probe
# [Liveness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
# Use `livenessProbe.probe: {}` to configure
# [livenessProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
enabled: false
initialDelaySeconds: 10
periodSeconds: 5
timeoutSeconds: 1
successThreshold: 1
failureThreshold: 5
terminationGracePeriodSeconds:
# -- Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
probe:
httpGet:
path: /
port: http
scheme: HTTP

# -- [Readiness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
readinessProbe:
# -- Enable/disable readiness probe
# [Readiness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
# See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
# Use `readinessProbe.probe: {}` to configure
# [readinessProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
enabled: false
initialDelaySeconds: 10
periodSeconds: 5
timeoutSeconds: 1
successThreshold: 1
failureThreshold: 5
terminationGracePeriodSeconds:
# -- Configure [startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
probe:
httpGet:
path: /
Expand Down
4 changes: 2 additions & 2 deletions helm/charts/charts/certIssuer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Helm chart to provide namespace Issuers for CertManager
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| className | string | `"nginx"` | Name of the [IngressClass](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use. |
| enabled | bool | `true` | enable or disable namespace [Issuer](https://cert-manager.io/docs/concepts/issuer/) |
| issuerEmail | string | `"[email protected]"` | eMail address for registration with Let's Encrypt account |
| enabled | bool | `true` | enable or disable namespace [Issuer](https://cert-manager.io/docs/concepts/issuer/). |
| issuerEmail | string | `"[email protected]"` | eMail address for registration with Let's Encrypt account. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
4 changes: 2 additions & 2 deletions helm/charts/charts/certIssuer/values.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -- enable or disable namespace [Issuer](https://cert-manager.io/docs/concepts/issuer/)
# -- enable or disable namespace [Issuer](https://cert-manager.io/docs/concepts/issuer/).
enabled: true
# -- eMail address for registration with Let's Encrypt account
# -- eMail address for registration with Let's Encrypt account.
issuerEmail: [email protected]
# -- Name of the [IngressClass](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class)
# to use.
Expand Down
Loading

0 comments on commit 235b6d0

Please sign in to comment.