Skip to content

Commit a8651fa

Browse files
committed
add documentation to the values
1 parent 34ea343 commit a8651fa

File tree

2 files changed

+86
-51
lines changed

2 files changed

+86
-51
lines changed

helmchart/geohealthcheck/README.md

Lines changed: 47 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,50 +8,70 @@ A Helm chart for GeoHealthCheck
88

99
| Key | Type | Default | Description |
1010
|-----|------|---------|-------------|
11+
| additionalCertificates | object | `{}` | |
1112
| affinity | object | `{}` | |
12-
| fullnameOverride | string | `""` | |
13+
| fullnameOverride | string | `""` | This is to override the release name. |
1314
| geohealthcheck.additionalConfigMaps | list | `[]` | additional configmaps additionalConfigMaps: - 'foo' - 'bar' |
1415
| geohealthcheck.additionalEnv | object | `{}` | additional env variables additionalEnv: name1: 'value1' name2: 'value2' |
1516
| geohealthcheck.additionalEnvSecrets | list | `[]` | additional envSecrets additionalEnvSecrets: - 'foo' - 'bar' |
17+
| geohealthcheck.adminEmail | string | `"[email protected]"` | email address of administrator / contact- notification emails will come from this address |
1618
| geohealthcheck.auth.secret | string | `"changeme"` | secret key to set when enabling authentication |
19+
| geohealthcheck.basicAuthDisabled | string | `"False"` | disable Basic Authentication to access GHC webapp and APIs (default: False), |
20+
| geohealthcheck.databaseUri | string | `"sqlite:///data.db"` | database connection string for SQL-Alchemy valid examples are: SQLite: 'sqlite:///data.db' PostgreSQL: 'postgresql+psycopg2://scott:tiger@localhost:5432/mydatabase' |
21+
| geohealthcheck.largeXml | string | `"False"` | allows GeoHealthCheck to receive large XML files from the servers under test (default False). Note: setting this to True might pose a security risk |
22+
| geohealthcheck.logLevel | string | `"30"` | logging level: 10=DEBUG 20=INFO 30=WARN(ING) 40=ERROR 50=FATAL/CRITICAL (default: 30, WARNING) |
23+
| geohealthcheck.metadataCacheSecs | string | `"900"` | metadata, “Capabilities Docs”, cache expiry time, default 900 secs, -1 to disable |
1724
| geohealthcheck.minimalRunFrequencyMins | int | `10` | minimal run frequency for Resource that can be set in web UI |
1825
| geohealthcheck.notifications | string | `"False"` | turn on email and webhook notifications |
26+
| geohealthcheck.notificationsEmail | list | `[]` | list of email addresses that notifications should come to. Use a different address to GHC_ADMIN_EMAIL if you have trouble receiving notification emails. Also, you can set separate notification emails t specific resources. Failing resource will send notification to emails from GHC_NOTIFICATIONS_EMAIL value and emails configured for that specific resource altogether. notificationsEmail: - '[email protected]' - '[email protected]' |
1927
| geohealthcheck.notificationsVerbosity | string | `"True"` | receive additional email notifications than just Failing and Fixed (default True) |
2028
| geohealthcheck.probeHttpTimeoutSecs | int | `30` | stop waiting for the first byte of a Probe response after the given number of seconds |
29+
| geohealthcheck.requireWebappAuth | string | `"False"` | require authentication (login or Basic Auth) to access GHC webapp and APIs (default: False) |
2130
| geohealthcheck.retentionDays | int | `30` | the number of days to keep Run history |
31+
| geohealthcheck.runnerInWebapp | string | `"True"` | should the GHC Runner Daemon be run in webapp (default: True) |
2232
| geohealthcheck.selfRegister | string | `"False"` | allow registrations from users on the website |
23-
| geohealthcheck.wwwLinkExceptionCheck | string | `"False"` | |
24-
| image.pullPolicy | string | `"IfNotPresent"` | |
25-
| image.repository | string | `"geopython/geohealthcheck"` | |
26-
| image.tag | string | `""` | |
27-
| imagePullSecrets | list | `[]` | |
28-
| ingress.annotations | object | `{}` | |
29-
| ingress.className | string | `""` | |
30-
| ingress.enabled | bool | `false` | |
31-
| ingress.hosts[0].host | string | `"chart-example.local"` | |
32-
| ingress.hosts[0].paths[0].path | string | `"/"` | |
33-
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
34-
| ingress.tls | list | `[]` | |
35-
| livenessProbe.httpGet.path | string | `"/"` | |
36-
| livenessProbe.httpGet.port | string | `"http"` | |
37-
| nameOverride | string | `""` | |
33+
| geohealthcheck.siteTitle | string | `"GeoHealthCheck Demonstration"` | title used for installation / deployment |
34+
| geohealthcheck.siteUrl | string | `"http://host"` | full URL of the installation / deployment |
35+
| geohealthcheck.smtpPassword | string | `nil` | SMTP server name or IP |
36+
| geohealthcheck.smtpPort | string | `nil` | SMTP port |
37+
| geohealthcheck.smtpServer | string | `nil` | SMTP server name or IP |
38+
| geohealthcheck.smtpUseTls | string | `nil` | whether or not to use StartTLS with SMTP |
39+
| geohealthcheck.smtpUsername | string | `nil` | SMTP server name or IP |
40+
| geohealthcheck.verifySsl | string | `"True"` | perform SSL verification for Probe HTTPS requests (default: True) |
41+
| geohealthcheck.wwwLinkExceptionCheck | string | `"False"` | turn on checking for OGC Exceptions in WWW:LINK Resource responses (default False) |
42+
| image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the image |
43+
| image.repository | string | `"geopython/geohealthcheck"` | image for GeoHealthCheck |
44+
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
45+
| imagePullSecrets | list | `[]` | This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ |
46+
| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ |
47+
| ingress.annotations | object | `{}` | annotations for the ingress annotations: kubernetes.io/ingress.class: nginx kubernetes.io/tls-acme: "true" |
48+
| ingress.className | string | `""` | ingress class name |
49+
| ingress.enabled | bool | `false` | enable/disable ingress |
50+
| initContainer.pullPolicy | string | `"IfNotPresent"` | Pull policy for the image of the init container |
51+
| initContainer.repository | string | `"library/ubuntu"` | image for the init container |
52+
| initContainer.resources | object | `{}` | resource definitions for the init container |
53+
| initContainer.tag | string | `"jammy"` | tag for the init container |
54+
| livenessProbe | object | `{"httpGet":{"path":"/","port":"http"}}` | This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ |
55+
| nameOverride | string | `""` | This is to override the chart name. |
56+
| networkPolicy.egressEnabled | bool | `true` | allow/deny external connections. This should be enabled if you want to monitor resources outside of this namespace |
57+
| networkPolicy.enabled | bool | `true` | Enable/disable network policy generation |
3858
| nodeSelector | object | `{}` | |
39-
| podAnnotations | object | `{}` | |
40-
| podLabels | object | `{}` | |
59+
| podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: yamllint disable-line rule:line-length https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ |
60+
| podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
4161
| podSecurityContext | object | `{}` | |
4262
| readinessProbe.httpGet.path | string | `"/"` | |
4363
| readinessProbe.httpGet.port | string | `"http"` | |
44-
| resources | object | `{}` | |
64+
| resources | object | `{}` | resources for the main container We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after 'resources:'. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi |
4565
| securityContext | object | `{}` | |
46-
| service.port | int | `80` | |
47-
| service.type | string | `"ClusterIP"` | |
48-
| serviceAccount.annotations | object | `{}` | |
49-
| serviceAccount.automount | bool | `true` | |
50-
| serviceAccount.create | bool | `true` | |
51-
| serviceAccount.name | string | `""` | |
66+
| service | object | `{"type":"ClusterIP"}` | This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ |
67+
| service.type | string | `"ClusterIP"` | This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types |
68+
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
69+
| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? |
70+
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
71+
| 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 |
5272
| tolerations | list | `[]` | |
53-
| volumeMounts | list | `[]` | |
54-
| volumes | list | `[]` | |
73+
| volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. volumeMounts: - name: foo mountPath: "/etc/foo" readOnly: true |
74+
| volumes | list | `[]` | Additional volumes on the output Deployment definition. volumes: - name: foo secret: secretName: mysecret optional: false |
5575

5676
----------------------------------------------
5777
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

helmchart/geohealthcheck/values.yaml

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,43 @@
22
# This sets the container image more information can be found here:
33
# https://kubernetes.io/docs/concepts/containers/images/
44
image:
5+
# -- image for GeoHealthCheck
56
repository: 'geopython/geohealthcheck'
7+
# -- Pull policy for the image
68
pullPolicy: 'IfNotPresent'
7-
# Overrides the image tag whose default is the chart appVersion.
9+
# -- Overrides the image tag whose default is the chart appVersion.
810
tag: ''
911

10-
# This is for the secretes for pulling an image from a private repository more
12+
# -- This is for the secretes for pulling an image from a private repository more
1113
# information can be found here:
1214
# https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1315
imagePullSecrets: []
14-
# This is to override the chart name.
16+
# -- This is to override the chart name.
1517
nameOverride: ''
18+
# -- This is to override the release name.
1619
fullnameOverride: ''
1720

1821
# This section builds out the service account more information can be found
1922
# here: https://kubernetes.io/docs/concepts/security/service-accounts/
2023
serviceAccount:
21-
# Specifies whether a service account should be created
24+
# -- Specifies whether a service account should be created
2225
create: true
23-
# Automatically mount a ServiceAccount's API credentials?
26+
# -- Automatically mount a ServiceAccount's API credentials?
2427
automount: true
25-
# Annotations to add to the service account
28+
# -- Annotations to add to the service account
2629
annotations: {}
27-
# The name of the service account to use.
30+
# -- The name of the service account to use.
2831
# If not set and create is true, a name is generated using the fullname
2932
# template
3033
name: ''
3134

32-
# This is for setting Kubernetes Annotations to a Pod.
35+
# -- This is for setting Kubernetes Annotations to a Pod.
3336
# For more information checkout:
3437
# yamllint disable-line rule:line-length
3538
# https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
3639
podAnnotations: {}
3740

38-
# This is for setting Kubernetes Labels to a Pod.
41+
# -- This is for setting Kubernetes Labels to a Pod.
3942
# For more information checkout:
4043
# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
4144
podLabels: {}
@@ -51,11 +54,16 @@ securityContext: {}
5154
# runAsNonRoot: true
5255
# runAsUser: 1000
5356

57+
# Definitions for the init container
5458
initContainer:
59+
# -- resource definitions for the init container
5560
resources: {}
61+
# -- image for the init container
5662
repository: 'library/ubuntu'
57-
pullPolicy: 'IfNotPresent'
63+
# -- tag for the init container
5864
tag: 'jammy'
65+
# -- Pull policy for the image of the init container
66+
pullPolicy: 'IfNotPresent'
5967

6068
geohealthcheck:
6169
# -- additional env variables
@@ -145,16 +153,16 @@ geohealthcheck:
145153
smtpUsername:
146154
# -- SMTP server name or IP
147155
smtpPassword:
148-
# This is for setting up a service more information can be found here:
156+
# -- This is for setting up a service more information can be found here:
149157
# https://kubernetes.io/docs/concepts/services-networking/service/
150158
service:
151-
# This sets the service type more information can be found here:
159+
# -- This sets the service type more information can be found here:
152160
# https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
153161
type: 'ClusterIP'
154162

155163
additionalCertificates: {}
156164

157-
# This block is for setting up the ingress for more information can be found
165+
# -- This block is for setting up the ingress for more information can be found
158166
# here: https://kubernetes.io/docs/concepts/services-networking/ingress/
159167
ingress:
160168
# -- enable/disable ingress
@@ -176,7 +184,7 @@ ingress:
176184
# hosts:
177185
# - chart-example.local
178186

179-
resources: {}
187+
# -- resources for the main container
180188
# We usually recommend not to specify default resources and to leave this as
181189
# a conscious choice for the user. This also increases chances charts run on
182190
# environments with little resources, such as Minikube. If you do want to
@@ -188,8 +196,9 @@ resources: {}
188196
# requests:
189197
# cpu: 100m
190198
# memory: 128Mi
199+
resources: {}
191200

192-
# This is to setup the liveness and readiness probes more information can be
201+
# -- This is to setup the liveness and readiness probes more information can be
193202
# found here:
194203
# https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
195204
livenessProbe:
@@ -201,25 +210,31 @@ readinessProbe:
201210
path: '/'
202211
port: 'http'
203212

204-
# Additional volumes on the output Deployment definition.
213+
# -- Additional volumes on the output Deployment definition.
214+
# volumes:
215+
# - name: foo
216+
# secret:
217+
# secretName: mysecret
218+
# optional: false
205219
volumes: []
206-
# - name: foo
207-
# secret:
208-
# secretName: mysecret
209-
# optional: false
210220

211-
# Additional volumeMounts on the output Deployment definition.
221+
# -- Additional volumeMounts on the output Deployment definition.
222+
# volumeMounts:
223+
# - name: foo
224+
# mountPath: "/etc/foo"
225+
# readOnly: true
212226
volumeMounts: []
213-
# - name: foo
214-
# mountPath: "/etc/foo"
215-
# readOnly: true
216227

217228
nodeSelector: {}
218229

219230
tolerations: []
220231

221232
affinity: {}
222233

234+
# Network Policy definition
223235
networkPolicy:
236+
# -- Enable/disable network policy generation
224237
enabled: true
238+
# -- allow/deny external connections. This should be enabled if you want to monitor resources
239+
# outside of this namespace
225240
egressEnabled: true

0 commit comments

Comments
 (0)