Skip to content

Commit

Permalink
Update Helm Chart documentation (#230)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidcollom authored Aug 14, 2024
1 parent c2a0128 commit e285636
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
4 changes: 4 additions & 0 deletions deploy/charts/version-checker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ A Helm chart for version-checker
| ecr.secretAccessKey | string | `nil` | ECR secret access key for read access to private registries |
| ecr.sessionToken | string | `nil` | ECR session token for read access to private registries |
| env | object | `{}` | Can be used to provide custom environment variables e.g. proxy settings |
| existingSecret | string | `""` | Provide an existing Secret within the cluster to use for authentication and configuration of version-checker |
| gcr.token | string | `nil` | Access token for read access to private GCR registries |
| ghcr.token | string | `nil` | Personal Access token for read access to GHCR releases |
| image.imagePullSecret | string | `nil` | Pull secrects - name of existing secret |
Expand All @@ -40,6 +41,7 @@ A Helm chart for version-checker
| livenessProbe.httpGet.port | int | `8080` | Port to use for the livenessProbe |
| livenessProbe.initialDelaySeconds | int | `3` | Number of seconds after the container has started before liveness probes are initiated. |
| livenessProbe.periodSeconds | int | `3` | How often (in seconds) to perform the livenessProbe. |
| nameOverride | string | `""` | Override the Chart Name |
| nodeSelector | object | `{}` | Configure nodeSelector |
| podSecurityContext | object | `{}` | Set pod-level security context |
| prometheus.enabled | bool | `false` | Deploy a Prometheus-Operator Prometheus Object to collect version-checker metrics |
Expand All @@ -66,3 +68,5 @@ A Helm chart for version-checker
| versionChecker.metricsServingAddress | string | `"0.0.0.0:8080"` | Port/interface to which version-checker should bind too |
| versionChecker.testAllContainers | bool | `true` | Enable/Disable the requirement for an enable.version-checker.io annotation on pods. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
2 changes: 1 addition & 1 deletion deploy/charts/version-checker/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ spec:
readinessProbe:
{{- omit .Values.readinessProbe "enabled" | toYaml | nindent 10}}
{{- end }}
{{- if .Values.existingSecret }}
{{- if not (empty .Values.existingSecret) }}
envFrom:
- secretRef:
name: {{.Values.existingSecret}}
Expand Down
8 changes: 7 additions & 1 deletion deploy/charts/version-checker/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

# -- Override the Chart Name
nameOverride: ""

# -- Replica Count for version-checker
replicaCount: 1

Expand Down Expand Up @@ -108,6 +111,8 @@ selfhosted:
# password: bar
# token:

# -- Provide an existing Secret within the cluster to use for authentication and configuration of version-checker
existingSecret: ""

# -- Setup version-checkers resource requests/limits
resources:
Expand All @@ -121,7 +126,8 @@ resources:
#

# -- Set container-level security context
securityContext: {}
securityContext:
{}
# allowPrivilegeEscalation: false
# capabilities:
# drop:
Expand Down

0 comments on commit e285636

Please sign in to comment.